JDBC Driver for REST

Build 22.0.8479

接続文字列オプション

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

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication


プロパティ説明
AuthSchemeリモートサービスに接続する際に使用する認証の種類。
AccessKeyアカウントのアクセスキー。この値にはセキュリティ認証情報ページからアクセスできます。
SecretKeyアカウントのシークレットキー。この値にはセキュリティ認証情報ページからアクセスできます。
ApiKeyIBM Cloud にユーザーを識別させるためのAPI キー。
UserThe user account used to authenticate.
PasswordThe password used to authenticate the user.
SharePointEdition使用しているSharePoint のエディション。SharePointOnline またはSharePointOnPremise のいずれかに設定します。

Connection


プロパティ説明
ConnectionType使用する接続の種類。
FormatFormat プロパティは、データソースから報告される形式を指定します。
URIXML/JSON リソースロケーションのUniform Resource Identifier (URI)。
RegionS3ライクなWeb サービスのホスティングリージョン。
ProjectIdGoogle Cloud Storage インスタンスが存在するプロジェクトのId。
OracleNamespace使用するOracle Cloud Object Storage ネームスペース。
StorageBaseURLクラウドストレージサービスプロバイダーのURL。
SimpleUploadLimitこの設定はしきい値をバイト単位で設定します。このしきい値を超えると、provider は1つのリクエストですべてをアップロードするのではなく、マルチパートでアップロードを実行します。
UseVirtualHostingTrue(デフォルト)の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます:http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します:http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。

AWS Authentication


プロパティ説明
AWSAccessKeyAWS アカウントのアクセスキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
AWSSecretKeyAWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
AWSRoleARN認証時に使用するロールのAmazon リソースネーム。
AWSPrincipalARNAWS アカウントのSAML ID プロバイダーのARN。
AWSRegionAmazon Web サービスのホスティングリージョン。
AWSCredentialsFile認証に使用するAWS クレデンシャルファイルへのパス。
AWSCredentialsFileProfile提供されたAWSCredentialsFile から使用されるプロファイルの名前。
AWSSessionTokenAWS のセッショントークン。
AWSExternalIdA unique identifier that might be required when you assume a role in another account.
MFASerialNumberMFA デバイスが使用されている場合は、そのシリアル番号。
MFATokenMFA デバイスから利用できる一時トークン。
CredentialsLocationMFA クレデンシャルが保存される設定ファイルの場所。
TemporaryTokenDuration一時トークンが持続する時間(秒単位)。
ServerSideEncryption有効にすると、Amazon S3バケットへのファイルアップロードがサーバー側で暗号化されます。

Azure Authentication


プロパティ説明
AzureStorageAccountAzure ストレージアカウント名。
AzureAccessKeyREST アカウントに関連付けられているストレージキー。
AzureSharedAccessSignature認証に使用可能な共有アクセスキー署名。
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment接続を確立するときに使用するAzure 環境。

SSO


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSOPropertiesセミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。
SSOExchangeUrlSAML 応答を処理して、REST の資格情報と交換するために使用するURL。

JSON and XML


プロパティ説明
XPathXML/JSON ドキュメント内で同じ階層で繰り返すエレメントのXPath(ドキュメントを複数行に分割することに使われます)。
DataModelXML/JSON ドキュメントをパースしてデータベースのメタデータを生成するときに使用するデータモデルを指定します。
JSONFormatJSON ドキュメントのフォーマットを指定します。 Format がJSON に設定されている場合にのみ効果があります。
XMLFormatSpecifies the format of the XML document.
FlattenArraysデフォルトで、ネスト配列はXML/JSON 文字列として返されます。 FlattenArrays プロパティはネスト配列のエレメントをフラット化してそれぞれのカラムとするために使われます。ネスト配列から返すエレメントの数に FlattenArrays を設定します。
FlattenObjectsフラット化されたオブジェクトプロパティとしてカラムを表示するには、 FlattenObjects をtrue に設定します。そうでなければ、配列にネストされたオブジェクトはXML/JSON 文字列として返されます。
BackwardsCompatibilityMode2017バージョンで使用可能なXML/JSON 機能を使用するには、 BackwardsCompatibilityMode をtrue に設定します。
QualifyColumnsControls whether the provider will use relative column names.
URISeparatorA delimiter used to separate different values in the URI property.

CSV


プロパティ説明
FMTThe format used to parse all CSV files.
IncludeColumnHeadersWhether to get column names from the first line of CSV files.

OAuth


プロパティ説明
InitiateOAuth接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。
OAuthVersion使われているOAuth のバージョン。
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthAccessTokenOAuth を使用して接続するためのアクセストークン。
OAuthAccessTokenSecretOAuth を使用して接続するためのアクセストークンのトークン シークレット。
OAuthSettingsLocationInitiateOAuth がGETANDREFRESH、またはREFRESH に設定されているときの設定ファイルの場所。代わりに、memory:// で始まる値を指定することで、これをメモリに保持することができます。
CallbackURL認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。
Scope初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。
OAuthGrantTypeOAuth フローのグラント種別。
OAuthPasswordGrantModeOAuthGrantType がPassword に設定されている場合のクライアントId とクライアントシークレットの渡し方。
OAuthIncludeCallbackURLWhether to include the callback URL in an access token request.
OAuthAuthorizationURLOAuth サービスの認可URL。
OAuthAccessTokenURLOAuth アクセストークンを取得するURL。
OAuthRefreshTokenURLOAuth トークンをリフレッシュするURL。
OAuthRequestTokenURLサービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。
OAuthVerifierOAuth 認可URL から返された検証コード。
AuthTokenOAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。
AuthKeyOAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。
OAuthParamsOAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。
OAuthRefreshToken対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。
OAuthExpiresInOAuth アクセストークンの有効期限(秒単位)。
OAuthTokenTimestamp現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ(ミリ秒)。

JWT OAuth


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクト。
OAuthJWTIssuerJava Web Token の発行者。
OAuthJWTSubjectアプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
OAuthJWTAudienceJWT を使用できるエンティティのスペース区切りリスト。
OAuthJWTValidityTimeJWT の有効期限(秒)。

Kerberos


プロパティ説明
KerberosKDCユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。
KerberosRealmユーザー認証に使用されるKerberos 領域。
KerberosSPNKerberos ドメインコントローラーのサービスプリンシパル名(SPN)。
KerberosKeytabFileKerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealmサービスのKerberos レルム。
KerberosServiceKDCサービスのKerberos KDC。
KerberosTicketCacheMIT Kerberos 資格情報キャッシュファイルへのフルパス。

SSL


プロパティ説明
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。
SSLClientCertTypeTLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPasswordTLS/SSL クライアント証明書のパスワード。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクト。
SSLModeFTP またはFTPS サーバーに接続する際の認証メカニズム。
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSH


プロパティ説明
SSHAuthModeSFTP サーバーへのログオンに使用する認証方法。
SSHClientCertユーザーの認証に使用する秘密鍵。
SSHClientCertPasswordSSHClientCert キーのパスワード(ある場合)。
SSHClientCertSubjectSSH クライアント証明書のサブジェクト。
SSHClientCertTypeSSHClientCert 秘密鍵の種類。
SSHUserSSH ユーザー。
SSHPasswordSSH パスワード。

Firewall


プロパティ説明
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy


プロパティ説明
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging


プロパティ説明
Logfileログファイルの名前と場所を指定するファイルパス。
Verbosityログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。
LogModulesログファイルに含めるコアモジュール。
MaxLogFileSizeログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。
MaxLogFileCountログファイルの最大ファイル数を指定する文字列。

Schema


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Caching


プロパティ説明
AutoCacheSELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。
CacheDriverデータのキャッシュに使用されるデータベースドライバー。
CacheConnectionキャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。
CacheLocationキャッシュデータベースへのパスとファイル名を指定します。
CacheToleranceAutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。
Offlineオフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。
CacheMetadataこのプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。

Miscellaneous


プロパティ説明
BatchSize送信する各バッチ処理の最大サイズ。
CharsetREST ファイルに移行、またはREST ファイルから移行した文字データをエンコードおよびデコードするための、セッション毎の文字セットを指定します。デフォルト値はUTF-8 です。
ClientCultureこのプロパティを使用して、クライアントアプリケーションが受け取るデータの形式(通貨値など)を指定できます。このプロパティは、クライアントアプリケーションがマシンの現在のカルチャ設定をサポートしていない場合に使用できます。例えば、Microsoft Access では'en-US' が必要です。
ConnectionLifeTime接続の最大有効期間(秒単位)。その時間が経過すると、接続オブジェクトは削除されます。
ConnectOnOpenこのプロパティは、接続が開かれたときにREST に接続するかどうかを指定します。
Cultureこの設定を使用して、provider に渡された特定のデータ型をprovider が解釈する方法を決定するカルチャ設定を指定できます。例えば、Culture='de-DE' の設定にすると、米国のマシンでもドイツ語形式で出力されます。
CustomHeadersユーザーが決定したその他のヘッダー(オプション)。
CustomUrlParamsリクエストに含めるカスタムクエリ文字列。
DataSourceこのプロパティは、リソースロケーションのURI を指定します。
DirectoryRetrievalDepthIncludeSubdirectories が有効の場合に、再帰的にスキャンされるサブフォルダを制限します。
ExcludeFilesテーブルとしてモデル化されたファイル一式から除外するファイル拡張子のカンマ区切りリスト。
FolderIdGoogle Drive のフォルダID。設定すると、URI で指定されたリソースの位置はすべての操作においてFolder ID からの相対位置となります。
GenerateSchemaFilesスキーマを生成して保存するユーザーの好みのタイミングを示します。
IncludeDropboxTeamResourcesDropbox チームフォルダやファイルを含めるかどうかを示します。
IncludeFilesテーブルとしてモデル化されたファイル一式に含めるファイル拡張子のカンマ区切りリスト。
IncludeItemsFromAllDrivesGoogle Drive の共有ドライブ項目を結果に含めるかどうか。存在しないかfalse に設定されている場合、共有ドライブ項目は返されません。
MaxRowsクエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
MetadataDiscoveryURI複数のファイルを1つのテーブルに集約する際に使用します。このプロパティは、集約されたテーブルのスキーマを決定するために読み込む特定のファイルを指定します。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeREST から返されるページあたりの結果の最大数。
PoolIdleTimeout接続が閉じられる前に許容されたアイドル時間。
PoolMaxSizeプールの最大接続数。
PoolMinSizeプール内の最小接続数。
PoolWaitTime使用可能な接続を待機する最大秒数。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Readonlyこのプロパティを使用して、provider からREST へのアクセスを読み取り専用に設定できます。
RowScanDepth動的にテーブルのカラムを決定するためにスキャンする行数。
RTKライセンス供与で使用されるランタイムキー。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionSchemeDetermines how to determine the data types of columns.
UseConnectionPoolingこのプロパティは、コネクションプーリングを有効にします。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479