Partilhar via


Executar a Consola SSMA (AccessToSQL)

A Microsoft fornece um conjunto robusto de comandos de arquivo de script e opções de linha de comando para executar e controlar atividades do Assistente de Migração do SQL Server (SSMA). As secções seguintes detalham o mesmo.

Comandos do arquivo de script do projeto

Os comandos Project lidam com a criação de projetos, abertura, salvamento e saída de projetos.

create-new-project

Cria um novo projeto SSMA.

Attribute Valor predefinido Description Tipo
project-folder Nenhum Indica a pasta do projeto que está sendo criado. Corda
project-name Nenhum Indica o nome do projeto. Corda
overwrite-if-exists false Atributo opcional, especificando se um projeto existente deve ser substituído. booleano
project-type sql-server-2016 Atributo opcional. As seguintes opções estão disponíveis para project-type:

sql-server-2016
sql-server-2017
sql-server-2019
sql-server-2022
sql-server-2025
sql-azure
Corda

Exemplo de sintaxe

<create-new-project
  project-folder="<project-folder>"
  project-name="<project-name>"
  overwrite-if-exists="<true | false>"
  project-type="<project-type>"
/>

open-project

Abre um projeto existente.

Attribute Valor predefinido Description Tipo
project-folder Nenhum Indica a pasta do projeto que está sendo criado. O comando falhará se a pasta especificada não existir. Corda
project-name Nenhum Indica o nome do projeto. O comando falhará se o projeto especificado não existir. Corda

Exemplo de sintaxe

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

Observação

O aplicativo SSMA For Access Console oferece suporte à compatibilidade com versões anteriores. Você pode abrir projetos criados pela versão anterior do SSMA.

save-project

Salva o projeto de migração.

Exemplo de sintaxe

<save-project/>

close-project

Fecha o projeto de migração.

Attribute Valor predefinido Description Tipo
if-modified ignore Atributo opcional para especificar o comportamento. Os valores possíveis são: save, errore ignore. Corda

Exemplo de sintaxe

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

O atributo if-modified é opcional, ignore por padrão.

Comandos do arquivo de script de conexão de banco de dados

Os comandos Conexão de Banco de Dados ajudam a se conectar ao banco de dados.

O recurso Procurar da interface não é suportado no console.

Os windows-authentication parâmetros e port não são aplicáveis ao ligar ao Azure SQL.

Para obter mais informações, consulte Criar arquivos de script.

connect-source-database

Executa a conexão com o banco de dados de origem e carrega metadados de alto nível do banco de dados de origem, mas não todos os metadados.

Se a conexão com a origem não puder ser estabelecida, um erro será gerado e o aplicativo de console interromperá a execução adicional

A server definição é recuperada do atributo name definido para cada conexão na server seção do arquivo de conexão do servidor ou do arquivo de script.

Exemplo de sintaxe

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

load-access-database

Usado para carregar ficheiros de banco de dados do Access.

Attribute Valor predefinido Description Tipo
database-file Nenhum Especifica o caminho para um banco de dados do Access. Corda

Exemplo de sintaxe

<load-access-database  database-file="<Access-database>"/>

Ou:

<load-access-database>
  <access-database database-file="<Access-database1>"/>
  <access-database database-file="<Access-database2>"/>
</load-access-database>

force-load Base de dados de origem ou de destino

Carrega os metadados de origem. Útil para trabalhar no projeto de migração offline.

Se a conexão com a origem ou o destino não puder ser estabelecida, um erro será gerado e o aplicativo de console interromperá a execução adicional.

Requer um ou mais nodos metabase como parâmetro de linha de comando.

Attribute Valor predefinido Description Tipo
object-name Nenhum Especifica o nome do objeto. Corda
metabase Nenhum Especifica o caminho para um banco de dados do Access. Os valores possíveis são: source ou target Corda

Exemplo de sintaxe

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

Ou:

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

reconnect-source-database

Reconecta-se ao banco de dados de origem, mas não carrega nenhum metadado, ao contrário do comando connect-source-database.

Se a (re)conexão com a origem não puder ser estabelecida, um erro será gerado e o aplicativo de console interromperá a execução adicional.

A server definição é recuperada do atributo name definido para cada conexão na server seção do arquivo de conexão do servidor ou do arquivo de script.

Exemplo de sintaxe

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

connect-target-database

Conecta-se ao SQL Server de destino ou ao Banco de Dados SQL do Azure e carrega metadados de alto nível do banco de dados de destino, mas não totalmente os metadados.

Se a conexão com o destino não puder ser estabelecida, um erro será gerado e o aplicativo de console interromperá a execução.

A server definição é recuperada do atributo name definido para cada conexão na server seção do arquivo de conexão do servidor ou do arquivo de script.

Exemplo de sintaxe

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

reconnect-target-database

Reconecta-se ao banco de dados de destino, mas não carrega nenhum metadados, ao contrário do comando connect-target-database.

Se a (re)conexão com o destino não puder ser estabelecida, um erro será gerado e o aplicativo de console interromperá a execução adicional.

A server definição é recuperada do atributo name definido para cada conexão na server seção do arquivo de conexão do servidor ou do arquivo de script.

Exemplo de sintaxe

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

Comandos do arquivo de script de relatório

Os comandos Report geram relatórios sobre o desempenho de várias atividades do Console SSMA

generate-assessment-report

Gera relatórios de avaliação no banco de dados de origem.

Se a conexão do banco de dados de origem não for executada antes de executar esse comando, um erro será gerado e o aplicativo de console será encerrado.

A falha ao se conectar ao servidor de banco de dados de origem durante a execução do comando também resulta no encerramento do aplicativo de console.

Script

  • assessment-report-folder: Especifica a pasta onde o relatório de avaliação pode ser armazenado. (atributo opcional)

  • object-name: Especifica os objetos considerados para a geração de relatórios de avaliação (pode ter nomes de objetos individuais ou um nome de objeto de grupo).

  • object-type: especifica o tipo do objeto especificado no atributo object-name (se a categoria do objeto for especificada, o tipo de objeto será "category").

  • assessment-report-overwrite: Especifica se a pasta do relatório de avaliação deve ser substituída, caso ela já exista.

    Valor padrão: false. (atributo opcional)

  • write-summary-report-to: Especifica o caminho onde o relatório é gerado.

    Se apenas o caminho da pasta for mencionado, o arquivo por nome AssessmentReport<n>.xml será criado. (atributo opcional)

    A criação de relatórios tem mais duas subcategorias:

    • report-errors (="true/false", com padrão como "false" (atributos opcionais))
    • verbose (="true/false", com padrão como "false" (atributos opcionais))

Exemplo de sintaxe

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

Ou:

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

Comandos do arquivo de script de migração

Os comandos Migration convertem o esquema do banco de dados de destino para o esquema de origem e migram dados para o servidor de destino.

A configuração de saída padrão do console para os comandos de migração é o relatório de saída 'Completo' sem relatório de erros detalhado: apenas resumo no nó raiz da árvore de objetos de origem.

convert-schema

Executa a conversão de esquema do esquema de origem para o esquema de destino.

Se a conexão do banco de dados de origem ou de destino não for executada antes da execução desse comando, ou se a conexão com o servidor de banco de dados de origem ou de destino falhar durante a execução do comando, um erro será gerado e o aplicativo de console será encerrado.

Script

  • conversion-report-folder: Especifica a pasta onde o relatório de avaliação pode ser armazenado. (atributo opcional)

  • object-name: Especifica os objetos de origem considerados para converter esquema (Ele pode ter nomes de objetos individuais ou um nome de objeto de grupo).

  • object-type: especifica o tipo do objeto especificado no atributo object-name (se a categoria do objeto for especificada, o tipo de objeto será "category").

  • conversion-report-overwrite: Especifica se a pasta do relatório de avaliação deve ser substituída, caso ela já exista.

    Valor padrão: false. (atributo opcional)

  • write-summary-report-to: Especifica o caminho onde o relatório é gerado.

    Se apenas o caminho da pasta for mencionado, o arquivo por nome SchemaConversionReport<n>.xml será criado. (atributo opcional)

    A criação de relatórios tem mais duas subcategorias:

    • report-errors (="true/false", com padrão como "false" (atributos opcionais))
    • verbose (="true/false", com padrão como "false" (atributos opcionais))

Exemplo de sintaxe

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

Ou:

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

migrate-data

Migra os dados de origem para o destino.

Script

  • object-name: Especifica os objetos de origem considerados para migrar dados (pode ter nomes de objetos individuais ou um nome de objeto de grupo).

  • object-type: especifica o tipo do objeto especificado no atributo object-name (se a categoria do objeto for especificada, o tipo de objeto será "category").

  • write-summary-report-to: Especifica o caminho onde o relatório é gerado.

    Se apenas o caminho da pasta for mencionado, o arquivo por nome DataMigrationReport<n>.xml será criado. (atributo opcional)

    A criação de relatórios tem mais duas subcategorias:

    • report-errors (="true/false", com padrão como "false" (atributos opcionais))

    • verbose (="true/false", com padrão como "false" (atributos opcionais))

Exemplo de sintaxe

<migrate-data
  write-summary-report-to="<filepath/folder>"
  report-errors="true" verbose="true">
    <metabase-object object-name="ssma.TT1"/>
    <metabase-object object-name="ssma.TT2"/>
    <metabase-object object-name="ssma.TT3"/>
    <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>

Ou:

<migrate-data
  object-name="ssma.Tables"
  object-type="category"
  write-summary-report-to="<filepath/folder>"
  report-errors="true" verbose="true"/>

Este comando vincula a tabela de origem (Access) à tabela de destino.

Exemplo de sintaxe

<link-tables>
  <metabase-object object-name="AccessDatabase.table1" object-type="Tables"/>
  <metabase-object object-name="AccessDatabase.table2" object-type="Tables"/>
