接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続の方法について詳しくは、接続の確立を参照してください。
プロパティ | 説明 |
AuthScheme | UMSaaSCloud に接続する際に使用する認証の種類。 |
User | 認証で使用されるUMSaaSCloud ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
SecurityToken | The security token used to authenticate access to the UMSaaSCloud account. |
UseSandbox | A boolean determining if the connection should be made to a Salesforce sandbox account. |
CredentialsLocation | The location of the settings file where token retrieved with OKTA MFA is saved. |
プロパティ | 説明 |
APIVersion | The version of the Salesforce API used. |
LoginURL | URL to the UMSaaSCloud server used for logging in. |
プロパティ | 説明 |
SSOLoginURL | ID プロバイダーのログインURL。 |
SSOProperties | ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 |
SSOExchangeUrl | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
プロパティ | 説明 |
UseBulkAPI | Whether to use the synchronous SOAP API or the asynchronous Bulk API. |
BulkAPIConcurrencyMode | The concurrency mode for processing bulk rows with BULK API v1. |
BulkPollingInterval | The time interval in milliseconds between requests that check the availability of the bulk query response. The default value is 500 ms. |
BulkQueryTimeout | The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes. |
WaitForBulkResults | Whether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true. |
プロパティ | 説明 |
UseToolingAPI | Whether to use the Salesforce Tooling API. |
プロパティ | 説明 |
InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
OAuthServerURL | The server URL to use if authenticating with OAuth. |
OAuthGrantType | OAuth フローのグラント種別。 |
OAuthAuthorizationURL | OAuth サービスの認可URL。 |
OAuthAccessTokenURL | OAuth アクセストークンを取得するURL。 |
OAuthVerifier | OAuth 認可URL から返された検証コード。 |
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 | A boolean indicating if you would like all inserts, updates, or deletes to fail in a request if even a single record fails. |
ArchiveMode | Boolean indicating whether to include deleted and archived records with a standard SELECT query. |
ConnectionLifeTime | 接続の最大有効期間(秒単位)。その時間が経過すると、接続オブジェクトは削除されます。 |
ContinueOnAlterException | Whether you want to continue after a ALTER statement has failed. |
ExposeConceptualEntities | Boolean determining if the Salesforce record types / conceptual entities should be exposed as tables. |
FilterScope | Optional scope to limit the records returned from queries. |
IncludeMetadataDescription | Set this property to a value other than NONE if you want to retrieve the descriptions for columns, tables or both of them from the Metadata API. |
IncludeReports | Whether to expose Salesforce Reports as views. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PoolIdleTimeout | 接続が閉じられる前に許容されたアイドル時間。 |
PoolMaxSize | プールの最大接続数。 |
PoolMinSize | プール内の最小接続数。 |
PoolWaitTime | 使用可能な接続を待機する最大秒数。 |
PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
QueryPassthrough | Whether to accept SOQL queries. |
Readonly | このプロパティを使用して、provider からUMSaaSCloud へのアクセスを読み取り専用に設定できます。 |
RemoveBOMCharacter | Specifies whether to remove the BOM character (char)0xfeff from the content. |
ReplaceInvalidUTF8Chars | Specifies whether to replace invalid UTF8 characters with a '?' |
RTK | ライセンス供与で使用されるランタイムキー。 |
ServerSideAggregation | A boolean determining if server side aggregation should be used. |
SessionTimeout | The time in minutes for which a Salesforce login session is reused. |
SkipFormulaFields | Set to true if formula fields should be skipped when listing columns. |
SkipPickListTranslation | 翻訳をスキップするカラムのカンマ区切りリスト。 例:Table1.Col1, Col3, ... ; |
SortColumns | Set to true to sort table columns instead of reporting them in the UMSaaSCloud order. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TranslatePickListFields | PickList フィールドをユーザーの言語に翻訳するかどうか。 |
UseConnectionPooling | このプロパティは、コネクションプーリングを有効にします。 |
UseDisplayNames | Boolean determining if the display names for the columns should be used instead of the API names. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |