Openflow Connector for SQL Server の設定¶

前提条件¶

コネクタを設定する前に、以下の前提条件を満たしていることを確認してください。

1. Openflow Connector for SQL Server について を確認してください。

2. サポートされている SQL Serverバージョン を確認してください。

3. ランタイムの展開を設定していることを確認してください。詳細については、次のトピックをご参照ください。

   • Openflowの設定 - BYOC

   • Set up Openflow - Snowflake Deployments.

4. If you use Openflow - Snowflake Deployments, ensure that you have reviewed configuring required domains and have granted access to the required domains for the SQL サーバー connector.

Set up your SQL Server instance¶

コネクタを設定する前に、SQL Server環境で次のタスクを実行してください。

1. Enable change tracking on the databases and tables that you plan to replicate, as shown in the following SQL Server example:

   ALTER DATABASE <database>
     SET CHANGE_TRACKING = ON
     (CHANGE_RETENTION = 2 DAYS, AUTO_CLEANUP = ON);
   
   ALTER TABLE <schema>.<table>
     ENABLE CHANGE_TRACKING
     WITH (TRACK_COLUMNS_UPDATED = ON);
   

   Copy

   注釈

   複製する予定のすべてのデータベースとテーブルに対してこれらのコマンドを実行します。

   コネクタは、複製を開始する前に、データベースとテーブルで変更追跡を有効にする必要があります。複製を予定しているすべてのテーブルで、変更の追跡が有効になっていることを確認してください。コネクタの実行中に、追加のテーブルの変更追跡を有効にすることもできます。

2. Create a login for the SQL Serverインスタンスのログインを作成する:

   CREATE LOGIN <user_name> WITH PASSWORD = '<password>';
   

   Copy

   このログインは、複製する予定のデータベースのユーザーを作成するために使用されます。

3. 各データベースで次のSQL Serverコマンドを実行して、複製するデータベースごとにユーザーを作成します。

   USE <source_database>;
   CREATE USER <user_name> FOR LOGIN <user_name>;
   

   Copy

4. 複製する各データベースのユーザーにSELECTおよびVIEW CHANGE TRACKING権限を付与します。

   GRANT SELECT ON <database>.<schema>.<table> TO <user_name>;
   GRANT VIEW CHANGE TRACKING ON <database>.<schema>.<table> TO <user_name>;
   

   Copy

   複製する予定のすべてのテーブルに対して、各データベースでこれらのコマンドを実行します。これらの権限は、前のステップで作成した各データベースのユーザーに付与する必要があります。

5. (Optional) Configure SSL connection.

   If you use an SSL connection to connect SQL Server, create the root certificate for your database server. This is required when configuring the connector.

Snowflake環境のセットアップ¶

As a Snowflake administrator, perform the following tasks:

1. 複製されたデータを格納するために、Snowflake内に宛先データベースを作成します。

   CREATE DATABASE <destination_database>;
   

   Copy

2. Snowflakeの サービスユーザー を作成します。

   CREATE USER <openflow_user>
     TYPE = SERVICE
     COMMENT='Service user for automated access of Openflow';
   

   Copy

3. コネクタ用Snowflakeロールを作成し、必要な権限を付与します。

   CREATE ROLE <openflow_role>;
   GRANT ROLE <openflow_role> TO USER <openflow_user>;
   GRANT USAGE ON DATABASE <destination_database> TO ROLE <openflow_role>;
   GRANT CREATE SCHEMA ON DATABASE <destination_database> TO ROLE <openflow_role>;
   

   Copy

   このロールを使用して、コネクタのSnowflakeデータベースへのアクセスを管理します。

   宛先データベースにオブジェクトを作成するには、アクセス管理に使用するロールに、データベースに対する USAGE権限およびCREATE SCHEMA権限 を付与する必要があります。

4. コネクタ用にSnowflakeウェアハウスを作成し、必要な権限を付与します。

   CREATE WAREHOUSE <openflow_warehouse> WITH
     WAREHOUSE_SIZE = 'MEDIUM'
     AUTO_SUSPEND = 300
     AUTO_RESUME = TRUE;
   GRANT USAGE, OPERATE ON WAREHOUSE <openflow_warehouse> TO ROLE <openflow_role>;
   

   Copy

   Snowflake recommends starting with a MEDIUM warehouse size, then experimenting with size depending on the number of tables being replicated and the amount of data transferred. Large numbers of tables typically scale better with multi-cluster warehouses, rather than a larger warehouse size. For more information, see multi-cluster warehouses.

5. Set up the public and private keys for key pair authentication:

   1. 安全なキーのペア（パブリックおよび秘密）を作成します。

   2. Store the private key for the user in a file to supply to the connector's configuration.

   3. Snowflakeユーザーに公開キーを割り当てます：

      ALTER USER <openflow_user> SET RSA_PUBLIC_KEY = 'thekey';
      

      Copy

      詳細については、 キーペア認証とキーペアローテーション をご参照ください。

コネクタを構成する¶

As a data engineer, install and configure the connector using the following sections.

コネクタをインストールする¶

1. Navigate to the Openflow overview page. In the Featured connectors section, select View more connectors.

2. Openflowのコネクタページでコネクタを探し、 Add to runtime を選択します。

3. In the Select runtime dialog, select your runtime from the Available runtimes drop-down list and click Add.

   注釈

   コネクタをインストールする前に、コネクタが取り込んだデータを格納するためのデータベースとスキーマをSnowflakeで作成したことを確認します。

4. Snowflakeアカウント認証情報でデプロイメントを認証し、Snowflakeアカウントへのランタイムアプリケーションのアクセスを許可するよう求められたられたら、 Allow を選択します。コネクタのインストールプロセスは数分で完了します。

5. Snowflakeアカウント認証情報でランタイムを認証します。

コネクタプロセスグループが追加されたOpenflowキャンバスが表示されます。

コネクタを構成する¶

To configure the connector, perform the following steps:

1. インポートしたプロセスグループを右クリックし、 Parameters を選択します。

2. Populate the required parameter values as described in フローパラメーター.

テーブルを削除し、複製に再追加する¶

To remove a table from replication, remove it from the Included Table Names or Included Table Regex parameters in the Replication Parameters context.

To re-add the table to replication later, first delete the corresponding destination table in Snowflake. Afterward, add the table back to the Included Table Names or Included Table Regex parameters. This ensures that the replication process starts fresh for the table.

このアプローチは、失敗したテーブル複製シナリオからの復旧にも使用できます。

[
    {
        "schema": "<source table schema>",
        "table" : "<source table name>",
        "included": ["<column name>", "<column name>"],
        "excluded": ["<column name>", "<column name>"],
        "includedPattern": "<regular expression>",
        "excludedPattern": "<regular expression>",
    }
]

customers_1234_1
customers_1234_2
orders_5678_1
orders_5678_2

フローを実行する¶

1. プレーンを右クリックし、 Enable all Controller Services を選択します。

2. インポートしたプロセスグループを右クリックし、 Start を選択します。コネクタがデータの取り込みを開始します。