接続プロパティ
接続プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続設定で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
プロパティ | 説明 |
AuthScheme | リモートサービスに接続する際に使用する認証の種類。 |
AccessKey | アカウントのアクセスキー。この値にはセキュリティ認証情報ページからアクセスできます。 |
SecretKey | アカウントのシークレットキー。この値にはセキュリティ認証情報ページからアクセスできます。 |
ApiKey | IBM Cloud にユーザーを識別させるためのAPI キー。 |
User | The user account used to authenticate. |
Password | The password used to authenticate the user. |
SharePointEdition | 使用しているSharePoint のエディション。SharePointOnline またはSharePointOnPremise のいずれかに設定します。 |
プロパティ | 説明 |
ConnectionType | CSV のファイルが保存および取得されるファイルストレージサービス、サーバー、またはファイルアクセスプロトコルを指定します。 |
URI | CSV リソースロケーションのUniform Resource Identifier (URI)。 |
Region | S3ライクなWeb サービスのホスティングリージョン。 |
ProjectId | Google Cloud Storage インスタンスが存在するプロジェクトのId。 |
OracleNamespace | 使用するOracle Cloud Object Storage ネームスペース。 |
StorageBaseURL | クラウドストレージサービスプロバイダーのURL。 |
SimpleUploadLimit | この設定はしきい値をバイト単位で設定します。このしきい値を超えると、provider は1つのリクエストですべてをアップロードするのではなく、マルチパートでアップロードを実行します。 |
UseVirtualHosting | True(デフォルト)の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます:http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します:http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。 |
UseLakeFormation | このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。 |
プロパティ | 説明 |
AWSAccessKey | AWS アカウントのアクセスキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。 |
AWSSecretKey | AWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。 |
AWSRoleARN | 認証時に使用するロールのAmazon リソースネーム。 |
AWSPrincipalARN | AWS アカウントのSAML ID プロバイダーのARN。 |
AWSRegion | Amazon Web サービスのホスティングリージョン。 |
AWSCredentialsFile | 認証に使用するAWS クレデンシャルファイルへのパス。 |
AWSCredentialsFileProfile | 提供されたAWSCredentialsFile から使用されるプロファイルの名前。 |
AWSSessionToken | AWS のセッショントークン。 |
AWSExternalId | 他のアカウントでロールを引き受ける際に必要となる一意の識別子。 |
MFASerialNumber | MFA デバイスが使用されている場合は、そのシリアル番号。 |
MFAToken | MFA デバイスから利用できる一時トークン。 |
TemporaryTokenDuration | 一時トークンが持続する時間(秒単位)。 |
ServerSideEncryption | 有効にすると、Amazon S3バケットへのファイルアップロードがサーバー側で暗号化されます。 |
SSEContext | A BASE64-encoded UTF-8 string holding JSON which represents a string-string (key-value) map. |
SSEEnableS3BucketKeys | Configuration to use an S3 Bucket Key at the object level when encrypting data with AWS KMS. Enabling this will reduce the cost of server-side encryption by lowering calls to AWS KMS. |
SSEKey | A symmetric encryption KeyManagementService key, that is used to protect the data when using ServerSideEncryption. |
プロパティ | 説明 |
AzureStorageAccount | Azure ストレージアカウント名。 |
AzureAccessKey | Azure アカウントに関連付けられているストレージキー。 |
AzureSharedAccessSignature | 認証に使用可能な共有アクセスキー署名。 |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
プロパティ | 説明 |
SSOLoginURL | ID プロバイダーのログインURL。 |
SSOProperties | セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。 |
SSOExchangeUrl | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
プロパティ | 説明 |
InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
OAuthVersion | 使われているOAuth のバージョン。 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
Scope | 初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。 |
OAuthGrantType | OAuth フローのグラント種別。 |
OAuthPasswordGrantMode | OAuthGrantType がPassword に設定されている場合のクライアントId とクライアントシークレットの渡し方。 |
OAuthIncludeCallbackURL | アクセストークンリクエストにコールバックURL を含めるかどうか。 |
OAuthAuthorizationURL | OAuth サービスの認可URL。 |
OAuthAccessTokenURL | OAuth アクセストークンを取得するURL。 |
OAuthRefreshTokenURL | OAuth トークンをリフレッシュするURL。 |
OAuthRequestTokenURL | サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。 |
AuthToken | OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。 |
AuthKey | OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。 |
OAuthParams | OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。 |
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
プロパティ | 説明 |
KerberosKDC | ユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。 |
KerberosRealm | ユーザー認証に使用されるKerberos 領域。 |
KerberosSPN | Kerberos ドメインコントローラーのサービスプリンシパル名(SPN)。 |
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 クライアント証明書のサブジェクト。 |
SSLMode | FTP またはFTPS サーバーに接続する際の認証メカニズム。 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
SSHAuthMode | サービスへのSSH トンネルを確立する際に使用される認証方法。 |
SSHClientCert | SSHUser の認証に使用する証明書。 |
SSHClientCertPassword | SSHClientCert キーのパスワード(ある場合)。 |
SSHClientCertSubject | SSH クライアント証明書のサブジェクト。 |
SSHClientCertType | SSHClientCert 秘密鍵の種類。 |
SSHUser | SSH ユーザー。 |
SSHPassword | SSH パスワード。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
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 です。 |
SchemaIniLocation | schema.ini ファイルを含むディレクトリのパス。 |
AggregateFiles | true に設定すると、プロバイダーは URI ディレクトリ内にある同じスキーマを持つすべてのファイルを AggregatedFiles と呼ばれる単一のテーブルに集計します。 |
MetadataDiscoveryURI | AggregateFiles と併用され、AggregatedFiles 結果セットのスキーマを読み出すための特定のファイルを指定します。 |
TypeDetectionScheme | カラムのデータ型を決定するための方法を指定します。 |
ColumnCount | The number of columns to detect when dynamically determining columns for the table. |
RowScanDepth | 動的にテーブルのカラムを決定するためにスキャンする行数。 |
プロパティ | 説明 |
AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
CacheProvider | データのキャッシュに使用されるプロバイダーの名前。 |
CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
プロパティ | 説明 |
IncludeColumnHeaders | 指定したファイルの一行目からカラム名を取得するかどうか。 |
FMT | すべてのテキストファイルのパースに使用する形式。 |
ExtendedProperties | Microsoft Jet OLE DB 4.0互換のテキストファイルの拡張プロパティです。 |
RowDelimiter | CSV の行末を検出する際に使用する文字。 |
SkipTop | 指定した行数を上から読み飛ばします。 |
IgnoreBlankRows | 空の行をスキップするかどうかを示します。 |
IncludeEmptyHeaders | カラムヘッダー内のカラム名に空の値を含めるかどうか。 |
SkipHeaderComments | true に設定すると、ファイルの先頭の# から始まる行がスキップされます。 |
Charset | CSV ファイルに移行、またはCSV ファイルから移行した文字データをエンコードおよびデコードするための、セッション毎の文字セットを指定します。デフォルト値はUTF-8 です。 |
QuoteEscapeCharacter | 値を囲む文字をエスケープする際に使用する文字を指定します。 |
QuoteCharacter | CSV ファイルで値を囲む際に使用する文字を指定します。 |
TrimSpaces | 囲まれた値を含むセル内の先頭と末尾のスペースを、プロバイダが削除するよう設定したい場合はTrue に設定します。 |
PushEmptyValuesAsNull | 空の値を空として読み取るか、null として読み取るかを示します。 |
NullValues | CSV ファイル内で見つかった場合null に変換される値の一覧(カンマ区切り)。 |
PathSeparator | Determines the character which will be used to replace the file separator. |
IgnoreIncompleteRows | Indicates whether to ignore incomplete rows. |
MaxCellLength | Max length a cell can hold, after passing this number the cell content will get truncated. If value is -1 then we don't limit the cell content length. |
DateTimeFormat | この設定では、CSV ファイルに書き込まれるdatetime 値のフォーマットを指定します。 |
プロパティ | 説明 |
BatchNamingConvention | Determines the naming convention of batch files. |
ClientCulture | このプロパティを使用して、クライアントアプリケーションが受け取るデータの形式(通貨値など)を指定できます。このプロパティは、クライアントアプリケーションがマシンの現在のカルチャ設定をサポートしていない場合に使用できます。例えば、Microsoft Access では'en-US' が必要です。 |
CreateBatchFolder | Whether to create a folder when InsertMode is set to FilePerBatch. |
Culture | この設定を使用して、provider に渡された特定のデータ型をprovider が解釈する方法を決定するカルチャ設定を指定できます。例えば、Culture='de-DE' の設定にすると、米国のマシンでもドイツ語形式で出力されます。 |
CustomHeaders | ユーザーが決定したその他のヘッダー(オプション)。 |
CustomUrlParams | リクエストに含めるカスタムクエリ文字列。 |
DirectoryRetrievalDepth | IncludeSubdirectories が有効の場合に、再帰的にスキャンされるサブフォルダを制限します。 |
ExcludeFileExtensions | ファイル拡張子をテーブル名から除外する必要がある場合はtrue に設定します。 |
ExcludeFiles | テーブルとしてモデル化されたファイル一式から除外するファイル拡張子のカンマ区切りリスト。 |
FolderId | Google Drive のフォルダID。設定すると、URI で指定されたリソースの位置はすべての操作においてFolder ID からの相対位置となります。 |
GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
IncludeDropboxTeamResources | Dropbox チームフォルダやファイルを含めるかどうかを示します。 |
IncludeFiles | テーブルとしてモデル化されたファイル一式に含めるファイル拡張子のカンマ区切りリスト。 |
IncludeItemsFromAllDrives | Google Drive の共有ドライブ項目を結果に含めるかどうか。存在しないかfalse に設定されている場合、共有ドライブ項目は返されません。 |
IncludeSubdirectories | ネストされたフォルダからファイルを読み出すかどうか。名前衝突が起こった場合は、テーブル名の前にアンダースコアで区切られたフォルダ名が付けられます。 |
InsertMode | CSV ファイルにデータを挿入する際のモードを指定します。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | CSV から返されるページあたりの結果の最大数。 |
Readonly | このプロパティを使用して、provider からCSV へのアクセスを読み取り専用に設定できます。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TruncateOnInserts | プロバイダが各INSERT(バッチINSERT)時に切り捨てるようにする場合は、True に設定します。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseRowNumbers | CSV で削除や更新を行う場合で、カスタムスキーマを指定したくない場合は、これをtrue に設定します。これにより、そのテーブルのキーとして使用されるRowNumber という名前の新しいカラムが作成されます。 |