Cloud

Build 25.0.9434
  • Snowflake
    • はじめに
      • 接続の確立
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • ストアドプロシージャ
        • GetSSOAuthorizationURL
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • Account
        • Warehouse
        • User
        • Password
        • URL
        • MFAPasscode
        • RoleName
      • Connection
        • UseVirtualHosting
      • Azure Authentication
        • AzureTenant
      • SSO
        • ProofKey
        • ExternalToken
        • SSOProperties
      • KeyPairAuth
        • PrivateKey
        • PrivateKeyPassword
        • PrivateKeyType
        • PrivateKeySubject
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • State
        • Scope
        • OAuthAuthorizationURL
        • OAuthAccessTokenURL
        • PKCEVerifier
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
        • Database
        • Schema
      • Miscellaneous
        • AllowPreparedStatement
        • AllowUserVariables
        • ApplicationName
        • AsyncQueryTimeout
        • BatchMode
        • BindingType
        • ClientTimestampNTZTimezone
        • CustomStage
        • ExternalStageAWSAccessKey
        • ExternalStageAWSSecretKey
        • ExternalStageAzureSASToken
        • IgnoreCase
        • MaxRows
        • MaxThreads
        • MergeDelete
        • MergeInsert
        • MergeUpdate
        • RetryOnChunkTimeout
        • S3Domain
        • SessionIdleTimeout
        • SessionParameters
        • Timeout
    • Third Party Copyrights

Snowflake - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるSnowflake へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してSnowflake に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Snowflake への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Snowflake は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのSnowflake への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Snowflake への接続

接続の確立 は、CData Cloud にデータベースを作成するためのSnowflake への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してSnowflake からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Snowflake に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Snowflake への接続

認証する前に、以下のプロパティを設定してSnowflake 接続を定義します。

  • URL:自身のSnowflake URL、例えばhttps://orgname-myaccount.snowflakecomputing.com。
    • Legacy URL を使用する場合:https://myaccount.region.snowflakecomputing.com。
    • 自身のURL を見つけるには:
      1. Snowflake UI の左下にある自身の名前をクリックします。
      2. Account ID にカーソルを合わせます。
      3. Copy Account URL アイコンをクリックして、アカウントURL をコピーします。
  • Database(オプション):Cloud によって公開されるテーブルとビューを、特定のSnowflake データベースのものに制限します。
  • Schema(オプション):Cloud によって公開されるテーブルとビューを、特定のSnowflake データベーススキーマのものに制限します。

Snowflake への認証

Cloud は、デフォルトでOAuth 認証をサポートし、フェデレーションID プロバイダーとキーベースログインの複数のオプションも提供します。

使用したい認証方法を指定するには、AuthScheme プロパティを設定します。

OAuth

OAuth で認証するには、AuthScheme をOAuth に設定します。

OAuth 認証を完了するには、カスタムOAuth アプリの作成 を参照してください。その後、次の接続プロパティを設定します。

  • OAuthClientId:登録したOAuth アプリケーションのクライアントID に設定。
  • OAuthClientSecret:登録したアプリケーションのクライアントシークレットに設定。
  • CallbackURL:OAuth アプリ設定で構成されたリダイレクトURI に設定。

Cloud は、特定のID プロバイダー向けのOAuth ベースの認証スキームもサポートしています。 これらのスキームは標準のOAuth 設定を拡張し、ブラウザベースのログインまたはヘッドレス認証のいずれかをサポートします。 ID プロバイダーによって、以下のOAuth ベースの認証スキームが追加でサポートされます。 AuthScheme を以下の値のいずれかに設定し、必要なプロパティを構成します。

  • AuthScheme=OAuthAzureAD:Azure Active Directory を使用して、非ブラウザOAuth 認証を実行します。Snowflake のセキュリティインテグレーションタイプはexternal_oauth です。
    • OAuthClientId:Azure AD アプリケーションのクライアントID に設定。
    • OAuthClientSecret:Azure AD アプリケーションのクライアントシークレットに設定。
    • CallbackURL:Azure AD アプリで構成されたリダイレクトURI に設定。
    • AzureTenant:Azure Active Directory のテナントID に設定。
    • InitiateOAuth:アクセストークンを自動的に取得してリフレッシュするには、GETANDREFRESH に設定。
  • AuthScheme=OAuthClientAzureAD:Azure Active Directory のクライアント資格情報付与フローを使用します。ブラウザは不要です。
    • OAuthClientId:Azure AD アプリケーションのクライアントID に設定。
    • OAuthClientSecret:Azure AD アプリケーションのクライアントシークレットに設定。
    • AzureTenant:Azure Active Directory のテナントID に設定。
    • InitiateOAuth:アクセストークンを自動的に取得してリフレッシュするには、GETANDREFRESH に設定。
  • AuthScheme=OAuthOkta:Okta をID プロバイダーとしてOAuth 認証を行います。
    • OAuthClientId:Okta アプリのクライアントID に設定。
    • OAuthClientSecret:Okta アプリのクライアントシークレットに設定。
    • CallbackURL:Okta アプリで構成されたリダイレクトURI に設定。
    • OAuthAuthorizationURL:OAuth サービスの認可URL に設定。
    • OAuthAccessTokenURL:OAuth アクセストークンを取得するURL に設定。
    • InitiateOAuth:アクセストークンを自動的に取得してリフレッシュするには、GETANDREFRESH に設定。
  • AuthScheme=OAuthClientOkta:Okta のクライアント資格情報付与フローを使用します。ブラウザは不要です。
    • OAuthClientId:Okta アプリのクライアントID に設定。
    • OAuthClientSecret:Okta アプリのクライアントシークレットに設定。
    • OAuthAuthorizationURL:OAuth サービスの認可URL に設定。
    • OAuthAccessTokenURL:OAuth アクセストークンを取得するURL に設定。
    • InitiateOAuth:アクセストークンを自動的に取得してリフレッシュするには、GETANDREFRESH に設定。
  • AuthScheme=OAuthOther:PingFederate などのサードパーティのID プロバイダーを使用してOAuth 認証を実行します。
    • OAuthClientId:IdP のクライアントID に設定。
    • OAuthClientSecret:IdP のクライアントシークレットに設定。
    • CallbackURL:OAuth 設定で定義されたリダイレクトURI に設定。
    • OAuthAuthorizationURL:OAuth サービスの認可URL に設定。
    • OAuthAccessTokenURL:OAuth アクセストークンを取得するURL に設定。
    • InitiateOAuth:アクセストークンを自動的に取得してリフレッシュするには、GETANDREFRESH に設定。
  • AuthScheme=OAuthClientOther:PingFederate などのサードパーティのID プロバイダーで、クライアント資格情報付与フローを使用します。ブラウザは不要です。
    • OAuthClientId:IdP のクライアントID に設定。
    • OAuthClientSecret:IdP のクライアントシークレットに設定。
    • OAuthAuthorizationURL:OAuth サービスの認可URL に設定。
    • OAuthAccessTokenURL:OAuth アクセストークンを取得するURL に設定。
    • InitiateOAuth:アクセストークンを自動的に取得してリフレッシュするには、GETANDREFRESH に設定。
  • AuthScheme=OAuthJWT:署名されたJWT と証明書を使用してOAuth 認証を実行します。このスキームは通常、Azure Active Directory およびJWT ベースのアサーションをサポートするその他のIdP で使用されます。
    • OAuthJWTCert:JWT の署名に使用される証明書ファイル(.pfx または.pem)へのパス。
    • OAuthJWTCertType:証明書ファイルの形式(PEM、PFX)。
    • OAuthClientId:OAuth アプリケーションのクライアントID。
    • OAuthClientSecret:(オプション)IdP が要求する場合は、クライアントシークレット。
    • AzureTenant:(Azure AD を使用する場合)Azure Active Directory のテナントID に設定。
    • InitiateOAuth:アクセストークンを自動的に取得してリフレッシュするには、GETANDREFRESH に設定。
  • AuthScheme=AzureMSI:Azure マネージドID(MSI)を使用してOAuth 認証を実行します。この方法は、Azure App Services や仮想マシンなどのAzure ホスティング環境で実行されるアプリケーションに最適です。
    • AzureResource:Snowflake セキュリティ統合に必要なターゲットリソースID に設定。
    • OAuthClientId:(オプション)ユーザーが割り当てられたマネージドID のクライアントID。
    • InitiateOAuth:アクセストークンを自動的に取得してリフレッシュするには、GETANDREFRESH に設定。

デスクトップアプリ

このセクションでは、カスタムOAuth アプリの資格情報を使用したデスクトップ認証について説明します。詳しくは、カスタムOAuth アプリの作成 を参照してください。

OAuth アクセストークンの取得

以下を設定して、接続してください。

  • OAuthClientId:OAuth 統合設定のクライアントID に設定。
  • OAuthClientSecret:OAuth 統合設定のクライアントシークレットに設定。
  • CallbackURL:OAuth 統合設定のリダイレクトURL に設定。
接続すると、Cloud はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

手動でのOAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

  • InitiateOAuth:OFF に設定。
  • OAuthClientId:OAuth 統合設定のクライアントID に設定。
  • OAuthClientSecret:OAuth 統合設定のクライアントシークレットに設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

  1. GetOAuthAuthorizationUrl ストアドプロシージャを呼び出します。CallbackURL インプットをアプリ設定で指定したリダイレクトURI に設定します。ストアドプロシージャがOAuth エンドポイントのURL とPKCEVerifier を返します。
  2. URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
  3. GetOAuthAccessToken ストアドプロシージャを呼び出します。CallbackURL インプットをアプリ設定で指定したリダイレクトURI に設定します。PKCEVerifier インプットを最初の手順で取得したPKCEVerifier の値に設定します。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下の2つのオプションから選択します。

    • オプション1:後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2:別のマシンにCloud をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。

  2. その後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにCloud を設定します。

オプション1:Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

手順については、カスタムOAuth アプリの作成 を参照してください。このセクションでは、データの認証および接続を行う手順について説明します。

Verifier code を取得するには、ヘッドレスマシンで次のプロパティを設定します。

  • InitiateOAuth:OFF に設定。
  • OAuthClientId:OAuth 統合設定のクライアントID に設定。
  • OAuthClientSecret:OAuth 統合設定のクライアントシークレットに設定。

次に、別のマシンから認証してOAuthVerifier 接続プロパティを取得します。

  1. GetOAuthAuthorizationUrl ストアドプロシージャを呼び出します。CallbackURL インプットをアプリ設定で指定したリダイレクトURI に設定します。ストアドプロシージャがOAuth エンドポイントのURL とPKCEVerifier を返します。
  2. 返されたURL をブラウザで開きます。ログインして、Cloud にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
  3. Verifier の値とPKCEVerifier の値を保存します。OAuthVerifier 接続プロパティにVerifier の値を設定し、PKCEVerifier 接続プロパティにPKCEVerifier の値を設定する必要があります。

最後に、ヘッドレスマシンで、次の接続プロパティを設定してOAuth 認証値を取得します。

  • OAuthClientId:OAuth 統合設定のクライアントID に設定。
  • OAuthClientSecret:OAuth 統合設定のクライアントシークレットに設定。
  • OAuthVerifier:verifier code に設定。
  • PKCEVerifier:PKCE verifier code に設定。
  • OAuthSettingsLocation:暗号化されたOAuth 認証値を指定された場所に永続化。
  • InitiateOAuth:REFRESH に設定。

データへの接続

OAuth 設定ファイルが生成されたら、次のプロパティを設定してデータに接続します。

  • OAuthSettingsLocation:暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がプロバイダーに読み書きのアクセス許可を与えることを確認してください。
  • InitiateOAuth:REFRESH に設定。

オプション2:OAuth 設定を転送

別のマシンにCloud をインストールするには、認証してから、結果のOAuth 値を転送します。

  1. セカンドマシンに、Cloud をインストールして、次の接続プロパティセットで接続します。
    • OAuthSettingsLocation:書き込み可能な場所に設定。
    • OAuthClientId:アプリケーション設定のクライアントID に設定。
    • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。
    • CallbackURL:アプリケーション設定のコールバックURL に設定。
  2. 認証する接続をテストします。生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
    • InitiateOAuth:REFRESH に設定。
    • OAuthSettingsLocation:OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

パスワード

User およびPassword をSnowflake ユーザーに設定し、AuthScheme をPASSWORD に設定します。

Note:Snowflake の2024_08 バンドル(2024年10月)以降を使用して作成されたアカウントでは、セキュリティ上の懸念によりパスワード認証はサポートされません。 代わりに、OAuth 認証やプライベートキー認証などの別の認証方法を使用してください。

プライベートキー

Cloud を使用すると、ユーザーアカウントに定義されたプライベートキーを使用してセキュアなトークンを作成することにより、キーペア認証を使用して認証できます。この方法で接続するには、AuthScheme をPrivateKey に設定し、次の値を設定します。

  • User:認証に使用するユーザーアカウント。
  • PrivateKey:プライベートキーを含む.pem ファイルへのパスなど、ユーザーに使用されるプライベートキー。
  • PrivateKeyType:プライベートキーを含むキーストアの種類(PEMKEY_FILE、PFXFILE など)。
  • PrivateKeyPassword:指定されたプライベートキーのパスワード。

Okta

AuthScheme をOKTA に設定します。Okta に接続するには、次の接続プロパティを使用します。

  • User:Okta ユーザーに設定。
  • Password:ユーザーのOkta パスワードに設定。
  • MFAPasscode(オプション):デバイスに送信されたOTP コードに設定。このプロパティは、OKTA サインオンにMFA が必要な場合にのみ使用します。
次のSSOProperties がOkta への認証に必要です。

  • Domain:OKTA org ドメイン名に設定。
  • MFAType(オプション):multi-factor タイプに設定。このプロパティは、OKTA サインオンにMFA が必要な場合にのみ使用します。このプロパティには、次のいずれかの値を指定します。
    • OKTAVerify
    • Email
    • SMS
  • APIToken(オプション):顧客がOkta 組織から作成したAPI Token に設定。Okta クライアントリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合には、これを指定する必要があります。ほとんどの場合必要ありません。

次は接続文字列の例です。

AuthScheme=OKTA;User=username;Password=password;Url='https://myaccount.region.snowflakecomputing.com';Warehouse=My_warehouse;SSO Properties='Domain=https://cdata-okta.okta.com';

次はOKTA MFA の接続文字列の例です。

AuthScheme=OKTA;User=username;Password=password;MFAPasscode=8111461;Url='https://myaccount.region.snowflakecomputing.com';Warehouse=My_warehouse;SSO Properties='Domain=https://cdata-okta.okta.com;MFAType=OktaVerify;';

AzureAD

AuthScheme をAzureAD に、User をAD ユーザーに設定します。接続すると、ブラウザが開きAzure AD にログインして認証を完了できます。 次はAzureAD の接続文字列の例です。
AuthScheme=AzureAD;Url=https://myaccount.region.snowflakecomputing.com;[email protected];

PingFederate

AuthScheme をPingFederate に設定します。PingFederate に接続するには、次の接続プロパティを設定します。

  • User:PingFederate ユーザーに設定。また、PingFederate Data Store にもユーザーを追加する必要があります。接続すると、ブラウザが開きPingFederate にログインして認証を完了できます。
  • Password:ユーザーパスワードに設定。
  • ProofKey(オプション):ブラウザを使用せずに接続する場合は、必ず指定してください。ブラウザの設定では、この値は自動生成されます。
  • ExternalToken(オプション):ブラウザを使用せずに接続する場合に必要です。ブラウザの設定では、この値は自動生成されます。
次はPingFederate(Data Store にActive Directory を使用することを想定した場合)の接続文字列の例です。
AuthScheme=PingFederate;Url=https://myaccount.region.snowflakecomputing.com;User=myuser@mydomain;Account=myaccount;Warehouse=mywarehouse;

Proof Key およびExternal Token の使用

AuthScheme をAzureAD またはPingFederate に設定するには、Proof Key およびExternal Token を使用します。インターネットブラウザで認証を完了する場合、これらの値は自動生成され、Snowflake のログインプロセスで使用される接続文字列に自動的に含まれます。

ブラウザ経由以外の方法で接続する場合は、ProofKey およびExternalToken に値を指定する必要があります。この場合、下記の手順に従って認証します。

  1. 8080 などのポートを指定して、ローカルWeb サーバーを作成します。
  2. 指定したポートを使って、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。このプロシージャは、ログインSSO URL を返します。
  3. 返されたURL をブラウザにコピーします。
  4. 表示されるページで、ユーザーネームとパスワードを入力します。
  5. ログイン後、コールバックURL が生成され、ローカルのWeb サーバーインスタンスに送信されます。このコールバックURL は特殊な形式になっています。コールバックURL からExternal Token を抽出するためのコードを独自に記述する必要があります。

