Compartilhar via

Execução do console do SSMA (AccessToSQL)

  • Artigo

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 SSMA. As seções a seguir detalham a mesma coisa.

Comandos do arquivo de script do Project

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

Comando

create-new-project: cria um novo projeto do SSMA.

Script

  • project-folder indica a pasta do projeto que está sendo criado.

  • project-name indica o nome do projeto. {string}

  • overwrite-if-existsO atributo opcional indica se um projeto existente deve ser substituído. {boolean}

  • project-type é um atributo opcional. As seguintes opções estão disponíveis para o tipo de projeto:

    • sql-server-2005

    • sql-server-2008

    • sql-server-2012

    • sql-server-2014

    • sql-server-2016

    • sql-azure

    O padrão é “sql-server-2008”.

Exemplo:

<create-new-project  
  
  project-folder="<project-folder>"  
  
  project-name="<project-name>"  
  
  overwrite-if-exists="<true/false>"  
  
  project-type="<sql-server-2008 | sql-server-2005 | sql-server-2012 | sql-server-2014 | sql-azure>"  
  
/>

O atributo “overwrite-if-exists” é false por padrão.

O atributo “project-type” é sql-server-2008 por padrão.

Comando

open-project: abre um projeto existente.

Script

  • project-folder indica a pasta do projeto que está sendo criado. O comando falhará se a pasta especificada não existir. {string}

  • project-name indica o nome do projeto. O comando falhará se o projeto especificado não existir. {string}

Exemplo de sintaxe:

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

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

Comando

save-project: salva o projeto de migração.

Script

Exemplo de sintaxe:

<save-project/>

Comando

close-project: fecha o projeto de migração.

Script

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 na conexão ao banco de dados.

O recurso Procurar da interface do usuário não é suportado no console.

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

Para obter mais informações sobre “Como criar arquivos de script', consulte Criar arquivos de script (AccessToSQL).

Comando

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, será gerado um erro e o aplicativo de console interromperá a execução adicional

Script

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

Exemplo de sintaxe:

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

Comando

load-access-database: usado para carregar arquivos de banco de dados do Access

Script

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>

Comando

force-load-source/target-database

  • Carrega os metadados de origem.

  • Útil para trabalhar em projetos de migração offline.

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

Script

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

Exemplo de sintaxe:

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

ou

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

Comando

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, será gerado um erro e o aplicativo de console interromperá a execução adicional.

Script

Exemplo de sintaxe:

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

Comando

connect-target-database

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

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

Script

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

Exemplo de sintaxe:

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

Comando

reconnect-target-database

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

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

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 do SSMA

Comando

generate-assessment-report

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

  • Se a conexão de banco de dados de origem não for executada antes de executar esse comando, será gerado um erro 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 do relatório 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 será gerado.

    Se apenas o caminho da pasta for mencionado, será criado o arquivo pelo nome AssessmentReport<n>.XML. (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 de migração do arquivo de script

Os comandos de migração convertem o esquema de banco de dados de destino para o esquema de origem e migram os dados para o servidor de destino.

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

Comando

convert-schema

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

  • Se a conexão de 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, será gerado um erro 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 o esquema (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 será gerado.

    Se apenas o caminho da pasta for mencionado, será criado o arquivo pelo nome SchemaConversionReport<n>.XML. (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>

Comando

migrate-data

  • Migra os dados da 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 será gerado.

    Se apenas o caminho da pasta for mencionado, será criado o arquivo pelo nome DataMigrationReport<n>.XML. (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"/>

Comando

link-tables: este comando vincula a tabela de origem (Access) à tabela de destino.

Script

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>

Comando

unlink-tables: este comando desvincula a tabela de origem (Access) da tabela de destino.

Script

Exemplos 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 de preparação para a migração do arquivo de script

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

Comando

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 Capacidade de gerenciamento

Os comandos de Capacidade de gerenciamento ajudam a sincronizar os objetos de banco de dados de destino com o banco de dados de origem.

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

Comando

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 de 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, será gerado um erro 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 erros de sincronização devem ser especificados como avisos ou erros. Opções disponíveis para o on-error:

    • 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 TargetSynchronizationReport.XML será 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>

Comando

refresh-from-database

  • Atualiza os objetos de origem do banco de dados.

  • Se esse comando for executado no banco de dados de destino, será gerado um erro.

Script

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

  • object-name: Especifica os objetos de origem considerados para a atualização do banco de dados de origem (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 erros de atualização devem ser especificados como avisos ou erros. Opções disponíveis para o on-error:

    • 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 atualização (atributo opcional), se for fornecido apenas o caminho da pasta, e, em seguida, o arquivo pelo nome SourceDBRefreshReport.XML será 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 de arquivo de script para a geração de script

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

Comando

save-as-script

Usado para salvar os scripts dos objetos em um arquivo mencionado quando metabase=target. Esta é uma alternativa ao comando de sincronização em que os scripts são obtidos e executados no banco de dados de destino.

Script

Requer um ou vários nós de 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 atributo object-name (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, um nome de arquivo no formato (object_name attribute value).out será fornecido.

  • overwrite: se for true, o mesmo nome de arquivo será substituído, caso exista. 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>

Próximas etapas

Para obter informações sobre as opções de linha de comando, confira Opções de linha de comando no console do SSMA (AccessToSQL).

Para obter informações sobre os arquivos de script de console de exemplo, confira Trabalhar com os arquivos do script do console de exemplo em execução no console do SSMA (AccessToSQL)

A próxima etapa depende dos requisitos do seu projeto: