接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
| プロパティ | 説明 |
| AuthScheme | The authentication scheme used. Accepted entries are PersonalAccessToken, Basic, OAuthU2M, AzureServicePrincipal and AzureAD. |
| Server | The host name or IP address of the server hosting the Databricks database. |
| User | The username used to authenticate with Databricks. |
| ProtocolVersion | The Protocol Version used to authenticate with Databricks. |
| Database | The name of the Databricks database. |
| HTTPPath | The path component of the URL endpoint. |
| Token | The token used to access the Databricks server. |
| プロパティ | 説明 |
| AWSAccessKey | AWS アカウントのアクセスキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。 |
| AWSSecretKey | AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。 |
| AWSRegion | Amazon Web サービスのホスティングリージョン。 |
| AWSS3Bucket | The name of your AWS S3 bucket. |
| プロパティ | 説明 |
| AzureStorageAccount | Azure ストレージアカウント名。 |
| AzureAccessKey | Azure アカウントに関連付けられているストレージキー。 |
| AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
| AzureBlobContainer | The name of your Azure Blob storage container. |
AzureServicePrincipal Authentication
| プロパティ | 説明 |
| AzureTenantId | The Tenant id of your Microsoft Azure Active Directory. |
| AzureClientId | The application(client) id of your Microsoft Azure Active Directory application. |
| AzureClientSecret | The application(client) secret of your Microsoft Azure Active Directory application. |
| プロパティ | 説明 |
| InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
| OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
| CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期限（秒単位）。 |
| OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ（ミリ秒）。 |
| OAuthLevel | You can generate an access token at either the Databricks account level or workspace level. |
| DatabricksAccountId | The Databricks account ID. |
| プロパティ | 説明 |
| SSLClientCert | SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。 |
| SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
| SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
| SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | この接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | プロキシサーバー（ ProxyServer 接続プロパティで指定）が起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| Logfile | ログファイルの名前と場所を指定するファイルパス。 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| LogModules | ログファイルに含めるコアモジュール。 |
| MaxLogFileSize | ログファイルの最大バイトサイズ（例えば、10MB）を指定する文字列。 |
| MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| Catalog | The default catalog name. |
| PrimaryKeyIdentifiers | Set this property to define primary keys. |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheProvider | データのキャッシュに使用されるプロバイダーの名前。 |
| CacheDriver | データのキャッシュに使用されるデータベースドライバー。 |
| CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| CloudStorageType | Determine which cloud storage service will be used. |
| StoreTableInCloud | This option specifies whether Databricks server will create and save tables in cloud storage. |
| QueryTableDetails | Specifies whether to use DESCRIBE FORMATTED ... to query detailed table information. If set to True, the query runs for a long time. |
| UseUploadApi | This option specifies whether the Databricks Upload API will be used when executing Bulk INSERT operations. |
| UseCloudFetch | This option specifies whether to use CloudFetch to improve query efficiency when the data volume of the table is large. |
| UseLegacyDataModel | This option specifies whether to support Unity Catalog. |
| QueryAllMetadata | This option controls whether to query all catalogs and schemas/databases or only specified ones. The default catalog is specified by the property Catalog . The default schema/database is specified by the property Database . |
| プロパティ | 説明 |
| AllowPreparedStatement | Prepare a query statement before its execution. |
| ConnectRetryWaitTime | This property specifies the number of seconds to wait prior to retrying a connection request. |
| ApplicationName | The application name connection string property expresses the HTTP User-Agent. |
| AsyncQueryTimeout | The timeout for asynchronous requests issued by the provider to download large result sets. |
| DescribeCommand | The describe command used to communicate with the Hive server. Accepted entries are DESCRIBE and DESC. |
| DetectView | Specifies whether to use DESCRIBE FORMATTED ... to detect the specified table is view or not. |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
| QueryPassthrough | このオプションは、クエリをDatabricks サーバーにas-is で渡します。 |
| Readonly | このプロパティを使用して、provider からDatabricks へのアクセスを読み取り専用に設定できます。 |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| ServerConfigurations | A name-value list of server configuration variables to override the server defaults. |
| ServerTimeZone | Determine how to interpret datetime values from the server. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UseDescTableQuery | This option specifies whether the columns will be retrieved using a DESC TABLE query or the GetColumns Thrift API.The GetColumns Thrift API works for the Apache Spark 3.0.0 or later. |
| UseInsertSelectSyntax | Specifies whether to use an INSERT INTO SELECT statement. |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |