接続プロパティ
接続プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続設定で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、はじめにを参照してください。
プロパティ | 説明 |
AuthScheme | Salesforce に接続する際に使用する認証の種類。 |
User | 認証するSalesforce ユーザーアカウントのユーザーID を指定します。 |
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 でバルク処理を行うための同時実行モード。 |
BulkUploadLimit | The max file size in MB allowed to be ingested by the Bulk API V2. |
BulkPollingInterval | 一括クエリの応答の可用性を確認するリクエスト間の時間間隔(ミリ秒単位)。デフォルト値は500 ミリ秒です。 |
BulkQueryTimeout | provider が一括クエリの応答を待機するタイムアウト(分単位)。デフォルト値は25分です。 |
WaitForBulkResults | 非同期API を使用するときにバルク結果を待つかどうか。 UseBulkAPI がtrue の場合にのみアクティブになります。 |
BulkAPIVersion | クエリの処理に使用するバルクAPI のバージョン。 |
プロパティ | 説明 |
UseToolingAPI | Salesforce Tooling API を使用するかどうか。 |
プロパティ | 説明 |
InitiateOAuth | OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。 |
OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
OAuthAccessToken | OAuth ネットワークへの認証後に受け取ったトークンで、ユーザーにアクセス権を付与します。 アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。 |
OAuthSettingsLocation | OAuth 値が保存される設定ファイルの場所を指定します。OAuth 設定を中心的な場所に保管することで、ユーザーがログインするたびにOAuth 接続プロパティを手動で入力する必要がなくなります。また、資格情報を接続やプロセス間で共有することもできます。 |
CallbackURL | OAuth 経由でSalesforce への認証を行った後にユーザーが戻るURL。 |
OAuthServerURL | OAuth でログインする場合に使用するサーバーURL。 |
OAuthGrantType | 選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。 |
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 トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)の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 | 指定されたキャッシュデータベース内の失効データに対する許容時間(秒単位)。 |
Offline | ライブSalesforce データの代わりに、指定されたキャッシュデータベースからデータを取得します。 |
CacheMetadata | provider がテーブルメタデータをファイルベースのキャッシュデータベースにキャッシュするかどうかを決定します。 |
プロパティ | 説明 |
AllOrNone | 1つのレコードが失敗しただけで、要求に含まれるすべての挿入、更新、または削除を失敗として処理するかどうかを示すboolean。 |
ArchiveMode | 標準のSELECT クエリで削除およびアーカイブされたレコードを含めるかどうかを示すboolean。 |
ContinueOnAlterException | ALTER ステートメントが失敗した後に続行するかどうか。 |
DefaultDomain | このプロパティは、Oracle Database Gateway for ODBC で使用されます。 |
EnableForeignKeyDetection | ODBC で外部キーを検出するかどうか。 |
ExposeConceptualEntities | Salesforce のレコードタイプ / 概念的エンティティをテーブルとして公開するかどうかを指定するboolean。 |
FilterScope | クエリから返されるレコードを制限するためのオプションのスコープ。 |
IncludeDualTable | Oracle データベースとの互換性を向上するためにOracle DUAL テーブルのモックを作成するには、このプロパティを設定します。 |
IncludeMetadataDescription | カラム、テーブル、またはその両方の説明をMetadata API から取得する場合は、このプロパティをNONE 以外の値に設定します。 |
IncludeReports | Salesforce Reports をビューとして公開するかどうか。 |
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 | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
QueryPassthrough | SOQL クエリを受け付けるかどうか。 |
Readonly | provider からSalesforce への読み取り専用アクセスを切り替えます。 |
RemoveBOMCharacter | コンテンツからBOM 文字(char)0xfeff を削除するかどうかを指定します。 |
RemovePrivateChar | Specifies whether to replace private use characters with a '?' |
ReplaceInvalidUTF8Chars | 無効なUTF8 文字を'?' に置き換えるかどうかを指定します。 |
ReportExactPicklistLength | picklist フィールドを正確にSalesforce の長さで報告するか、255 の長さで報告するか。 |
RTK | provider のライセンスを取得するためのランタイムキーを指定します。設定されていないか無効な場合、provider は標準のライセンス方法をデフォルトとして使用します。このプロパティは、標準のライセンス方法がサポートされていないか、ランタイムキーが必要な環境でのみ使用してください。 |
ServerSideAggregation | サーバー側の集計を使用するかどうかを決定するboolean。 |
SessionTimeout | Salesforce ログインセッションのタイムアウト時間(分単位)。 |
SkipFormulaFields | カラムをリストする際に数式フィールドをスキップする必要がある場合は、true に設定します。 |
SkipPickListTranslation | 翻訳をスキップするカラムのカンマ区切りリスト。 例:Table1.Col1, Col3, ... ; |
SortColumns | true に設定すると、テーブルのカラムをSalesforce のレポート順ではなくソートします。 |
Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
TranslatePickListFields | PickList フィールドをユーザーの言語に翻訳するかどうか。 |
UpperCaseIdentifiers | このプロパティは、大文字で設定されているすべての識別子を報告します。これは、Oracle データベースのデフォルト設定で、Oracle Database Gateway のようなOracle ツールとの統合を向上します。 |
UseDisplayNames | API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。 |
UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |