REST サービスへの接続

RESTful リソースの Uniform Resource Identifier（URI）または絶対ファイル パス

HTTP 認証で使用されるスキーム。NTLM、BASIC、DIGEST、または NONE エントリを指定できます。

• NTLM Windows 資格情報で認証します。
• BASIC ユーザー名とパスワードはサーバーで base64 にエンコードされます。
• DIGEST ユーザー名とパスワードは渡されず、ハッシュが渡されます。
• NONE プレーン テキスト パスワードとユーザー名。

OAuth フローの付与タイプ。次のオプションを使用できます。

• CODE
• CLIENT
• PASSWORD

このプロパティは、Content-Type や From など、他のプロパティから作成された HTTP 要求ヘッダーに追加される HTTP ヘッダーの文字列に設定することができます。

ヘッダーの形式は、HTTP 仕様の規定に従い、"header: value" にする必要があります。各ヘッダーは独自の行に入ります。

このオプションは慎重に使用してください。無効なヘッダーが含まれる場合、HTTP 要求が失敗することがあります。このプロパティは、専用または非標準 API と統合するために、微調整する際に有用です。

Content-Type: text/html; charset=utf-8

Connection: keep-alive

特定の使用例でのみ必要な非表示のプロパティ。通常、何も入力する必要がありません。セミコロン区切りで複数のプロパティを指定します。

キャッシュ構成

• CachePartial=True 列のサブセットのみをキャッシュに保存します。これはクエリで指定できます。
• QueryPassthrough=True 指定されたクエリを、ドライバーの SQL パーサーを使用する代わりに、キャッシュデータベースに渡します。

統合と形式

• SupportAccessLinkedMode Access のリンク モードでは、ほとんどのデータソースが複数 ID クエリをサポートしないため、一般的に、常にキャッシュを使用することをお勧めします。ただし、Access でドライバーを使用せず、リンク モードで使用する場合、このプロパティを False に設定し、特定のテーブルに対する SELECT * クエリのキャッシュの使用を回避する必要があります。
• DefaultColumnSize データソースがメタデータで列長を提供しないときに、文字列フィールドのデフォルト長を設定します。デフォルト値は 2000 です。
• ConvertDateTimeToGMT コンピューターのローカル時刻の代わりに、日付時刻値を GMT (UTC) に変換するかどうか。
• RecordToFile=filename 基本のソケット データ転送を指定されたファイルに記録します。

OAuth プロパティ

• InitiateOAuth このプロパティを設定すると、接続するときに、プロセスを開始して、OAuth アクセス トークンを取得または更新します。次のオプションを使用できます。

  • OFF OAuth フローが完全に自分によって処理されることを示します。OAuthAccessToken は認証で必要です。

  • GETANDREFRESH OAuth フロー全体がドライバーによって処理されることを示します。現在、トークンが存在しない場合、ブラウザー経由で確認することで取得します。トークンが存在する場合は、必要に応じて更新されます。

  • REFRESH ドライバーが OAuthAccessToken の更新のみを処理することを示します。ブラウザー経由で認証するようにドライバーによって確認されることはありません。最初に OAuthAccessToken と OAuthRefreshToken の取得を処理する必要があります。

• OAuthSettingsLocation InitiateOAuth が true に設定されているときに、OAuth 値が保存される設定ファイルの場所。InitiateOAuth が有効な場合、ドライバーは OAuth 値を設定ファイルに保存し、OAuth 接続プロパティを手動で入力するようにユーザーに要求することを回避します。OAuth セッションが期限切れになると、InitiateOAuth が設定されていれば、ドライバーは自動的に新しいアクセス トークンを取得します。InitiateOAuth が有効で、OAuthSettingsLocation が定義されていない場合、ドライバーはデフォルト設定ファイルの %AppData%\CData\REST Data Provider\OAuthSettings.txt（Windows）を使用します。macOS では、このファイルは ~/Library/Application Support/CData/REST Data Provider/OAuthSettings.txt にあります。Linux では、~/cdata/.config です。

• OAuthAcccessToken OAuthAccessToken は、認証処理の一部として OAuth サーバーから取得します。アクセス トークンには、サーバー依存のタイムアウトがあり、要求間で再利用できます。アクセス トークンは、ユーザー名とパスワードの代わりに使用されます。アクセス トークンは、サーバーで課すことによって、資格情報を保護します。

• OAuthAccessTokenSecret OAuthAccessTokenSecret は、認証処理の一部として、OAuth サーバーから取得されます。OAuthAccessToken を使用し、タイムアウトするまで、複数の要求を使用できます。

• OAuthRefreshToken OAuthRefreshToken プロパティは、OAuth 認証を使用するときに、OAuthAccessToken を更新するために使用されます。

field1=value1&field2=value2&field3=value3

JSON または XML ドキュメントを解析し、メタデータを生成するときに使用するデータ モデルを指定します。

• ドキュメント ドキュメントごとの行を表す単一テーブルが返されます。このデータ モデルでは、ネストされたドキュメント（オブジェクト配列）は平坦化されず、集計として返されます。XPath 値が明示的に指定されていない場合、ドライバーは検出された最上位のドキュメント（オブジェクト配列）を XPath として特定し、使用します。
• FlattenedDocuments JSON または XML ファイルの使用可能なドキュメントの JOIN を表す単一テーブルが返されます。このデータ モデルでは、ネストされた XPath 値は SQL JOIN と同じ方法で機能します。また、ネストされた兄弟 XPath 値（同じ高さの子パス）は、SQL CROSS JOIN として処理されます。明示的に指定されない場合、ドライバーは、JSON または XML ファイルを解析し、使用可能なドキュメント（ネストされたドキュメントを含む）を特定して、使用可能な XPath 値を特定します。
• 関係 複数のテーブルが返されます。各 XPath の 1 つが指定されます。このデータ モデルでは、ネストされたドキュメント（オブジェクト配列）が、関係テーブルおよび主キー、外部キーとして返されます。明示的に指定されない場合、ドライバーは、JSON または XML ファイルを解析し、使用可能なドキュメント（ネストされたドキュメントを含む）を特定して、使用可能な XPath 値を特定します。

デフォルトでは、配列でネストされたオブジェクトは、JSON または XML の文字列として返されます。FlattenArrays プロパティを使用して、ネストされた配列の要素を固有の列に平坦化できます。FlattenArrays を、ネストされた配列から返す要素数に設定します。

FlattenArrays を -1 に設定すると、ネストされた配列のすべての要素を平坦化します。

解析されたドキュメントからスキーマ ファイル (RSD) を生成するかどうかを指定します。

• Never スキーマ ファイル (RSD) は生成されません。
• OnUse テーブルのスキーマ ファイル (RSD) が存在しない場合、初めてテーブルが参照されるときに、スキーマ ファイル (RSD) が生成されます。
• OnStart 現在スキーマ ファイル (RSD) がないテーブルに対して、接続時に、スキーマ ファイル (RSD) が生成されます。

このプロパティは、Format、URI、XPath、および Location とともに使用されます。

XML/JSON ドキュメント内の同じ高さで繰り返す要素の Path（JSON ドキュメントを複数の行に分割するのに使用されます）。

複数のパスは、セミコロン区切りのリストで指定できます。DataModel 設定では、テーブルを作成し、データを表示するために XPath 値がどのように使用されるのかを構成できます。

テーブルの列を動的に決定するときにスキャンする行数。スキーマ（RSD）ファイルがテーブルで使用できないとき（GenerateSchemaFiles を使用するときなど）には、列が動的に決定されます。値が大きいと、要求が長くなりますが、より正確になります。

この値を 0（ゼロ）に設定すると、文書全体が解析されます。

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

指定されていない場合は、コンピューターが信頼するすべての証明書が許可されます。

'*' を使用すると、すべての証明書を許可することを示します（セキュリティの問題のため推奨されません）。

• -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
• C:\cert.cer
• -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
• ecadbdda5a1529c58a1e9e09828d70e4
• 34a929226ae0819f2ec14b4a3d904f801cbb150d

主キー列の最大長。

一部の ODBC ツールでは、主キー列の長さが特定の値を超えることができません。このプロパティでは、ODBC ドライバーが主キー列のすべての報告された列を無効にします。Microsoft Access Linked データソースとして ODBC ドライバーを使用するときには、特に注意してください。

LimitKeySize を 0 に接続すると、キー長が元の長さに戻ります。

このプロパティは、列が SQL_LONGVARCHAR として返されるかどうかを制御します。

一部のアプリケーションでは、特定の文字数よりも大きいすべてのテキスト データを SQL_LONGVARCHAR として報告する必要があります。これを使用すると、指定されたサイズよりも大きい列をマッピングし、SQL_VARCHAR ではなく、SQL_LONGVARCHAR として報告されます。

擬似列を列としてテーブルに含めるかどうかを指定します。

この設定は、テーブル列ではない場合に、擬似列の値を設定できない Entity Framework で特に有用です。

アスタリスク（*）文字を使用すると、すべてのテーブルとすべての列を含めることができます。例：*=*

Table1=Column1, Table1=Column2, Table2=Column3

この値は、ProxyServer および ProxyPort で指定された HTTP プロキシで認証するために使用する認証タイプを指定します。

ドライバーはデフォルトでシステム プロキシ設定を使用し、さらなる構成は必要ありません。別のプロキシに接続する場合は、ProxyAutoDetect を false に設定し、ProxyServer と ProxyPort も false に設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要に応じて、ProxyUser と ProxyPassword を設定します。

認証タイプは次のいずれかにすることができます。

• BASICHTTP BASIC 認証を実行します。
• DIGEST HTTP DIGEST 認証を実行します。
• NEGOTIATE 認証に適したプロトコルに基づき、NTLM または Kerberos トークンを取得します。
• PROPRIETARY NTLM または Kerberos token を生成しません。HTTP 要求の承認ヘッダーでこのトークンを指定する必要があります。

ProxyServer プロキシに接続するときに使用する SSL タイプ。

• AUTO デフォルト設定。URL が HTTPS URL の場合、TUNNEL オプションを使用します。URL が HTTP URL の場合、コンポーネントは NEVER オプションを使用します。
• ALWAYS 接続は常に SSL 有効です。
• NEVER 接続は SSL 有効ではありません。
• TUNNEL 接続はトンネル プロキシ経由です。プロキシ サーバーはリモート ホストへの接続を開き、トラフィックはプロキシ経由で前後します。

プロキシ サーバー経由での接続から除外されるホストまたは IP のセミコロン区切りのリスト。

デフォルトでシステム プロキシ設定を使用します。追加の構成は必要ありません。この接続のプロキシ例外を明示的に構成する場合は、ProxyAutoDetect を false に設定し、ProxyServer と ProxyPort を構成する必要があります。認証するには、ProxyAuthScheme を設定し、必要に応じて、ProxyUser と ProxyPassword を設定します。