Partager via

Exécuter la console SSMA (Db2ToSQL)

  • Article

Microsoft vous fournit un ensemble robuste de commandes de fichier de script pour exécuter et contrôler les activités Assistant Migration SQL Server (SSMA). Les sections suivantes les détaillent. L’application console utilise certaines commandes de fichier de script standard, comme indiqué dans cette section.

Commandes de fichier script de projet

Les commandes Projet gèrent la création de projets, l’ouverture, l’enregistrement et la sortie de projets.

Interface

create-new-project: crée un projet SSMA.

Script

  • project-folder indique le dossier du projet créé.

  • project-name indique le nom du projet. {string}

  • overwrite-if-existsL’attribut facultatif indique si un projet existant doit être remplacé. {boolean}

  • project-type:Attribut facultatif. Indique le type de projet. Par exemple, sql-server-2019 ou sql-azure. La valeur par défaut est sql-server-2016.

Exemple :

<create-new-project
   project-folder="<project-folder>"
   project-name="<project-name>"
   overwrite-if-exists="<true/false>"   (optional)
   project-type="<sql-server-2016 | sql-server-2017 | sql-server-2019 | sql-server-2022 | sql-azure>"   (optional)
/>

L’attribut overwrite-if-exists est false par défaut.

L’attribut project-type est sql-server-2016 par défaut.

Interface

open-project: ouvre un projet existant.

Script

  • project-folder indique le dossier du projet créé. La commande échoue si le dossier spécifié n’existe pas. {string}

  • project-name indique le nom du projet. La commande échoue si le projet spécifié n’existe pas. {string}

Exemple de syntaxe :

<open-project
   project-folder="<project-folder>"
   project-name="<project-name>"
/>

L’application console SSMA pour Db2 prend en charge la compatibilité descendante. Vous pouvez ouvrir des projets créés par la version précédente de SSMA.

Interface

save-project: enregistre le projet de migration.

Exemple de syntaxe :

<save-project/>

Interface

close-project: ferme le projet de migration.

Exemple de syntaxe :

<close-project
   if-modified="<save/error/ignore>"   (optional)
/>

Commandes de fichier de script de connexion de base de données

Les commandes de connexion de base de données aident à se connecter à la base de données.

  • La fonctionnalité Parcourir de l’interface utilisateur n’est pas prise en charge dans la console.

  • Pour plus d’informations, consultez Créer des fichiers de script.

Interface

connect-source-database

  • Effectue une connexion à la base de données source et charge les métadonnées de haut niveau de la base de données source, mais pas toutes les métadonnées.

  • Si la connexion à la source ne peut pas être établie, une erreur est générée et l’application console arrête l’exécution ultérieure

Script

La définition du serveur est récupérée à partir de l’attribut de nom défini pour chaque connexion dans la section serveur du fichier de connexion du serveur ou du fichier de script.

Exemple de syntaxe :

<connect-source-database  server="<server-unique-name>"/>

Interface

force-load-source-database/force-load-target-database

  • Charge les métadonnées sources.

  • Utile pour travailler sur le projet de migration hors connexion.

  • Si la connexion à la source/cible ne peut pas être établie, une erreur est générée et l’application console arrête l’exécution ultérieure

Script

Nécessite un ou plusieurs nœuds de métabase comme paramètre de ligne de commande.

Exemple de syntaxe :

<force-load object-name="<object-name>"
  metabase="<source/target>"/>

Or

<force-load>
   <metabase-object object-name="<object-name>"/>
</force-load>

Interface

reconnect-source-database

  • Se reconnecte à la base de données source, mais ne charge pas de métadonnées contrairement à la commande connect-source-database.

  • Si (re)connexion avec la source ne peut pas être établie, une erreur est générée et l’application console arrête l’exécution ultérieure.

Exemple de syntaxe :

<reconnect-source-database  server="<server-unique-name>"/>

Interface

connect-target-database

  • Se connecte à la base de données SQL Server cible et charge les métadonnées de haut niveau de la base de données cible, mais pas entièrement les métadonnées.

  • Si la connexion à la cible ne peut pas être établie, une erreur est générée et l’application console arrête l’exécution ultérieure.

Script

La définition du serveur est récupérée à partir de l’attribut de nom défini pour chaque connexion dans la section serveur du fichier de connexion du serveur ou du fichier de script

Exemple de syntaxe :

<connect-target-database  server="<server-unique-name>"/>

Interface

reconnect-target-database

  • Se reconnecte à la base de données cible, mais ne charge pas de métadonnées, contrairement à la commande connect-target-database.

  • Si la (re)connexion à la cible ne peut pas être établie, une erreur est générée et l’application console arrête l’exécution ultérieure.

Exemple de syntaxe :

<reconnect-target-database  server="<server-unique-name>"/>

Commandes de fichier script de rapport

Les commandes Rapport génèrent des rapports sur les performances des différentes activités de la console SSMA.

Interface

generate-assessment-report

  • Génère des rapports d’évaluation sur la base de données source.

  • Si la connexion de base de données source n’est pas effectuée avant d’exécuter cette commande, une erreur est générée et l’application console se ferme.

  • L’échec de la connexion au serveur de base de données source pendant l’exécution de la commande entraîne également la fin de l’application console.

Script

  • conversion-report-folder: Spécifie le dossier dans lequel le rapport d’évaluation peut être stocké. (Attribut facultatif)

  • object-name: Spécifie les objets pris en compte pour la génération de rapport d’évaluation (il peut avoir des noms d’objets individuels ou un nom d’objet de groupe).

  • object-type: spécifie le type de l’objet spécifié dans l’attribut object-name (si la catégorie d’objet est spécifiée, le type d’objet est category).

  • conversion-report-overwrite: Spécifie s’il faut remplacer le dossier du rapport d’évaluation s’il existe déjà.

    Valeur par défaut : false. (Attribut facultatif)

  • write-summary-report-to: Spécifie le chemin d’accès où le rapport récapitulative est généré.

    Si seul le chemin d'accès du dossier est mentionné, le fichier par nom AssessmentReport<n>.XML est créé. (Attribut facultatif)

    La création de rapports comporte deux sous-catégories supplémentaires :

    • report-errorstrue ou false, avec la valeur par défaut comme false (attributs facultatifs)
    • verbosetrue ou false, avec la valeur par défaut comme false (attributs facultatifs)

Exemple de syntaxe :

<generate-assessment-report
   object-name="<object-name>"
   object-type="<object-category>"
   write-summary-report-to="<file>"   (optional)
   verbose="<true/false>"   (optional)
   report-errors="<true/false>"   (optional)
   assessment-report-folder="<folder-name>"   (optional)
   conversion-report-overwrite="<true/false>"   (optional)
/>

Or

<generate-assessment-report
   conversion-report-folder="<folder-name>"   (optional)
   conversion-report-overwrite="<true/false>"   (optional)
>
      <metabase-object object-name="<object-name>"
         object-type="<object-category>"/>
</generate-assessment-report>

Commandes de fichier script de migration

Les commandes de migration convertissent le schéma de la base de données cible en schéma source et migrent les données vers le serveur cible. Le paramètre de sortie de la console par défaut pour les commandes de migration est le rapport de sortie « Complet » sans rapport d’erreurs détaillé : résumé uniquement au niveau du nœud racine de l’arborescence d’objets source.

Interface

convert-schema

  • Effectue la conversion de schéma de la source vers le schéma cible.

  • Si la connexion de base de données source ou cible n’est pas effectuée avant d’exécuter cette commande ou si la connexion au serveur de base de données source ou cible échoue pendant l’exécution de la commande, une erreur est générée et l’application console se ferme.

Script

  • conversion-report-folder: Spécifie le dossier dans lequel le rapport d’évaluation peut être stocké. (Attribut facultatif)

  • object-name: Spécifie les objets sources pris en compte pour la conversion du schéma (il peut avoir des noms d’objets individuels ou un nom d’objet de groupe).

  • object-type: spécifie le type de l’objet spécifié dans l’attribut object-name (si la catégorie d’objet est spécifiée, le type d’objet est category).

  • conversion-report-overwrite: Spécifie s’il faut remplacer le dossier du rapport d’évaluation s’il existe déjà.

    Valeur par défaut : false. (Attribut facultatif)

  • write-summary-report-to: Spécifie le chemin d’accès où le rapport récapitulative est généré.

    Si seul le chemin d'accès du dossier est mentionné, le fichier par nom SchemaConversionReport<n>.XML est créé. (Attribut facultatif)

    La création de rapports comporte deux sous-catégories supplémentaires :

    • report-errorstrue ou false, avec la valeur par défaut comme false (attributs facultatifs)

    • verbosetrue ou false, avec la valeur par défaut comme false (attributs facultatifs)

Exemple de syntaxe :

<convert-schema
   object-name="<object-name>"
   object-type="<object-category>"
   write-summary-report-to="<file-name/folder-name>"   (optional)
   verbose="<true/false>"   (optional)
   report-errors="<true/false>"   (optional)
   conversion-report-folder="<folder-name>"   (optional)
   conversion-report-overwrite="<true/false>"   (optional)
/>

Or

<convert-schema
   conversion-report-folder="<folder-name>"   (optional)
   conversion-report-overwrite="<true/false>"   (optional)
      <metabase-object object-name="<object-name>"
         object-type="<object-category>"/>
</convert-schema>

Interface

migrate-data: migre les données sources vers la cible.

Script

  • conversion-report-folder: Spécifie le dossier dans lequel le rapport d’évaluation peut être stocké. (Attribut facultatif)

  • object-name: Spécifie les objets sources pris en compte pour la migration de données (il peut avoir des noms d’objets individuels ou un nom d’objet de groupe).

  • object-type: spécifie le type de l’objet spécifié dans l’attribut object-name (si la catégorie d’objet est spécifiée, le type d’objet est category).

  • conversion-report-overwrite: Spécifie s’il faut remplacer le dossier du rapport d’évaluation s’il existe déjà.

    Valeur par défaut : false. (Attribut facultatif)

  • write-summary-report-to: Spécifie le chemin d’accès où le rapport récapitulative est généré.

    Si seul le chemin du dossier est mentionné, le fichier par nom DataMigrationReport<n>.xml est créé. (Attribut facultatif)

    La création de rapports comporte deux sous-catégories supplémentaires :

    • report-errorstrue ou false, avec la valeur par défaut comme false (attributs facultatifs)
    • verbosetrue ou false, avec la valeur par défaut comme false (attributs facultatifs)

Exemple de syntaxe :

<migrate-data
   write-summary-report-to="<file-name/folder-name>"
   report-errors="<true/false>"
   verbose="<true/false>">
      <metabase-object object-name="<object-name>"/>
      <metabase-object object-name="<object-name>"/>
      <metabase-object object-name="<object-name>"/>
      <data-migration-connection
         source-use-last-used="true"/source-server="<server-unique-name>"
         target-use-last-used="true"/target-server="<server-unique-name>"/>
</migrate-data>

Or

<migrate-data
   object-name="<object-name>"
   object-type="<object-category>"
   write-summary-report-to="<file-name/folder-name>"
   report-errors="<true/false>"
   verbose="<true/false>"/>

Commandes de fichier de script de préparation de la migration

La commande Préparation de la migration lance le mappage de schéma entre les bases de données source et cible.

Interface

  • map-schema: mappage de schéma de la base de données source au schéma cible.

Script

  • source-schema: spécifie le schéma source que nous prévoyons de migrer.
  • sql-server-schema: spécifie le schéma cible dans lequel nous voulons qu’il soit migré.

Exemple de syntaxe :

<map-schema
   source-schema="<source-schema>"
   sql-server-schema="<target-schema>"/>

Interface

map-schema: mappage de schéma de la base de données source au schéma cible.

Script

source-schema spécifie le schéma source que nous avons l’intention de migrer.

sql-server-schema spécifie le schéma cible dans lequel nous voulons qu’il soit migré.

Exemple de syntaxe :

<map-schema
   source-schema="<source-schema>"
   sql-server-schema="<target-schema>"/>

Commandes de fichier de script de facilité de gestion

Les commandes de facilité de gestion permettent de synchroniser les objets de base de données cibles avec la base de données source.