SAML プロバイダー

Cloud は、OneLogin などのSAML ベースのID プロバイダーを汎用的にサポートしています。

AuthScheme をExternalBrowser に設定します。

OneLogin

User を認証したいSnowflake ユーザーに設定します。

接続を試みると、SAML プロバイダーは、デフォルトのWeb ブラウザでログインプロンプトを起動します。

Snowflake を認証するために、SAML プロバイダーに紐づいた認証情報を提供します。

アクセス制御の設定

認証ユーザーがシステム定義のロールにマップしている場合は、RoleName プロパティで指定します。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

データモデル

Cloud は、Snowflake API を使用して双方向SQL アクセスを可能にします。

スキーマの検出

CData Cloud は、ウェアハウス、データベース、スキーマなど、Snowflake からデータの構造を自動的に取得します。データベースやスキーマの指定は任意ですが、指定することで、利用可能なテーブルやビューが選択したデータベースやスキーマ内のものに限定されます。

ストアドプロシージャ

ストアドプロシージャ は、Snowflake のファンクションライクなインターフェースです。これらはOAuth 認証に使用されます。

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Snowflake の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSnowflake から関連するレスポンスデータを返します。

CData Cloud - Snowflake ストアドプロシージャ

Name Description
GetSSOAuthorizationURL Retrieves the Single Sign-On (SSO) authorization URL for browser-based authentication in Snowflake. The returned URL must be accessed in a web browser to request an access token for API connections.

CData Cloud

GetSSOAuthorizationURL

Retrieves the Single Sign-On (SSO) authorization URL for browser-based authentication in Snowflake. The returned URL must be accessed in a web browser to request an access token for API connections.

Input

Name Type Required Description
Port String False Specifies the listening port on the local machine for the callback URL where the authorization response will be received.

デフォルト値は80です。

Result Set Columns

Name Type Description
ProofKey String A cryptographic key used for verifying the integrity of the authentication request in the SSO process.
SSOURL String The SSO authorization URL that users must visit to initiate authentication with Snowflake.
TokenURL String The URL used to request an access token after successful SSO authentication.

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
AuthSchemeSpecifies the authentication scheme used to establish a connection to Snowflake. It determines the authentication mechanism required for validating the user's identity and allows integration with various SSO and OAuth providers. Accepted entries are Password, OKTA, AzureAD, AzureMSI, PingFederate, PrivateKey, OAuth, OAuthClient, OAuthAzureAD, OAuthClientAzureAD, OAuthOKTA, OAuthClientOKTA, OAuthOther, OAuthClientOther, OAuthJWT or ExternalBrowser.
AccountThe Snowflake account identifier used to connect to a Snowflake instance. The account identifier is usually derived from the URL automatically.
WarehouseSpecifies the name of the Snowflake warehouse to be used for query execution. A warehouse in Snowflake is a virtual compute resource that provides the necessary processing power to perform operations such as data loading, querying, and analytics.
UserSpecifies the username used for authenticating with the Snowflake database. The username is required for establishing a successful connection, regardless of the authentication method being used (Password, OKTA, PrivateKey, AzureAD, or OAuth).
PasswordSpecifies the user's password used for authenticating with Snowflake. This property is required when using password-based authentication methods, including Password, PingFederate, and OKTA.
URLSet this property to the URL of your Snowflake database instance. This URL is required for establishing a connection to your Snowflake environment and should follow the standard format provided by Snowflake. The URL is typically structured as follows: https://orgname-myaccount.snowflakecomputing.com.
MFAPasscodeProvides a Multi-Factor Authentication (MFA) code when connecting to Snowflake. This code is required when MFA is enabled for your Snowflake account and you are using time-based one-time passwords (TOTP) or push-based authentication methods.
RoleNameSpecifies the role assigned to the Snowflake user during authentication. This property determines the access privileges and permissions the user has when executing queries and managing resources in Snowflake.

Connection


プロパティ説明
UseVirtualHostingTrue(デフォルト)の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます:http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します:http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されているSnowflake テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。

SSO


プロパティ説明
ProofKeySpecifies the Proof Key used for Single Sign-On (SSO) authentication with Snowflake when integrating with external Identity Providers (IdPs) such as Azure AD and PingFederate. This value is typically generated during the OAuth 2.0 Authorization Code Flow.
ExternalTokenSpecifies the OAuth or SSO token used for authentication with Snowflake. This property is required when performing Single Sign-On (SSO) or OAuth-based authentication with external identity providers like Azure AD or PingFederate.
SSOPropertiesSpecifies additional properties required to connect to the identity provider (IdP). These properties are provided as a semicolon-separated list of key-value pairs, and are commonly used for Single Sign-On (SSO) authentication with Okta or other providers.

KeyPairAuth


プロパティ説明
PrivateKeySpecifies the private key used for Key Pair Authentication when connecting to Snowflake. This property allows authentication via a public-private key pair, providing a highly secure alternative to standard password-based authentication. The PrivateKeyType field specifies the type of the certificate store specified by PrivateKey .
PrivateKeyPasswordSpecifies the password used to decrypt the private key when using Key Pair Authentication with Snowflake. This property is required when the private key file is encrypted with a password for added security.
PrivateKeyTypeSpecifies the type of key store or format containing the private key used for Key Pair Authentication with Snowflake. This property allows the user to choose from various formats and storage mechanisms for supplying the private key.
PrivateKeySubjectSpecifies the subject name of the certificate containing the private key used for Key Pair Authentication with Snowflake. This property is necessary when the PrivateKeyType is set to USER or MACHINE, indicating that the private key is stored in a certificate store rather than a file or PEM blob.

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
StateSpecifies an optional state parameter used during the OAuth authorization process. This value serves as a mechanism to preserve the application's state between the authorization request and the redirect response. It is commonly used to prevent Cross-Site Request Forgery (CSRF) attacks by validating the authenticity of the request upon receiving the callback.
ScopeDetermines the OAuth scopes that the application requests from Snowflake. Setting appropriate scopes defines the permissions that the application will be granted during the OAuth authorization process.
OAuthAuthorizationURLOAuth サービスの認可URL。
OAuthAccessTokenURLOAuth アクセストークンを取得するURL。
PKCEVerifierSpecifies the Proof Key for Code Exchange (PKCE) Verifier used during the OAuth 2.0 PKCE authentication flow. It is used as input when calling GetOAuthAccessToken . This random value is required when obtaining an access token from the authorization server after the initial authorization code is provided.

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
DatabaseThe default database to use for the session when connecting to Snowflake. All SQL queries executed during the session target this database by default.
SchemaSpecifies the schema within the Snowflake database to which the connection will be made. Providing a schema name helps narrow down the scope of database objects being accessed, improving performance when retrieving metadata and executing queries.

Miscellaneous


プロパティ説明
AllowPreparedStatementDetermines whether prepared statements are allowed when executing queries in Snowflake.
AllowUserVariablesDetermines whether user-defined variables (prefixed by an $) can be used in SQL queries executed through the connection.
ApplicationNameSpecifies the name of the application making the connection to Snowflake. This property sets the HTTP User-Agent header for the connection, allowing Snowflake to identify and log queries by application name.
AsyncQueryTimeoutSpecifies the maximum duration, in seconds, that the provider will wait for an asynchronous request to complete when downloading large result sets. Asynchronous requests are typically used for executing complex queries or retrieving large datasets where immediate results are not expected. This property ensures that long-running operations do not hang indefinitely.
BatchModeSpecifies the batch operation mode for executing bulk data operations in Snowflake. This property determines whether the connection should use Binding API or Upload API based on the size of the data being processed.
BindingTypeSpecifies the binding type used for handling Date, Time, and Timestamp_* data types during data insertion operations. This property ensures consistent handling of temporal data when using different APIs for data ingestion.
ClientTimestampNTZTimezoneControls how to handle the Timestamp_NTZ value since the Timestamp_NTZ type is a value without time zone.
CustomStageSpecifies the name of a custom stage to be used during bulk write operations in Snowflake. This can be either an internal stage (stored within Snowflake) or an external stage (hosted on cloud services like AWS S3 or Azure Blob Storage).
ExternalStageAWSAccessKeySpecifies the AWS Access Key ID used to authenticate with an AWS S3 external stage during bulk write operations in Snowflake. This property is necessary when using a CustomStage that references an AWS S3 bucket.
ExternalStageAWSSecretKeySpecifies the AWS Secret Access Key associated with your AWS Access Key ID ( ExternalStageAWSAccessKey ). This property is required for authenticating access to AWS S3 external stages during bulk write operations in Snowflake.
ExternalStageAzureSASTokenSpecifies the Azure Blob Storage Shared Access Signature (SAS) token used to authenticate access to an Azure Blob Storage external stage. This property allows Snowflake to interact with Azure Blob Storage containers or objects for bulk data operations. This property is necessary when using a CustomStage that references an Azure location.
IgnoreCaseControls whether case sensitivity is ignored for object names (for example, databases, schemas, tables, and columns) when executing SQL queries.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreads同時リクエスト数を指定します。
MergeDeleteA Boolean property that determines whether batch DELETE statements are automatically converted to MERGE statements. This applies only when the DELETE statement’s WHERE clause exclusively contains the table’s primary key fields combined using the AND logical operator. When enabled, Snowflake attempts to handle deletions more efficiently by using the MERGE mechanism instead of standard batch deletion.
MergeInsertA Boolean property that determines whether INSERT statements are automatically converted to MERGE statements when executed. This property is applicable only when the INSERT operation includes a table’s primary key field. When enabled, Snowflake attempts to upsert records by merging incoming data with existing rows if a primary key conflict occurs, rather than performing a simple insert operation.
MergeUpdateA Boolean property that determines whether batch UPDATE statements are automatically converted to MERGE statements. This applies only when the UPDATE statement’s WHERE clause exclusively includes the table’s primary key fields combined using the AND logical operator. When enabled, Snowflake optimizes updates by leveraging the MERGE mechanism instead of standard batch updates.
RetryOnChunkTimeoutSpecifies whether the connection should retry downloading data chunks from Snowflake when a network issue or timeout occurs.
S3DomainSpecifies the URI of the Amazon S3 bucket used as the Snowflake S3 stage. This property is required when defining external stages for data loading and unloading between Snowflake and S3.
SessionIdleTimeoutSpecifies the timeout duration, in minutes, for idle sessions. This setting corresponds to Snowflake's session policy parameter 'SESSION_IDLE_TIMEOUT_MINS'. The default value is 240 minutes, meaning a session is terminated if it remains inactive for more than four hours.
SessionParametersSpecifies additional session parameters to customize the behavior of the Snowflake connection. These parameters are passed as a semicolon-separated list of key-value pairs. Common use cases include setting query tags or modifying identifier handling settings.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
AuthSchemeSpecifies the authentication scheme used to establish a connection to Snowflake. It determines the authentication mechanism required for validating the user's identity and allows integration with various SSO and OAuth providers. Accepted entries are Password, OKTA, AzureAD, AzureMSI, PingFederate, PrivateKey, OAuth, OAuthClient, OAuthAzureAD, OAuthClientAzureAD, OAuthOKTA, OAuthClientOKTA, OAuthOther, OAuthClientOther, OAuthJWT or ExternalBrowser.
AccountThe Snowflake account identifier used to connect to a Snowflake instance. The account identifier is usually derived from the URL automatically.
WarehouseSpecifies the name of the Snowflake warehouse to be used for query execution. A warehouse in Snowflake is a virtual compute resource that provides the necessary processing power to perform operations such as data loading, querying, and analytics.
UserSpecifies the username used for authenticating with the Snowflake database. The username is required for establishing a successful connection, regardless of the authentication method being used (Password, OKTA, PrivateKey, AzureAD, or OAuth).
PasswordSpecifies the user's password used for authenticating with Snowflake. This property is required when using password-based authentication methods, including Password, PingFederate, and OKTA.
URLSet this property to the URL of your Snowflake database instance. This URL is required for establishing a connection to your Snowflake environment and should follow the standard format provided by Snowflake. The URL is typically structured as follows: https://orgname-myaccount.snowflakecomputing.com.
MFAPasscodeProvides a Multi-Factor Authentication (MFA) code when connecting to Snowflake. This code is required when MFA is enabled for your Snowflake account and you are using time-based one-time passwords (TOTP) or push-based authentication methods.
RoleNameSpecifies the role assigned to the Snowflake user during authentication. This property determines the access privileges and permissions the user has when executing queries and managing resources in Snowflake.
CData Cloud

AuthScheme

Specifies the authentication scheme used to establish a connection to Snowflake. It determines the authentication mechanism required for validating the user's identity and allows integration with various SSO and OAuth providers. Accepted entries are Password, OKTA, AzureAD, AzureMSI, PingFederate, PrivateKey, OAuth, OAuthClient, OAuthAzureAD, OAuthClientAzureAD, OAuthOKTA, OAuthClientOKTA, OAuthOther, OAuthClientOther, OAuthJWT or ExternalBrowser.

Possible Values

Password, OKTA, PrivateKey, OAuth, OAuthClient, OAuthAzureAD, OAuthClientAzureAD, OAuthOKTA, OAuthClientOKTA, OAuthOther, OAuthClientOther, OAuthJWT, PingFederate

データ型

string

デフォルト値

"OAuth"

解説

The Cloud supports the following authentication mechanisms. See the Getting Started chapter for authentication guides.

  • Password: Standard username/password authentication. Recommended for simple authentication setups.
  • OKTA: Set this to use the OKTA SSO identity provider. Set SSOProperties in addition to the User and Password you use to authenticate to OKTA.
  • AzureAD: Integrates with Azure Active Directory (Azure AD) for user authentication. Set this along with User to use the Azure AD identity provider. When connecting, your browser opens, allowing you to login to Azure AD to complete the authentication.
  • AzureMSI: Uses Azure Managed Service Identity (MSI) for authentication. Set this along with AzureResource to use the Azure Managed Service Identity when running on an Azure Virtual Machine (VM).
  • PingFederate: Uses PingFederate SSO identity provider for authentication. Set this along with User to use the PingFederate SSO identity provider. When connecting, your browser opens, allowing you to login to PingFederate to complete the authentication.
  • PrivateKey: Key pair authentication using RSA key pairs for enhanced security. You must also set PrivateKey, PrivateKeyPassword and PrivateKeyType to authenticate with this method.
  • OAuth: Standard OAuth 2.0 authentication using tokens. Set OAuthClientId, OAuthClientSecret to the Snowflake OAuth credentials. Additionally, set InitiateOAuth to GETANDREFRESH. Note that the CData driver always uses PKCE with OAuth for extra security. It works for Snowflake’s built-in OAuth service.
  • OAuthClient: Deprecated. The OAuthClient authentication mode is not supported because the Snowflake’s built-in OAuth service does not support the Client Credentials grant type.
  • OAuthAzureAD: Standard OAuth 2.0 authentication using tokens. Set OAuthClientId, OAuthClientSecret to the Snowflake OAuth credentials. Additionally, set InitiateOAuth to GETANDREFRESH. Note that the CData driver always uses PKCE with OAuth for extra security. The Identity Provider (IdP) is the external Azure AD.
  • OAuthClientAzureAD: Client grant type OAuth authentication for service-to-service communication. Set OAuthClientId, OAuthClientSecret to the Snowflake OAuth credentials. Additionally, set InitiateOAuth to GETANDREFRESH. The Identity Provider (IdP) is the external Azure AD.
  • OAuthOKTA: Standard OAuth 2.0 authentication using tokens. Set OAuthClientId, OAuthClientSecret to the Snowflake OAuth credentials. Additionally, set InitiateOAuth to GETANDREFRESH. Note that the CData driver always uses PKCE with OAuth for extra security. The Identity Provider (IdP) is the external OKTA.
  • OAuthClientOKTA: Client grant type OAuth authentication for service-to-service communication. Set OAuthClientId, OAuthClientSecret to the Snowflake OAuth credentials. Additionally, set InitiateOAuth to GETANDREFRESH. The Identity Provider (IdP) is the external OKTA.
  • OAuthOther: Standard OAuth 2.0 authentication using tokens. Set OAuthClientId, OAuthClientSecret to the Snowflake OAuth credentials. Additionally, set InitiateOAuth to GETANDREFRESH. Note that the CData driver always uses PKCE with OAuth for extra security. The Identity Provider (IdP) is other external customized application.
  • OAuthClientOther: Client grant type OAuth authentication for service-to-service communication. Set OAuthClientId, OAuthClientSecret to the Snowflake OAuth credentials. Additionally, set InitiateOAuth to GETANDREFRESH. The Identity Provider (IdP) is other external customized application.
  • OAuthJWT: Set this to perform External OAuth authentication with a JWT certificate. The Identity Provider (IdP) is the external Azure AD. Requires the following additional connection properties. [OAuthJWTCert,/OAuthJWTCertType]
  • ExternalBrowser: Uses OneLogin SSO identity provider or other browser-based SSO providers. Set this along with User. When connecting, your browser opens and authentication is completed automatically.

CData Cloud

Account

The Snowflake account identifier used to connect to a Snowflake instance. The account identifier is usually derived from the URL automatically.

データ型

string

デフォルト値

""

解説

The account identifier is usually derived from the Snowflake login URL. For example, if the login URL is https://myorganization-myaccount.snowflakecomputing.com, the account is myorganization-myaccount. If your account includes an AWS cloud region, it would have the format myorganization-myaccount.aws_region. Set this if your Snowflake database URL doesn't include the account name. Use the command SELECT CURRENT_ACCOUNT(); to return the exact account value.

CData Cloud

Warehouse

Specifies the name of the Snowflake warehouse to be used for query execution. A warehouse in Snowflake is a virtual compute resource that provides the necessary processing power to perform operations such as data loading, querying, and analytics.

データ型

string

デフォルト値

""

解説

Provide the name of the Snowflake warehouse you wish to connect to. This warehouse name is required to enable query processing and data manipulation. For example:

Warehouse='MYACCOUNT_WH'
Ensure the specified warehouse is active and accessible for your user account.

CData Cloud

User

Specifies the username used for authenticating with the Snowflake database. The username is required for establishing a successful connection, regardless of the authentication method being used (Password, OKTA, PrivateKey, AzureAD, or OAuth).

データ型

string

デフォルト値

""

解説

Provide the username associated with your Snowflake account to enable authentication. This username is required when connecting via various authentication schemes, including Password, OAuth, SSO (OKTA, AzureAD, PingFederate), and External Browser.

CData Cloud

Password

Specifies the user's password used for authenticating with Snowflake. This property is required when using password-based authentication methods, including Password, PingFederate, and OKTA.

データ型

string

デフォルト値

""

解説

The Password property is supplied during the connection process along with the User property.

The authentication mechanism (AuthScheme) determines how the password is processed:

  • Password: Basic username-password authentication.
  • PingFederate: Redirects to a PingFederate endpoint for SSO.
  • OKTA: Used in conjunction with an MFA passcode if required.
Once validated, the user is granted access to the Snowflake environment.

CData Cloud

URL

Set this property to the URL of your Snowflake database instance. This URL is required for establishing a connection to your Snowflake environment and should follow the standard format provided by Snowflake. The URL is typically structured as follows: https://orgname-myaccount.snowflakecomputing.com.

データ型

string

デフォルト値

""

解説

To find your URL:

  1. Click your name in the lower left-hand corner of your Snowflake UI.
  2. Hover over your Account ID.
  3. Click the Copy Account URL icon to copy your account URL.

CData Cloud

MFAPasscode

Provides a Multi-Factor Authentication (MFA) code when connecting to Snowflake. This code is required when MFA is enabled for your Snowflake account and you are using time-based one-time passwords (TOTP) or push-based authentication methods.

データ型

string

デフォルト値

""

解説

Allows connecting to Snowflake using a code generated by an MFA application such as Google Authenticator, Duo, or Microsoft Authenticator. The user must supply a one-time code during connection.

CData Cloud

RoleName

Specifies the role assigned to the Snowflake user during authentication. This property determines the access privileges and permissions the user has when executing queries and managing resources in Snowflake.

データ型

string

デフォルト値

""

解説

The default roles in Snowflake are: PUBLIC, SYSADMIN, or ACCOUNTADMIN.

  • PUBLIC: Basic read-only access for most users.
  • SYSADMIN: High-level access for managing databases, schemas, and objects.
  • ACCOUNTADMIN: Full administrative privileges, including user and account management.
If this value is not set, Snowflake uses the default logged-in user's role. A custom role may also be specified.

CData Cloud

Connection

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。


プロパティ説明
UseVirtualHostingTrue(デフォルト)の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます:http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します:http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。
CData Cloud

UseVirtualHosting

True(デフォルト)の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます:http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します:http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。

データ型

bool

デフォルト値

true

解説

True(デフォルト)の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます:http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します:http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。

CData Cloud

Azure Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。


プロパティ説明
AzureTenantデータにアクセスするために使用されているSnowflake テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。
CData Cloud

AzureTenant

データにアクセスするために使用されているSnowflake テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。

データ型

string

デフォルト値

""

解説

テナントとは、Microsoft Entra ID(旧称:Azure AD)を通じて管理される、組織のユーザーやリソースのためのデジタルコンテナです。 各テナントには一意のディレクトリID が関連付けられており、多くの場合、カスタムドメイン(例:microsoft.com やcontoso.onmicrosoft.com)も関連付けられています。

Microsoft Entra 管理センターでディレクトリ(テナント)ID を確認するには、Microsoft Entra ID -> プロパティに移動し、「ディレクトリ(テナント)ID」と表示されている値をコピーします。

このプロパティは以下の場合に必要です。

  • AuthScheme がAzureServicePrincipal またはAzureServicePrincipalCert に設定されている場合
  • AuthScheme がAzureAD で、ユーザーアカウントが複数のテナントに属している場合

テナントの値は、2つの形式のいずれかで指定できます。

  • ドメイン名(例:contoso.onmicrosoft.com)
  • GUID 形式のディレクトリ(テナント)ID(例:c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0)

テナントを明示的に指定することで、認証リクエストが正しいディレクトリにルーティングされるようになります。これは、ユーザーが複数のテナントに所属している場合や、サービスプリンシパルベースの認証を使用する場合に特に重要です。

この値が必要な場面で省略されると、認証に失敗したり、誤ったテナントに接続されたりする可能性があります。その結果、認可されていないまたはリソースが見つからないといったエラーが発生する可能性があります。

CData Cloud

SSO

このセクションでは、本プロバイダーの接続文字列で設定可能なSSO プロパティの全リストを提供します。


プロパティ説明
ProofKeySpecifies the Proof Key used for Single Sign-On (SSO) authentication with Snowflake when integrating with external Identity Providers (IdPs) such as Azure AD and PingFederate. This value is typically generated during the OAuth 2.0 Authorization Code Flow.
ExternalTokenSpecifies the OAuth or SSO token used for authentication with Snowflake. This property is required when performing Single Sign-On (SSO) or OAuth-based authentication with external identity providers like Azure AD or PingFederate.
SSOPropertiesSpecifies additional properties required to connect to the identity provider (IdP). These properties are provided as a semicolon-separated list of key-value pairs, and are commonly used for Single Sign-On (SSO) authentication with Okta or other providers.
CData Cloud

ProofKey

Specifies the Proof Key used for Single Sign-On (SSO) authentication with Snowflake when integrating with external Identity Providers (IdPs) such as Azure AD and PingFederate. This value is typically generated during the OAuth 2.0 Authorization Code Flow.

データ型

string

デフォルト値

""

解説

To obtain the ProofKey:

  1. Initiate the SSO Flow: Use the GetSSOAuthorizationURL call to generate a Authorization URL for the user to authenticate via the Identity Provider (IdP). The IdP accesses the Authorization URL, authenticates it, and returns a proof key.
  2. Provide Proof Key to Snowflake: Set this connection property to the proof key returned by the IdP.

CData Cloud

ExternalToken

Specifies the OAuth or SSO token used for authentication with Snowflake. This property is required when performing Single Sign-On (SSO) or OAuth-based authentication with external identity providers like Azure AD or PingFederate.

データ型

string

デフォルト値

""

解説

To obtain an external token:

  1. Register your Application with the Identity Provider (IdP).
  2. Obtain a Client ID and Client Secret from the IdP.
  3. Request an OAuth Token by performing an OAuth authorization flow.
  4. Pass the Token as the ExternalToken in your Snowflake connection.

CData Cloud

SSOProperties

Specifies additional properties required to connect to the identity provider (IdP). These properties are provided as a semicolon-separated list of key-value pairs, and are commonly used for Single Sign-On (SSO) authentication with Okta or other providers.

データ型

string

デフォルト値

""

解説

This property allows you to define specific connection parameters needed to authenticate with the identity provider. The entries should be formatted as a semicolon-separated list of key-value pairs.

For example, when using Okta as the identity provider:

OKTA

  • Domain: The Okta domain you are signing in with, such as: myorg.okta.com
  • APIToken: Your Okta API token. Usually unnecessary but can be provided if needed.
Example usage:
SSOProperties='Domain=myorg.okta.com;APIToken=YourOktaToken;'

CData Cloud

KeyPairAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なKeyPairAuth プロパティの全リストを提供します。


プロパティ説明
PrivateKeySpecifies the private key used for Key Pair Authentication when connecting to Snowflake. This property allows authentication via a public-private key pair, providing a highly secure alternative to standard password-based authentication. The PrivateKeyType field specifies the type of the certificate store specified by PrivateKey .
PrivateKeyPasswordSpecifies the password used to decrypt the private key when using Key Pair Authentication with Snowflake. This property is required when the private key file is encrypted with a password for added security.
PrivateKeyTypeSpecifies the type of key store or format containing the private key used for Key Pair Authentication with Snowflake. This property allows the user to choose from various formats and storage mechanisms for supplying the private key.
PrivateKeySubjectSpecifies the subject name of the certificate containing the private key used for Key Pair Authentication with Snowflake. This property is necessary when the PrivateKeyType is set to USER or MACHINE, indicating that the private key is stored in a certificate store rather than a file or PEM blob.
CData Cloud

PrivateKey

Specifies the private key used for Key Pair Authentication when connecting to Snowflake. This property allows authentication via a public-private key pair, providing a highly secure alternative to standard password-based authentication. The PrivateKeyType field specifies the type of the certificate store specified by PrivateKey .

データ型

string

デフォルト値

""

解説

The contents of this property is dependent on the PrivateKeyType. This property's content can take one of three forms.

  • The certificate store type is a file-based type, such as PEMKEY_FILE, PFXFILE, or PUBLIC_KEY_FILE: this property must be set to the path to the file.
  • The certificate store type is a blob-based type, such as PEMKEY_BLOB, PFXBLOB, or PUBLIC_KEY_BLOB: this property must be set to the text content of the file.
  • The certificate store type is a Windows-only type such as USER or MACHINE: this property refers to the certificate name.
If the certificate store is password protected, specify the password in PrivateKeyPassword.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

CData Cloud

PrivateKeyPassword

Specifies the password used to decrypt the private key when using Key Pair Authentication with Snowflake. This property is required when the private key file is encrypted with a password for added security.

データ型

string

デフォルト値

""

解説

The password for the private key specified in the PrivateKey property, if required.

CData Cloud

PrivateKeyType

Specifies the type of key store or format containing the private key used for Key Pair Authentication with Snowflake. This property allows the user to choose from various formats and storage mechanisms for supplying the private key.

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

This property can take one of the following values. The value chosen affects the format of the PrivateKey connection property contents:

USERFor Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
MACHINEFor Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILEThe certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILEThe certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
PEMKEY_FILEThe certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOBThe certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILEThe certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILEThe certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILEThe certificate store is the name of a PKCS7 file containing certificates.
PPKFILEThe certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILEThe certificate store is the name of a file that contains a certificate in XML format.
XMLBLOBThe certificate store is a string that contains a certificate in XML format.

CData Cloud

PrivateKeySubject

Specifies the subject name of the certificate containing the private key used for Key Pair Authentication with Snowflake. This property is necessary when the PrivateKeyType is set to USER or MACHINE, indicating that the private key is stored in a certificate store rather than a file or PEM blob.

データ型

string

デフォルト値

"*"

解説

To obtain the PrivateKeySubject:

  1. Open the Certificate Manager (Windows) by pressing Windows+r and entering certmgr.msc (for user certificates) or mmc + Add Certificates snap-in (for machine certificates).
  2. Locate the desired certificate.
  3. Right-click the certificate and select Properties.
  4. Copy the Subject field.
  5. Paste this value in the PrivateKeySubject property.

CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
StateSpecifies an optional state parameter used during the OAuth authorization process. This value serves as a mechanism to preserve the application's state between the authorization request and the redirect response. It is commonly used to prevent Cross-Site Request Forgery (CSRF) attacks by validating the authenticity of the request upon receiving the callback.
ScopeDetermines the OAuth scopes that the application requests from Snowflake. Setting appropriate scopes defines the permissions that the application will be granted during the OAuth authorization process.
OAuthAuthorizationURLOAuth サービスの認可URL。
OAuthAccessTokenURLOAuth アクセストークンを取得するURL。
PKCEVerifierSpecifies the Proof Key for Code Exchange (PKCE) Verifier used during the OAuth 2.0 PKCE authentication flow. It is used as input when calling GetOAuthAccessToken . This random value is required when obtaining an access token from the authorization server after the initial authorization code is provided.
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

State

Specifies an optional state parameter used during the OAuth authorization process. This value serves as a mechanism to preserve the application's state between the authorization request and the redirect response. It is commonly used to prevent Cross-Site Request Forgery (CSRF) attacks by validating the authenticity of the request upon receiving the callback.

データ型

string

デフォルト値

""

解説

This property is typically a randomly generated string that your application sends to the authorization server and expects to receive back unchanged. This helps to ensure that the response is coming from the intended request and not from a malicious source.


Example usage: State='xyz123RandomStringForValidation'

This property is for organizations with a particularly high security requirement.

CData Cloud

Scope

Determines the OAuth scopes that the application requests from Snowflake. Setting appropriate scopes defines the permissions that the application will be granted during the OAuth authorization process.

データ型

string

デフォルト値

""

解説

By default, the Cloud will request authorization for all available scopes. To restrict permissions, you can specify this property as a space-separated list of desired OAuth scopes, allowing for more granular control over access permissions.

For example, to request only read and write access to user data, you might set the value of this property as:

"read_data write_data"
If you only need to read user profile information, you might use:
"read_profile"

CData Cloud

OAuthAuthorizationURL

OAuth サービスの認可URL。

データ型

string

デフォルト値

""

解説

OAuth サービスの認可URL。このURL でユーザーはサーバーにログインしてアプリケーションにアクセス許可を与えます。OAuth 1.0 では、アクセス許可が付与されるとリクエストトークンが認可されます。

CData Cloud

OAuthAccessTokenURL

OAuth アクセストークンを取得するURL。

データ型

string

デフォルト値

""

解説

OAuth 1.0 では、このURL で認可されたリクエストトークンがアクセストークンと交換されます。

CData Cloud

PKCEVerifier

Specifies the Proof Key for Code Exchange (PKCE) Verifier used during the OAuth 2.0 PKCE authentication flow. It is used as input when calling GetOAuthAccessToken . This random value is required when obtaining an access token from the authorization server after the initial authorization code is provided.

データ型

string

デフォルト値

""

解説

Use PKCEVerifier when integrating with external Identity Providers (IdPs) that support PKCE, such as Azure AD, Okta, or Google Identity.

The PKCEVerifier is usually derived from the GetOAuthAuthorizationUrl call.

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
MD5 Thumbprint(hex 値はスペースまたはコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
DatabaseThe default database to use for the session when connecting to Snowflake. All SQL queries executed during the session target this database by default.
SchemaSpecifies the schema within the Snowflake database to which the connection will be made. Providing a schema name helps narrow down the scope of database objects being accessed, improving performance when retrieving metadata and executing queries.
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Database

The default database to use for the session when connecting to Snowflake. All SQL queries executed during the session target this database by default.

データ型

string

デフォルト値

""

解説

The Database property simplifies your queries if you normally work with one database during a session. If you work with multiple databases in the same session, do not set this property. If you do not set this property, use the fully qualified path to tables and schemas in SQL queries.

CData Cloud

Schema

Specifies the schema within the Snowflake database to which the connection will be made. Providing a schema name helps narrow down the scope of database objects being accessed, improving performance when retrieving metadata and executing queries.

データ型

string

デフォルト値

""

解説

By specifying a schema, you can reduce the scope of metadata retrieval, which is particularly useful when working with large databases. If not specified, the connection may default to the schema defined by the user's default role or configuration.

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
AllowPreparedStatementDetermines whether prepared statements are allowed when executing queries in Snowflake.
AllowUserVariablesDetermines whether user-defined variables (prefixed by an $) can be used in SQL queries executed through the connection.
ApplicationNameSpecifies the name of the application making the connection to Snowflake. This property sets the HTTP User-Agent header for the connection, allowing Snowflake to identify and log queries by application name.
AsyncQueryTimeoutSpecifies the maximum duration, in seconds, that the provider will wait for an asynchronous request to complete when downloading large result sets. Asynchronous requests are typically used for executing complex queries or retrieving large datasets where immediate results are not expected. This property ensures that long-running operations do not hang indefinitely.
BatchModeSpecifies the batch operation mode for executing bulk data operations in Snowflake. This property determines whether the connection should use Binding API or Upload API based on the size of the data being processed.
BindingTypeSpecifies the binding type used for handling Date, Time, and Timestamp_* data types during data insertion operations. This property ensures consistent handling of temporal data when using different APIs for data ingestion.
ClientTimestampNTZTimezoneControls how to handle the Timestamp_NTZ value since the Timestamp_NTZ type is a value without time zone.
CustomStageSpecifies the name of a custom stage to be used during bulk write operations in Snowflake. This can be either an internal stage (stored within Snowflake) or an external stage (hosted on cloud services like AWS S3 or Azure Blob Storage).
ExternalStageAWSAccessKeySpecifies the AWS Access Key ID used to authenticate with an AWS S3 external stage during bulk write operations in Snowflake. This property is necessary when using a CustomStage that references an AWS S3 bucket.
ExternalStageAWSSecretKeySpecifies the AWS Secret Access Key associated with your AWS Access Key ID ( ExternalStageAWSAccessKey ). This property is required for authenticating access to AWS S3 external stages during bulk write operations in Snowflake.
ExternalStageAzureSASTokenSpecifies the Azure Blob Storage Shared Access Signature (SAS) token used to authenticate access to an Azure Blob Storage external stage. This property allows Snowflake to interact with Azure Blob Storage containers or objects for bulk data operations. This property is necessary when using a CustomStage that references an Azure location.
IgnoreCaseControls whether case sensitivity is ignored for object names (for example, databases, schemas, tables, and columns) when executing SQL queries.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreads同時リクエスト数を指定します。
MergeDeleteA Boolean property that determines whether batch DELETE statements are automatically converted to MERGE statements. This applies only when the DELETE statement’s WHERE clause exclusively contains the table’s primary key fields combined using the AND logical operator. When enabled, Snowflake attempts to handle deletions more efficiently by using the MERGE mechanism instead of standard batch deletion.
MergeInsertA Boolean property that determines whether INSERT statements are automatically converted to MERGE statements when executed. This property is applicable only when the INSERT operation includes a table’s primary key field. When enabled, Snowflake attempts to upsert records by merging incoming data with existing rows if a primary key conflict occurs, rather than performing a simple insert operation.
MergeUpdateA Boolean property that determines whether batch UPDATE statements are automatically converted to MERGE statements. This applies only when the UPDATE statement’s WHERE clause exclusively includes the table’s primary key fields combined using the AND logical operator. When enabled, Snowflake optimizes updates by leveraging the MERGE mechanism instead of standard batch updates.
RetryOnChunkTimeoutSpecifies whether the connection should retry downloading data chunks from Snowflake when a network issue or timeout occurs.
S3DomainSpecifies the URI of the Amazon S3 bucket used as the Snowflake S3 stage. This property is required when defining external stages for data loading and unloading between Snowflake and S3.
SessionIdleTimeoutSpecifies the timeout duration, in minutes, for idle sessions. This setting corresponds to Snowflake's session policy parameter 'SESSION_IDLE_TIMEOUT_MINS'. The default value is 240 minutes, meaning a session is terminated if it remains inactive for more than four hours.
SessionParametersSpecifies additional session parameters to customize the behavior of the Snowflake connection. These parameters are passed as a semicolon-separated list of key-value pairs. Common use cases include setting query tags or modifying identifier handling settings.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

AllowPreparedStatement

Determines whether prepared statements are allowed when executing queries in Snowflake.

データ型

bool

デフォルト値

false

解説

A prepared statement is a SQL query that is precompiled and can be executed multiple times with different parameters.

The default value for this property is 'false', meaning that statements are parsed each time they are executed. Leave the default setting if you are executing many different queries only once, or if you have complex queries.

If you are executing the same query repeatedly, you will generally see better performance by setting this property to 'true'. Preparing the query avoids recompiling the same query over and over. However, prepared statements also require the Cloud to keep the connection active and open while the statement is prepared.

CData Cloud

AllowUserVariables

Determines whether user-defined variables (prefixed by an $) can be used in SQL queries executed through the connection.

データ型

bool

デフォルト値

false

解説

When set to 'true', user variables (prefixed by an $) can be used in SQL queries. By default, identifiers prefixed with $ are treated as command parameters rather than user-defined variables.

CData Cloud

ApplicationName

Specifies the name of the application making the connection to Snowflake. This property sets the HTTP User-Agent header for the connection, allowing Snowflake to identify and log queries by application name.

データ型

string

デフォルト値

""

解説

Snowflake logs the application name in query history and session information, making it useful for tracking and monitoring queries from different applications connecting to the same Snowflake environment. It can identify which applications generate heavy workloads. If not specified, Snowflake assigns a default value (often the client driver name).

You can view the ApplicationName in Snowflake's QUERY_HISTORY table.

CData Cloud

AsyncQueryTimeout

Specifies the maximum duration, in seconds, that the provider will wait for an asynchronous request to complete when downloading large result sets. Asynchronous requests are typically used for executing complex queries or retrieving large datasets where immediate results are not expected. This property ensures that long-running operations do not hang indefinitely.

データ型

int

デフォルト値

300

解説

If this property is set to 0, asynchronous operations will run until completion, regardless of how long they take, unless an error condition occurs. This property is different from Timeout, which governs the timeout for individual HTTP operations.

When dealing with large datasets, setting a reasonable timeout value ensures that the operation will terminate if it exceeds the specified duration, helping to prevent resource exhaustion or prolonged processing.

If the AsyncQueryTimeout limit is reached and the asynchronous request has not completed, the Cloud will raise an error condition indicating that the request was unsuccessful due to a timeout.

CData Cloud

BatchMode

Specifies the batch operation mode for executing bulk data operations in Snowflake. This property determines whether the connection should use Binding API or Upload API based on the size of the data being processed.

Possible Values

Auto, Binding, Upload

データ型

string

デフォルト値

"Auto"

解説

There are three accepted values: Auto (default), Binding, and Upload.

  • Auto: Automatically selects the API based on the count of values. Uses Binding API if below the threshold defined by the session parameter client_binding_threshold. Otherwise, uses Upload API.
  • Binding: Forces the use of the Binding API regardless of data size. Suitable for smaller data batches.
  • Upload: Forces the use of the Upload API regardless of data size. Recommended for larger bulk uploads.

Forcing Binding or Upload can improve performance if you know the data size will always be small or large, respectively.

CData Cloud

BindingType

Specifies the binding type used for handling Date, Time, and Timestamp_* data types during data insertion operations. This property ensures consistent handling of temporal data when using different APIs for data ingestion.

Possible Values

DEFAULT, TEXT

データ型

string

デフォルト値

"DEFAULT"

解説

There are two kinds of binding types: DEFAULT and TEXT.

  • DEFAULT: Uses native binding types: DATE for Date, TIME for Time, and TIMESTAMP_* for Timestamp. By default, the driver selects either the Binding API or Upload API based on the number of records, unless BatchMode is specified.

    The behavior for TIMESTAMP_* types is determined by the session parameter CLIENT_TIMESTAMP_TYPE_MAPPING. However, when using the Upload API, this session parameter does not apply, potentially causing inconsistent timestamp values when inserting different quantities of records.

  • TEXT: Uses TEXT binding for Date, Time, and Timestamp_* types. This ensures consistent timestamp handling across both the Binding API and Upload API, regardless of the number of records being inserted.

    If you need consistent timestamp handling across Binding API and Upload API, use BindingType=TEXT.

CData Cloud

ClientTimestampNTZTimezone

Controls how to handle the Timestamp_NTZ value since the Timestamp_NTZ type is a value without time zone.

Possible Values

Local, UTC, Unspecified

データ型

string

デフォルト値

"Local"

解説

CData Cloud

CustomStage

Specifies the name of a custom stage to be used during bulk write operations in Snowflake. This can be either an internal stage (stored within Snowflake) or an external stage (hosted on cloud services like AWS S3 or Azure Blob Storage).

データ型

string

デフォルト値

""

解説

If the stage is external, the AWS or Azure credentials must be provided as well via the ExternalStageAWSAccessKey/ExternalStageAWSSecretKey or ExternalStageAzureSASToken properties.

When the CustomStage property is left unspecified, the Cloud generates a temporary stage automatically during the upload process and delete it after the upload is complete.

To avoid parsing errors with the generated CSV, you should include the FIELD_OPTIONALLY_ENCLOSED_BY parameter on the stage definition and set it to the double quote character. Otherwise, you may face parsing issues if you have string values that contain special characters in CSV (such as commas or double quotes).

For example:

CREATE STAGE "TEST_STAGE_CDATA" FILE_FORMAT = (FIELD_OPTIONALLY_ENCLOSED_BY='\"' )

Use internal stages for small to medium-sized data or external stages for integrating with cloud storage systems like AWS S3 or Azure Blob Storage.

CData Cloud

ExternalStageAWSAccessKey

Specifies the AWS Access Key ID used to authenticate with an AWS S3 external stage during bulk write operations in Snowflake. This property is necessary when using a CustomStage that references an AWS S3 bucket.

データ型

string

デフォルト値

""

解説

Your AWS account access key. This value is accessible from your AWS security credentials page:

  1. Sign into the AWS Management console with the credentials for your root account.
  2. Select your account name or number and select My Security Credentials in the menu that is displayed.
  3. Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.

CData Cloud

ExternalStageAWSSecretKey

Specifies the AWS Secret Access Key associated with your AWS Access Key ID ( ExternalStageAWSAccessKey ). This property is required for authenticating access to AWS S3 external stages during bulk write operations in Snowflake.

データ型

string

デフォルト値

""

解説

Your AWS account secret key. This value is accessible from your AWS security credentials page:

  1. Sign into the AWS Management console with the credentials for your root account.
  2. Select your account name or number and select My Security Credentials in the menu that is displayed.
  3. Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.

CData Cloud

ExternalStageAzureSASToken

Specifies the Azure Blob Storage Shared Access Signature (SAS) token used to authenticate access to an Azure Blob Storage external stage. This property allows Snowflake to interact with Azure Blob Storage containers or objects for bulk data operations. This property is necessary when using a CustomStage that references an Azure location.

データ型

string

デフォルト値

""

解説

The string value of the Azure Blob shared access signature.

In the Azure Portal, go to Shared access signature in the Settings section for your Azure Blob container. Click Generate SAS token and URL and copy the value from the Blob SAS token textbox. Please be careful to select the proper permissions (Create, Write, Delete) in the Permissions dropdown list and the validity of the Start and Expiration time before you generate the SAS token.

CData Cloud

IgnoreCase

Controls whether case sensitivity is ignored for object names (for example, databases, schemas, tables, and columns) when executing SQL queries.

データ型

bool

デフォルト値

false

解説

The default value is 'false' (object names are case sensitive). This property is useful for legacy systems that do not enforce case sensitivity.

CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

MaxThreads

同時リクエスト数を指定します。

データ型

string

デフォルト値

"5"

解説

このプロパティを使用すると、複数のリクエストを同時に発行することができパフォーマンスが向上します。

CData Cloud

MergeDelete

A Boolean property that determines whether batch DELETE statements are automatically converted to MERGE statements. This applies only when the DELETE statement’s WHERE clause exclusively contains the table’s primary key fields combined using the AND logical operator. When enabled, Snowflake attempts to handle deletions more efficiently by using the MERGE mechanism instead of standard batch deletion.

データ型

bool

デフォルト値

false

解説

MergeDelete allows for upsert functionality. This property is primarily intended for use with tools where you have no direct control over the queries being executed. Otherwise, as long as Query Passthrough is 'true', you could execute the MERGE command directly.

When this property is 'false', DELETE bulk statements are executed against the server. When it is set to 'true' and the DELETE query contains the primary key field, Snowflake sends a MERGE query that executes a DELETE if match is found in Snowflake.

For example this query:

DELETE FROM "Table" WHERE "ID" = 1 AND "NAME" = 'Jerry'

is sent to Snowflake as the following MERGE request:

MERGE INTO "Table" AS "Target" USING "RTABLE1_TMP_20eca05b-c050-47dd-89bc-81c7f617f877" AS "Source" ON ("Target"."ID" = "Source"."ID" AND "Target"."NAME" = "Source"."NAME") 
WHEN MATCHED THEN DELETE

CData Cloud

MergeInsert

A Boolean property that determines whether INSERT statements are automatically converted to MERGE statements when executed. This property is applicable only when the INSERT operation includes a table’s primary key field. When enabled, Snowflake attempts to upsert records by merging incoming data with existing rows if a primary key conflict occurs, rather than performing a simple insert operation.

データ型

bool

デフォルト値

false

解説

MergeInsert allows for upsert functionality. This property is primarily intended for use with tools where you have no direct control over the queries being executed. Otherwise, as long as Query Passthrough is 'true', you could execute the MERGE command directly.

When this property is 'false', INSERT statements are executed directly against the server. When it is set to 'true' and the INSERT query contains the primary key field, the Snowflake sends a MERGE query that executes an INSERT if no match is found in Snowflake or an UPDATE if it is found. For example this query:

INSERT INTO "Table" ("ID", "NAME", "AGE") VALUES (1, 'NewName', 10)
is sent to Snowflake as the following MERGE request:
MERGE INTO "Table" AS "Target" USING (SELECT 1 AS "ID") AS [Source] ON ("Target"."ID" = "Source"."ID") 
WHEN NOT MATCHED THEN INSERT ("ID", "NAME", "AGE") VALUES (1, 'NewName', 10) 
WHEN MATCHED THEN UPDATE SET "NAME" = 'NewName', "AGE" = 10

CData Cloud

MergeUpdate

A Boolean property that determines whether batch UPDATE statements are automatically converted to MERGE statements. This applies only when the UPDATE statement’s WHERE clause exclusively includes the table’s primary key fields combined using the AND logical operator. When enabled, Snowflake optimizes updates by leveraging the MERGE mechanism instead of standard batch updates.

データ型

bool

デフォルト値

false

解説

MergeUpdate allows for upsert functionality. This property is primarily intended for use with tools where you have no direct control over the queries being executed. Otherwise, as long as Query Passthrough is 'true', you could execute the MERGE command directly.

When this property is 'false', UPDATE statements are executed directly against the server. When it is set to 'true' and the UPDATE query contains the primary key field, Snowflake sends a MERGE query that executes an UPDATE if a match is found in Snowflake. For example this query:

UPDATE "Table" SET "NAME" = 'NewName', "AGE" = 10 WHERE "ID" = 1
is sent to Snowflake as the following MERGE request:
MERGE INTO "Table" AS "Target" USING "RTABLE1_TMP_20eca05b-c050-47dd-89bc-81c7f617f877" AS "Source" ON ("Target"."ID" = "Source"."ID") 
WHEN MATCHED THEN UPDATE SET "Target"."NAME" = "Source"."NAME", "Target"."AGE" = "Source"."AGE"

CData Cloud

RetryOnChunkTimeout

Specifies whether the connection should retry downloading data chunks from Snowflake when a network issue or timeout occurs.

データ型

bool

デフォルト値

false

解説

Typically if a network issue such as a timeout occurs during chunk downloading of data, the CData Cloud throws an exception. Set this property to 'true' to cause the CData Cloud to attempt retrying the request before failing.

CData Cloud

S3Domain

Specifies the URI of the Amazon S3 bucket used as the Snowflake S3 stage. This property is required when defining external stages for data loading and unloading between Snowflake and S3.

データ型

string

デフォルト値

""

解説

Generally, the default domain is "s3.amazonaws.com". However, for Chinese S3 regions, the default domain is "s3.{region}.amazonaws.com.cn". Ensure the specified domain matches the region of your S3 bucket for proper connectivity.

CData Cloud

SessionIdleTimeout

Specifies the timeout duration, in minutes, for idle sessions. This setting corresponds to Snowflake's session policy parameter 'SESSION_IDLE_TIMEOUT_MINS'. The default value is 240 minutes, meaning a session is terminated if it remains inactive for more than four hours.

データ型

int

デフォルト値

240

解説

For example, changing the setting of this property to "60" terminates an idle session after one hour of inactivity.

CData Cloud

SessionParameters

Specifies additional session parameters to customize the behavior of the Snowflake connection. These parameters are passed as a semicolon-separated list of key-value pairs. Common use cases include setting query tags or modifying identifier handling settings.

データ型

string

デフォルト値

""

解説

This property allows the user to define session-specific configurations for Snowflake.

For example, the following session parameters sets a query tag for tracking purposes and allows case-insensitive handling of quoted identifiers. They are separated by a semicolon.

This property is used in rare cases only.


SessionParameters='QUERY_TAG=MyTag;QUOTED_IDENTIFIERS_IGNORE_CASE=True;'

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

120

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434