1. Home
  2. Cloud
  3. Confluent Cloud への外部システムの接続

重要

このページの日本語コンテンツは古くなっている可能性があります。最新の英語版コンテンツをご覧になるには、こちらをクリックしてください。

Microsoft SQL Server Sink（JDBC）Connector for Confluent Cloud

注釈

Confluent Platform 用にコネクターをローカルにインストールする場合は、「JDBC Connector（Source および Sink）for Confluent Platform」を参照してください。

Kafka Connect Microsoft SQL Server Sink Connector for Confluent Cloud を使用すると、Apache Kafka® トピックのデータを Microsoft SQL Server データベースに移動できます。このコネクターは、Kafka のトピックのデータを、指定された Microsoft SQL Server データベースのテーブルに書き込みます。テーブルの自動作成および制限付きの自動進化がサポートされます。

機能

Microsoft SQL Server Sink Connector には、以下の機能があります。

  • べき等性のある書き込み: デフォルトの insert.mode は INSERT です。UPSERT として構成されている場合、コネクターはプレーンな insert ステートメントではなく upsert セマンティクスを使用します。upsert セマンティクスでは、プライマリキーの制約違反がある場合にアトミックに新しい行を追加したり既存の行をアップデートしたりします。これにより、べき等性が確保されます。
  • SSL のサポート: 一方向 SSL をサポートします。
  • スキーマ: このコネクターは、Avro、JSON スキーマ、および Protobuf 入力 値 フォーマットをサポートします。このコネクターは、Avro、JSON スキーマ、Protobuf、および String の入力 キー フォーマットをサポートします。スキーマレジストリ ベースのフォーマットを使用するには、Schema Registry を有効にしておく必要があります。
  • プライマリキーのサポート: サポートされる PK モード は、kafka、none、record_key、および record_value です。PK Fields プロパティと組み合わせて使用します。
  • テーブルおよび列の自動作成: auto.create および auto-evolve がサポートされます。テーブルまたは列がない場合に、自動的に作成することができます。テーブル名は Kafka トピック名に基づいて作成されます。
  • 少なくとも 1 回のデリバリー: コネクターによって、Kafka のトピックからのレコードが少なくとも 1 回は配信されることが保証されます。
  • 複数のタスクのサポート: 1 つまたは複数のタスクの実行をサポートしています。タスクが多いほどパフォーマンスが向上する可能性があります。

Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。

制限

以下の情報を確認してください。

クイックスタート

このクイックスタートを使用して、Confluent Cloud Microsoft SQL Server Sink Connector の利用を開始することができます。このクイックスタートでは、コネクターを選択し、Microsoft SQL Server データベースにイベントをストリーミングするようにコネクターを構成するための基本的な方法について説明します。

前提条件
  • アマゾンウェブサービス （AWS）、Microsoft Azure （Azure）、または Google Cloud Platform （GCP）上の Confluent Cloud クラスターへのアクセスを許可されていること。
  • Microsoft SQL Server データベースへのアクセスを許可されていること。
  • データベースと Kafka クラスターは同じリージョンに存在している必要があります。別のリージョンを使用する場合、追加のデータ転送料金が発生する可能性があることに注意してください。
  • ネットワークに関する考慮事項については、「Networking and DNS Considerations」を参照してください。静的なエグレス IP を使用する方法については、「静的なエグレス IP アドレス」を参照してください。
  • Confluent CLI がインストールされ、クラスター用に構成されていること。「Confluent CLI のインストール」を参照してください。
  • スキーマレジストリ ベースのフォーマット（Avro、JSON_SR（JSON スキーマ）、Protobuf など）を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」を参照してください。
  • Kafka クラスターの認証情報。次のいずれかの方法で認証情報を指定できます。
    • 既存の サービスアカウント のリソース ID を入力する。
    • コネクター用の Confluent Cloud サービスアカウント を作成します。「サービスアカウント」のドキュメントで、必要な ACL エントリを確認してください。一部のコネクターには固有の ACL 要件があります。
    • Confluent Cloud の API キーとシークレットを作成する。キーとシークレットを作成するには、confluent api-key create を使用するか、コネクターのセットアップ時に Cloud Console で直接 API キーとシークレットを自動生成します。

Confluent Cloud Console の使用

ステップ 1: Confluent Cloud クラスターを起動します。

インストール手順については、「Quick Start for Confluent Cloud」を参照してください。

ステップ 2: コネクターを追加します。

左のナビゲーションメニューの Data integration をクリックし、Connectors をクリックします。クラスター内に既にコネクターがある場合は、+ Add connector をクリックします。

ステップ 3: コネクターを選択します。

Click the Microsoft SQL Server Sink connector card.

Microsoft SQL Server Sink Connector Card

ステップ 4: コネクターの詳細情報を入力します。

注釈

  • すべての 前提条件 を満たしていることを確認してください。
  • アスタリスク（ * ）は必須項目であることを示しています。

Add Microsoft SQL Server Sink Connector 画面で、以下を実行します。

既に Kafka トピックを用意している場合は、Topics リストから接続するトピックを選択します。

新しいトピックを作成するには、+Add new topic をクリックします。

ステップ 5: データベースで結果を確認します。

新しいレコードが Microsoft SQL Server データベースに追加されていることを確認します。

Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。

ちなみに

コネクターを起動すると、デッドレターキューのトピックが自動的に生成されます。詳細については、「Confluent Cloud デッドレターキュー」を参照してください。

参考

フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。

../_images/topology.ja.png

Confluent CLI の使用

以下の手順に従うと、Confluent CLI を使用してコネクターをセットアップし、実行できます。

注釈

ステップ 1: 使用可能なコネクターをリスト表示します。

以下のコマンドを入力して、使用可能なコネクターをリスト表示します。

confluent connect plugin list

ステップ 2: コネクターの必須の構成プロパティを表示します。

以下のコマンドを実行して、コネクターの必須プロパティを表示します。

confluent connect plugin describe <connector-catalog-name>

例:

confluent connect plugin describe MicrosoftSqlServerSink

出力例:

Following are the required configs:
connector.class: MicrosoftSqlServerSink
input.data.format
name
kafka.auth.mode
kafka.api.key
kafka.api.secret
connection.host
connection.port
connection.user
connection.password
db.name
tasks.max
topics

ステップ 3: コネクターの構成ファイルを作成します。

コネクター構成プロパティを含む JSON ファイルを作成します。以下の例は、コネクターの必須プロパティとオプションのプロパティを示しています。

{
  "topics": "sql_ratings",
  "input.data.format": "AVRO",
  "input.key.format": "AVRO",
  "connector.class": "MicrosoftSqlServerSink",
  "name": "MicrosoftSqlServerSinkConnector_0",
  "kafka.auth.mode": "KAFKA_API_KEY",
  "kafka.api.key": "****************",
  "kafka.api.secret": "****************************************************************",
  "connection.host": "connect-sqlserver-cdc.<host-id>.us-west-2.rds.amazonaws.com",
  "connection.port": "1433",
  "connection.user": "admin",
  "connection.password": "************",
  "db.name": "mothership",
  "insert.mode": "UPSERT",
  "auto.create": "true",
  "auto.evolve": "true",
  "tasks.max": "1",
  "pk.mode": "record_value",
  "pk.fields": "user_id"
}

各プロパティの定義は次のとおりです。その他のプロパティ値と定義については、Microsoft SQL Server Sink の構成プロパティ を参照してください。

  • "connector.class": コネクターのプラグイン名を指定します。
  • "name": 新しいコネクターの名前を設定します。

  • "kafka.auth.mode": 使用するコネクターの認証モードを指定します。オプションは SERVICE_ACCOUNT または KAFKA_API_KEY （デフォルト）です。API キーとシークレットを使用するには、構成プロパティ kafka.api.key と kafka.api.secret を構成例（前述）のように指定します。サービスアカウント を使用するには、プロパティ kafka.service.account.id=<service-account-resource-ID> に リソース ID を指定します。使用できるサービスアカウントのリソース ID のリストを表示するには、次のコマンドを使用します。

    confluent iam service-account list

    例:

    confluent iam service-account list

   Id     | Resource ID |       Name        |    Description
+---------+-------------+-------------------+-------------------
   123456 | sa-l1r23m   | sa-1              | Service account 1
   789101 | sa-l4d56p   | sa-2              | Service account 2

  • "input.data.format": Kafka 入力レコード値のフォーマット（Kafka トピックから送られるデータ）を設定します。指定可能なエントリは、AVRO、JSON_SR （JSON スキーマ）、または PROTOBUF です。スキーマベースのメッセージフォーマットを使用する場合は、Confluent Cloud Schema Registry を構成しておく必要があります。

  • "input.key.format": 入力レコードキーフォーマット（Kafka トピックから送られるデータ）を設定します。指定可能なエントリは、AVRO、JSON_SR （JSON スキーマ）、PROTOBUF、または STRING です。スキーマベースのメッセージフォーマットを使用する場合は、Confluent Cloud Schema Registry を構成しておく必要があります。

  • delete.on.null: null レコード値を削除として扱うかどうかを指定します。pk.mode を record_key に設定する必要があります。デフォルトは false です。

  • "topics": 特定のトピック名を指定するか、複数のトピック名をコンマ区切りにしたリストを指定します。

  • "insert.mode": 以下のいずれかのモードを入力します。

    • INSERT: 標準的な INSERT 行関数を使用します。該当する行が既にテーブルに存在する場合は、エラーが発生します。
    • UPSERT: このモードは INSERT と似ています。ただし、該当する行が既に存在する場合に、UPSERT 関数は、指定された値で列の値を上書きします。

  • db.timezone: 時間ベースの値を挿入する場合にコネクターで使用するタイムゾーンの名前。デフォルトは UTC です。

  • "auto.create" （テーブル）および "auto-evolve" （列） :（オプション）入力レコードスキーマに定義されているテーブルまたは列が存在しない場合に、それらを自動的に作成するかどうかを設定します。構成に入力しない場合は、どちらもデフォルトの false になります。

  • "pk.mode": サポートされるモードを以下に示します。

    • kafka: Kafka 座標をプライマリキーとして使用します。PK Fields とともに使用する必要があります。
    • none: プライマリキーを使用しません。
    • record_key: レコードキーのフィールドを使用します。プリミティブ型または構造体のどちらかにすることができます。
    • record_value: Kafka レコード値からのフィールドが使用されます。構造体型になっている必要があります。

  • "pk.fields": これは、プライマリキーのフィールド名をコンマ区切りにしたリストです。このプロパティの実行時の解釈は、選択した pk.mode によって異なります。選択肢を以下に示します。

    • kafka: Kafka の座標を表す 3 つの値である必要があります。空にすると、座標 __connect_topic__、connect_partition__、connect_offset がデフォルトとして使用されます。
    • none: PK フィールドを使用しません。
    • record_key: 空にすると、キー構造体からすべてのフィールドが使用されます。それ以外の場合、これはプロパティでフィールドを抽出するために使用されます。プリミティブキーの場合は、単一のフィールド名のみが構成されている必要があります。
    • record_value: レコード値からフィールドを抽出するために使用します。空にすると、値の構造体のすべてのフィールドが使用されます。

  • "tasks.max": このコネクターで実行できるタスクの最大数。タスクについて詳しくは、Confluent Cloud コネクターの制限事項 を参照してください。

Single Message Transforms: CLI を使用する SMT の追加の詳細については、Single Message Transforms（SMT） のドキュメントを参照してください。

すべてのプロパティの値と定義については、「構成プロパティ」を参照してください。

ステップ 4: 構成ファイルを読み込み、コネクターを作成します。

以下のコマンドを入力して、構成を読み込み、コネクターを起動します。

confluent connect create --config <file-name>.json

例:

confluent connect create --config microsoft-sql-server-sink-config.json

出力例:

Created connector MicrosoftSqlServerSinkConnector_0 lcc-ix4dl

ステップ 5: コネクターのステータスを確認します。

以下のコマンドを入力して、コネクターのステータスを確認します。

confluent connect list

出力例:

ID          |       Name                         | Status  | Type
+-----------+------------------------------------+---------+------+
lcc-ix4dl   | MicrosoftSqlServerSinkConnector_0  | RUNNING | sink

ステップ 6: データベースで結果を確認します。

