接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
プロパティ | 説明 |
AuthScheme | The scheme used for authentication. Accepted entries are Password, OAuth. |
Server | The host name or IP address of the server. |
Database | The name of the AlloyDB database. |
User | 認証で使用されるAlloyDB ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
Port | The port number of the AlloyDB server. |
UseSSL | This field sets whether SSL is enabled. |
Visibility | Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for the current user. |
プロパティ | 説明 |
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 エポックタイムスタンプ(ミリ秒)。 |
プロパティ | 説明 |
KerberosKDC | ユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。 |
KerberosRealm | ユーザー認証に使用されるKerberos 領域。 |
KerberosSPN | Kerberos ドメインコントローラーのサービスプリンシパル名(SPN)。 |
KerberosUser | The principal name for the Kerberos Domain Controller. Used in the format host/user@realm |
KerberosKeytabFile | Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。 |
KerberosServiceRealm | サービスのKerberos レルム。 |
KerberosServiceKDC | サービスのKerberos KDC。 |
KerberosTicketCache | MIT Kerberos 資格情報キャッシュファイルへのフルパス。 |
プロパティ | 説明 |
SSLClientCert | SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。 |
SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
SSHAuthMode | サービスへのSSH トンネルを確立する際に使用される認証方法。 |
SSHClientCert | SSHUser の認証に使用する証明書。 |
SSHClientCertPassword | SSHClientCert キーのパスワード(ある場合)。 |
SSHClientCertSubject | SSH クライアント証明書のサブジェクト。 |
SSHClientCertType | SSHClientCert 秘密鍵の種類。 |
SSHServer | SSH サーバー。 |
SSHPort | SSH ポート。 |
SSHUser | SSH ユーザー。 |
SSHPassword | SSH パスワード。 |
SSHServerFingerprint | SSH サーバーのフィンガープリント。 |
UseSSH | AlloyDB 接続をSSH 経由でトンネリングするかどうか。 SSH を使用します。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
Logfile | ログファイルの名前と場所を指定するファイルパス。 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
LogModules | ログファイルに含めるコアモジュール。 |
MaxLogFileSize | ログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。 |
MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
IgnoredSchemas | Visibility restriction filter which is used to hide schemas from the list of schemas obtained by querying metadata. For example, 'information_schema, pg_catalog'. Schema names are case sensitive. |
プロパティ | 説明 |
AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
CacheDriver | データのキャッシュに使用されるデータベースドライバー。 |
CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
プロパティ | 説明 |
AllowPreparedStatement | Prepare a query statement before its execution. |
BatchSize | 送信する各バッチ処理の最大サイズ。 |
BrowsePartitions | By default, the provider exposes the super table and its partitions by metadata. You may hide sub partitions by setting this property to false. |
ConnectionLifeTime | 接続の最大有効期間(秒単位)。その時間が経過すると、接続オブジェクトは削除されます。 |
ConnectOnOpen | このプロパティは、接続が開かれたときにAlloyDB に接続するかどうかを指定します。 |
FetchResultSetMetadata | This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server. |
GeneratedKeys | Specifies what columns returned by JDBC Statement.getGeneratedKeys() method. By default entire row(s) is returned. |
IncludeTableTypes | If set to true, the provider will query for the types of individual tables and views. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PoolIdleTimeout | 接続が閉じられる前に許容されたアイドル時間。 |
PoolMaxSize | プールの最大接続数。 |
PoolMinSize | プール内の最小接続数。 |
PoolWaitTime | 使用可能な接続を待機する最大秒数。 |
QueryPassthrough | このオプションは、クエリをAlloyDB サーバーにas-is で渡します。 |
Readonly | このプロパティを使用して、provider からAlloyDB へのアクセスを読み取り専用に設定できます。 |
RTK | ライセンス供与で使用されるランタイムキー。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TimeZone | Notifies the server about the timezone on the client with a standard SET TIMEZONE query when a connection is being opened. |
UseConnectionPooling | このプロパティは、コネクションプーリングを有効にします。 |