接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続の方法について詳しくは、接続の確立を参照してください。
プロパティ | 説明 |
AuthScheme | Salesforce に接続する際に使用する認証の種類。 |
User | 認証で使用されるSalesforce ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
SecurityToken | 認証で使用されるSalesforce アカウントのセキュリティトークン。 |
UseSandbox | Salesforce Sandbox アカウントに接続するかどうかを決定するboolean。 |
CredentialsLocation | OKTA MFA で取得したトークンが保存される設定ファイルの場所。 |
プロパティ | 説明 |
APIVersion | 使用されるSalesforce API のバージョン。 |
LoginURL | ログインで使用されるSalesforce サーバーへのURL。 |
プロパティ | 説明 |
SSOLoginURL | ID プロバイダーのログインURL。 |
SSOProperties | ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 |
SSOExchangeUrl | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
プロパティ | 説明 |
UseBulkAPI | 同期SOAP API を使うか、非同期Bulk API を使うか。 |
BulkAPIConcurrencyMode | BULK API v1 でバルク処理を行うための同時実行モード。 |
BulkPollingInterval | 一括クエリの応答の可用性を確認するリクエスト間の時間間隔(ミリ秒単位)。デフォルト値は500 ミリ秒です。 |
BulkQueryTimeout | provider が一括クエリの応答を待機するタイムアウト(分単位)。デフォルト値は25分です。 |
WaitForBulkResults | 非同期API を使用するときにバルク結果を待つかどうか。 UseBulkAPI がtrue の場合にのみアクティブになります。 |
プロパティ | 説明 |
UseToolingAPI | Salesforce Tooling API を使用するかどうか。 |
プロパティ | 説明 |
InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
OAuthServerURL | OAuth でログインする場合に使用するサーバーURL。 |
OAuthGrantType | OAuth フローのグラント種別。 |
OAuthAuthorizationURL | OAuth サービスの認可URL。 |
OAuthAccessTokenURL | OAuth アクセストークンを取得するURL。 |
OAuthVerifier | OAuth 認可URL から返された検証コード。 |
PKCEVerifier | PKCE 認証スキームにGetOAuthAuthorizationUrl ストアドプロシージャを実行することで生成されるPKCE code verifier。 |
OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
OAuthExpiresIn | OAuth アクセストークンの有効期限(秒単位)。 |
OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ(ミリ秒)。 |
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
OAuthJWTIssuer | Java Web Token の発行者。 |
OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
プロパティ | 説明 |
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 です。 |
プロパティ | 説明 |
AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
CacheProvider | データのキャッシュに使用されるプロバイダーの名前。 |
CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
プロパティ | 説明 |
AllOrNone | 1つのレコードが失敗しただけで、要求に含まれるすべての挿入、更新、または削除を失敗として処理するかどうかを示すboolean。 |
ArchiveMode | 標準のSELECT クエリで削除およびアーカイブされたレコードを含めるかどうかを示すboolean。 |
ConnectionLifeTime | 接続の最大有効期間(秒単位)。その時間が経過すると、接続オブジェクトは削除されます。 |
ContinueOnAlterException | ALTER ステートメントが失敗した後に続行するかどうか。 |
ExposeConceptualEntities | Salesforce のレコードタイプ / 概念的エンティティをテーブルとして公開するかどうかを指定するboolean。 |
FilterScope | クエリから返されるレコードを制限するためのオプションのスコープ。 |
IncludeMetadataDescription | カラム、テーブル、またはその両方の説明をMetadata API から取得する場合は、このプロパティをNONE 以外の値に設定します。 |
IncludeReports | Salesforce Reports をビューとして公開するかどうか。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PoolIdleTimeout | 接続が閉じられる前に許容されたアイドル時間。 |
PoolMaxSize | プールの最大接続数。 |
PoolMinSize | プール内の最小接続数。 |
PoolWaitTime | 使用可能な接続を待機する最大秒数。 |
PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
QueryPassthrough | SOQL クエリを受け付けるかどうか。 |
Readonly | このプロパティを使用して、provider からSalesforce へのアクセスを読み取り専用に設定できます。 |
RemoveBOMCharacter | コンテンツからBOM 文字(char)0xfeff を削除するかどうかを指定します。 |
RemovePrivateChar | Specifies whether to replace private use characters with a '?' |
ReplaceInvalidUTF8Chars | 無効なUTF8 文字を'?' に置き換えるかどうかを指定します。 |
RTK | ライセンス供与で使用されるランタイムキー。 |
ServerSideAggregation | サーバー側の集計を使用するかどうかを決定するboolean。 |
SessionTimeout | Salesforce ログインセッションのタイムアウト時間(分単位)。 |
SkipFormulaFields | カラムをリストする際に数式フィールドをスキップする必要がある場合は、true に設定します。 |
SkipPickListTranslation | 翻訳をスキップするカラムのカンマ区切りリスト。 例:Table1.Col1, Col3, ... ; |
SortColumns | true に設定すると、テーブルのカラムをSalesforce のレポート順ではなくソートします。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TranslatePickListFields | PickList フィールドをユーザーの言語に翻訳するかどうか。 |
UseConnectionPooling | このプロパティは、コネクションプーリングを有効にします。 |
UseDisplayNames | API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |