Cloud

Build 25.0.9540
  • Microsoft SharePoint Excel
    • はじめに
      • 接続の確立
      • データアクセスのファインチューニング
      • トラブルシューティング
      • Kerberos の使用
      • SSL の設定
      • ファイアウォールとプロキシ
    • Data Model
      • OData API
      • REST API
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
      • データ型マッピング
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • URL
        • User
        • Password
        • SharePointVersion
        • STSURL
        • UseNTLMV1
      • Connection
        • DefineTables
        • File
        • Folder
        • Header
        • Library
        • IgnoreCalcError
        • MaxRows
        • TypeDetectionScheme
        • UseRESTAPI
      • SSO
        • SSOLoginURL
        • SSODomain
        • SSOProperties
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • IncludeNavigationParentColumns
        • PseudoColumns
        • RowScanDepth
        • ShowEmptyRows
        • ThrowsKeyNotFound
        • Timeout
    • Third Party Copyrights

Microsoft SharePoint Excel - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるExcel Services へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してExcel Services に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Excel Services への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Excel Services は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのExcel Services への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Excel Services への接続

接続の確立 は、CData Cloud にデータベースを作成するためのExcel Services への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してExcel Services からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Excel Services に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

このセクションでは、SharePoint Online およびSharePoint On Premises への接続に関する詳細について説明します。

ワークブックへの接続

使用しているSharePoint のエディションに関わらず、File をExcel ワークブックに設定します。このパスは次のプロパティからの相対パスです。

  • Library:デフォルトでは、Shared Documents ライブラリが使用されます。このプロパティを使って、組織内の別のドキュメントライブラリを指定できます。例えば、OneDrive for Business に接続する場合は、このプロパティを"Documents" に設定します。
  • Folder:このプロパティを使って、ライブラリ内のサブフォルダへのパスを指定できます。パスはLibrary で指定されたライブラリ名と関連があります。

テーブルとしてのスプレッドシートデータへの接続

Cloud は、基底のAPI の使用可能なオブジェクトに基づいて使用可能なテーブルを検出します。

API は異なるAPI オブジェクトを表示します。スプレッドシートの構成とSharePoint のバージョンに基づいてAPI を選択します。

  • OData: OData API を使用すると、Excel で[挿入]->[テーブル]をクリックして作成されたExcel テーブルオブジェクト(範囲やスプレッドシートではありません)から定義されたテーブルにアクセスできます。OData API に接続する際、ワークブックにテーブルオブジェクトが定義されていない場合は、Cloud がテーブルを返さないことがあります。テーブルとしてスプレッドシートまたは範囲に接続するには、UseRESTAPI をtrue に設定します。
  • REST: REST API を使用すると、Excel テーブルオブジェクト、範囲、およびスプレッドシートから定義されたテーブルへのアクセスを可能にします。これはデフォルトのAPI です。範囲およびスプレッドシートから多数の行をリクエストすることはREST API によって制限されており、Cloud では返される行数をデフォルトで100に制限しています。またCloud は、デフォルトで1行目からカラム名を検出します。これを無効にするには、Header を設定します。

DefineTables を追加設定すると、Excel の範囲の構文を使用して、範囲に基づいてテーブルを定義できます。大きすぎる範囲は、API によって制限されます。

Cloud がテーブルを検出してそれらをクエリする方法について、詳しくはData Model を参照してください。

SharePoint オンプレミスへの接続

URL をサーバー名もしくはIP アドレスに設定します。さらに、SharePointVersion および認証値を設定します。

SharePoint OnPremises を認証するには、AuthScheme を認証タイプに設定し、必要に応じてUser およびPassword を設定します。

Note:SharePoint On-Premises 2010に接続する場合は、 UseRESTAPI をtrue に設定する必要があります。

  • Windows(NTLM)

    これは最も一般的な認証タイプです。そのため、Cloud はNTLM をデフォルトとして使用するように事前設定されています。Windows のUser およびPassword を設定して接続します。

  • Kerberos

    Kerberos で認証する方法についての詳細は、Kerberos の使用 を参照してください。

  • Forms

    この設定で、Active Directory の代わりにカスタム認証メソッドによる認証が可能になります。この認証タイプを使用するには、AuthScheme をFORMS に設定し、User およびPassword を設定します。

  • ADFS

    AuthScheme をADFS に設定します。次の接続プロパティを設定する必要があります。

    • User:ADFS ユーザーに設定。
    • Password:ユーザーのADFS パスワードに設定。
    • SSOLoginURL:ADFS サーバーのWS-Trust エンドポイントに設定。
    次のSSOProperties がADFS への認証に必要です。
    • RelyingParty:SharePoint のADFS サーバー上の証明書利用者の識別子の値です。
    以下は接続文字列の例です。
    AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;SSOLoginURL=https://<authority>/adfs/services/trust/2005/usernamemixed;SSO Properties ='RelyingParty=urn:sharepoint:sp2016;';

  • Anonymous Access

    Set the AuthScheme to NONE along with the URL.

CData Cloud

データアクセスのファインチューニング

データアクセスのファインチューニング

高度なインテグレーションで簡単にデータにアクセスできるようにするには、次のクエリを使うことができます:

  • TypeDetectionScheme:このプロパティを使って、RowScanDepth で指定された値に基づく自動型検出を有効化/無効化できます。
  • RowScanDepth:このプロパティは、カラムのデータ型を判定するためにスキャンされる行数を指定します。

CData Cloud

トラブルシューティング

Troubleshooting

413 Request Entity Too Large

This error occurs when a workbook has too much data per row. Generally, solution to this error will be to make the Excel table smaller or to make the rows less dense.

However, setting the following connection properties will enable you to work around this limitation. Note: This workaround is only supported when using the REST API.

  • DefineTables: Set this to the desired cell range in your sheet.
  • Other: Set this to PageSize=X to determine the number of records that will be paged through at once. Each page should contain less than 100kb. Note that smaller page sizes also entail slower perfomance.

CData Cloud

Kerberos の使用

Kerberos

Kerberos でExcel Services への認証を行うには、AuthScheme をNEGOTIATE に設定します。

Kerberos 経由でExcel Services への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。

Kerberos チケットの取得

Kerberos チケットは、依頼者のID を認証するために使用されます。正式なログイン / パスワードの代わりにチケットを使用することで、パスワードをローカルに保存したり、ネットワーク経由で送信したりする必要がなくなります。 ユーザーは、ローカルコンピュータでログインするか、 コマンドプロンプトでkinit USER と入力するたびに、再認証されます(チケットはリフレッシュされます)。

Cloud は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。

MIT Kerberos 資格情報キャッシュファイル

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。

このオプションは、KRB5CCNAME がシステムに作成されている必要があります。

MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには:

  1. お使いの環境にKRB5CCNAME 変数が存在することを確認します。
  2. KRB5CCNAME を資格情報キャッシュファイルを指すパスに設定します。(例えば、C:\krb_cache\krb5cc_0 または/tmp/krb5cc_0 です。)資格情報キャッシュファイルは、MIT Kerberos チケットマネージャーを使用してチケットを生成するときに作成されます。
  3. チケットを取得するには:
    1. MIT Kerberos チケットマネージャーアプリケーションを開きます。
    2. Get Ticket をクリックします。
    3. プリンシパル名とパスワードを入力します。
    4. OK をクリックします。

    チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。

Cloud はキャッシュファイルを使用してExcel Services に接続するためのKerberos チケットを取得します。

Note: KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Cloud は指定されたキャッシュファイルを使用してExcel Services に接続するためのKerberos チケットを取得します。

Keytab ファイル

お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。

この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

お使いの環境にKRB5CCNAME 環境変数およびKerberosKeytabFile プロパティが設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。

この方法を使用するには、User およびPassword プロパティを、Excel Services での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム認証の有効化

より複雑なKerberos 環境では、複数のレルムおよびKDC サーバーが使用されるクロスレルム認証が必要になる場合があります。例えば、1つのレルム / KDC がユーザー認証に使用され、別のレルム / KDC がサービスチケットの取得に使用される場合です。

このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

Data Model

Cloud は、SharePoint 2013で導入されたREST API およびOData API を通じて、SharePoint オンプレミスからExcel データを取得することをサポートします。Excel ファイルは、Excel 2007 以降で使用されている.xlsx 形式である必要があります。

Note: Microsoft はSharePoint Online のExcel Services API を2022年2月に終了する予定であることを表明しました。 今後、SharePoint データにアクセスする際には、CData Cloud for Excel Online への移行をご検討ください。

Cloud は、以下に基づいてワークブック内のテーブルを検出できます。

  • スプレッドシート
  • Excel テーブル
  • 範囲
次のセクションでは、使用可能なAPI オブジェクトについて詳しく説明します。

動的なメタデータクエリ

動的なメタデータクエリを通じて、Excel テーブルやスプレッドシートの追加やカラムの変更などのExcel でのあらゆる変更は、再接続時に反映されます。

テーブル検出の設定

OData API とREST API(デフォルト)はそれぞれ異なるAPI オブジェクトを表示します。ワークブックの構成とExcel Services のバージョンに基づいて、使用するAPI を選択します。

Excel テーブルへの接続

OData API は、スプレッドシートの[挿入]->[テーブル]で定義したExcel テーブルのみ表示します。

スプレッドシート、範囲、およびExcel テーブルへの接続

Excel テーブルの外のデータにアクセスする必要がある場合は、UseRESTAPI をtrue に設定します。REST API を使用すると、スプレッドシート、範囲、およびExcel テーブルにデータベーステーブルとしてアクセスできます。

スプレッドシートと範囲へのSQL の実行について、詳しくはREST API を参照してください。

SharePoint バージョンでサポートされているAPI

次のテーブルは、各SharePoint バージョンで使用できるAPI を示しています。

SharePoint バージョン利用可能なAPI
SharePoint OnlineREST またはOData
SharePoint オンプレミス 2016REST またはOData
SharePoint オンプレミス 2013REST またはOData
SharePoint オンプレミス 2010REST

CData Cloud

OData API

OData プロトコルを使う場合、スプレッドシート内のExcel テーブルで定義されたデータのみにアクセスできます。このデータは、Excel で[挿入]->[テーブル]をクリックして作成します。

テーブルオブジェクトの外にデータがある場合には、OData API 経由での取得はできません。この場合には、テーブルが返されません。 これはOData API の仕様であり、この場合にはREST API の使用を検討してください。

CData Cloud

REST API

REST API を使用している場合は、次のテーブルからデータを選択できます。

  • ワークブック内のスプレッドシート
  • Excel テーブルオブジェクト
  • DefineTables で指定する範囲

名前衝突の解決

2つ以上のテーブルが同じ名前を持つ場合、Cloud は衝突を解決するために、次の優先順位を使用します:[範囲]->[Excel テーブル]->[シート]の降順。

次に例を示します。MyTable がDefineTables にあり、同じ名前のExcel テーブルがワークブックにあります。DefineTables で指定された定義はExcel テーブルをオーバーライドします。

スプレッドシートから選択

スプレッドシートからデータを選択するには、FROM 句でスプレッドシート名を指定します。デフォルトでは、1行目はカラム名の定義に使われます。Header をfalse に設定すると、自動カラム名検出を無効にできます。

データの範囲はA1:Z100 です。異なる範囲を指定するには、DefineTables を使用します。

Excel テーブルから選択

Excel テーブルオブジェクトからデータを選択するには、FROM 句でテーブル名を指定します。これらはExcel で[挿入]->[テーブル]をクリックして作成されたテーブルです。

範囲から選択

標準のExcel 形式を使用して範囲を定義できます。範囲をDefineTables のテーブル名にマッピングします。

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Excel Services のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Account テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Account' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのExcel Services プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Account テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Account' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、Data Model セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

データ型マッピング

データ型のマッピング

Cloud は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

Excel Services (OData V3) Excel Services (OData V4) CData スキーマ
Edm.Binary Edm.Binary binary
Edm.Boolean Edm.Boolean bool
Edm.DateTime Edm.DateTimeOffset datetime
Edm.Double Edm.Double double
Edm.Guid Edm.Guid guid
Edm.Int32 Edm.Int32 int
Edm.String Edm.String string
Edm.TimeOfDay Edm.TimeOfDay time

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
AuthSchemeSpecifies the authentication scheme the provider uses to connect. Set this to one of the following values: NTLM, Basic, Digest, Forms, Negotiate, ADFS, or None.
URLSpecifies the base URL of the SharePoint site or site collection the provider connects to.
UserSpecifies the username for the account used to authenticate to the server.
PasswordSpecifies the password for the user account used to authenticate to the server.
SharePointVersionSpecifies the version of the SharePoint server that the provider connects to.
STSURLSpecifies the URL of the security token service (STS) used for single sign-on (SSO) with ADFS.
UseNTLMV1Specifies whether the provider uses the NTLMv1 authentication protocol instead of the default NTLMv2.

Connection


プロパティ説明
DefineTablesSpecifies custom table definitions by mapping table names to sheet ranges in the spreadsheet. Use name-value pairs in the form TableName=SheetName!Range.
FileSpecifies the name of the Excel file to connect to, including the .xlsx extension.
FolderSpecifies the folder path within the document library where the file specified in the File property is located.
HeaderSpecifies whether the first row of the sheet contains column names when using the REST API.
LibrarySpecifies the name of the document library that contains the Excel file you want to connect to.
IgnoreCalcErrorSpecifies whether the provider should ignore formula calculation errors in Excel worksheets.
MaxRowsSpecifies the maximum number of rows the provider returns when a query does not include aggregation or grouping.
TypeDetectionSchemeSpecifies how the provider determines the data types of columns in a worksheet.
UseRESTAPISpecifies whether the provider uses the SharePoint REST API instead of the OData API to retrieve data.

SSO


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSODomainSpecifies the domain associated with the user account when using single sign-on (SSO).
SSOPropertiesID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
IncludeNavigationParentColumnsSpecifies whether the provider includes non-key parent columns in views generated from navigation properties.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
RowScanDepthテーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
ShowEmptyRowsSpecifies whether the provider includes empty rows when reading data from a worksheet.
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
AuthSchemeSpecifies the authentication scheme the provider uses to connect. Set this to one of the following values: NTLM, Basic, Digest, Forms, Negotiate, ADFS, or None.
URLSpecifies the base URL of the SharePoint site or site collection the provider connects to.
UserSpecifies the username for the account used to authenticate to the server.
PasswordSpecifies the password for the user account used to authenticate to the server.
SharePointVersionSpecifies the version of the SharePoint server that the provider connects to.
STSURLSpecifies the URL of the security token service (STS) used for single sign-on (SSO) with ADFS.
UseNTLMV1Specifies whether the provider uses the NTLMv1 authentication protocol instead of the default NTLMv2.
CData Cloud

AuthScheme

Specifies the authentication scheme the provider uses to connect. Set this to one of the following values: NTLM, Basic, Digest, Forms, Negotiate, ADFS, or None.

Possible Values

NTLM, Basic, Digest, Forms, None, Negotiate, ADFS

データ型

string

デフォルト値

"NTLM"

解説

Used with User and Password to authenticate against the server.

Use one of the following options:

  • NTLM: Uses your Windows credentials to authenticate.
  • Basic: Uses HTTP Basic authentication.
  • Digest: Uses HTTP Digest authentication.
  • Forms: Uses Forms authentication.
  • Negotiate: The Cloud negotiates the authentication mechanism with the server. Use this to enable Kerberos authentication.
  • ADFS: Uses Single Sign-On authentication with Active Directory Federation Services (ADFS).
  • None: Uses anonymous authentication.

CData Cloud

URL

Specifies the base URL of the SharePoint site or site collection the provider connects to.

データ型

string

デフォルト値

""

解説

This property specifies the full base URL of the SharePoint site or site collection where your Excel file is stored.

The Cloud uses this URL to construct additional requests to access files, metadata, and resources within the site.

Examples of valid values:

  • http://server/SharePoint/
  • http://server/Sites/mysite/
  • http://server:90/

Use this property to establish the root connection point for all SharePoint operations.

CData Cloud

User

Specifies the username for the account used to authenticate to the server.

データ型

string

デフォルト値

""

解説

This property specifies the username for the account the Cloud uses to authenticate to the SharePoint server.

It is used together with the Password property.

The required username format may vary depending on the authentication scheme. For example, domain\username which is typically used in NTLM or Kerberos environments or [email protected] for ADFS or Forms authentication.

Use this property when the selected authentication scheme requires user credentials.

CData Cloud

Password

Specifies the password for the user account used to authenticate to the server.

データ型

string

デフォルト値

""

解説

This property, along with the User property, provides the credentials the Cloud uses to authenticate to the server.

The password must match the account specified in the User property and must be valid for the authentication scheme in use.

Use this property when the selected authentication scheme requires a password-based login.

CData Cloud

SharePointVersion

Specifies the version of the SharePoint server that the provider connects to.

Possible Values

SharePoint 2013, SharePoint 2010

データ型

string

デフォルト値

"SharePoint 2013"

解説

This property specifies the version of SharePoint Server running on the target environment.

Accepted values are:

  • SharePoint 2010
  • SharePoint 2013

CData Cloud

STSURL

Specifies the URL of the security token service (STS) used for single sign-on (SSO) with ADFS.

データ型

string

デフォルト値

""

解説

This property specifies the URL of the security token service (STS) used to request authentication tokens during single sign-on (SSO).

It is required only when AuthScheme is set to ADFS and the SSO flow uses a locally hosted Active Directory Federation Services (ADFS) instance.

Use this property when connecting to a SharePoint environment secured by an on-premises ADFS server.

CData Cloud

UseNTLMV1

Specifies whether the provider uses the NTLMv1 authentication protocol instead of the default NTLMv2.

データ型

bool

デフォルト値

false

解説

This property controls which version of the NTLM authentication protocol the Cloud uses to connect to the server.

If set to true, the Cloud uses NTLMv1.

If set to false, it uses the more secure NTLMv2.

Use this property only if the server explicitly requires NTLMv1 and does not support NTLMv2.

CData Cloud

Connection

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。


プロパティ説明
DefineTablesSpecifies custom table definitions by mapping table names to sheet ranges in the spreadsheet. Use name-value pairs in the form TableName=SheetName!Range.
FileSpecifies the name of the Excel file to connect to, including the .xlsx extension.
FolderSpecifies the folder path within the document library where the file specified in the File property is located.
HeaderSpecifies whether the first row of the sheet contains column names when using the REST API.
LibrarySpecifies the name of the document library that contains the Excel file you want to connect to.
IgnoreCalcErrorSpecifies whether the provider should ignore formula calculation errors in Excel worksheets.
MaxRowsSpecifies the maximum number of rows the provider returns when a query does not include aggregation or grouping.
TypeDetectionSchemeSpecifies how the provider determines the data types of columns in a worksheet.
UseRESTAPISpecifies whether the provider uses the SharePoint REST API instead of the OData API to retrieve data.
CData Cloud

DefineTables

Specifies custom table definitions by mapping table names to sheet ranges in the spreadsheet. Use name-value pairs in the form TableName=SheetName!Range.

データ型

string

デフォルト値

""

解説

This property allows you to define custom tables in your spreadsheet by mapping each table name to a specific sheet and cell range. These tables are used when querying the data.

Use a comma-separated list of name-value pairs in the format TableName=SheetName!Range. TableName is the name that appears in queries. SheetName is the name of the worksheet, and Range is the cell range containing the data.

For example:

DefineTables="DefinedTable1=Sheet1!A1:N25,DefinedTable2=Sheet2!C3:M53"

In this example, the Cloud defines two tables. The first table is called "DefinedTable1" and points to the range A1 through N25 on the worksheet named "Sheet1". The second table, "DefinedTable2", points to cells C3 through M53 on "Sheet2". These tables appear in the list of available tables when querying the spreadsheet.

If a custom-defined table shares a name with a default-discovered table (such as one based on a worksheet), the custom table overrides the default.

CData Cloud

File

Specifies the name of the Excel file to connect to, including the .xlsx extension.

データ型

string

デフォルト値

""

解説

This property specifies the name of the Excel workbook that the Cloud connects to. Include the ".xlsx" file extension in the name.

The file must exist in the location that the Cloud is configured to search. If the file does not exist, the connection will fail.

CData Cloud

Folder

Specifies the folder path within the document library where the file specified in the File property is located.

データ型

string

デフォルト値

""

解説

This property specifies the full, hierarchical path to the subfolder within the document library where the File is stored.

Use forward slashes to separate folder levels. For example, if the file is stored in a folder called "SubFolder" inside a folder called "BaseFolder", set this property to "/BaseFolder/SubFolder/".

The folder path must begin and end with a forward slash.

CData Cloud

Header

Specifies whether the first row of the sheet contains column names when using the REST API.

データ型

bool

デフォルト値

true

解説

This property determines how the Cloud names columns when reading data using the REST API and only applies when UseRESTAPI is set to true.

If this property is set to true, the Cloud uses the values in the first row as column names.

If this property is set to false, the Cloud assigns pseudo-column names such as A, B, C, and so on.

Use this property when your data includes column headers in the first row and you want the query results to reflect those names.

CData Cloud

Library

Specifies the name of the document library that contains the Excel file you want to connect to.

データ型

string

デフォルト値

""

解説

This property specifies the name of the document library that contains the Excel file the Cloud connects to.

If you do not set this property, the Cloud defaults to using the "Shared Documents" library.

To connect to OneDrive for Business, set this property to "Documents".

If your SharePoint site uses a language other than English, enter the localized name of the document library. For example, in French-language SharePoint sites, the library might be named "Documents partagés".

To find the correct library name:

  1. Navigate to your SharePoint site collection.
  2. Open the document library page.
  3. Click the settings (gear) icon and select Library settings.
  4. Under List Information, look for the Web Address field.
  5. The last segment in the web address typically reflects the library name.

For example, if your SharePoint site is in French, the URL might look like this: https://YourSharePointSite/subSites/.../Documents%20partages/Forms/AllItems.aspx

In this case, the document library name is Documents partagés.

Use this property when your Excel file is stored outside the default library or in a OneDrive for Business account.

CData Cloud

IgnoreCalcError

Specifies whether the provider should ignore formula calculation errors in Excel worksheets.

データ型

bool

デフォルト値

true

解説

This property controls how the Cloud handles formula calculation errors when reading Excel data.

If set to true, the Cloud ignores any errors that occur during formula evaluation. While this may result in unreliable values for calculated fields, other non-calculated data remains accurate.

If set to false, the Cloud stops processing if a calculation error occurs.

Use this property when you want to load available data despite potential issues in calculated cells.

CData Cloud

MaxRows

Specifies the maximum number of rows the provider returns when a query does not include aggregation or grouping.

データ型

string

デフォルト値

"-1"

解説

This property controls the number of rows the Cloud returns when running a query without aggregation or GROUP BY clauses.

Set this property to a positive integer to limit the number of rows returned. Set it to -1 to return all available rows.

Limiting rows can improve performance when previewing data in design-time environments such as business intelligence tools or query builders.

Use this property when working with large datasets and you want to avoid loading the entire result set during development or metadata exploration.

CData Cloud

TypeDetectionScheme

Specifies how the provider determines the data types of columns in a worksheet.

Possible Values

None, RowScan

データ型

string

デフォルト値

"RowScan"

解説

This property controls how the Cloud determines the data types of columns when reading Excel data.

Available options:

  • None: All columns are returned as string values, with no type inference.
  • RowScan: The Cloud scans sample rows to heuristically determine each column’s data type. The number of rows scanned is controlled by the RowScanDepth property.

Use this property when you need to control or bypass automatic data type detection in your worksheet.

CData Cloud

UseRESTAPI

Specifies whether the provider uses the SharePoint REST API instead of the OData API to retrieve data.

データ型

bool

デフォルト値

true

解説

This property determines which SharePoint API the Cloud uses to retrieve data.

If set to true, the Cloud uses the REST API. If set to false, it uses the OData API.

SharePoint 2010 only supports the REST API. Later versions of SharePoint support both the REST and OData APIs.

Use the REST API to query spreadsheets and ranges as tables, as well as defined table objects. The OData API allows access only to named table objects.

See Data Model for more details on querying spreadsheets organized in different ways.

Use this property when you need to retrieve data from cell ranges or non-tabular worksheet layouts that the OData API cannot expose.

CData Cloud

SSO

このセクションでは、本プロバイダーの接続文字列で設定可能なSSO プロパティの全リストを提供します。


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSODomainSpecifies the domain associated with the user account when using single sign-on (SSO).
SSOPropertiesID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。
CData Cloud

SSOLoginURL

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

SSODomain

Specifies the domain associated with the user account when using single sign-on (SSO).

データ型

string

デフォルト値

""

解説

This property specifies the domain used by the user account during single sign-on (SSO) authentication.

It is only applicable when the AuthScheme is set to ADFS.

Use this property when the domain of the user identity ([email protected]) is different from the domain expected by the SSO service ([email protected]).

This property is commonly required when using Active Directory Federation Services (ADFS).

CData Cloud

SSOProperties

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

データ型

string

デフォルト値

""

解説

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

SSOLoginURL と一緒に使用します。

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

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

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

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

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
MD5 Thumbprint(hex 値はスペースまたはコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

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

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

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

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

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

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
IncludeNavigationParentColumnsSpecifies whether the provider includes non-key parent columns in views generated from navigation properties.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
RowScanDepthテーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
ShowEmptyRowsSpecifies whether the provider includes empty rows when reading data from a worksheet.
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

IncludeNavigationParentColumns

Specifies whether the provider includes non-key parent columns in views generated from navigation properties.

データ型

bool

デフォルト値

true

解説

This property controls whether the Cloud includes non-key parent columns in views that represent navigation relationships.

When set to true, these views include both the primary key columns of the parent and additional columns that provide more context about the parent.

When set to false, the Cloud still includes the parent’s primary keys to support joins, but omits all other columns from the parent.

Use this property when you want to filter or analyze data based on details from the parent entity in navigation-related views.

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

RowScanDepth

テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。

データ型

int

デフォルト値

50

解説

テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。

大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。

CData Cloud

ShowEmptyRows

Specifies whether the provider includes empty rows when reading data from a worksheet.

データ型

bool

デフォルト値

true

解説

This property determines whether the Cloud includes completely empty rows in the output when reading data from a worksheet and only applies when UseRESTAPI is set to true.

If this property is set to true, the Cloud includes empty rows in the result set.

If this property is set to false, it skips them.

Use this property when empty rows in your spreadsheet are meaningful and should be preserved in the output.

CData Cloud

ThrowsKeyNotFound

更新された行がない場合に例外をスローするかどうかを指定します。

データ型

bool

デフォルト値

false

解説

更新された行がない場合に例外をスローするかどうかを指定します。

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

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

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9540