SQL Serverをデータパイプラインソースとして設定 ​

SQL Serverをデータパイプラインソースとして設定し、レコードを抽出して宛先に同期します。 このガイドを使用して、コネクションの設定、パイプラインの設定、オブジェクトの追加、同期動作の確認、および既知の制限事項の理解を行います。

サポートされている機能 ​

SQL Serverをパイプラインソースとして使用する場合、次の機能がサポートされます。

前提条件 ​

SQL Serverをデータパイプラインソースとして接続する前に、次の要件を満たしてください。

• オンプレミスエージェントホストから到達可能なSQL Serverインスタンス
• バージョン30以上で稼働しているオンプレミスエージェント。 設定手順については、オンプレミスエージェントのドキュメントを参照してください。
• 同期する予定のテーブルに対するSELECT権限とVIEW DEFINITION権限を持つSQL Serverユーザー
• SQL Serverインスタンスのホスト、ポート、データベース名、ユーザー名、およびパスワード
• SQL Serverデータベースおよび同期する予定の各テーブルでChange Trackingが有効になっていること。 設定手順については、Change Trackingの有効化を参照してください。

Change Trackingの有効化 ​

Workatoでは、増分同期で行レベルの挿入、更新、および削除を検出するためにSQL Server Change Trackingが必要です。 パイプラインがオブジェクトを検出したり同期を実行したりできるようにする前に、データベース管理者はデータベースレベルとテーブルレベルの両方でこれを有効にする必要があります。

データベースレベルでChange Trackingを有効にします。

ALTER DATABASE CURRENT SET CHANGE_TRACKING = ON (CHANGE_RETENTION = 7 DAYS, AUTO_CLEANUP = ON)

Workatoでは、最小保持期間を3日にすることを推奨しています。 パイプラインが一時停止または遅延した場合に備えて、7日間にすると安全なバッファーを確保できます。

同期する予定の各テーブルについて、テーブルレベルでChange Trackingを有効にします。

ALTER TABLE [schema].[table_name] ENABLE CHANGE_TRACKING WITH (TRACK_COLUMNS_UPDATED = ON)

パイプラインにオブジェクトとして追加する予定の各テーブルについて、テーブルレベルのコマンドを繰り返します。

サポートされるコネクションタイプ ​

SQL Serverパイプラインでは、オンプレミスグループを通じたユーザー名とパスワードによる認証をサポートしています。 接続するには、SQL Serverのユーザー名とパスワードが必要です。

SQL Serverに接続する ​

SQL Serverをデータパイプラインソースとして接続するには、次の手順を実行します。

パイプラインの設定 ​

SQL Serverをデータパイプラインソースとして設定するには、次の手順を実行します。

[minute] [hour] [day of month] [month] [day of week]

0 8 * * *

サポートされるオブジェクト ​

SQL Serverデータパイプラインは、接続先データベース内のテーブルからデータを同期します。 Workatoは、パイプライン設定中にオブジェクトを追加を選択すると、接続先データベース内のすべてのスキーマにまたがる利用可能なテーブルを検出します。 パイプラインには、1つ以上のテーブルをオブジェクトとして追加できます。 SQL Server Change Trackingにはベーステーブルが必要なため、ビューはサポートされていません。

同期モード ​

SQL Serverデータパイプラインは、完全更新と増分同期をサポートしています。 同期モードは、パイプラインに追加するときにオブジェクトごとに設定されます。

完全更新 ​

完全更新同期では、パイプライン実行ごとにソーステーブルからすべての行を読み取り、宛先テーブルを上書きします。 同期ごとにデータの完全なスナップショットが必要なテーブルには、完全更新を使用します。

増分同期 ​

増分同期では、SQL Server Change Trackingを使用して、前回の同期実行が成功して以降の行レベルの挿入、更新、および削除を検出します。 Workatoは、タイムスタンプ列でフィルタリングするのではなく、Change Trackingログをクエリします。 パイプラインで増分同期を実行する前に、データベースレベルとテーブルレベルの両方でChange Trackingを有効にする必要があります。 設定手順については、Change Trackingの有効化を参照してください。

識別子の処理 ​

Workatoパイプラインは、次のルールを適用してソース列名を有効な宛先識別子に変換します。

• 列名は大文字に変換されます。
• $、スペース、ダッシュなどの特殊文字はアンダースコア（_）に置き換えられます。
• 識別子は、予約語との競合を防ぐために角かっこで囲まれます。

たとえば、ソース列$Name$は宛先テーブルで[_NAME_]になります。

制限事項 ​

SQL Serverをデータパイプラインソースとして使用する場合、次の制限事項が適用されます。

オブジェクトが表示されない ​

オブジェクトを追加を選択してもパイプラインにオブジェクトが表示されない場合は、次を確認してください。

• Change Trackingが有効になっていません。 Workatoがオブジェクトを検出できるようにする前に、データベースレベルとテーブルレベルでChange Trackingを有効にする必要があります。 必要なSQLコマンドについては、Change Trackingの有効化を参照してください。
• クラウドコネクションが選択されています。 パイプラインは、クラウドコネクション経由ではテーブルを検出できません。 コネクションタイプフィールドでオンプレミスグループに切り替えます。

オブジェクトなしエラー

オンプレミスエージェントのバージョン要件 ​

Workatoでは、SQL Serverデータパイプラインをサポートするために、バージョン30以上のオンプレミスエージェントが必要です。 以前のバージョンはサポートされていません。 Workatoでは、利用可能な最新バージョンの使用を推奨しています。

最小同期頻度 ​

サポートされる最小同期間隔は15分です。 これより高い頻度で同期をトリガーすることはできません。