入力ストリームは使用せず、すべて無視します。

AllOrNone がtrue に設定されている場合、挿入、更新、または削除操作中に単一のレコードが失敗すると、リクエスト全体がロールバックされ、レコードはコミットされません。

AllOrNone がfalse に設定されている場合、一部のレコードが失敗しても、バッチ内の成功したレコードはコミットされます。

このプロパティはBulk API リクエストを使用する場合には適用されません。

このプロパティを使用すると、必要に応じてデフォルトのバージョンをオーバーライドできます。

指定したAPI バージョンがSalesforce でサポートされていることを確認してください。サポートされていないバージョンを使用すると、エラーや予期しない動作が発生する可能性があります。

デフォルトでは、Salesforce はクエリ結果から削除済みおよびアーカイブされたレコードを除外します。 ArchiveMode がtrue に設定されている場合、本製品 はこれらのレコードを含む代替クエリ動作を使用します。 これはSalesforce のqueryAll 操作に対応し、アクティブなレコードと標準クエリでは返されない論理削除されたレコードの両方を取得します。

この設定は、完全に削除される前の削除済みレコードの取得、履歴レポート用のアーカイブデータへのアクセス、または完全なデータセットが必要な監査の実行に役立ちます。

パフォーマンスの考慮事項

queryAll 動作で取得される削除済みレコードは、完全に削除されるまでの間のみ利用可能で、通常は削除から15日後となります。 削除済みおよびアーカイブされたレコードを含めると、API 使用量が増加し、大幅に増大したデータセットとなる可能性があり、クエリのパフォーマンスに影響を与える場合があります。 アクティブなレコードのみが必要な場合は、ArchiveMode をfalse に設定しておくことで、不要なデータ取得を避けて効率を向上させることができます。

Salesforce は複数の認証方法をサポートしています。適切な値は、組織が使用する認証フローによって異なります。

• Basic：Basic ユーザー / パスワード認証を使用する場合に設定。
• OAuth：コードグラント種別でOAuth を実行する場合に設定。
• OAuthClient：クライアントグラント種別でOAuth を実行する場合に設定。
• OAuthPassword：パスワードグラント種別でOAuth を実行する場合に設定。
• OAuthJWT：JWT 証明書を使用してOAuth 認証を行う場合に設定。次の追加の接続プロパティが必要です。[OAuthJWTCert,/OAuthJWTCertType/OAuthJWTCertPassword/OAuthJWTCertSubject/OAuthJWTIssuer/OAuthJWTSubject]
• OAuthPKCE：標準OAuth2 フローのProof Key of Code Exchange（PKCE）拡張機能を使用するように設定。自身でPKCEVerifier を設定するか、ドライバーが自動的に生成します。
• OneLogin：OneLogin 経由でSSO 認証を実行する場合に設定。すべてのID プロバイダーでは、次の共通の接続プロパティが必要です。 [SSOLoginURL/SSOExchangeURL]
• PingFederate：PingFederate 経由でSSO 認証を実行する場合に設定。すべてのID プロバイダーでは、次の共通の接続プロパティが必要です。 [SSOLoginURL/SSOExchangeURL]
• OKTA：OKTA 経由でSSO 認証を実行する場合に設定。すべてのID プロバイダーでは、次の共通の接続プロパティが必要です。 [SSOLoginURL/SSOExchangeURL]
• ADFS：ADFS 経由でSSO 認証を実行する場合に設定。すべてのID プロバイダーでは、次の共通の接続プロパティが必要です。 [SSOLoginURL/SSOExchangeURL]
• AzureAD：AzureAD 経由でSSO 認証を実行する場合に設定。詳しくは、接続プロパティSSOProperties を参照してください。

この接続プロパティがTrue に設定されている場合、本製品 はSELECT クエリの対象となるテーブルの内容を自動的にキャッシュします。これらのテーブルの内容は、CacheConnection およびCacheDriver 接続プロパティで指定されたキャッシュデータベースにキャッシュされます。

関連項目

• CacheMetadata：CacheMetadata を有効にすると、取得されたすべてのメタデータはキャッシュデータベースにミラーリングされます。これは、本製品 が以降にメタデータを検出しようとする場合に、メタデータがキャッシュデータベースから直接読み取られSalesforce にメタデータをリクエストする時間が不要になるため、より高速になることを意味します。
• 明示的なデータのキャッシュ：このセクションでは、AutoCache をOffline モードで使用する例を示します。
• CACHE ステートメント：CACHE ステートメントを使用して、SELECT クエリの対象となる任意のテーブルの内容を明示的にキャッシュできます。

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Salesforce Bulk API v1 は、一括データ操作を処理するための2つの並行処理モードをサポートしています。BulkAPIConcurrencyMode をSerial に設定すると、バッチが確実に順次処理されるようになり、関連レコードを扱う際にレコードロックの問題を防ぐことができます。 ただし、特に大規模なデータセットを処理する場合、パフォーマンスが低下する可能性があります。

Parallel を使用すると、複数のバッチを同時に処理できるため、スループットが大幅に向上します。 ただし、Salesforce はレコードロックを実行するため、関連レコードを更新しようとする並列操作では、競合によりエラーが発生する場合があります。

パフォーマンスの考慮事項

一括データの効率的な処理は、高スループットアプリケーションにとって重要です。ワークロードが独立したレコードを含む場合、Parallel モードを有効にすることで処理を大幅に高速化できます。 ただし、操作が関連レコードの更新を含む場合、Serial モードを使用することでロックの問題を防ぐことができます。

このプロパティは、データ構造と処理のニーズに基づいて一括操作を最適化する際に役立ちます。 適切な設定を選択することで、API リクエスト時間を短縮し、システム全体のパフォーマンスを向上させることができます。

このプロパティは、Bulk API v1 が有効な場合にのみ適用されます。Bulk API v2 では並行処理が自動的に制御されるため、この設定はサポートされていません。

Salesforce では、それぞれ異なる用途に最適化された2つのバージョンのBulk API を提供しています。

• Bulk API v1 では、レコードがバッチで処理される方法をより詳細に制御できます。パフォーマンス重視のシナリオや高度なワークフローに適しています。
• Bulk API v2 では、バッチ処理とエラー管理を自動的に処理することで、一括操作を簡素化します。ほとんどの標準的な用途に推奨されます。

パフォーマンスの考慮事項

Salesforce API バージョン62.0 以降では、より一貫した設計、より強力なSalesforce API エコシステムとの統合、およびAPI 消費量の削減により、一般的にv2 が推奨されます。 v2 を使用することで、手動での最適化の必要性が減り、ほとんどの標準的な一括操作に適した選択肢となります。 ただし、大規模またはパフォーマンス重視のワークフローでは、v1 がバッチ処理とエラー処理の制御においてより大きな柔軟性を提供します。

このプロパティはポーリング頻度を決定し、本製品 がジョブステータスを確認するリクエストを送信する頻度を制御します。 値を小さくするとポーリング頻度が増加し、値を大きくするとAPI コール数が減少しますが、クエリ結果の取得に遅延が生じる可能性があります。 UseBulkAPI がtrue に設定されている場合、本製品 は一括クエリ操作（SELECT 文など）と一括インジェスト操作（INSERT、UPDATE、DELETE など）の両方について、Salesforce に非同期ジョブを送信します。 本製品 は定期的にSalesforce サーバーをポーリングして、結果が準備できているかを確認します。 ポーリングは、WaitForBulkResults がtrue に設定されている場合にのみ、クエリとインジェストの応答に対して実行されます。

パフォーマンスの考慮事項

頻繁なポーリング（小さな値）は、クエリの実行を高速化する可能性がありますが、API 使用量を増加させる場合があります。 ポーリング間隔を大きくするとAPI リクエストが減少しますが、クエリが完了してもポーリングが遅延した場合、応答時間が遅くなる可能性があります。

このプロパティは、Salesforce で一括クエリを実行する場合のパフォーマンスとAPI 消費量を微調整する際に役立ちます。 クエリサイズとAPI レート制限に基づいてこの設定を調整することで、パフォーマンスを最適化できます。

この設定は、Salesforce Bulk API が使用されている場合にのみ適用されます。

UseBulkAPI がtrue に設定されている場合、本製品 はSELECT クエリをSalesforce の非同期ジョブとして送信します。 本製品 は定期的にSalesforce をポーリングして、結果が準備できているかを確認します。

このプロパティは、本製品 が一括クエリの完了を待機する合計時間を制御し、この時間を超えるとタイムアウトします。クエリがこの時間よりも長くかかる場合、接続はタイムアウトエラーで失敗します。 BulkQueryTimeout を長く設定すると、Salesforce が大規模または複雑なクエリを処理する時間を増やすことができ、タイムアウトによる失敗の可能性を減らします。 ただし、この値を高く設定しすぎると、正常に完了する可能性が低いクエリに対して長時間待機することになる場合があります。

このプロパティは、すべての接続リクエストに適用され、一括クエリの実行時間ではなく非アクティブ状態を管理するTimeout とは異なります。

このプロパティは、Salesforce Bulk API で大規模なデータセットや実行時間の長いクエリを処理する場合に役立ちます。 この値を調整することで、予想される実行時間に基づいてクエリの成功率とタイムアウト処理のバランスを取ることができます。

この設定は、Salesforce Bulk API が使用されている場合にのみ適用されます。

UseBulkAPI がtrue に設定されている場合、このプロパティはSalesforce Bulk API v2 経由での取り込みに許可される最大ファイルサイズを定義します。 Salesforce では最大アップロードサイズが100 MB に制限されており、これがこの設定のデフォルト値です。この制限を超えると、エラーや操作の失敗が発生する可能性があります。 ほとんどの場合、この値を変更する必要はありません。ただし、必要に応じてより小さい値に調整することができます。例えば、ジョブサイズを削減したり、ネットワーク制約を管理したりする場合です。

パフォーマンスの考慮事項

このプロパティは、Salesforce の一括アップロード制限への準拠を確実にします。100 MB を超えるファイルをアップロードしようとすると失敗します。 大きなアップロードでタイムアウトやエラーが発生する場合は、ファイルサイズを小さくするか、データをより小さなチャンクに分割して、信頼性を向上させ、API レートや処理制限の超過を回避することを検討してください。

このプロパティは、一括データ取り込みを管理する際に役立ち、Salesforce のファイルサイズ制約との互換性を確保し、大規模なデータセットの効率的な処理を維持するのに役立ちます。

この設定は、Salesforce Bulk API v2 が使用されている場合にのみ適用されます。

対象のキャッシュデータベースは、この接続プロパティとCacheDriver 接続プロパティの組み合わせによって決定されます。指定されたキャッシュデータベースを使用するには、両方のプロパティが必要です。

この接続プロパティで指定された接続文字列は、CacheDriver 接続プロパティで指定されたJDBC ドライバーに直接渡されます。使用可能な接続プロパティの詳細については、指定されたJDBC ドライバー のドキュメントを参照してください。

CacheDriver で指定したJDBC ドライバーがアプリケーションのクラスパスに含まれていることを確認してください。

以下に、一般的なキャッシュデータベースの設定例を示します。

Derby およびJava DB

CacheDriver とこの接続プロパティを使用して、Derby への接続を設定します。以下は、Derby JDBC URL 構文です。

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]

jdbc:derby:memory

SQLite

SQLite へキャッシュするにはSQLite JDBC ドライバーを使用できます。次はJDBC URL の構文です。

jdbc:sqlite:dataSource

• Data Source：SQLite データベースファイルへのパス。または、:memoryの値を使ってインメモリにキャッシュします。

MySQL

以下はCData JDBC Driver for MySQL のJDBC URL の例です。

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache

• Server：キャッシュ先のMySQL データベースをホストしているサーバーのIP アドレスまたはドメイン名。
• Port：指定されたサーバー上のMySQL インスタンスが実行されているポート。
• Database：キャッシュ先のMySQL データベースの名前。指定されたサーバーでホストされているMySQL データベースの名前と一致する必要があります。
• User：選択したMySQL データベースに登録されているユーザーのユーザー名。
• Password：指定されたMySQL ユーザーに紐付けられたパスワード。

SQL Server

Microsoft JDBC Driver for SQL Server のJDBC URL の構文は次のとおりです。

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]

jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true

• Server：SQL Server を起動しているコンピューターの名前またはネットワークアドレス名。デフォルトのインスタンスではなく、名前付きインスタンスに接続するには、ホスト名とインスタンス名をバックスラッシュで区切って指定します。
• Port：指定されたサーバー上のSQL Server インスタンスが実行されているポート。
• Database：キャッシュ先のSQL Server データベースの名前。指定されたサーバーでホストされているSQL Server データベースの名前と一致する必要があります。
• Integrated Security：現在のWindows アカウントを認証に使用する場合は、このオプションをTrue に設定します。代わりにUser とPassword で認証するには、このオプションをFalse に設定します。

  統合セキュリティを使用するには、Windows システムパス上のフォルダにsqljdbc_auth.dll も追加する必要があります。このファイルは、Microsoft JDBC Driver for SQL Server インストールの"auth" サブフォルダにあります。アセンブリのビット数はJVM のビット数と一致する必要があります。

• User Id：選択したSQL Server データベースに登録されているユーザーのユーザー名。このプロパティは、統合セキュリティを使用していない場合にのみ必要です。
• Password：指定されたSQL Server ユーザーに紐付けられたパスワード。このプロパティは、統合セキュリティを使用していない場合にのみ必要です。

Oracle

次はOracle JDBC Thin ドライバーの従来のJDBC URL 構文です。

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]

jdbc:oracle:thin:scott/tiger@myhost:1521:orcl

• Data Source：Oracle データベースを識別する接続記述子。これは、TSN 接続記述子、接続記述子を決定するOracle Net Services 名、またはバージョン11g 以降ではEasy Connect ネーミング（任意のポート名およびサービス名を持つOracle サーバーのホスト名）になります。

• User Id：選択したOracle データベースに登録されているユーザーのユーザー名。
• Password：指定されたOracle ユーザーにに紐付けられたパスワード。

PostgreSQL

次は公式のPostgreSQL JDBC ドライバーのJDBC URL 構文です。

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]

jdbc:postgresql:postgres

• Host：PostgreSQL データベースをホストしているサーバーのアドレス。
• Port：指定されたホストサーバー上のPostgreSQL データベースがホストされているポート。
• Database：キャッシュ先のPostgreSQL データベースの名前。指定されたサーバーでホストされているPostgreSQL データベースの名前と一致する必要があります。
• User name：選択したPostgreSQL データベースに登録されているユーザーのユーザー名。"user" パラメータを使ってJDBC URL に指定できます。
• Password：指定されたユーザーに紐付けられたパスワード。

CData JDBC drivers を含むJDBC ドライバーが用意されている任意のデータベースにキャッシュできます。

Note：指定されたJDBC ドライバーのJAR ファイルをクラスパスに追加する必要があります。CData JDBC drivers の場合、このJAR ファイルはドライバーのインストールディレクトリの"lib" サブフォルダにあります。

また、CacheConnection 接続プロパティを設定して、指定されたJDBC ドライバーの接続文字列を入力する必要があります。

例

Derby およびJava DB

Java DB は、Derby のOracle ディストリビューションです。Java DB にキャッシュするには、Derby JDBC ドライバーのJAR ファイルであるderbytools.jar をクラスパスに追加する必要があります。

Derby JDBC ドライバーのJAR ファイルは、このページからダウンロードできるdb-derby-10.17.1.0-bin.zip に同梱されています。derbytools.jar はこのzip ファイルの"lib" サブフォルダにあります。

クラスパスにderbytools.jar を追加した後、以下のようにJava DB データベースにキャッシュすることができます。

jdbc:salesforce:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';AuthScheme=Basic;User=myUser;Password=myPassword;Security Token=myToken;

jdbc:salesforce:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';AuthScheme=Basic;User=myUser;Password=myPassword;Security Token=myToken;

SQLite

次はSQLite JDBC ドライバーのJDBC URL です。

jdbc:salesforce:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';AuthScheme=Basic;User=myUser;Password=myPassword;Security Token=myToken;

MySQL

以下はCData JDBC Driver for MySQL のJDBC URL です。

  jdbc:salesforce:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';AuthScheme=Basic;User=myUser;Password=myPassword;Security Token=myToken;
  

SQL Server

次のJDBC URL はMicrosoft JDBC Driver for SQL Server を使用しています。

jdbc:salesforce:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';AuthScheme=Basic;User=myUser;Password=myPassword;Security Token=myToken;

Oracle

次はOracle Thin Client のJDBC URL です。

jdbc:salesforce:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';AuthScheme=Basic;User=myUser;Password=myPassword;Security Token=myToken;

PostgreSQL

次のJDBC URL は公式のPostgreSQL JDBC ドライバーを使用しています。

jdbc:salesforce:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';AuthScheme=Basic;User=myUser;Password=myPassword;Security Token=myToken;

CacheLocation は単純なファイルベースキャッシュです。

本製品 はDerby データベースのOracle のディストリビューションあるJava DB をファイルベースのキャッシュに使用しています。Java DB にキャッシュするには、Derby JDBC ドライバーのJAR ファイルであるderbytools.jar をクラスパスに追加する必要があります。

Derby JDBC ドライバーのJAR ファイルは、このページからダウンロードできるdb-derby-10.17.1.0-bin.zip に同梱されています。derbytools.jar はこのzip ファイルの"lib" サブフォルダにあります。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Salesforce Data Provider となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます。

関連項目

• AutoCache：後のオフライン使用のために、暗黙的にキャッシュを作成して維持するように設定します。
• CacheMetadata：Salesforce カタログをCacheLocation に永続化するように設定します。

この接続プロパティがTrue に設定されている場合、クエリを実行すると、Salesforce カタログのテーブルメタデータはCacheConnection とCacheDriver で指定されたキャッシュデータベースにキャッシュされ、もしこれらの接続プロパティが設定されていない場合はユーザーのホームディレクトリにキャッシュされます。

ホームディレクトリの場所はプラットフォームによって異なります。

テーブルのメタデータの取得は、テーブルがはじめてクエリされた際に一度だけ行われます。

CacheMetadata を使用するタイミング

本製品 がメタデータ検索で取得するSalesforce テーブルとカラムの数が多い場合、本製品 がすべてのテーブルメタデータをリストするのに時間がかかることがあります。

次のような場合に、メタデータの取得に時間がかかることがあります。

• 使用しているSalesforce インスタンスのテーブル数が多い。
• 本製品 が、接続プロパティによってデフォルト設定よりも多くのテーブルを検出するように設定されている。
• 本製品 に対して多くの短期間接続を行っている。

CacheMetadata を使用しないタイミング

本製品 は、はじめてテーブルやビューのメタデータを発見したときから最大1時間、そのメタデータをメモリに自動的に保持するため、通常はCacheMetadata は必要ありません。

CacheMetadata は、変動しやすいメタデータを扱うシナリオでは理想的ではありません。はじめてテーブルをクエリするとき、本製品 はそのメタデータをキャッシュデータベースファイルにキャッシュします。このキャッシュはテーブルスキーマの更新を反映するために動的に更新されることはないため、新規、変更、削除されたカラムを取得するには、キャッシュデータベースファイルを削除して再構築する必要があります。

キャッシュ内のテーブルに対してクエリを実行すると、本製品 はキャッシュの最終更新から経過した時間を確認します。

キャッシュの最終更新がこの接続プロパティの値（秒単位）よりも前の場合、本製品 はキャッシュを更新します。

それ以外は、本製品 はキャッシュから直接データを返します。

カスタムOAuth アプリケーションを作成した場合、OAuth 認可サーバーは認証プロセス中にユーザーをこのURL にリダイレクトします。 この値は、カスタムOAuth アプリケーションの設定時に指定したコールバックURL と一致する必要があります。

このプロパティは、接続が本製品 によって自動的に閉じられるまでのアクティブな状態を維持する時間を制御します。 時間は秒単位で指定します。このプロパティを0より大きい値に設定すると接続の有効期間が制限され、その後本製品 が接続を終了します。

デフォルトではこのプロパティは0に設定されており、接続の有効期間に制限はありません。接続は明示的に閉じられるか、ネットワークの中断やセッションのタイムアウトなどの外部要因によって終了されるまで開いたままになります。

このプロパティは、リソースの利用状況を管理し、古くなった接続やアイドル状態の接続が無期限に持続するのを防ぐのに役立ちます。

true に設定すると、プロバイダーは「接続テスト」操作を実行します。これは、データベースツールで接続性を検証するために一般的に使用されます。 この操作はセッションデータを保持しません。単に接続が確立できるかどうかを確認するだけで、NOOP（操作なし）コマンドのように機能します。

false に設定すると、接続は操作が必要になるまで遅延されます。これは、接続が頻繁に開閉されるがすぐに操作が行われないようなシナリオでパフォーマンスが向上する場合があります。

テーブルスキーマを変更する際、Salesforce では単一のALTER ステートメントで変更できるカラム数に制限があります。 これに準拠するため、本製品 はALTER ステートメントを自動的に複数の小さなステートメントに分割し、それぞれ最大10 カラムまで変更します。

ContinueOnAlterException がtrue に設定されている場合、本製品 は一つのステートメントが失敗しても、残りのALTER ステートメントの実行を続行します。 false に設定されている場合、エラーが発生すると処理は即座に停止します。

このプロパティをtrue に設定すると、一部のステートメントが失敗してもスキーマ変更を部分的に進めることができ、バッチ更新や重要でないカラムの変更に役立ちます。 ただし、これを有効にすると、一部の変更が成功し他が失敗した場合、テーブル構造に不整合が生じる可能性があります。

このプロパティは、Salesforce オブジェクトでスキーマ更新を実行する際に、エラー処理と実行の継続性のバランスを取る必要がある場合に役立ちます。

OKTA MFA 認証を使用する場合、取得されるトークンは期限が短く、通常2時間後に期限切れになります。 期限切れになると、本製品 は新しいMFA パスコードを要求し、接続の更新が必要になります。

このプロパティは、接続間で認証を持続させるためにトークンが保存され、読み取られる場所を定義します。 デフォルトでは、トークンは"%APPDATA%\\CData\\Salesforce Data Provider\\CredentialsFile.txt" に保存されます。 %APPDATA% 変数は、オペレーティングシステムに応じて異なるシステムの場所に解決されます。

カスタムの認証情報の場所を設定することは、複数の環境で認証を管理したり、制御されたディレクトリでトークンを保護したりする場合に役立ちます。 ただし、ファイルがドライバーからアクセス可能であり、セッション間で誤って削除されないようにしてください。

各Salesforce オブジェクトは、ビジネスプロセスに基づいてオブジェクト内のレコードを分類する複数のレコードタイプを持つことができます。 例えば、Account オブジェクトには、Partner、Customer、Supplier などのレコードタイプが含まれ、それぞれが異なるページレイアウト、ビジネスプロセス、選択リスト値を持つことがあります。

デフォルトでは、レコードタイプは個別のテーブルとして公開されず、すべてのレコードが単一のテーブル内に表示されます。 ExposeConceptualEntities がtrue に設定されている場合、本製品 は各レコードタイプ用の追加テーブルを作成し、分類されたデータへの直接アクセスを可能にします。 この機能により、ユーザーは単一のテーブル内でフィルタリングすることなく、特定のタイプのレコードを取得できるため、クエリが簡素化されます。

使用上の考慮事項

メタデータの複雑性：このプロパティを有効にすると、スキーマ内のテーブル数が大幅に増加する可能性があります。 多くのレコードタイプを持つ大規模なSalesforce インスタンスでは、メタデータの取得時間が長くなる可能性があります。

スキーマの変更：Salesforce 管理者がレコードタイプを追加または削除した場合、利用可能なテーブルが動的に変更されるため、クエリと統合において調整が必要になる場合があります。

クエリの最適化：この機能はレコードの取得を簡素化しますが、ユーザーは標準オブジェクトテーブルでフィルタを使用して同じ結果を得ることもできます。 例： SELECT * FROM Account WHERE RecordType = 'Partner'

このプロパティは、レコードタイプがビジネスプロセスをセグメント化するために頻繁に使用される複雑な Salesforce 実装で作業する際に役立ちます。また、ユーザーが特定のレコードカテゴリにアクセスするためのより構造化された方法を必要とする場合にも有用です。この設定を有効にすると、メタデータの複雑性が増す代償として、より明確なスキーマ構成を提供できます。

SOQL クエリを実行する際、このプロパティは"USING SCOPE" キーワードを追加し、選択されたフィルタスコープに基づいてクエリ結果を制限します。 これにより、Salesforce でのユーザーのロールと可視性設定に最も関連するレコードにクエリを絞り込むことができます。

例えば、FilterScope がMine に設定されている場合、クエリは現在認証されているユーザーが所有するレコードのみを取得します： SELECT Id, Name FROM Account USING SCOPE Mine

FilterScope がMineAndMyGroups に設定されている場合、クエリ結果はユーザーとその所属グループの両方が所有するレコードを含むように拡張されます。

FilterScope を使用することで、返されるレコード数を減らすことによりクエリパフォーマンスを向上させることができます。特に大規模なデータセットにおいて効果的です。 ただし、過度に制限的な設定は、クエリ結果から必要なレコードを除外してしまう可能性があるため、適切なスコープを選択するようにしてください。

このプロパティは、マルチユーザー環境において、ユーザーが自身のロール、チーム、または割り当てられたテリトリーに関連するレコードを取得するのに役立ちます。

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、本製品 はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

ItemURL カラムをすべてのテーブルで公開するかどうかを決定するboolean。

Salesforce Metadata API は、テーブルとカラムの説明を提供し、データ検索とスキーマドキュメントに役立ちます。 デフォルトでは説明は取得されませんが、このプロパティにより必要に応じて追加のメタデータを取得できます。次に例を示します。

1. このプロパティをColumns に設定すると、スキーマ内のすべてのカラムの説明を取得します。
2. Tables に設定すると、カラムではなくすべてのテーブルの説明を取得します。
3. TablesAndColumns に設定すると、テーブルとそれぞれのカラムの両方の説明を取得します。

パフォーマンスの考慮事項

このプロパティを有効にするとAPI コール数が増加し、特に大規模なスキーマを持つ環境でパフォーマンスに影響を与える可能性があります。 過度のAPI リクエストを避けるため、必要な場合にのみ使用することを検討してください。

このプロパティは、スキーマの探索、ドキュメント、またはレポートツールで追加のメタデータコンテキストが必要な場合に役立ちます。

Salesforce レポートは、ユーザーがSalesforce UI 内で作成する、事前定義された構造化データビューを提供します。 IncludeReports がtrue に設定されている場合、プロバイダーはレポートをビューとして公開し、データベーステーブルのようにクエリ可能にします。

パフォーマンスの考慮事項

クエリの柔軟性：ビューとして公開されたレポートは直接クエリできますが、Salesforce レポートの制限を継承するため、標準テーブルのように変更することはできません。

API 使用量：このプロパティを有効にすると、レポートデータを取得するために追加のAPI リクエストが発生する可能性があります。クエリにレポートが不要な場合は、API 消費量を削減するために無効にすることを検討してください。

アクセス制御：レポートをクエリするユーザーは、レポートにビューとしてアクセスするためにSalesforce で適切な権限を持っている必要があります。

このプロパティは、Salesforce レポートを分析ワークフローに統合する際に役立ち、Salesforce UI からデータを手動でエクスポートすることなく、事前構築されたレポートを直接クエリできるようになります。

OAuth は、アプリケーションがHTTP サービス上のユーザーアカウントに限定的にアクセスすることを可能にする認可フレームワークです。OAuth フローは、以下の用途で使用される方法を定義します。

• ユーザーのログイン。
• 認証に使用するOAuth アクセストークンとユーザー認証情報の交換。
• アプリケーションへの限定的なアクセスの提供。

OAuth アクセスの開始と維持のオプションは、本製品 が処理するフローの部分に基づいて命名されています。

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Salesforce Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：

このプロパティは、認証イベント、クエリ実行、接続の詳細など、本製品 の操作を記録するログファイルの場所と名前を指定します。 指定されたファイルが存在しない場合、本製品 はそのファイルを作成します。本製品 を実行しているユーザーまたはサービスが、指定されたパスまたはファイルへの書き込み権限を持っていることを確認してください。 適切な権限がない場合、ログファイルは作成されません。パスワードやトークンなどの接続文字列の機密情報は、ログで自動的にマスキングされます。 ただし、データ自体に含まれる機密情報はマスキングされない可能性があります。

Logfile に相対パスを指定し、Location プロパティが設定されている場合、そのディレクトリがログファイルのベースパスとして使用されます。

追加プロパティにより、ログの動作をカスタマイズできます。

• ログファイルの詳細レベルを制御するには、Verbosity を使用します。
• MaxLogFileSize でログファイルのサイズを管理し、MaxLogFileCount で保持するログファイルの数を制御します。
• LogModules プロパティを調整することで、特定のログモジュールをフィルタリングします。

Java のログ出力

Java のログ出力もサポートされています。Java のログ出力を有効化するには、Logfile を次のように設定します：

Logfile=JAVALOG://myloggername

上記の例のように、JAVALOG:// がJava のログを使用するための必須プレフィックスで、独自のロガーで代用することになります。

次に、指定されたロガーのgetLogger メソッドが呼び出され、指定された値を使用してLogger インスタンスが作成されます。ログのインスタンスがすでに存在する場合は、既存のインスタンスを参照します。

Java のログ出力が有効になっている場合、Verbosity は特定のログレベルに対応します。

このプロパティは、Salesforce にログインする際に使用される認証エンドポイントを定義します。デフォルトでは、本製品 はSalesforce の標準SOAP API ログイン URL：https://login.salesforce.com/services/Soap/c/62.0 に接続します。

以下の場合にこの値を変更してください：

• 組織が認証にカスタムSalesforce ドメイン（My Domain）を使用している場合
• 標準エンドポイント（https://login.salesforce.com）からのログインがログインポリシーによって制限されている場合
• 組織が特定の地域またはコンプライアンスベースのログインエンドポイントを必要とする場合

Note： 標準のサンドボックス環境に接続するには、UseSandbox プロパティを使用してください。 これにより、ログイン試行が自動的にサンドボックスログインエンドポイント（https://test.salesforce.com）にルーティングされ、組織がドメイン固有のログインポリシーを実施していない限り、LoginURL を手動で設定する必要はありません。

不正確なURL 設定は認証を妨げる可能性があるため、指定されたログインエンドポイントがSalesforce インスタンスに対して有効であることを確認することが重要です。 シングルサインオン（SSO）を使用している場合、ログインURL はID プロバイダーの設定と一致する必要があります。 サンドボックスと本番環境を頻繁に切り替える組織は、接続の問題を避けるために、このプロパティを適切に更新する必要があります。

このプロパティは、Salesforce サンドボックス、Government Cloud、または地域データセンターを使用するなど、カスタム認証エンドポイントを必要とする組織に役立ちます。

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

各ログファイル名には、識別しやすいように日付と時刻が含まれています。

このプロパティには以下の値を指定できます。

• 2以上の値を設定すると、保持されるログファイルの最大数が設定されます。
• 値が1の場合、ログファイルは1つだけ保持されます。最大サイズに達すると、ファイルは削除され新しいファイルに置き換えられます。これにより、現在のログ以外の履歴は残りません。
• 0または負の値を設定すると、ログファイルの数に制限がなくなりログ記録が無期限に続きます。

ログファイルのサイズを管理するには、MaxLogFileSize プロパティを使用します。これらの2つのプロパティは、ログフォルダ内のログファイルのサイズと保持を制御するために連携して動作します。

100 KB より小さい値の場合、本製品 は100 KB を最小許容サイズとして使用します。

保持されるログファイルの総数を制御するには、このプロパティとMaxLogFileCount プロパティを組み合わせて使用します。 これらのプロパティを組み合わせることで、ログファイルのサイズと保持を効果的に管理できます。

このプロパティは、集計やGROUP BY 句を含まないクエリに対して本製品 が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

デフォルトでは、Boolean カラムにNULL 値が発生した場合、ドライバーはNULL 値を無視します。 * NullBooleanBehavior='IGNORE' の場合、CUD 操作ではNULL 値は無視され、SELECT 操作ではドライバーはNULL 値と比較します。 * NullBooleanBehavior='FALSE' の場合、CUD 操作およびSELECT 操作でNULL 値は'False' に変換されます。

OAuthAccessToken は、保護されたリソースへのアクセスを認可する一時的な認証情報です。 これは通常、ユーザーまたはクライアントアプリケーションがOAuth 認証フローを完了した後に、ID プロバイダーから返されます。 このプロパティは、自動化されたワークフローや、トークンの処理をドライバーの外部で管理したいカスタムOAuth 実装で最も一般的に使用されます。

OAuth アクセストークンにはサーバーに依存する時間制限があり、ユーザーのアクセスを制限します。これは、OAuthExpiresIn プロパティを使用して設定します。ただし、ユーザーが操作を続けている限り、リクエスト間で再発行することでアクセスを維持することができます。

InitiateOAuth がREFRESH に設定されている場合、OAuthExpiresIn とOAuthTokenTimestamp の両方を設定することを推奨します。 本製品 は、これらのプロパティを使用してトークンの有効期限を判断し、最も効率的にリフレッシュできるようにします。OAuthExpiresIn およびOAuthTokenTimestamp が指定されていない場合、本製品 はトークンを直ちにリフレッシュします。

Note：アクセストークンは機密性の高い認証情報として扱い、安全に保管する必要があります。アクセス制御されていないログ、スクリプト、または設定ファイルでの公開は避けてください。

OAuth アクセストークンを取得するURL。OAuth 1.0 では、このURL で認可されたリクエストトークンがアクセストークンと交換されます。

OAuth サービスの認可URL。このURL でユーザーはサーバーにログインしてアプリケーションにアクセス許可を与えます。OAuth 1.0 では、アクセス許可が付与されるとリクエストトークンが認可されます。

このプロパティは以下の場合に必要です。

• カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
• 接続の確立 に記載されているように、ドライバーで組み込みOAuth 認証情報が利用できない場合。

（組み込みOAuth 認証情報が存在する場合、アプリケーション登録情報は既に本製品 によって提供されており、手動で入力する必要がない場合があります。）

この値は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

Note：クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

このプロパティは、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

• この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
• クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

OAuth アクセストークンは認証済みのユーザーに割り当てられ、そのユーザーに指定された期間のネットワークへのアクセスを許可します。アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。

サーバーによって作成されたアクセストークンは、限定された時間のみ有効です。OAuthExpiresIn は、トークンが作成されてから有効である秒数です。例えば、2024-01-29 20:00:00 UTC に生成され、2024-01-29 21:00:00 UTC（1時間後）に期限切れとなるトークンは、現在の時刻に関係なくOAuthExpiresIn の値は3600です。

ユーザーがアクセストークンの有効期限が切れるまでの時間を確認するには、OAuthTokenTimestamp をチェックします。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData JDBC Driver for Salesforce 2025J は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

注記

• Windows の共通のユーザーとシステム証明書ストアは以下のとおりです。
  • MY：個人証明書と関連付けられた秘密キーを 格納している証明書ストア。
  • CA：証明機関の証明書。
  • ROOT：ルート証明書。
  • SPC：ソフトウェア発行元証明書。
• Javaでは、証明書ストアは通常、証明書および 任意の秘密キーを含むファイルです。
• 証明書ストアの種類がPFXFile の場合は、 このプロパティにファイル名を設定します。
• PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

• サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
• 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
• 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例：CN=www.server.com, OU=test, C=US, E=support@cdata.com。一般的なフィールドには以下のものが含まれます。

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例："O=ACME, Inc."。

Java Web Token の発行者。 OAuth クライアントID に設定します。

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。 OAuth アプリの使用を許可されたユーザーのユーザー名（E メールアドレス）を設定します。

現在のアクセストークンが期限切れになったときに、新しいアクセストークンを取得するためにリフレッシュトークンが使用されます。 これにより、ユーザーが再度ログインすることなく、長時間実行されるワークフローや自動化された処理において、シームレスな認証が可能になります。 このプロパティは、対話型の認証ができないヘッドレス環境、CI/CD、またはサーバーベースの環境において特に重要です。

リフレッシュトークンは通常、初回のOAuth 交換時にGetOAuthAccessToken ストアドプロシージャを呼び出すことで取得されます。 その後、このプロパティを使用してトークンを自動でリフレッシュするか、（手動で更新を管理したい場合は）OAuthRefreshToken ストアドプロシージャに渡すことができます。

InitiateOAuth がREFRESH に設定されている場合、ドライバーはこのトークンを使用して、新しいアクセストークンを自動的に取得します。 最初のリフレッシュの後、ドライバーは更新されたトークンをOAuthSettingsLocation によって定義された場所に保存し、その後の接続ではその値を使用します。

Note：OAuthRefreshToken は安全に取り扱い、信頼できる場所に保管する必要があります。 アクセストークンと同様に、リフレッシュトークンもID プロバイダーのポリシーによって、有効期限が切れたり、取り消されたりする場合があります。

OAuth で認証する際、本製品 はこのプロパティを使用して認証リクエストを行います。 ほとんどの場合、本製品 はこの値を自動的に取得するため、手動で設定する必要はありません。

OAuth 認証を使用する場合は、User、Password、またはSecurityToken プロパティを指定しないでください。代わりにOAuth 認証情報とトークンが使用されます。

ほとんどの設定では、本製品 はOAuth サーバー URL を自動的に決定します。 このプロパティは通常のOAuth セットアップでは必要なく、カスタムドメインや政府系エンドポイントなどの特別なケースでのみ必要です。 ただし、カスタム認証エンドポイントに依存している組織や、特定のOAuth インフラストラクチャ設定を持つ組織では、このプロパティを手動で指定することで、接続が正しくルーティングされることを確実にします。

このプロパティは、OAuth を介して認証し、カスタムSalesforce ログインエンドポイント経由で接続する場合や、独自のOAuth 設定を持つ環境のトラブルシューティングを行う場合に役立ちます。

以下のいずれかの方法でOAuth の値をセントラルファイルに保存し、その値へのアクセスを共有できます。

• InitiateOAuth をGETANDREFRESH またはREFRESH に設定し、OAuth 設定ファイルのファイルパスを指定します。
• メモリストレージを使用して、資格情報を静的メモリにロードします。

以下のセクションでは、それぞれの方法について詳しく説明します。

OAuthSettingsLocation ファイルパスの指定

• Windows（ODBC およびPower BI）：registry://%DSN%
• Windows：%APPDATA%CDataSalesforce Data Provider\OAuthSettings.txt
• Mac：%APPDATA%/CData/Salesforce Data Provider/OAuthSettings.txt
• Linux：%APPDATA%/CData/Salesforce Data Provider/OAuthSettings.txt

メモリストレージ経由での資格情報のロード

資格情報が接続間で永続化されるファイルベースのストレージとは異なり、メモリストレージは資格情報を静的メモリにロードし、資格情報はプロセスが継続している間は同じ識別子を使用して接続間で共有されます。そのプロセス外で資格情報を永続化するには、接続を閉じる前に資格情報を手動で保存する必要があります。これにより、プロセスが再開されたときに接続にそれらを設定することができます。

OAuth プロパティの値を取得するには、sys_connection_props システムテーブルをクエリします。複数の接続で同じ資格情報を使用している場合は、プロパティは最後に閉じた接続から読み取られます。

サポートされるストレージの種類

• memory://：OAuth トークンをメモリ内に保存します（一意の識別子、同一プロセス内で共有など）。
• registry://：Windows ODBC およびPower BI エディションでのみサポートされています。DSN 設定のレジストリにOAuth トークンを格納します。registry://CData JDBC Driver for Salesforce 2025J Data Source、またはregistry://%DSN% のようなDSN 名で終わる必要があります。
• %DSN%：接続先のDSN 名。
• デフォルト（接頭辞なし）：OAuth トークンをファイル内に格納します。値には絶対パス、または%APPDATA% か%PROGRAMFILES% で始まるパスのいずれかを指定できます。

OAuth アクセストークンは認証済みのユーザーに割り当てられ、そのユーザーに指定された期間のネットワークへのアクセスを許可します。アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。

サーバーによって作成されたアクセストークンは、限定された時間のみ有効です。OAuthTokenTimestamp は、サーバーがトークンを作成した時のUnix タイムスタンプです。例えば、OAuthTokenTimestamp=1706558400 は、OAuthAccessToken がサーバーによって2024-01-29 20:00:00 UTC に生成されたことを示します。

OAuthVerifier 値の取得方法の詳細については、 を参照してください。

この接続プロパティががTrue に設定されている場合、すべてのクエリは、ライブSalesforce データではなくキャッシュデータベースに対して実行されます。

このモードでは、INSERT、UPDATE、DELETE、CACHE などの一部のSQL 操作が無効になります。

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

キャッシュの設定

統合およびフォーマット

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

PKCE 認証スキームにGetOAuthAuthorizationUrl ストアドプロシージャを実行することで生成されるProof Key for Code Exchange code verifier。これは、ヘッドレスシステムのようにブラウザを起動できないシステム上で使用できます。

ヘッドレスマシンでの認証

PKCEVerifier 値を取得するには、 を参照してください。

OAuthSettingsLocation と共に、OAuthVerifier およびPKCEVerifier を設定します。接続すると、本製品 はOAuth 認証トークンのOAuthVerifier とPKCEVerifier を交換し、暗号化して、指定された場所に保存します。 交換を自動化するには、InitiateOAuth をGETANDREFRESH に設定します。

OAuth 設定ファイルが生成されたら、接続プロパティからOAuthVerifier とPKCEVerifier を削除してOAuthSettingsLocation セットで接続できます。

OAuth トークン値を自動的にリフレッシュするには、OAuthSettingsLocation を設定し、さらにInitiateOAuth をREFRESH に設定します。

このプロパティは、UseConnectionPooling が有効な場合にのみ適用されます。接続プーリングは、リクエストごとに新しい接続を作成するのではなく、確立されたデータベース接続を再利用するメカニズムです。 これにより、頻繁な接続作成に伴うオーバーヘッドを削減し、パフォーマンスが向上します。

PoolIdleTimeout は、使用されていない接続を閉じてリソースを管理するのに役立ち、アイドル接続を維持することによる潜在的なオーバーヘッドを削減します。 値を小さくするとアイドル状態の接続を迅速にクリーンアップできます。一方、値を大きくすると接続を長く開いておけるため、再接続が頻繁に発生するシナリオではパフォーマンスが向上する可能性があります。

このプロパティは、接続プールで維持できるアクティブな接続の最大数を定義します。 このプロパティは、UseConnectionPooling がtrue に設定されている場合にのみ適用されます。 上限に達すると、新しい接続リクエストは既存の接続がプールに戻されるのを待つ必要があります。

プロパティを0または負の値に設定して接続プールを無効にすると接続の管理を簡素化できますが、トラフィックが多いシナリオではパフォーマンスが低下する可能性があります。 このプロパティは、リソースの使用率を最適化し、アプリケーションがサーバーやネットワークの制限を超えないようにするのに役立ちます。

このプロパティは、指定された最小数の接続が常に接続プールで利用可能であることを確実にします。 この設定は、接続を事前に初期化してすぐに使用できる状態に保つことで、待ち時間を減らすのに役立ちます。

デフォルトでは、プロバイダーはプールに少なくとも1つの接続を維持します。 より大きな値を設定することで、一貫したトラフィックがある環境でのパフォーマンスを向上させることができますが、リソースの使用量が増加する可能性があります。 値を小さくすると、非アクティブ時にプールがすべての接続を解放し、リソースの消費を抑えることができます。

このプロパティは、新しい接続リクエストがプールの利用可能な接続を待機する時間を制御します。 指定された時間内に接続が利用可能にならない場合、本製品 はエラーを返します。

デフォルト値は60秒で、接続リクエストが無期限に待機しないようにします。 トラフィックが多い環境やプールサイズが限られている場合、この値を大きくすることで接続が利用可能になるまでの時間を延ばすことができますが、失敗したリクエストのエラー処理が遅れる可能性があります。

認証タイプは次のいずれかです。

• BASIC：本製品 はHTTP BASIC 認証を行います。
• DIGEST：本製品 はHTTP DIGEST 認証を行います。
• NTLM：本製品 はNTLM トークンを取得します。
• NEGOTIATE：本製品 は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

この接続プロパティをTrue に設定すると、本製品 は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するために本製品 を構成する場合は、ProxyAutoDetect をFalse に設定します。

このプロパティがTrue に設定されている場合、使用するプロキシはこれらの場所をこの順番でチェックして決定されます。ある場所でプロキシが決定できない場合、本製品 は次の場所をチェックします。

1. 本製品 は、JVM のプロパティ（http.proxy、https.proxy、socksProxy など）から検索を行います。
2. JVM のプロパティが存在しない場合、本製品 はjava.home/lib/net.properties を検索します。
3. java.net.useSystemProxies がTrue に設定されている場合、本製品 はSystemProxy を検索します。
4. Windows では、本製品はレジストリのインターネットオプション、具体的にはレジストリキーHKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Internet Settings\ からプロキシ設定を読み取ります。Windows 10以降では、Windows の設定にあるプロキシの設定に対応します。

これらの設定は、マシンの現在のユーザーにのみ適用されることに注意してください。アプリケーションをサービスとして実行している場合、本製品 はユーザー設定を読み込みません。代わりに、本製品 の接続プロパティでプロキシ設定を手動で行う必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Note：本製品 はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

本製品 は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、本製品 は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyAutoDetect がFalse に設定されている場合、本製品 はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、本製品 は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAutoDetect がFalse に設定されている場合、本製品 はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、本製品 は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

本製品 は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、本製品 は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

このプロパティを使用すると、本製品 がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

空の値を空文字列として解釈するか、NULL として解釈するかを指定します。この設定は、UseBulkAPI = true かつBulkAPIVersion = v2 の場合のSELECT ステートメントにのみ影響します。

デフォルトでは、ドライバーはBULK V2 API クエリ操作から返される空の値をNULL としてプッシュします。PushEmptyValuesAsNull をfalse に設定すると、代わりに空の値はVARCHAR カラムでは空文字列として、数値フィールドでは0としてプッシュされます。

デフォルトでは、本製品 はSQL クエリを受け取り、Salesforce に送信する前に自動的にSOQL に変換します。 これにより、ユーザーは馴染みのあるSQL 構文で作業でき、ドライバーがクエリ変換を処理します。

QueryPassthrough がtrue に設定されている場合、本製品 はSOQL クエリを直接受け取り、変換せずにSalesforce に送信します。 これは、SQL では簡単に表現できないSalesforce 固有のクエリ機能を最大限に活用するために、ネイティブSOQL を記述することを好む上級ユーザーに役立ちます。

パススルーモードを使用すると、ユーザーはクエリ構造を完全に制御でき、高度なSOQL 機能にアクセスできます。 ただし、これにはSOQL 構文の知識が必要であり、無効なクエリは本製品 によって修正または変換されません。 このプロパティを有効にすることは、SQL で構築するのが困難な複雑なクエリには有益ですが、一般的な使用では、SQL からSOQL への変換の方がユーザーフレンドリーです。

このプロパティは、SOQL の記述に慣れており、Salesforce に送信されるクエリを直接制御する必要がある上級ユーザーに役立ちます。

true に設定すると、本製品 はSELECT クエリのみを許可します。INSERT、UPDATE、DELETE、またはストアドプロシージャのクエリを実行しようとすると、失敗してエラーメッセージが表示されます。

BOM 文字（0xFEFF）は、バイト順序を示すためにUTF-8 またはUTF-16 エンコードされたファイルやAPI レスポンスの先頭に存在することがあります。 ただし、この文字は、特にCSV インポート、API レスポンス、またはメタデータを読み取る際に、コンテンツの解析や処理で問題を引き起こす可能性があります。

RemoveBOMCharacter がtrue に設定されている場合、本製品 は受信コンテンツからBOM 文字を削除して、クリーンな解析を確保し、クエリ結果やメタデータ検出でエラーや予期しない文字を回避します。

パフォーマンスの考慮事項

BOM 文字を削除することで、このマーカーを含む外部データソースやAPI と作業する際の互換性が向上する可能性があります。 ただし、ソースシステムがエンコーディング解釈のためにBOM に依存している場合、それを削除すると、特定のエッジケースで文字エンコーディングの誤解釈を引き起こす可能性があります。 このプロパティは一般的に、コンテンツの先頭で予期しない文字や解析エラーが発生する場合に有効にする必要があります。

このプロパティは、BOM 文字が存在して解析の問題を引き起こすファイルインポート、ストリームデータ、またはAPI レスポンスを扱う際に、クリーンな入力を処理するのに役立ちます。

私用文字は、アプリケーション固有の使用のために予約されたUnicode 文字であり、標準的な意味は割り当てられていません。 一部のSalesforce データやメタデータ応答にはこれらの文字が含まれている場合があり、これらを認識またはサポートしないダウンストリームアプリケーション、エクスポート、または解析ツールで問題を引き起こす可能性があります。

RemovePrivateChar がtrue に設定されている場合、本製品 は遭遇した私用文字を '?' に置き換えて互換性を確保し、解析や表示エラーを防ぎます。

このプロパティを有効にすると、私用文字を適切に処理しないデータエクスポート、ログ、またはアプリケーションで作業する際に、よりクリーンで標準化された出力が確保されます。 ただし、文字を置き換えることで、これらの文字がカスタムエンコーディングや注釈に意図的に使用されていた場合、非標準情報が失われる可能性があります。

このプロパティは、厳密な文字処理を必要とするシステムで作業する場合や、Salesforce データ内の見えない文字やサポートされていない文字で問題が発生する場合に役立ちます。

Salesforce からのAPI 応答やデータに、無効または破損したUTF-8 シーケンスが含まれている場合があります。 これらは、適切な形式のUTF-8 コンテンツを期待するダウンストリームアプリケーションで、解析エラー、エクスポートの失敗、またはその他の問題を引き起こす可能性があります。

ReplaceInvalidUTF8Chars がtrue に設定されている場合、本製品 は無効なUTF-8 文字を '?' に置き換えて、厳密なエンコーディング準拠を実施するシステムでデータが安全に利用できるようにします。 これにより、データ取得エラーを防ぎ、エクスポートやレポートワークフローでの失敗を回避します。

このプロパティを有効にすると、厳密なUTF-8 準拠を必要とするシステムでのデータ互換性と安定性が確保されます。 ただし、文字を置き換えることで、無効な文字が非標準データの一部であった場合に、元の情報が失われる可能性があります。 データ結果でエンコーディングエラーや読み取り不可能な文字が発生する場合に、このプロパティを使用してください。

このプロパティは、クリーンで適切な形式のUTF-8 データを必要とし、エンコーディングの問題を許容できない外部アプリケーションやデータパイプラインで作業する場合に役立ちます。

デフォルトでは、本製品はSalesforce での実際の長さに関係なく、すべての選択リストフィールドを長さ255 で報告します。 これによりスキーマ定義が簡素化されますが、フィールド制約を正確に反映しない場合があります。

このプロパティがtrue に設定されている場合、本製品 は各選択リストフィールドをSalesforce メタデータで定義されている正確な長さで報告します。 これは、フィールドサイズ制約への厳密な準拠を必要とするアプリケーションや統合に役立ちます。

正確な長さを報告することで、スキーマ検出の複雑性が若干増加する可能性がありますが、データ検証とフォーム生成のための正確なメタデータが確保されます。 固定長の255 を使用するとスキーマ管理が簡素化されますが、値がSalesforce によって実際に実施される制限を超える場合に問題が発生する可能性があります。 このプロパティは、選択リストフィールドに対するSalesforce の正確なフィールド制約を尊重する必要があるシステムで作業する場合に有効にする必要があります。

このプロパティは、統合、フォーム、または検証ロジックを設計する際に選択リストフィールドの正確なメタデータを必要とする開発者やデータアーキテクトに役立ちます。

ほとんどの構成で標準的なライセンス機構をサポートしているため、通常はこのプロパティは不要です。 このプロパティの設定方法については、同梱のライセンスドキュメントを参照してください。このランタイムキーは、OEM ライセンスを購入した場合にのみ使用できます。

Warning： このプロパティの値は既存のすべてのライセンス情報よりも優先されます。ライセンスエラーを避けるため、提供されたランタイムキーが正しいことを確認してください。

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。

InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、要求するスコープを変更したい場合は、このプロパティまたはScope 入力を使用する必要があります。

Basic またはOAuthPassword 認証を使用する場合、Salesforce ではユーザーのパスワードに加えてセキュリティトークンが必要になる場合があります。 このトークンは追加のセキュリティ対策であり、通常、信頼されていないIP アドレスから、またはSalesforce で設定された信頼されたIP 範囲外からログインする際に使用されます。

セキュリティトークンを取得するには、Salesforce にログインし、設定 -> 私の個人情報 -> 私のセキュリティトークンのリセットに移動して、新しいトークンをリクエストします。 トークンは登録されたメールアドレスに送信されます。パスワードがリセットされた場合は、セキュリティトークンもリセットして新しいトークンを取得する必要があります。

このプロパティは、IP アドレスがSalesforce で定義された信頼されたIP 範囲内にない場合、または組織がセキュリティトークン要件を実施している場合にのみ必要です。

このプロパティは、信頼されていないネットワークからSalesforce に安全に接続する場合や、追加の検証を必要とするBasic 認証方法を使用する場合に役立ちます。

ServerSideAggregation がtrue に設定されている場合、本製品 は集計ロジックをSalesforce API にプッシュし、クライアント側の処理を削減して、小規模または構造化されたクエリの効率を向上させます。 ただし、サーバーサイドの集計には制限があります。例えば、非プライマリキーフィールドで2,000レコードを超える集計クエリを実行すると、Salesforce はEXCEEDED_ID_LIMIT エラーを返す場合があります。 このような場合、ServerSideAggregation をfalse に設定することで、本製品 はクライアントサイドで集計を実行し、この制限に達することなくクエリを完了できます。

サーバーサイドの集計を有効にすると、処理がSalesforce にオフロードされ、サポートされる操作と小さな結果セットでクエリ速度を大幅に向上させることができます。 ただし、非プライマリキーフィールドでの大規模な集計は、API 制限により失敗する可能性があります。 このプロパティを無効にすると、集計処理がクライアントに移行され、API エラーを回避できますが、ローカルリソースの使用量と処理時間が増加する可能性があります。

このプロパティは、大規模なデータセットや非プライマリキーフィールドで集計を行うクエリで作業する際に役立ち、Salesforce の集計機能の制限を処理する柔軟性を提供します。

本製品 は、提供された認証資格情報を使用してSalesforce でログインセッションを作成します。このセッションは、繰り返しの認証リクエストを避けるために、後続のクエリで再利用されます。

SessionTimeout プロパティは、このログインセッションがアクティブに保たれる時間を制御します。SessionTimeout を0に設定すると、セッションの再利用が完全に無効になり、プロバイダーはすべてのリクエストで認証を実行するようになります。 これは、より厳格なセキュリティが必要なシナリオや、短期間の資格情報ポリシーを扱う場合に役立ちます。

このプロパティは、Basic 認証とSSO 接続にのみ適用されます。OAuth は、セッションの有効期限とトークンの更新を異なる方法で処理するため、OAuth ベースの認証では使用されません。

パフォーマンスの考慮事項

このプロパティは、Basic 認証またはSSO に依存する環境でパフォーマンスの最適化とセキュリティ要件のバランスを取る際に役立ちます。

Salesforce の数式フィールドは、他のフィールド値に基づいて計算されるフィールドです。Salesforce 内でのレポートやデータ変換には有用ですが、外部からのクエリやデータロードには必ずしも必要ではない場合があります。

SkipFormulaFields がtrue に設定されている場合、本製品 は利用可能なカラムを一覧表示する際に、スキーマからすべての数式フィールドを除外します。 これにより、クエリでこれらのフィールドを必要としないユーザーにとって、スキーマが簡素化され、煩雑さが軽減されます。

数式フィールドを除外することで、スキーマ検出が高速化され、メタデータクエリで返されるカラム数が減少します。特に多数の数式フィールドを持つオブジェクトで効果的です。 ただし、レポートやクエリが数式値に依存している場合、これらのフィールドをスキップすることで機能が制限され、クエリ結果で利用可能なデータが少なくなる可能性があります。

このプロパティは、データモデルの合理化、メタデータ読み込み時間の改善、または直接保存されたデータフィールドのみに焦点を当てることを目的とする組織に役立ちます。

TranslatePickListFields が有効な場合、本製品 はユーザーのSalesforce 言語設定に基づいて選択リスト値を自動的に翻訳します。 ただし、翻訳が不要で、代わりに元の選択リスト値を返すべき特定のカラムがある場合があります。

SkipPickListTranslation プロパティでは、翻訳せずに元の選択リスト値を保持するカラムを指定できます。 カラムは、テーブル名で完全修飾（例：Table1.Col1）するか、コンテキストが明確な場合はカラム名のみで指定できます。

このプロパティは、レポート、エクスポートの一貫性、または翻訳されていない選択リスト値に依存する他のシステムとの統合のために、元の選択リスト値を保持する必要がある開発者やアナリストに役立ちます。

パフォーマンスの考慮事項

翻訳をスキップするカラムを指定することで、不要なAPI 翻訳オーバーヘッドを削減し、大規模なクエリでパフォーマンスを向上させることができます。 また、翻訳された値と外部システムの参照データとの不整合を回避するのにも役立ちます。 翻訳が意図せずスキップされることを防ぐため、リストされたカラムが正確であることを確認してください。

デフォルトでは、本製品 はSalesforce から返される順序と同じ順序でカラムを報告します。 本製品 によって追加されるメタデータカラムなどの疑似カラムが有効になっている場合、これらのカラムはカラムリストの最後に追加されます。

SortColumns がtrue に設定されている場合、本製品 は疑似カラムを含むすべてのカラムをアルファベット順で報告します。 これにより、メタデータを表示するユーザーインターフェースや開発ツールでカラムリストをナビゲートしやすくなります。

カラムのソートはクエリパフォーマンスに影響しませんが、メタデータの表示方法が変わります。 アルファベット順はカラムの発見しやすさを向上させることができますが、Salesforce が元来意図した論理的なグループ化や順序を認識しにくくなる可能性があります。 このプロパティは、開発者やユーザーが開発やレポートの利便性のために予測可能でアルファベット順にソートされたカラムリストに依存するシナリオで最も有用です。

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

証明書は、システムのトラストストアに基づいてマシンによって信頼されていると検証されています。使用されるトラストストアは、システムに指定された'javax.net.ssl.trustStore' 値になります。このプロパティに値が指定されていない場合は、Java のデフォルトのトラストストア（例えば、JAVA_HOME\lib\security\cacerts）が使用されます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

CData JDBC Driver for Salesforce 2025J はここで指定されたURL を使用してSAML 応答を処理し、サービスの資格情報と交換します。 取得した資格情報はSSO 接続時の最後の情報であり、Salesforce との通信に使用されます。

ID プロバイダーのログインURL。

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。SSOLoginURL と一緒に使用します。

SSO 設定については、 で詳しく説明します。

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

このプロパティは、本製品 が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、本製品 は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリはタイムアウトの値を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

デフォルトでは、本製品 はSalesforce に保存されている元の選択リスト値を取得します。 TranslatePickListFields がtrue に設定されている場合、本製品 は、ユーザーのSalesforce プロファイル設定に基づいて、これらの値をユーザーの優先言語に翻訳します。 これにより、選択リスト値がSalesforce UI でユーザーが見るものと一致する、馴染みのあるローカライズされた形式で表示されるようになります。

この設定は、翻訳により明確性と使いやすさが向上するレポート、ダッシュボード、ユーザー向けアプリケーションで特に有用です。 ただし、元の選択リスト値に依存するシステムやデータセットとの統合が必要な場合は、このプロパティを無効にしておく必要があります。

パフォーマンスの考慮事項

選択リストの翻訳を有効にすると、追加のAPI 呼び出しやメタデータ検索が発生する可能性があり、スキーマ検出時間やクエリオーバーヘッドがわずかに増加する場合があります。 さらに、翻訳されていない値を保存する外部システムとの整合性を保つには、このプロパティを無効にするか、選択的制御のためにSkipPickListTranslation を使用する必要があります。

このプロパティは、多言語環境をサポートし、各認証されたユーザーのローカル言語で選択リストフィールドを表示したい組織に役立ちます。

UseBulkAPI がtrue に設定されている場合、本製品 は読み取りと書き込みの両方にSalesforce のBulk API を使用します。 読み取りでは、本製品 は一括クエリジョブを作成し、結果が利用可能になると返し始めます。 JOIN や集計を含むクエリはBulk API でサポートされていないため、本製品 は自動的にSOAP API にフォールバックします。

書き込みでは、バッチあたり最大10,000レコードを送信できます。これらのリクエストは非同期であり、本製品 はSalesforce が操作を完全に処理するまで待機しません。 これらのジョブのステータスは、一時システムテーブルを使用して監視できます。次に例を示します。 SELECT * FROM Info#TEMP

このクエリは、ジョブとバッチID を返します。これらのID は、GetJob、GetBatch、およびGetBatchResults と組み合わせて使用し、ジョブの進行状況を追跡できます。

UseBulkAPI がfalse に設定されている場合、本製品 は読み取りと書き込みにSOAP API を使用します。 このモードでは、書き込みでもバッチ処理がサポートされますが、結果は同期的に返されます。

Bulk API は大規模なデータセットを非同期で処理するように最適化されており、大量のインポートとエクスポートに適しています。 ただし、結合や集計を含む複雑なクエリはサポートされておらず、SOAP API へのフォールバックが必要です。 書き込みでは、Bulk API は大量のレコードボリュームの効率的な処理を可能にしますが、非同期な性質により、ジョブの監視が必要になります。 SOAP API は操作に対して即座にフィードバックを提供し、小規模なトランザクションにより適しています。

このプロパティは、非同期処理が許容されるか、または好まれる大規模なデータ操作に役立ちます。

このプロパティは、頻繁な接続作成に関連するオーバーヘッドを削減し、接続の使用率が高いアプリケーションのパフォーマンスを向上させます。 接続プーリングが有効な場合、アプリケーションは各接続が不要になったら明示的に閉じる必要があります。 接続を閉じると、物理的に終了するのではなく、再利用できるようにプールに戻ります。 接続がPoolIdleTimeout 時間を超えてアイドル状態になると、本製品 は自動的に接続を閉じてリソースを解放します。

デフォルトでは、接続プーリングは無効になっています。追加のプロパティ（PoolMaxSize、PoolIdleTimeout、PoolWaitTime など）を使用すると、接続プールの動作をカスタマイズできます。 これらの設定は、プールサイズ、アイドル接続タイムアウト、および接続が利用可能になるまでの待機時間の細かい調整を可能にします。 接続プールの使用に関する詳細は、接続プール を参照してください。

デフォルトでは、本製品 は静的で開発者向けのSalesforce API 名を使用してカラム名を表示します。 UseDisplayNames がtrue に設定されている場合、本製品 はカラムの表示名を使用し、ユーザーがSalesforce UI で見るものと一致させます。 これにより、基本的なAPI 用語よりもSalesforce インターフェースに慣れているユーザーにとって、クエリとメタデータの操作がより直感的になります。

エンドユーザーやビジネスユーザー向けのレポートやクエリを作成する際に、Salesforce UI に表示されるフィールド名を期待する場合は、このプロパティを使用してください。

UseDisplayNames を有効にすると、API 名を表示名にマッピングするために必要な追加処理により、メタデータ処理時間がわずかに増加する可能性があります。 ただし、メタデータAPI 呼び出しの数は増加しません。 表示名はSalesforce 管理者によって変更される可能性があるため、これらを使用するとクエリの安定性が時間の経過とともに低下する可能性があります。長期的な連携では、一貫性のためにAPI 名を推奨します。

このプロパティは、UI ベースのレポートやビジネス向けクエリを構築する際の可読性とユーザーフレンドリーさを向上させる場合に役立ちます。

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューは本製品 によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Account WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみが本製品 によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。

UseSandbox がtrue に設定されている場合、本製品 は本番データとは別のテストおよび開発環境であるSalesforce サンドボックスアカウントに接続します。 正しく認証するには、ユーザー名にサンドボックス名を追加する必要があります。例えば、ユーザー名がuser でサンドボックス名がsandbox の場合、User プロパティをuser.sandbox として指定する必要があります。

Salesforce サンドボックス環境は、本番データに影響を与えることなく、開発、ステージング、またはテストに一般的に使用されます。 このプロパティにより、接続が正しい環境とエンドポイントに導かれることを確実にします。 このプロパティを設定することによる直接的なパフォーマンスへの影響はありませんが、サンドボックス環境では本番環境と比較してAPI 制限やリソースの可用性が異なる場合があります。 また、最近のリフレッシュが実行されていない限り、サンドボックスのメタデータとデータは本番環境と完全に同期されていない可能性があります。 このプロパティは、本番データに影響を与えることなく、クエリ、操作、統合を安全にテストする必要がある開発者、テスト担当者、管理者に役立ちます。

UseToolingAPI がtrue に設定されている場合、プロバイダーは標準のデータAPI の代わりにSalesforce の Tooling API を使用します。 Tooling API は開発、デプロイメント、デバッグタスク用に設計されており、メタデータタイプ、Apex クラス、トリガー、その他の開発関連エンティティへのアクセスを可能にします。

このプロパティは、メタデータオブジェクトをクエリしたり、Apex コードを検査したり、標準のREST またはSOAP API では利用できないその他の管理および開発関連の操作を実行したりする必要がある開発者に役立ちます。

UseToolingAPI がfalse に設定されている場合、本製品 は、メタデータや開発ツールよりもビジネスデータに焦点を当てた標準のSalesforce API を使用します。

Tooling API を使用すると、特殊なメタデータと開発オブジェクトにアクセスできますが、特定のエンティティタイプに限定されます。 大規模なデータ操作や標準のCRM レコードには適していません。このプロパティを有効にしても通常のデータクエリのパフォーマンスには影響しませんが、メタデータやツールクエリにのみ関係します。

このプロパティは、Salesforce 開発環境内でのメタデータ検査、Apex 監視、デプロイメントのデバッグなどのタスクに役立ちます。

このプロパティは、本製品 がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

WaitForBulkResults がfalse に設定されている場合、本製品 は一括データ変更操作をSalesforce に送信し、ジョブの処理完了を待機せずに即座に制御を返します。 これにより実行は高速になりますが、結果の詳細はまだ利用できません。この場合、Info#TEMP テーブルには作成されたバッチまたはジョブに関する情報が含まれており、ストアドプロシージャと組み合わせて使用し、最終結果を手動で取得できます。

WaitForBulkResults がtrue に設定されている場合、本製品 は各一括操作の処理がSalesforce で完了するまで待機してから結果を返します。 これにより、LastResultInfo#TEMP テーブルに、ID、ステータス値、エラーメッセージなど、影響を受けた各行の詳細情報が追加のクエリを必要とせずに含まれます。

結果の取得

Info#TEMP またはLastResultInfo#TEMP で見つかったジョブとバッチID は、ストアドプロシージャと組み合わせて使用し、詳細なジョブとバッチの結果を取得できます：

• Bulk API v1： GetJob、GetBatch、GetBatchResults
• Bulk API v2： GetJobInfoV2、QueryResultsV2

パフォーマンスの考慮事項

結果を待機しないことで実行時間が短縮され、アプリケーションをより早く継続できますが、成功または失敗を追跡するための追加のフォローアップステップが必要になります。 このプロパティを有効にすると、処理時間が増加しますが、単一の操作で詳細な結果を提供します。

このプロパティは、一括データ変更ワークフローにおいて、スピードと詳細な操作の洞察のバランスを取る際に役立ちます。