スクリプト ファイルの作成 (AccessToSQL)

  • [アーティクル]

SSMA コンソール アプリケーションを起動する前の最初の手順は、スクリプト ファイルを作成し、必要に応じて変数値ファイルとサーバー接続ファイルを作成することです。

スクリプト ファイルは、次の 3 つのセクションに分割できます。

  1. config: ユーザーがコンソール アプリケーションの構成パラメーターを設定できるようにします。

  2. servers: ユーザーがソース/ターゲット サーバー定義を設定できるようにします。 これは、別のサーバー接続ファイルに含めることもできます。

  3. script-commands: ユーザーが SSMA ワークフロー コマンドを実行できるようにします。

それぞれについて後のセクションで説明します:

Access コンソールの設定の構成

スクリプトの構成は、コンソール スクリプト ファイルに表示されます。

いずれかの要素が構成ノードで指定されている場合、グローバル設定として設定されます。つまり、すべてのスクリプト コマンドに適用できます。 ユーザーがグローバル設定をオーバーライドする場合、script-command セクションの各コマンド内でこれらの構成要素を設定することもできます。

ユーザー設定可能なオプションは次の通りです:

  1. 出力ウィンドウプロバイダー: suppress-messages 属性が 'true' に設定されている場合、コマンド固有のメッセージはコンソールに表示されません。 属性の説明を以下に示します。

    • destination: 出力をファイルまたは StdOut に出力する必要があるかどうかを指定します。 既定では、false です。

    • file-name: ファイルのパス (オプション)。

    • suppress-messages: コンソール上のメッセージを非表示にします。 既定では、false です。

    例:

    <output-providers>  

  <output-window  

    suppress-messages="<true/false>"   (optional)  

    destination="<file/stdout>"        (optional)  

    file-name="<file-name>"            (optional)  

   />  

</output-providers>

    or

    <...All commands...>  

  <output-window  

     suppress-messages="<true/false>"   (optional)  

     destination="<file/stdout>"        (optional)  

     file-name="<file-name>"            (optional)  

   />  

</...All commands...>

  2. データ移行接続プロバイダー: データ移行で考慮するソース/ターゲット サーバーを指定します。 Source-use-last-used は、最後に使用されたソース サーバーがデータ移行に使用されることを示します。 同様に、target-use-last-used は、最後に使用されたターゲット サーバーがデータ移行に使用されることを示します。 ユーザーは、source-server または target-server 属性を使用して、サーバー (ソースまたはターゲット) を指定することもできます。

    1 つまたは他の指定された属性のみを使用できます。つまり、次のようになります。

    • source-use-last-used="true" (既定) または source-server="source_servername"

    • target-use-last-used="true" (既定) または target-server="target_servername"

    例:

    <output-providers>  

  <data-migration-connection   source-use-last-used="true"  

                               target-server="target_1"/>  

</output-providers>

    or

    <migrate-data>  

  <data-migration-connection   source-server="source_1"  

                               target-use-last-used="true"/>  

</migrate-data>

  3. ユーザー入力ポップアップ: これにより、オブジェクトがデータベースから読み込まれるときにエラーを処理できます。 ユーザーが入力モードを指定し、エラーが発生した場合、コンソールはユーザーの指定に従い処理されます。

    モードは次のとおりです。

    • ask-user - 続行('yes') またはエラーアウト ('no') をユーザーに求めます。

    • error- コンソールにエラーが表示され、実行を停止します。

    • continue- コンソールが実行を続行します。

    既定のモードは エラー です。

    例:

    <output-providers>  

  <user-input-popup mode="<ask-user/continue/error>"/>  

</output-providers>

    or

    <!-- Connect to target database -->  

<connect-target-database server="target_0">  

  <user-input-popup mode="<ask-user/continue/error>"/>  

</connect-target-database>

  4. 再接続プロバイダー: これにより、接続エラーが発生した場合にユーザーが再接続設定を設定できます。 これは、ソース サーバーとターゲット サーバーの両方で設定できます。

    再接続モードは次のとおりです。

    • reconnect-to-last-used-server: 接続がアクティブでない場合は、最大で 5 回使用された最後のサーバーへの再接続を試行します。

    • generate-an-error: 接続がアクティブでない場合は、エラーが生成されます。

    既定のモードは generate-an-error です。

    例:

    <output-providers>  

 <reconnect-manager on-source-reconnect="<reconnect-to-last-used-server/generate-an-error>"  

                    on-target-reconnect="<reconnect-to-last-used-server/generate-an-error>"/>  

</output-providers>

    or

    <!--synchronization-->  

<synchronize-target>  

  <reconnect-manager on-target-reconnect="reconnect-to-last-used-server"/>  

</synchronize-target>

    or

    <!--data migration-->  

<migrate-data server="target_0">  

  <reconnect-manager  

    on-source-reconnect="reconnect-to-last-used-server"  

    on-target-reconnect="generate-an-error"/>  

</migrate-data>

  5. コンバーター上書きプロバイダー: これにより、ユーザーはターゲット メタベースに既に存在するオブジェクトを処理できます。 考えられるアクションは次のとおりです。

    • error: コンソールにエラーが表示され、実行を停止します。

    • overwrite: 既存のオブジェクト値を上書きします。 既定では、このアクションが実行されます。

    • skip: コンソールは、データベースの既存のオブジェクトをスキップします。

    • ask-user: ユーザーに入力を求めます ('yes'/ 'no')

    例:

    <output-providers>  

  <object-overwrite action="<error|skip|overwrite|ask-user>"/>  

</output-providers>

    or

    <convert-schema object-name="ssma.TT1">  

  <object-overwrite action="<error|skip|overwrite|ask-user>"/>  

</convert-schema>

  6. 失敗した前提条件プロバイダー: これにより、ユーザーはコマンドの処理に必要な前提条件を処理できます。 既定では、strict-mode は 'false' です。 'true' に設定すると、前提条件を満たさない場合に例外が生成されます。

    例:

    <output-providers>  

  <prerequisites strict-mode="<true|false>"/>  

</output-providers>

  7. 操作の停止: 操作の途中で、ユーザーが操作を停止する場合は、'Ctrl + C' ホットキーを使用します。 SSMA for Access コンソールは操作が完了されるのを待機し、コンソールの実行を終了します。

    ユーザーがすぐに実行を停止する場合は、SSMA コンソール アプリケーションを強制終了するために 、'Ctrl+C' ホットキーをもう一度押すことができます

  8. 進行状況プロバイダー: 各コンソール コマンドの進行状況を通知します。 これは、既定では無効になっています。 progress-reporting 属性は、次の要素で構成されます。

    • off

    • every-1%

    • every-2%

    • every-5%

    • every-10%

    • every-20%

    例:

    <output-providers>  

 <progress-reporting enable="<true|false>"           (optional)  

                     report-messages="<true|false>"  (optional)  

                     report-progress="every-1%|every-2%|every-5%|every-10%|every-20%|off" (optional)/>  

</output-providers>

    or

    <...All commands...>  

  <progress-reporting  

    enable="<true|false>"              (optional)  

    report-messages="<true|false>"     (optional)  

    report-progress="every-1%|every-2%|every-5%|every-10%|every-20%|off"     (optional)/>  

</...All commands...>

  9. ロガーの詳細: ログの詳細レベルを設定します。 これは、UI の [すべてのカテゴリ] オプションに対応します。 既定では、ログの詳細レベルは "error" です。

    logger-level オプションには、以下が含まれます。

    • fatal-error: 致命的なエラー メッセージのみがログに記録されます。

    • error: エラーと致命的なエラー メッセージのみがログに記録されます。

    • warning: デバッグ メッセージと情報メッセージを除くすべてのレベルがログに記録されます。

    • info: デバッグ メッセージを除くすべてのレベルがログに記録されます。

    • debug: すべてのレベルのメッセージがログに記録されます。

    注意

    必須メッセージは、すべてのレベルでログに記録されます。

    例:

    <output-providers>  

  <log-verbosity level="fatal-error/error/warning/info/debug"/>  

</output-providers>

    or

    <...All commands...>  

  <log-verbosity level="fatal-error/error/warning/info/debug"/>  

</...All commands...>

  10. 暗号化されたパスワードのオーバーライド: "true" の場合、サーバー接続ファイルまたはスクリプト ファイルのサーバー定義セクションで指定されたクリア テキストのパスワードにより、保護されたストレージに格納されている暗号化されたパスワード (存在する場合) がオーバーライドされます。 クリア テキストでパスワードが指定されていない場合は、ユーザーはパスワードを入力するように求められます。

    次の 2 つのケースがあります。

    1. オーバーライド オプションが false の場合、検索の順序は Protected storage->Script File->Server Connection File-> Prompt User になります。

    2. オーバーライド オプションが true の場合、検索の順序は Script File->Server Connection File->Prompt User になります。

    例:

    <output-providers>  

  <encrypted-password override="<true/false>"/>  

</output-providers>

構成不可能なオプションは次のとおりです。

  • 再接続の最大試行回数: 確立された接続がネットワーク障害によりタイムアウトまたは中断した場合、サーバーを再接続する必要があります。 再接続は最大 5 回の再試行が許可され、その後、コンソールは自動的に再接続を実行します。 自動再接続機能を使用すると、スクリプトを再実行する手間が軽減されます。

サーバー接続パラメーター

サーバー接続パラメーターは、スクリプト ファイルまたはサーバー接続ファイルで定義できます。 詳細については、「 サーバー接続ファイルの作成 (AccessToSQL)」 セクションを参照してください。

スクリプト コマンド

スクリプト ファイルには、一連の移行ワークフロー コマンドが XML 形式で含まれています。 SSMA コンソール アプリケーションは、スクリプト ファイルにコマンドが表示される順序で移行を処理します。

たとえば、Access データベース内の特定のテーブルの一般的なデータ移行は、Database-> の階層に従います。

スクリプト ファイル内のすべてのコマンドが正常に実行されると、SSMA コンソール アプリケーションが終了し、コントロールがユーザーに戻されます。 スクリプト ファイルの内容は、変数値ファイルまたは変数値のスクリプト ファイル内の別のセクションに含まれる変数情報を使用して、多かれ少なかれ静的です。

例:

<!--Sample of script file commands -->  
  
<ssma-script-file>  
  
  <script-commands>  
  
    <create-new-project project-folder="$project_folder$"  
  
                        project-name="$project_name$"  
  
                        overwrite-if-exists="true"/>  
  
    <connect-source-database server="source_2"/>  
  
    <save-project/>  
  
    <close-project/>  
  
  </script-commands>  
  
</ssma-script-file>

3 つのスクリプト ファイル (さまざまなシナリオの実行用)、変数値ファイル、およびサーバー接続ファイルで構成されるテンプレートは、製品ディレクトリのサンプルのコンソール スクリプト フォルダーに用意されています。

  • AssessmentReportGenerationSample.xml

  • ConversionAndDataMigrationSample.xml

  • VariableValueFileSample.xml

  • ServersConnectionFileSample.xml

そこに表示されるパラメーターを関連性について変更すると、テンプレート (ファイル)を実行することができます。

script-commands の完全なリストについては、「SSMA コンソールの実行 (AccessToSQL)」を参照してください。

スクリプト ファイルの妥当性確認

ユーザーは、'Schemas' フォルダーにあるスキーマ定義ファイル 'A2SSConsoleScriptSchema.xsd' に対して、スクリプト ファイルの妥当性確認を簡単に実行できます。

次のステップ

コンソールを操作する次の手順は、「変数値ファイルの作成 (AccessToSQL)」です。

関連項目

変数値ファイルの作成 (AccessToSQL)