新しいレコードが Microsoft SQL Server データベースに追加されていることを確認します。

Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。

ちなみに

コネクターを起動すると、デッドレターキューのトピックが自動的に生成されます。詳細については、「Confluent Cloud デッドレターキュー」を参照してください。

構成プロパティ

このコネクターでは、以下のコネクター構成プロパティを使用します。

データの取得元とするトピック（Which topics do you want to get data from?）

topics

特定のトピック名を指定するか、複数のトピック名をコンマ区切りにしたリストを指定します。

  • 型: list
  • 重要度: 高

入力メッセージ（Input messages）

input.data.format

Kafka 入力レコード値のフォーマットを設定します。指定可能なエントリは、AVRO、JSON_SR、または PROTOBUF です。スキーマベースのメッセージフォーマット（AVRO、JSON_SR、PROTOBUF など）を使用する場合は、Confluent Cloud Schema Registry を構成しておく必要がある点に注意してください。

  • 型: string
  • 重要度: 高
input.key.format

Kafka 入力レコードキーのフォーマットを設定します。pk.mode=record_key を使用する場合は、ここに適切なフォーマットを設定する必要があります。指定可能なエントリは、AVRO、JSON_SR、PROTOBUF、STRING です。スキーマベースのメッセージフォーマット（AVRO、JSON_SR、PROTOBUF など）を使用する場合は、Confluent Cloud Schema Registry を構成しておく必要がある点に注意してください。

  • 型: string
  • 重要度: 高
delete.enabled

null レコード値を削除として扱うかどうか。pk.mode を record_key に設定する必要があります。

  • 型: boolean
  • デフォルト: false
  • 重要度: 低

データへの接続方法（How should we connect to your data?）

name

コネクターの名前を設定します。

  • 型: string
  • 指定可能な値: 最大 64 文字の文字列
  • 重要度: 高

Kafka クラスターの認証情報（Kafka Cluster credentials）

kafka.auth.mode

Kafka の認証モード。KAFKA_API_KEY または SERVICE_ACCOUNT を指定できます。デフォルトは KAFKA_API_KEY モードです。

  • 型: string
  • デフォルト: KAFKA_API_KEY
  • 指定可能な値: KAFKA_API_KEY、SERVICE_ACCOUNT
  • 重要度: 高
kafka.api.key
  • 型: password
  • 重要度: 高
kafka.service.account.id

Kafka クラスターとの通信用の API キーを生成するために使用されるサービスアカウント。

  • 型: string
  • 重要度: 高
kafka.api.secret
  • 型: password
  • 重要度: 高

データベースへの接続方法（How should we connect to your database?）

connection.host

Depending on the service environment, certain network access limitations may exist. Make sure the connector can reach your service. Do not include jdbc:xxxx:// in the connection hostname property (e.g. database-1.abc234ec2.us-west.rds.amazonaws.com).

  • 型: string
  • 重要度: 高
connection.port

JDBC 接続ポート。

  • 型: int
  • 指定可能な値: [0,...,65535]
  • 重要度: 高
connection.user

JDBC 接続ユーザー。

  • 型: string
  • 重要度: 高
connection.password

JDBC 接続パスワード。

  • 型: password
  • 重要度: 高
db.name

JDBC データベース名。

  • 型: string
  • 重要度: 高
ssl.mode

データベースへの接続に使用する必要がある SSL モードを指定します。prefer および require では、接続を暗号化できますが、サーバーの証明書の検証は行われません。verify-ca および verify-full では、SSL CA 証明書情報が含まれるファイルを指定する必要があります。サーバーの証明書は検証され、これらの認証機関のうちの 1 つで署名されます。verify-ca では、信頼できる CA によって発行されたサーバー証明書であることが検証されます。verify-full では、信頼できる CA によって発行されたサーバー証明書であること、およびサーバーのホスト名が証明書と一致していることが検証されます。クライアント認証は実行されません。

  • 型: string
  • デフォルト: prefer
  • 重要度: 高
ssl.truststorefile

サーバー CA 証明書情報が含まれるトラストストア。ssl モードとして verify-ca または verify-full を使用する場合にのみ必要になります。

  • 型: password
  • デフォルト: [hidden]
  • 重要度: 低
ssl.truststorepassword

サーバー CA 証明書情報が含まれるトラストストアのパスワード。ssl モードとして verify-ca または verify-full を使用する場合にのみ必要になります。

  • 型: password
  • デフォルト: [hidden]
  • 重要度: 低

データベースの詳細（Database details）

insert.mode

使用する挿入モード。

  • 型: string
  • デフォルト: INSERT
  • 重要度: 高
table.name.format

送信先テーブルの名前のフォーマット文字列。元のトピック名を表すプレースホルダーとして ${topic} を含めることができます。

たとえば、トピック「orders」の場合、kafka_${topic} はテーブル名「kafka_orders」にマッピングされます。

  • 型: string
  • デフォルト: ${topic}
  • 重要度: 中
table.types

シンクコネクターが書き込むことができるデータベーステーブルのタイプのコンマ区切りのリスト。デフォルトでは TABLE になりますが、TABLE と VIEW の任意の組み合わせを使用できます。すべてのデータベースでビューへの書き込みがサポートされているわけではありません。サポートされている場合、ビューの定義とレコードのスキーマが一致していないと（auto.evolve に関係なく）、シンクコネクターでエラーが発生します。

  • 型: list
  • デフォルト: TABLE
  • 重要度: 低
fields.whitelist

レコード値フィールド名のコンマ区切りのリスト。空の場合は、レコード値のすべてのフィールドが利用されます。リストを設定した場合は、目的のフィールドのフィルター処理に使用されます。

  • 型: list
  • 重要度: 中
db.timezone

コネクターで時間ベースの基準を使用してクエリを実行する場合に使用する JDBC タイムゾーンの名前。デフォルトは UTC です。

  • 型: string
  • デフォルト: UTC
  • 重要度: 中

プライマリキー（Primary Key）

pk.mode

プライマリキーモード。相互作用について pk.fields の説明も参照してください。サポートされるモードを以下に示します。

none: キーを使用しません。

kafka: Apache Kafka® 座標を PK として使用します。

record_value: レコード値のフィールドを使用します。これは構造体である必要があります。

record_key: レコードキーのフィールドを使用します。これは構造体である必要があります。

  • 型: string
  • 指定可能な値: kafka、none、record_key、record_value
  • 重要度: 高
pk.fields

プライマリキーのフィールド名のコンマ区切りのリスト。この構成の実行時の解釈は、pk.mode によって異なります。

none: このモードでは、プライマリキーとして使用されるフィールドはないため、無視されます。

kafka: Kafka 座標を表す 3 つの値である必要があります。空の場合はデフォルトで __connect_topic,__connect_partition,__connect_offset になります。

record_value: 空の場合は、値構造体のすべてのフィールドが使用されます。指定されている場合は、目的のフィールドの抽出に使用されます。

  • 型: list
  • 重要度: 高

SQL/DDL サポート（SQL/DDL Support）

auto.create

送信先テーブルが存在しない場合に、テーブルを自動的に作成するかどうかを指定します。

  • 型: boolean
  • デフォルト: false
  • 重要度: 中
auto.evolve

列が存在しない場合に、テーブルに列を自動的に追加するかどうかを指定します。

  • 型: boolean
  • デフォルト: false
  • 重要度: 中
quote.sql.identifiers

SQL ステートメントで、テーブル名、列名、その他の識別子をいつクォートするかを指定します。後方互換性のため、デフォルトは「always」となっています。

  • 型: string
  • デフォルト: ALWAYS
  • 指定可能な値: ALWAYS、NEVER
  • 重要度: 中

接続の詳細（Connection details）

batch.sizes

新しいデータのポーリング時に単一のバッチに含める最大行数。この設定を使用して、コネクターの内部にバッファリングするデータの量を制限できます。

  • 型: int
  • デフォルト: 3000
  • 指定可能な値: [1,...,5000]
  • 重要度: 低

このコネクターのタスク数（Number of tasks for this connector）

tasks.max
  • 型: int
  • 指定可能な値: [1,...]
  • 重要度: 高

次のステップ

参考

フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。

../_images/topology.ja.png