Le paramètre de sortie de la console par défaut pour les commandes de migration est le rapport de sortie « Complet » sans rapport d’erreurs détaillé : résumé uniquement au niveau du nœud racine de l’arborescence d’objets source.

Interface

synchronize-target

  • Synchronise les objets cibles avec la base de données cible.

  • Si cette commande est exécutée sur la base de données source, une erreur est rencontrée.

  • Si la connexion de base de données cible n’est pas effectuée avant l’exécution de cette commande ou si la connexion au serveur de base de données cible échoue pendant l’exécution de la commande, une erreur est générée et l’application console se ferme.

Script

  • object-name: Spécifie les objets cibles pris en compte pour la synchronisation avec la base de données cible (il peut avoir des noms d’objets individuels ou un nom d’objet de groupe).

  • object-type: spécifie le type de l’objet spécifié dans l’attribut object-name (si la catégorie d’objet est spécifiée, le type d’objet est category).

  • on-error: Spécifie s’il faut spécifier des erreurs de synchronisation en tant qu’avertissements ou erreur. Options disponibles pour l’erreur :

    • report-total-as-warning
    • report-each-as-warning
    • fail-script

  • report-errors-to: Spécifie l’emplacement du rapport d’erreur pour l’opération de synchronisation (attribut facultatif)

    Si seul le chemin d’accès au dossier est donné, le fichier par nom TargetSynchronizationReport.xml est créé.

Exemple de syntaxe :

<synchronize-target
   object-name="<object-name>"
   on-error="<report-total-as-warning/
               report-each-as-warning/
               fail-script>"   (optional)
   report-errors-to="<file-name/folder-name>"   (optional)
/>

Or

<synchronize-target
   object-name="<object-name>"
   object-type="<object-category>"/>

Or

<synchronize-target>
   <metabase-object object-name="<object-name>"/>
   <metabase-object object-name="<object-name>"/>
   <metabase-object object-name="<object-name>"/>
</synchronize-target>

Interface

refresh-from-database

  • Actualise les objets sources de la base de données.

  • Si cette commande est exécutée sur la base de données cible, une erreur est générée.

Script

Nécessite un ou plusieurs nœuds de métabase comme paramètre de ligne de commande.

  • object-name: Spécifie les objets sources pris en compte pour l’actualisation à partir de la base de données source (il peut avoir des noms d’objets individuels ou un nom d’objet de groupe).

  • object-type: Spécifie le type de l’objet spécifié dans l’attribut object-name (si la catégorie d’objet est spécifiée, le type d’objet est category).

  • on-error: Spécifie s’il faut spécifier des erreurs d’actualisation en tant qu’avertissements ou erreur. Options disponibles pour l’erreur :

    • report-total-as-warning
    • report-each-as-warning
    • fail-script

  • report-errors-to: Spécifie l’emplacement du rapport d’erreur pour l’opération d’actualisation (attribut facultatif) si seul le chemin d’accès au dossier est donné, le fichier par nom SourceDBRefreshReport.xml est créé.

Exemple de syntaxe :

<refresh-from-database
   object-name="<object-name>"
   on-error="<report-total-as-warning/
               report-each-as-warning/
               fail-script>"   (optional)
   report-errors-to="<file-name/folder-name>"   (optional)
/>

Or

<refresh-from-database
   object-name="<object-name>"
   object-type="<object-category>"/>

Or

<refresh-from-database>
   <metabase-object object-name="<object-name>"/>
</refresh-from-database>

Commandes de fichier de script de génération de script de script

Les commandes génération de script effectuent des tâches doubles : elles permettent d’enregistrer la sortie de la console dans un fichier de script ; et enregistrez la sortie T-SQL dans la console ou un fichier en fonction du paramètre que vous spécifiez.

Interface

save-as-script: Enregistrez les scripts des objets dans un fichier mentionné lorsque metabase=target. Il s’agit d’une alternative à la commande de synchronisation dans laquelle nous obtenons les scripts et qui s’exécutent de la même façon sur la base de données cible.

Script

Nécessite un ou plusieurs nœuds de métabase comme paramètre de ligne de commande.

  • object-name: Spécifie les objets dont les scripts doivent être enregistrés. (Il peut avoir des noms d’objets individuels ou un nom d’objet de groupe)

  • object-type: spécifie le type de l’objet spécifié dans l’attribut object-name (si la catégorie d’objet est spécifiée, le type d’objet est category).

  • metabase: Spécifie s’il s’agit de la métabase source ou cible.

  • destination: Spécifie le chemin d’accès ou le dossier dans lequel le script doit être enregistré, si le nom de fichier n’est pas donné, un nom de fichier au format (object_name valeur d’attribut).

  • overwrite: s’il true remplace ensuite si le même nom de fichier existe. Elle peut avoir les valeurs (true/false).

Exemple de syntaxe :

<save-as-script
   metabase="<source/target>"
   object-name="<object-name>"
   object-type="<object-category>"
   destination="<file/folder>"
   overwrite="<true/false>"   (optional)
/>

Or

<save-as-script
   metabase="<source/target>"
   destination="<file/folder>"
      <metabase-object object-name="<object-name>"
         object-type="<object-category>"/>
</save-as-script>

Interface

convert-sql-statement

  • context spécifie le nom du schéma.

  • destination spécifie si la sortie doit être stockée dans un fichier.

    Si cet attribut n’est pas spécifié, l’instruction T-SQL convertie s’affiche sur la console. (Attribut facultatif)

  • conversion-report-folder spécifie le dossier dans lequel le rapport d’évaluation peut être stocké. (Attribut facultatif)

  • conversion-report-overwrite spécifie s’il faut remplacer le dossier du rapport d’évaluation s’il existe déjà.

    Valeur par défaut : false. (Attribut facultatif)

  • write-converted-sql-to spécifie le chemin du dossier (ou) du fichier dans lequel le T-SQL converti doit être stocké. Lorsqu’un chemin d’accès au dossier est spécifié avec l’attribut sql-files , chaque fichier source a un fichier T-SQL cible correspondant créé sous le dossier spécifié. Lorsqu’un chemin d’accès au dossier est spécifié avec l’attribut sql , le T-SQL converti est écrit dans un fichier nommé Result.out sous le dossier spécifié.

  • sql spécifie les instructions SQL Db2 à convertir, une ou plusieurs instructions peuvent être séparées à l’aide d’un « ; »

  • sql-files spécifie le chemin des fichiers SQL qui doivent être convertis en code T-SQL.

  • write-summary-report-to spécifie le chemin d’accès où le rapport est généré. Si seul le chemin du dossier est mentionné, le fichier par nom ConvertSQLReport.xml est créé. (Attribut facultatif)

    La création de rapports comporte deux sous-catégories supplémentaires :

    • report-errors: true ou false, avec la valeur par défaut comme false (attributs facultatifs)
    • verbose: true ou false, avec la valeur par défaut comme false (attributs facultatifs)

Script

Nécessite un ou plusieurs nœuds de métabase comme paramètre de ligne de commande.

Exemple de syntaxe :

<convert-sql-statement
   context="<schema-name>"
   conversion-report-folder="<folder-name>"
   conversion-report-overwrite="<true/false>"
   write-summary-report-to="<file-name/folder-name>"   (optional)
   verbose="<true/false>"   (optional)
   report-errors="<true/false>"   (optional)
   destination="<stdout/file>"   (optional)
   file-name="<file-name>"
   sql="SELECT 1 FROM DUAL;">
   <output-window suppress-messages="<true/false>" />
</convert-sql-statement>

Or

<convert-sql-statement
   context="<schema-name>"
   conversion-report-folder="<folder-name>"
   conversion-report-overwrite="<true/false>"
   write-summary-report-to="<file-name/folder-name>" (optional)
   verbose="<true/false>" (optional)
   report-errors="<true/false>"
   destination="<stdout/file>"   (optional)
   write-converted-sql-to="<file-name/folder-name>"
   sql-files="<folder-name>\*.sql" />

Or

<convert-sql-statement
   context="<schema-name>"
   conversion-report-folder="<folder-name>"
   conversion-report-overwrite="<true/false>"
   sql-files="<folder-name>\*.sql" />

Contenu connexe