</link-tables>

Ou:

<link-tables>
  <metabase-object object-name="AccessDatabase.Tables" object-type="category"/>
</link-tables>

Este comando desvincula a tabela de origem (Access) da tabela de destino.

Exemplo de sintaxe

<unlink-tables>
  <metabase-object object-name="AccessDatabase.table1" object-type="Tables"/>
  <metabase-object object-name="AccessDatabase.table2" object-type="Tables"/>
</unlink-tables>

Ou:

<unlink-tables>
  <metabase-object object-name="AccessDatabase.Tables" object-type="category"/>
</unlink-tables>

Comandos do ficheiro de script para a preparação da migração

O comando Preparação da Migração inicia o mapeamento de esquema entre os bancos de dados de origem e de destino.

map-schema

Mapeamento de esquema do banco de dados de origem para o esquema de destino.

Script

  • source-schema especifica o esquema de origem que pretendemos migrar.
  • sql-server-schema especifica o esquema de destino para onde queremos que ele seja migrado.

Exemplo de sintaxe

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

Comandos de gerenciabilidade

Os comandos Manageability ajudam a sincronizar os objetos do banco de dados de destino com o banco de dados de origem.

A configuração de saída padrão do console para os comandos de migração é o relatório de saída 'Completo' sem relatório de erros detalhado: apenas resumo no nó raiz da árvore de objetos de origem.

synchronize-target

Sincroniza os objetos de destino com o banco de dados de destino. Se esse comando for executado no banco de dados de origem, você receberá um erro.

Se a conexão do banco de dados de destino não for executada antes da execução desse comando ou se a conexão com o servidor de banco de dados de destino falhar durante a execução do comando, um erro será gerado e o aplicativo de console será encerrado.

Script

  • object-name: Especifica os objetos de destino considerados para sincronização com o banco de dados de destino (Ele pode ter nomes de objetos individuais ou um nome de objeto de grupo).

  • object-type: Especifica o tipo do objeto especificado no atributo object-name (se a categoria do objeto for especificada, o tipo de objeto será category).

  • on-error: Especifica se os erros de sincronização devem ser especificados como avisos ou erro. Opções disponíveis:

    • report-total-as-warning
    • report-each-as-warning
    • fail-script
  • report-errors-to: Especifica o local do relatório de erros para a operação de sincronização (atributo opcional)

    Se apenas o caminho da pasta for fornecido, um arquivo com o nome de TargetSynchronizationReport.xml é criado.

Exemplo de sintaxe

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

Ou:

<synchronize-target
  object-name="ssma.dbo.Procedures"
  object-type="category"/>

Ou:

<synchronize-target>
  <metabase-object object-name="ssma.dbo.TT1"/>
  <metabase-object object-name="ssma.dbo.TT2"/>
  <metabase-object object-name="ssma.dbo.TT3"/>
</synchronize-target>

refresh-from-database

Atualiza os objetos de origem do banco de dados. Se esse comando for executado no banco de dados de destino, um erro será gerado.

Script

Requer um ou vários nós da metabase como parâmetro de linha de comando.

  • object-name: Especifica os objetos de origem considerados para atualização do banco de dados de origem (Ele pode ter nomes de objetos individuais ou um nome de objeto de grupo).

  • object-type: Especifica o tipo do objeto especificado no atributo object-name (se a categoria do objeto for especificada, o tipo de objeto será category).

  • on-error: Especifica se os erros de atualização devem ser especificados como avisos ou erros. Opções disponíveis:

    • report-total-as-warning
    • report-each-as-warning
    • fail-script
  • report-errors-to: Especifica o local do relatório de erros para a operação de sincronização (atributo opcional)

    Se apenas o caminho da pasta for fornecido, um arquivo com o nome de SourceDBRefreshReport.xml é criado.

Exemplo de sintaxe

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

Ou:

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

Ou:

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

Comandos do ficheiro de script de geração

Os comandos de Geração de Scripts ajudam a salvar a saída do console em um arquivo de script.

save-as-script

Usado para guardar os scripts dos objetos num ficheiro especificado quando metabase=target. Esta é uma alternativa ao comando de sincronização, no qual obtemos os scripts e executamos os mesmos no banco de dados de destino.

Script

Requer um ou vários nós da metabase como parâmetro de linha de comando.

  • object-name: Especifica os objetos cujos scripts devem ser salvos. (Pode ter nomes de objetos individuais ou um nome de objeto de grupo).

  • object-type: Especifica o tipo do objeto especificado no object-name atributo. Se a categoria do objeto for especificada, o tipo de objeto será category.

  • metabase: Especifica se é a metabase de origem ou de destino.

  • destination: Especifica o caminho ou a pasta onde o script deve ser salvo. Se o nome do arquivo não for fornecido, então um nome de arquivo no formato (object_name attribute value).

  • overwrite: Se true então ele sobrescreve se existirem nomes de ficheiros idênticos. Pode ter os valores (true/false).

Exemplo de sintaxe

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

Ou:

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