Cloud

Build 24.0.9175
  • SQL Server
    • はじめに
      • 接続の確立
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • データ型マッピング
      • ストアドプロシージャ
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • Server
        • Port
        • Database
        • User
        • Password
        • Domain
        • IntegratedSecurity
        • NTLMVersion
        • Encrypt
      • Bulk
        • BatchMode
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • OAuthGrantType
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
      • SSL
        • SSLServerCert
      • SSH
        • SSHAuthMode
        • SSHClientCert
        • SSHClientCertPassword
        • SSHClientCertSubject
        • SSHClientCertType
        • SSHServer
        • SSHPort
        • SSHUser
        • SSHPassword
        • SSHServerFingerprint
        • UseSSH
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • ApplicationIntent
        • ApplicationName
        • IncludeSystemSchemas
        • MaxRows
        • Timeout

SQL Server - CData Cloud

概要

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

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

主要機能

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

CData Cloud

はじめに

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

SQL Server への接続

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

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

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

CData Cloud

接続の確立

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

SQL Server への接続

CData Cloud - SQL Server を使用して、Microsoft SQL Server、Azure SQL Server、またはAzure Data Warehouse の任意のインスタンスに接続できます。

Microsoft SQL Server

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

  • Server:SQL Server を実行するサーバー名。
  • Database:SQL Server データベース名。

Azure SQL Server またはAzure Data Warehouse

以下の接続プロパティを設定することで、Azure SQL Server またはAzure Data Warehouse に接続できます。

  • Server:Azure を実行しているサーバー。Azure ポータルにログインして、SQL データベース(またはSQL データウェアハウス) -> 自身のデータベースを選択 -> 概要 -> サーバー名に進むと確認できます。
  • Database:Azure ポータルのSQL データベース(またはSQL データウェアハウス)ページに表示されるデータベース名。

SQL Server への認証

Cloud は、SQL Server 認証、Windows 認証、またはKerberos 認証を使用するSQL Server への認証をサポートします。

Microsoft SQL Server

SQL Server のユーザーログイン認証情報を使用してMicrosoft SQL Server に認証するには、以下のように設定します。

  • AuthScheme:Password に設定。
  • User:SQL Server との認証に使われるユーザー名。
  • Password:認証ユーザーに関連付けられたパスワード。

Windows

Cloud がプロセスを実行しているWindows ユーザーのID から自動的にログイン認証情報を取得できるようにするには、以下のように設定します。

  • AuthScheme:NTLM に設定。
  • IntegratedSecurity:true に設定。

Kerberos

Kerberos でSQL Server への認証を行うには、AuthScheme をKERBEROS に設定します。

Kerberos 経由でSQL Server への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。

Kerberos チケットの取得

Kerberos チケットは、依頼者のID を認証するために使用されます。正式なログイン / パスワードの代わりにチケットを使用することで、パスワードをローカルに保存したり、ネットワーク経由で送信したりする必要がなくなります。 ユーザーは、ローカルコンピュータでログインするか、 コマンドプロンプトでkinit USER と入力するたびに、再認証されます(チケットはリフレッシュされます)。

Cloud は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。

MIT Kerberos 資格情報キャッシュファイル

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。

このオプションは、KRB5CCNAME がシステムに作成されている必要があります。

MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには:

  1. お使いの環境にKRB5CCNAME 変数が存在することを確認します。
  2. KRB5CCNAME を資格情報キャッシュファイルを指すパスに設定します。(例えば、C:\krb_cache\krb5cc_0 または/tmp/krb5cc_0 です。)資格情報キャッシュファイルは、MIT Kerberos チケットマネージャーを使用してチケットを生成するときに作成されます。
  3. チケットを取得するには:
    1. MIT Kerberos チケットマネージャーアプリケーションを開きます。
    2. Get Ticket をクリックします。
    3. プリンシパル名とパスワードを入力します。
    4. OK をクリックします。

    チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。

Cloud はキャッシュファイルを使用してSQL Server に接続するためのKerberos チケットを取得します。

Note: KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Cloud は指定されたキャッシュファイルを使用してSQL Server に接続するためのKerberos チケットを取得します。

Keytab ファイル

お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。

この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

お使いの環境にKRB5CCNAME 環境変数およびKerberosKeytabFile プロパティが設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。

この方法を使用するには、User およびPassword プロパティを、SQL Server での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム認証の有効化

より複雑なKerberos 環境では、複数のレルムおよびKDC サーバーが使用されるクロスレルム認証が必要になる場合があります。例えば、1つのレルム / KDC がユーザー認証に使用され、別のレルム / KDC がサービスチケットの取得に使用される場合です。

このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。

NTLM

NTLM 認証メカニズムを使用して、ユーザー名とパスワードで認証することができます。

認証するには、次を設定します。

  • AuthScheme:NTLM
  • User:認証するユーザーの名前。
  • Password:認証ユーザーに関連付けられたパスワード。

または、AuthScheme をAzureAd、AzurePassword、AzureMSI のいずれかに設定してOAuth を使用することもできます。すべてのOAuth接続で、AzureTenant 接続プロパティをSQL Server データベースがホストされているテナントのId に設定する必要があります。

Azure AD

Azure AD は、Microsoft のマルチテナント、クラウドベースのディレクトリおよびID 管理サービスです。これはユーザーベースの認証で、AuthScheme をAzureAD に設定する必要があります。

Web アプリケーションを介したAzure AD への認証には、 常にカスタムOAuth アプリケーションの作成が必要です。

カスタムOAuthアプリケーションの作成の詳細については、カスタムAzure AD アプリケーションの作成 を参照してください。

Azure サービスプリンシパル

サービスプリンシパルは、Azure AD アプリケーション内のセキュリティオブジェクトであり、特定のAzure AD テナント内でそのアプリケーションができることを定義します。 サービスプリンシパルは、Azure サービスポータルで作成します。 作成プロセスの過程で、サービスプリンシパルがクライアントシークレットまたは証明書のどちらを経由してAzure AD リソースにアクセスするかも指定します。

サービスプリンシパルの権限は、特定のユーザーに紐づくのではなく、割り当てられたロールに基づきます。 リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

Azure サービスプリンシパルを使用して認証する場合、サービスプリンシパルによるAzure AD アプリの作成 で説明するようにAzure AD テナントにアプリケーションを登録する必要があります。

次のサブセクションで説明するプロパティを設定すれば、接続の準備は完了です。これらは、クライアントシークレットで認証するか、証明書で認証するかによって異なります。

クライアントシークレットによる認証

  • AuthScheme:AzureServicePrincipal。
  • AzureTenant:接続するAzure AD テナント。
  • OAuthGrantType:CLIENT。
  • OAuthClientId:アプリケーション設定のクライアントId。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレット。

証明書による認証

  • AuthScheme:AzureServicePrincipalCert。
  • AzureTenant:接続するAzure AD テナント。
  • OAuthGrantType:CLIENT。
  • OAuthClientId:アプリケーション設定のクライアントId。
  • OAuthJWTCert:JWT 証明書のストア。
  • OAuthJWTCertType:JWT 証明書ストアの種類。

Azure Password

AuthScheme をAzurePassword に設定します。

Azure 資格情報を使用して直接接続するには、次の接続プロパティを指定します。

  • User:Azure に接続するためのユーザーアカウント。
  • Password:Azure に接続するためのユーザーアカウントのパスワード。
  • AzureTenant:Azure 上のSQL Server への認証に使用するカスタムAzure AD アプリケーションのディレクトリ(テナント)ID。カスタムアプリケーションの概要ページに表示されます。

Managed Service Identity (MSI)

Azure VM 上でSQL Server を実行しており、マネージドID(MSI)認証情報を自動的に取得して接続したい場合は、AuthScheme を AzureMSI に設定します。

User-Managed Identities

マネージドID のトークンを取得するには、OAuthClientId プロパティを使用してマネージドID のclient_id を指定します。

VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

TLS を有効化するには、Encrypt をTrue に設定します。

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

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

クライアントSSL 証明書

SQL Server Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

  • SSLClientCert:クライアント証明書のための証明書ストア名。
  • SSLClientCertType:TLS / SSL クライアント証明書を格納するキーストアの種類。
  • SSLClientCertPassword:TLS / SSL クライアント証明書のパスワード。
  • SSLClientCertSubject:TLS / SSL クライアント証明書のサブジェクト。

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

データモデル

SQL Server から直接データをモデリングするだけでなく、CData Cloud には、Azure がホストするSQL Server へのOAuth 接続を支援するために設計されたストアドプロシージャもいくつか組み込まれています。ストアドプロシージャはここにリストされています。

CData Cloud

データ型マッピング

データ型マッピング

Cloud は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

SQL Server CData スキーマ
bigint long
bigint identity long
binary binary
bit bool
char string
date date
datetime datetime
datetimeoffset datetime
datetime2 datetime
decimal decimal
decimal identity decimal
float float
geography binary
geometry binary
hierarchyid binary
image binary
int int
int identity int
money decimal
nchar string
ntext string
nvarchar string
numeric decimal
numeric identity decimal
real float
rowversion binary
smalldatetime datetime
smallint short
smallint identity short
smallmoney decimal
sql_variant binary
table string
text string
time time
timestamp binary
tinyint byte
tinyint identity byte
uniqueidentifier string
varbinary binary
varchar string
xml string

CData Cloud

ストアドプロシージャ

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

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

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

Name Description

CData Cloud

接続文字列オプション

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

Authentication


プロパティ説明
AuthScheme認証で使用されるスキーム。有効な入力値は、Password、NTLM、Kerberos、AzurePassword、AzureAD、AzureMSI、AzureServicePrincipal、AzureServicePrincipalCert です。
ServerSQL Server を実行するサーバー名。
PortMS SQL Server のポート。
DatabaseSQL Server データベース名。
User認証するSQL Server ユーザーアカウントのユーザーID を指定します。
Password認証するユーザーアカウントのパスワードを指定します。
DomainWindows(NTLM)セキュリティログインのドメイン名。
IntegratedSecurityWhether or not to authenticate with Windows Integrated Security.
NTLMVersionNTLM のバージョン。
Encryptこのフィールドは、SSL を有効にするかどうか、および'Strict' 暗号化タイプを使用するかどうかを設定します。

Bulk


プロパティ説明
BatchModeSQL Server bulkInsert のバッチモード。

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されるSQL Server テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
AzureEnvironment接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

JWT OAuth


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

SSL


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

SSH


プロパティ説明
SSHAuthModeサービスへのSSH トンネルを確立する際に使用される認証方法。
SSHClientCertSSHUser の認証に使用する証明書。
SSHClientCertPasswordSSHClientCert キーのパスワード(ある場合)。
SSHClientCertSubjectSSH クライアント証明書のサブジェクト。
SSHClientCertTypeSSHClientCert 秘密鍵の種類。
SSHServerSSH サーバー。
SSHPortSSH ポート。
SSHUserSSH ユーザー。
SSHPasswordSSH パスワード。
SSHServerFingerprintSSH サーバーのフィンガープリント。
UseSSHSQL Server 接続をSSH 経由でトンネリングするかどうか。 SSH を使用します。

Logging


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

Schema


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

Miscellaneous


プロパティ説明
ApplicationIntentApplication Intent 接続文字列プロパティは、可用性グループデータベースの読み取り / 書き込みバージョンまたは読み取り専用バージョンのいずれかを指定するクライアントアプリケーションのリクエストを表します。読み取り専用ルーティングを使用するには、クライアントは可用性グループリスナーに接続する際に、接続文字列で読み取り専用のApplication Intent を使用する必要があります。読み取り専用のApplication Intent がない場合、可用性グループリスナーへの接続はプライマリレプリカ上のデータベースに指示されます。
ApplicationNameアプリケーション名の接続文字列プロパティは、HTTP User-Agent を表します。
IncludeSystemSchemasこのプロパティは、'guest'、'sys'、'INFORMATION_SCHEMA'、および名前が'db_' で始まるシステムスキーマをクエリするかどうかを指定します。
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Timeoutprovider のタイムアウト。
CData Cloud

Authentication

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


プロパティ説明
AuthScheme認証で使用されるスキーム。有効な入力値は、Password、NTLM、Kerberos、AzurePassword、AzureAD、AzureMSI、AzureServicePrincipal、AzureServicePrincipalCert です。
ServerSQL Server を実行するサーバー名。
PortMS SQL Server のポート。
DatabaseSQL Server データベース名。
User認証するSQL Server ユーザーアカウントのユーザーID を指定します。
Password認証するユーザーアカウントのパスワードを指定します。
DomainWindows(NTLM)セキュリティログインのドメイン名。
IntegratedSecurityWhether or not to authenticate with Windows Integrated Security.
NTLMVersionNTLM のバージョン。
Encryptこのフィールドは、SSL を有効にするかどうか、および'Strict' 暗号化タイプを使用するかどうかを設定します。
CData Cloud

AuthScheme

認証で使用されるスキーム。有効な入力値は、Password、NTLM、Kerberos、AzurePassword、AzureAD、AzureMSI、AzureServicePrincipal、AzureServicePrincipalCert です。

Possible Values

Password, AzurePassword, AzureAD, AzureServicePrincipal, AzureServicePrincipalCert

データ型

string

デフォルト値

"Password"

解説

このフィールドは、Password およびUser とともに、サーバーに対して認証をするために使われます。デフォルト値はPassword です。次のオプションを使って、認証スキームを選択してください。

  • Password:認証にSQL Server のパスワードを使用する場合に設定。
  • NTLM:NTLM 認証を使用する場合に設定。
  • Kerberos:Kerberos 認証を使用する場合に設定。
  • AzurePassword:Azure Active Directory パスワード認証を使用する場合に設定。
  • AzureAD:Azure Active Directory OAuth 認証を使用する場合に設定。
  • AzureMSI:Azure Active Directory Managed Service Identity 認証を使用する場合に設定。
  • AzureServicePrincipal:Azure サービスプリンシパルとして認証する場合に設定。
  • AzureServicePrincipalCert:証明書を使用してAzure サービスプリンシパルとして認証する場合に設定。

CData Cloud

Server

SQL Server を実行するサーバー名。

データ型

string

デフォルト値

""

解説

このプロパティをSQL Server インスタンスの名前またはネットワークアドレスに設定します。

CData Cloud

Port

MS SQL Server のポート。

データ型

string

デフォルト値

"1433"

解説

MS SQL Server Database をホスティングしているServer のポート。

CData Cloud

Database

SQL Server データベース名。

データ型

string

デフォルト値

""

解説

指定したServer 上で実行されているSQL Server データベースの名前。

CData Cloud

User

認証するSQL Server ユーザーアカウントのユーザーID を指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

CData Cloud

Password

認証するユーザーアカウントのパスワードを指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

CData Cloud

Domain

Windows(NTLM)セキュリティログインのドメイン名。

データ型

string

デフォルト値

""

解説

Windows(NTLM)セキュリティログインのドメイン名。

CData Cloud

IntegratedSecurity

Whether or not to authenticate with Windows Integrated Security.

データ型

bool

デフォルト値

false

解説

When this is set to true, a Windows identity will be used to perform Windows authentication. If this value is false, SQL Server authentication will be used.

CData Cloud

NTLMVersion

NTLM のバージョン。

Possible Values

1, 2

データ型

string

デフォルト値

"1"

解説

このプロパティは、使用するNTLM のバージョンを指定します。

CData Cloud

Encrypt

このフィールドは、SSL を有効にするかどうか、および'Strict' 暗号化タイプを使用するかどうかを設定します。

Possible Values

True, False, Strict

データ型

string

デフォルト値

"False"

解説

このフィールドは、Cloud がサーバーとのTLS/SSL 接続をネゴシエートするかどうかを設定します。デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合します。別の証明書を指定するには、SSLServerCert を設定します。 'Strict' (厳密)な暗号化を使用すると、適切なセキュリティプラクティスが適用され、SQL Server のトラフィックが標準のネットワークアプライアンスで管理できるようになります。

CData Cloud

Bulk

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


プロパティ説明
BatchModeSQL Server bulkInsert のバッチモード。
CData Cloud

BatchMode

SQL Server bulkInsert のバッチモード。

Possible Values

BCP, STANDARD

データ型

string

デフォルト値

"STANDARD"

解説

BCP では、クライアントとサーバー間のTCP 通信を通じてBulkLoadBCP プロトコルで直接SQL Server にデータを転送しますが、これはINSERT ステートメントのみをサポートします。 STANDARD では、バッチ操作に標準のINSERT、UPDATE、DELETE ステートメントを使用します。

CData Cloud

Azure Authentication

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


プロパティ説明
AzureTenantデータにアクセスするために使用されるSQL Server テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
AzureEnvironment接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。
CData Cloud

AzureTenant

データにアクセスするために使用されるSQL Server テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)

データ型

string

デフォルト値

""

解説

テナントは、主にドメイン(例えば、microsoft.com)に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID(ディレクトリID とも呼ばれる)によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。

Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。

AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。

CData Cloud

AzureEnvironment

接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

データ型

string

デフォルト値

"GLOBAL"

解説

Azure アカウントがGlobal ネットワークとは異なるネットワーク(China、USGOVT、USGOVTDOD など)の一部である場合は、必要です。

CData Cloud

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

CData Cloud

OAuthGrantType

選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

Possible Values

CODE, CLIENT

データ型

string

デフォルト値

"CODE"

解説

ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。

CData Cloud

JWT OAuth

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


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
CData Cloud

OAuthJWTCert

JWT 証明書のストア。

データ型

string

デフォルト値

""

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA証明機関の証明書。
ROOTルート証明書。
SPCソフトウェア発行元証明書。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。

CData Cloud

OAuthJWTCertType

JWT 証明書を格納するキーストアの種類。

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

このプロパティには次の値の一つを設定できます。

USERWindows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。
MACHINEWindows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。
PFXFILEこの証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。
PFXBLOBこの証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILEこの証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。
JKSBLOBこの証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。
PEMKEY_FILEこの証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOBこの証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILEこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOBこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILEこの証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOBこの証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILEこの証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILEこの証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。
XMLFILEこの証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOBこの証明書ストアは、XML 形式の証明書を含む文字列の名前です。
BCFKSFILEこの証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOBこの証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。

CData Cloud

OAuthJWTCertPassword

OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

データ型

string

デフォルト値

""

解説

このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

CData Cloud

OAuthJWTCertSubject

OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

データ型

string

デフォルト値

"*"

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

  • サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
  • 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
  • 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EE メールアドレス

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。

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

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

CData Cloud

SSH

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


プロパティ説明
SSHAuthModeサービスへのSSH トンネルを確立する際に使用される認証方法。
SSHClientCertSSHUser の認証に使用する証明書。
SSHClientCertPasswordSSHClientCert キーのパスワード(ある場合)。
SSHClientCertSubjectSSH クライアント証明書のサブジェクト。
SSHClientCertTypeSSHClientCert 秘密鍵の種類。
SSHServerSSH サーバー。
SSHPortSSH ポート。
SSHUserSSH ユーザー。
SSHPasswordSSH パスワード。
SSHServerFingerprintSSH サーバーのフィンガープリント。
UseSSHSQL Server 接続をSSH 経由でトンネリングするかどうか。 SSH を使用します。
CData Cloud

SSHAuthMode

サービスへのSSH トンネルを確立する際に使用される認証方法。

Possible Values

None, Password, Public_Key

データ型

string

デフォルト値

"Password"

解説

  • None:認証は行われません。現在のSSHUser の値は無視され、接続は匿名でログインされます。
  • Password:Cloud は、SSHUser とSSHPassword の値を使用してユーザーを認証します。
  • Public_Key:Cloud は、SSHUser とSSHClientCert の値を使用してユーザーを認証します。SSHClientCert には、この認証方法を成功させるために使用可能な秘密鍵が必要です。

CData Cloud

SSHClientCert

SSHUser の認証に使用する証明書。

データ型

string

デフォルト値

""

解説

公開鍵認証を使用するには、SSHClientCert に有効な秘密鍵が含まれている必要があります。 公開鍵はオプションで、含まれていない場合はCloud が秘密鍵から生成します。 Cloud は公開鍵をサーバーに送信し、ユーザーが公開鍵を認証した場合に接続が許可されます。

SSHClientCertType フィールドは、SSHClientCert により指定されたキーストアの種類を指定します。 ストアがパスワードで保護されている場合は、SSHClientCertPassword でパスワードを指定します。

一部の種類のキーストアは、複数のキーを含むことができるコンテナです。 デフォルトでは、Cloud はストアの最初のキーを選択しますが、SSHClientCertSubject を使用して特定のキーを指定することも可能です。

CData Cloud

SSHClientCertPassword

SSHClientCert キーのパスワード(ある場合)。

データ型

string

デフォルト値

""

解説

このプロパティは、証明書ベースの認証を使用する場合のSSH トンネリングに必要です。 SSH 証明書がパスワードで保護されたキーストアにある場合、証明書にアクセスするためにこのプロパティを使用してパスワードを指定します。

CData Cloud

SSHClientCertSubject

SSH クライアント証明書のサブジェクト。

データ型

string

デフォルト値

"*"

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EEメールアドレス

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

CData Cloud

SSHClientCertType

SSHClientCert 秘密鍵の種類。

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PPKBLOB, XMLBLOB

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

このプロパティには次の値の1つを設定できます。

種類説明許容されるBlob 値
MACHINE/USER Blob 値はサポートされていません。
JKSFILE/JKSBLOB base64のみ
PFXFILE/PFXBLOBPKCS12形式(.pfx)のファイル。証明書と秘密鍵の両方を含む必要があります。base64のみ
PEMKEY_FILE/PEMKEY_BLOBPEM 形式のファイル。RSA、DSA、またはOPENSSH の秘密鍵を含む必要があります。オプションで、秘密鍵と一致する証明書を含むことができます。base64またはプレーンテキスト。blob をテキストとして入力する場合、改行をスペースに置き換えることができます。
PPKFILE/PPKBLOBputtygen ツールで作成されたPuTTY 形式の秘密鍵。base64のみ
XMLFILE/XMLBLOB.NET のRSA クラスによって生成される形式のXML キー:RSA.ToXmlString(true)。base64またはプレーンテキスト。

CData Cloud

SSHServer

SSH サーバー。

データ型

string

デフォルト値

""

解説

SSH サーバー。

CData Cloud

SSHPort

SSH ポート。

データ型

string

デフォルト値

"22"

解説

SSH ポート。

CData Cloud

SSHUser

SSH ユーザー。

データ型

string

デフォルト値

""

解説

SSH ユーザー。

CData Cloud

SSHPassword

SSH パスワード。

データ型

string

デフォルト値

""

解説

SSH パスワード。

CData Cloud

SSHServerFingerprint

SSH サーバーのフィンガープリント。

データ型

string

デフォルト値

""

解説

SSH サーバーのフィンガープリント。

CData Cloud

UseSSH

SQL Server 接続をSSH 経由でトンネリングするかどうか。 SSH を使用します。

データ型

bool

デフォルト値

false

解説

デフォルトでは、Cloud はSQL Server に直接接続しようとします。 このオプションを有効にすると、Cloud は代わりにSSHServer とのSSH 接続を確立し、その接続を経由してSQL Server への接続をトンネリングします。

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 です。
CData Cloud

BrowsableSchemas

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

Miscellaneous

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


プロパティ説明
ApplicationIntentApplication Intent 接続文字列プロパティは、可用性グループデータベースの読み取り / 書き込みバージョンまたは読み取り専用バージョンのいずれかを指定するクライアントアプリケーションのリクエストを表します。読み取り専用ルーティングを使用するには、クライアントは可用性グループリスナーに接続する際に、接続文字列で読み取り専用のApplication Intent を使用する必要があります。読み取り専用のApplication Intent がない場合、可用性グループリスナーへの接続はプライマリレプリカ上のデータベースに指示されます。
ApplicationNameアプリケーション名の接続文字列プロパティは、HTTP User-Agent を表します。
IncludeSystemSchemasこのプロパティは、'guest'、'sys'、'INFORMATION_SCHEMA'、および名前が'db_' で始まるシステムスキーマをクエリするかどうかを指定します。
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Timeoutprovider のタイムアウト。
CData Cloud

ApplicationIntent

Application Intent 接続文字列プロパティは、可用性グループデータベースの読み取り / 書き込みバージョンまたは読み取り専用バージョンのいずれかを指定するクライアントアプリケーションのリクエストを表します。読み取り専用ルーティングを使用するには、クライアントは可用性グループリスナーに接続する際に、接続文字列で読み取り専用のApplication Intent を使用する必要があります。読み取り専用のApplication Intent がない場合、可用性グループリスナーへの接続はプライマリレプリカ上のデータベースに指示されます。

データ型

string

デフォルト値

"ReadWrite"

解説

ApplicationIntent を使用すると、可用性グループリスナーに接続する際に読み取り専用のセカンダリに接続できます。

CData Cloud

ApplicationName

アプリケーション名の接続文字列プロパティは、HTTP User-Agent を表します。

データ型

string

デフォルト値

""

解説

CData Cloud

IncludeSystemSchemas

このプロパティは、'guest'、'sys'、'INFORMATION_SCHEMA'、および名前が'db_' で始まるシステムスキーマをクエリするかどうかを指定します。

データ型

bool

デフォルト値

true

解説

このプロパティは、'guest'、'sys'、'INFORMATION_SCHEMA'、および名前が'db_' で始まるシステムスキーマをクエリするかどうかを指定します。

CData Cloud

MaxRows

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

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

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

CData Cloud

Timeout

provider のタイムアウト。

データ型

int

デフォルト値

30

解説

Timeout プロパティが0に設定されている場合は、操作はタイムアウトされず、処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Cloud はエラー状態を発生させます。

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