接続プロパティ
接続プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続設定で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、はじめにを参照してください。
| プロパティ | 説明 |
| AuthScheme | Salesforce への接続時に使用する認証方法を指定します。 |
| User | 認証するユーザーのユーザーID を指定します。 |
| Password | 認証するユーザーのパスワードを指定します。 |
| SecurityToken | Salesforce アカウントへのアクセスを認証するために使用されるセキュリティトークンを指定します。 |
| UseSandbox | 本番インスタンスではなく、Salesforce サンドボックス環境に接続するかどうかを指定します。 |
| CredentialsLocation | 認証用のOKTA MFA トークンが保存されるファイルパスを指定します。 |
| プロパティ | 説明 |
| APIVersion | 接続に使用するSalesforce API バージョンを指定します。 |
| LoginURL | 認証とログインに使用されるSalesforce サーバーURL を指定します。 |
| プロパティ | 説明 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 |
| SSOExchangeURL | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
| プロパティ | 説明 |
| UseBulkAPI | Salesforce でのデータ読み書きに非同期Bulk API を使用するか、同期SOAP API を使用するかを指定します。 |
| BulkAPIConcurrencyMode | Salesforce Bulk API v1 で一括行を処理する際に使用する並行処理モードを指定します。 |
| BulkUploadLimit | Salesforce Bulk API v2 を使用してアップロードできる最大ファイルサイズ(MB)を指定します。 |
| BulkPollingInterval | 一括プロセスの応答の可用性を確認するリクエスト間の時間間隔(ミリ秒)を指定します。 |
| BulkQueryTimeout | provider が一括クエリの応答を待機する最大時間(分)を指定し、この時間を過ぎるとタイムアウトします。 |
| WaitForBulkResults | 非同期Bulk API を使用する際に、provider が一括操作結果の完了を待機するかどうかを指定します。UseBulkAPI がtrue に設定されている場合にのみ適用されます。 |
| BulkAPIVersion | 一括クエリおよびデータ操作の処理に使用するSalesforce Bulk API バージョンを指定します。 |
| PushEmptyValuesAsNull | 空の値を空文字列として解釈するか、NULL として解釈するかを指定します。 |
| プロパティ | 説明 |
| InitiateOAuth | OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| OAuthAccessToken | データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。 |
| OAuthSettingsLocation | OAuth 値が保存される設定ファイルの場所を指定します。 |
| CallbackURL | OAuth 経由でSalesforce への認証を行った後にユーザーが戻るURL を指定します(カスタムOAuth アプリケーションのみ)。 |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
| OAuthServerURL | 認証プロセス中に使用されるOAuth サーバー URL を指定します。 |
| OAuthAuthorizationURL | OAuth サービスの認可URL。 |
| OAuthAccessTokenURL | OAuth アクセストークンを取得するURL。 |
| OAuthVerifier | OAuthAuthorizationURL から返された検証コードを指定します。ブラウザを起動できないヘッドレスサーバーでOAuth 認証を行う場合に使用します。 OAuthSettingsLocation および OAuthVerifier の両方が設定される必要があります。 |
| PKCEVerifier | PKCE 認証スキームにGetOAuthAuthorizationUrl ストアドプロシージャを実行することで生成されるPKCE code verifier。 |
| OAuthRefreshToken | 元のアクセストークンが期限切れになった後に新しいアクセストークンを要求するために使用される、OAuth リフレッシュトークンを指定します。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期間を秒単位で指定します。ユーザーが操作を続けている限り、アクセスを維持するためにトークンを再発行することができます。 |
| OAuthTokenTimestamp | 現在のアクセストークンがいつ作成されたかを示すUnix エポックタイムスタンプをミリ秒単位で表示します。 |
| プロパティ | 説明 |
| OAuthJWTCert | クライアント証明書のJWT 証明書ストアの名前を指定します。 |
| OAuthJWTCertType | JWT 証明書を格納しているキーストアの種類を指定します。 |
| OAuthJWTCertPassword | パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| Logfile | provider が認証、クエリ実行、接続の詳細などのアクティビティを記録するログファイルのファイルパスを指定します。 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| MaxLogFileSize | 単一のログファイルの最大サイズをバイト単位で指定します。例えば、'10 MB' です。ファイルが上限に達すると、provider は日付と時刻を名前に付加した新しいログファイルを作成します。 |
| MaxLogFileCount | provider が保持するログファイルの最大数を指定します。上限に達すると、最も古いログファイルが削除され、新しいログファイルのためのスペースが作られます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの対象となるテーブルの内容が、指定されたキャッシュデータベースに自動的にキャッシュされるかどうかを指定します。 |
| CacheProvider | ADO.NET プロバイダーの名前空間。指定されたプロバイダーは、すべてのキャッシュ操作のターゲットデータベースとして使用されます。 |
| CacheDriver | JDBC ドライバーのドライバークラス。指定されたドライバーは、すべてのキャッシュ操作のためにターゲットデータベースに接続するために使用されます。 |
| CacheConnection | 指定されたキャッシュデータベースの接続文字列を指定します。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | 指定されたキャッシュデータベース内の失効データに対する許容時間(秒単位)を指定します。AutoCache がTrue に設定されている必要があります。 |
| Offline | ライブSalesforce データの代わりに、指定されたキャッシュデータベースからデータを取得します。 |
| CacheMetadata | provider がテーブルメタデータをファイルベースのキャッシュデータベースにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| AllOrNone | リクエスト内のすべての挿入、更新、または削除操作において、個別のレコードが失敗した場合にすべての操作を失敗させるかどうかを指定します。 |
| ArchiveMode | 標準のSELECT クエリで削除済みおよびアーカイブされたレコードを含めるかどうかを指定します。 |
| ConnectOnOpen | プロバイダーが接続を開くと同時にSalesforce への接続を確立するかどうかを指定します。すぐに接続性を検証する必要がある場合は、ConnectOnOpen をTrue に設定します。 |
| ContinueOnAlterException | ALTER ステートメントの一つが失敗した後に、provider が後続のALTER ステートメントの実行を続行するかどうかを指定します。 |
| DefaultDomain | このプロパティは、Oracle Database Gateway for ODBC で使用されます。 |
| EnableForeignKeyDetection | ODBC で外部キーを検出するかどうか。 |
| ExposeConceptualEntities | Salesforce のレコードタイプを個別のテーブルとして公開するかどうかを指定します。 |
| FilterScope | Salesforce のUSING SCOPE キーワードを使用してクエリで返されるレコードを制限するオプションのスコープを指定します。 |
| IncludeDualTable | Oracle データベースとの互換性を向上するためにOracle DUAL テーブルのモックを作成するには、このプロパティを設定します。 |
| IncludeItemURL | ItemURL カラムをすべてのテーブルで公開するかどうかを決定するboolean。 |
| IncludeMetadataDescription | Salesforce Metadata API からカラム、テーブル、またはその両方の説明を取得するかどうかを指定します。 |
| IncludeReports | Salesforce レポートをスキーマ内のビューとして公開するかどうかを指定します。 |
| 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 を含まないクエリで返される最大行数を指定します。 |
| NullBooleanBehavior | このプロパティは、Boolean カラムに対してNULL 値をどのように処理するかを決定します。 |
| Other | 特定のユースケースに対する追加の隠しプロパティを指定します。特定の問題に対処するため、サポートチームが推奨する場合にのみ使用してください。詳細は備考を参照してください。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| QueryPassthrough | SQL クエリをSOQL に変換する代わりに、SOQL クエリを直接Salesforce に渡すことを許可するかどうかを指定します。 |
| Readonly | provider からSalesforce への読み取り専用アクセスを切り替えます。 |
| RemoveBOMCharacter | provider がコンテンツからバイトオーダーマーク(BOM)文字(0xFEFF)を削除するかどうかを指定します。 |
| RemovePrivateChar | 取得されたコンテンツ内の私用文字を '?' 文字に置き換えるかどうかを指定します。 |
| ReplaceInvalidUTF8Chars | コンテンツ内の無効なUTF-8 文字を '?' 文字に置き換えるかどうかを指定します。 |
| ReportExactPicklistLength | Salesforce で定義されている選択リストフィールドの正確な長さを報告するか、デフォルトの長さの255で報告するかを指定します。 |
| RTK | provider のライセンスを取得するためのランタイムキーを指定します。設定されていないか無効な場合、provider は標準のライセンス方法をデフォルトとして使用します。このプロパティは、標準のライセンス方法がサポートされていないか、ランタイムキーが必要な環境でのみ必要です。 |
| ServerSideAggregation | SUM、COUNT、GROUP BY などの集計操作をSalesforce サーバーで実行するか、クライアント側で処理するかを指定します。 |
| SessionTimeout | Salesforce ログインセッションが期限切れになる前に再利用される時間(分)を指定します。 |
| SkipFormulaFields | Salesforce オブジェクトのカラム一覧表示時に数式フィールドを除外するかどうかを指定します。 |
| SkipPickListTranslation | データ取得時に選択リストの翻訳をスキップするカラムをカンマ区切りで指定します。 |
| SortColumns | テーブルカラムを名前でアルファベット順にソートするか、Salesforce で提供される順序で報告するかを指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| TranslatePickListFields | 選択リストフィールドの値を、現在認証されているSalesforce ユーザーの言語に翻訳するかどうかを指定します。 |
| UpperCaseIdentifiers | このプロパティは、大文字で設定されているすべての識別子を報告します。これは、Oracle データベースのデフォルト設定で、Oracle Database Gateway のようなOracle ツールとの統合を向上します。 |
| UseDisplayNames | メタデータの一覧表示とデータクエリ時に、API 名の代わりにカラムの表示名を使用するかどうを指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseToolingAPI | メタデータと開発関連オブジェクトの取得・変更にSalesforce Tooling API を使用するかどうかを指定します。 |