接続プロパティ
接続プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続設定で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、はじめにを参照してください。
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Azure Cosmos DB. |
| AccountEndpoint | 値は、Cosmos DB アカウントの［Keys］ブレードからのCosmos DB アカウントURL である必要があります。 |
| AccountKey | Azure Cosmos DB REST API に接続するためのマスターキートークンまたはリソーストークン。 |
| TokenType | トークンの種類を示します：マスターまたはリソース。 |
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
| AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
| プロパティ | 説明 |
| InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
| CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
| OAuthGrantType | OAuth フローのグラント種別。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
| プロパティ | 説明 |
| 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 です。 |
| Schema | 作業するAzure Cosmos DB データベースを指定します。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheProvider | データのキャッシュに使用されるプロバイダーの名前。 |
| CacheDriver | データのキャッシュに使用されるデータベースドライバー。 |
| CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| BatchSize | 送信する各バッチ処理の最大サイズ。 |
| CalculateAggregates | 集計の計算値を返すか、パーティション範囲でグループ化するかを指定します。 |
| ConsistencyLevel | Denotes the type of token: master or resource. |
| DefaultDomain | このプロパティは、Oracle Database Gateway for ODBC で使用されます。 |
| EnableForeignKeyDetection | ODBC で外部キーを検出するかどうか。 |
| FlattenArrays | デフォルトで、ネスト配列はJSON 文字列として返されます。 FlattenArrays プロパティはネスト配列のエレメントをフラット化してそれぞれのカラムとするために使われます。ネスト配列から返すエレメントの数に FlattenArrays を設定します。 |
| FlattenObjects | フラット化されたオブジェクトプロパティとしてカラムを表示するには、 FlattenObjects をtrue に設定します。そうでなければ、配列にネストされたオブジェクトはJSON 文字列として返されます。 |
| ForceQueryOnNonIndexedContainers | Force the use of an index scan to process the query if indexing is disabled or the right index path is not available. |
| GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
| IncludeDualTable | Oracle データベースとの互換性を向上するためにOracle DUAL テーブルのモックを作成するには、このプロパティを設定します。 |
| LimitKeySize | 主キーカラムの最大長。 |
| MapBigintToVarchar | このプロパティは、bigint 型がSQL_BIGINT の代わりにSQL_VARCHAR にマップされるかどうかをコントロールします。デフォルトはfalse です。 |
| MapToInt | このプロパティは、Long 型がSQL_BIGINT の代わりにSQL_INTEGER にマップされるかどうかをコントロールします。デフォルトはfalse です。 |
| MapToLongVarchar | このプロパティは、カラムをSQL_LONGVARCHAR として返すかどうかを制御します。 |
| MapToWVarchar | このプロパティは、文字列型をSQL_VARCHAR ではなくSQL_WVARCHAR にマッピングするかどうかを制御します。デフォルトではSQL_WVARCHAR が設定されます。 |
| MaximumColumnSize | カラムの最大サイズ。 |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| MaxThreads | Specifies the maximum number of concurrent requests for Batch CUD (Create, Update, Delete) operations. |
| MultiThreadCount | パーティション化されたコレクション内の集計クエリでは、異なるパーティション範囲に対する並列リクエストが必要になります。このプロパティを、同時に発行する並列リクエストの数に設定します。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | Azure Cosmos DB から返されるページあたりの結果の最大数。 |
| PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
| Readonly | このプロパティを使用して、provider からAzure Cosmos DB へのアクセスを読み取り専用に設定できます。 |
| RequestPriorityLevel | Specifies the priority for the request sent to Azure Cosmos DB, when there are more requests than the configured RU/s in a second. |
| RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| SeparatorCharacter | 階層を示すために使用する記号。 |
| SetPartitionKeyAsPK | Whether or not to use the collection's Partition Key field as part of composite Primary Key for the corresponding exposed table. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| TypeDetectionScheme | 各ドキュメントコレクションのフィールドおよびデータタイプを決定するために、provider がデータをどのようにスキャンするかを示すカンマ区切りのオプション。 |
| UpperCaseIdentifiers | このプロパティは、大文字で設定されているすべての識別子を報告します。これは、Oracle データベースのデフォルト設定で、Oracle Database Gateway のようなOracle ツールとの統合を向上します。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| UseRidAsPk | Set this property to false to switch using the id column as primary key instead the default _rid. |
| WriteThroughputBudget | Defines the Requests Units (RU) budget per Second that the Batch CUD (Create, Update, Delete) operations should not exceed. |