Snowpipe Streamingの設定¶
Snowpipe Streamingプロパティ¶
profile.json
ファイルで API 接続設定を構成します。プロパティについては、このトピックで説明します。
Java の例 (GitHub)で示されているように、変数 PROFILE_PATH
への入力としてファイルパスを指定することにより、 profile.json
から設定を読み込むことができます。
必須のプロパティ¶
authorization_type
ユーザーの認証および承認メソッドを構成します。次のいずれかのメソッドを使用します。
JWT
: JSON Webトークン(JWT)によるキーペア認証。このメソッドがデフォルトです。authorization_type
が構成されていない場合、デフォルトのメソッドJWT
が使用されます。キーペア認証用に次のprivate_key
を構成します。private_key
ユーザーを認証するための秘密キー。ヘッダーまたはフッターではなく、キーのみを含めます。キーが複数の行に分割されている場合、改行を削除します。暗号化されていないキーを提供するか、暗号化されたキーを提供して
snowflake.private.key.passphrase
パラメーターを提供し、Snowflakeがキーを復号化できるようにします。このパラメータは、snowflake.private.key
パラメーター値が暗号化されている場合 にのみ 使用します。
OAuth
: Snowflake OAuth。このオプションは、Snowflake Ingest SDK バージョン2.0.3以降でのみ使用できます。profile.json
ファイル内のSnowflake OAuth に対して次のパラメーターを構成します。oauth_client_id
: OAuth 統合のクライアント ID。oauth_client_secret
: OAuth 統合のクライアントシークレット。oauth_refresh_token
: OAuth 統合の有効なリフレッシュトークン。
Snowflake/ OKTA OAuth でトークン更新をサポートするには、3つのパラメータを設定する必要があります:
oauth_client_id
、oauth_client_secret
、およびoauth_refresh_token
。ただし、トークン更新リクエストでこれらの値を必要としない、 OAuth 用にカスタマイズされた API エンドポイントを使用する場合は、これらのパラメータのフィールドに任意のプレースホルダを入力できます。
url
Snowflakeアカウントにアクセスするための URL。この URL には、使用する アカウント識別子 が含まれている必要があります。プロトコル(
https://
)とポート番号はオプションです。すでにSnowflake Ingest SDK を使用しており、
profile.json
ファイルでhost
、scheme
、およびport
プロパティを設定している場合は、url
は必要ありません。user
Snowflakeアカウントのユーザーログイン名。
オプションのプロパティ¶
enable_iceberg_streaming
プロパティを
true
にセットすると、Snowflakeが管理する Apache Iceberg™ テーブルでSnowpipe Streamingが有効になります。詳細については、 Snowpipe Streamingを Apache Iceberg™ テーブルで使用する をご参照ください。max_client_lag
このプロパティを使用して、データフラッシュレイテンシーを構成します。デフォルトでは、Snowpipe Streamingは標準的なSnowflakeテーブル(非Apache Iceberg)のデータを1秒ごとにフラッシュします。max_client_lag構成では、これをオーバーライドし、1秒から10分までの希望するフラッシュレイテンシーにセットすることができます。詳細情報については、 Snowpipe Streamingのレイテンシーの推奨事項 を参照してください。
snowflake.private.key.passphrase
キーが暗号化されている場合に秘密キーを復号化するためのパスフレーズ。詳細については、 キーペア認証およびキーローテーションの使用 (このトピック内) をご参照ください。
role
Snowflakeに接続した後にセッションに使用するアクセス制御ロール。
role
プロパティは、Snowflake Ingest SDK バージョン2.0.3以降ではオプションとなります。これは、Ingest SDK の旧バージョンでは必要です。
例¶
クライアント SDK を使用してSnowpipe Streamingアプリケーションをビルドする方法を示す簡単な例については、 このJavaファイル (GitHub)をご参照ください。
クイックスタートの例: