Microsoft Excel Online への接続を追加

Microsoft Excel Online への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Microsoft Excel Online アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからMicrosoft Excel Online コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Microsoft Excel Online への接続

Microsoft Excel Online データソースへの接続に使用できる認証方法は2つあります。

• OAuth 2.0 ベースの方法：Microsoft Excel Online は、Azure AD およびAzure サービスプリンシパルの両方でOAuth 2.0 ベースの認証を提供します。
  • Azure AD 認証の場合は、AuthScheme をAzureAD に設定します。
  • Azure サービスプリンシパル認証の場合は、AuthScheme をAzureServicePrincipal に設定します。
• マネージドサービスID（MSI）認証。この方法を使用するには、AuthScheme をAzureMSI に設定します。

Azure AD

Azure AD は、ユーザーベースの認証です。Azure AD をデスクトップアプリケーション経由でMicrosoft Excel Onlineに接続するために認証情報が提供されます。埋め込みクレデンシャルを認証に使用するには、OAuth クレデンシャル（OAuthClientId およびOAuthClientSecret）を空白のままにします。

Web アプリケーション経由で接続する場合は、カスタムOAuth Azure AD アプリケーションを作成する必要があります。カスタムAzure AD アプリケーションの作成により、OAuth 認証情報のOAuthClientId およびOAuthClientSecret が作成されます。 カスタムAzure AD アプリケーションを作成する方法、およびWeb アプリケーション経由で接続しない場合でアプリケーションを作成した方が有利な場合については、カスタムOAuth アプリケーションの作成 を参照してください。

Azure サービスプリンシパル

Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されます。直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

AzureAD アプリとAzure サービスプリンシパルの作成

Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにAzure AD アプリケーションを作成して登録する必要があります。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。

アプリケーションへのロールの割り当て

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。

1. 検索バーでサブスクリプションサービスを検索・選択して、サブスクリプションページを開きます。
2. アプリケーションを割り当てるサブスクリプションを選択します。
3. アクセス制御 (IAM)を開き、追加 -> ロール割り当ての追加 を選択してロール割り当ての追加ページを開きます。
4. 作成したAzure AD アプリに割り当てるロールとして、所有者を選択します。

認証の完了 クライアントシークレットと証明書のどちらを使用するかを選択し、以下の該当する手順に従ってください。

クライアントシークレット

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

• AuthScheme：クライアントシークレットを使用する場合はAzureServicePrincipal。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

証明書

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

• AuthScheme：証明書を使用する場合はAzureServicePrincipalCert。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth 交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthJWTCert：JWT 証明書のストア。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類。

これで接続する準備が整いました。クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

Managed Service Identity (MSI)

Azure VM 上でMicrosoft Excel Online を実行しており、MSI を利用して接続したい場合は、AuthScheme をAzureMSI に設定します。

User-Managed Identities

マネージドID のトークンを取得するには、OAuthClientId プロパティを使用してマネージドID の"client_id" を指定します。

VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。

ワークブックへの接続

Sync App は、マイクロソフトアカウントで指定したドライブからワークブックとワークシートを公開します。ワークブックに接続するには、Excel Online への認証を提供し、以下のプロパティのいずれかを設定します。

検出されるドライブを制御するには：

• Drive：特定のドライブのID。Drives およびSharePointSites ビューを使用して、アクセス可能なすべてのサイトおよびドライブを表示できます。
• SharepointURL：SharePoint サイトのブラウザURL。ドライバーは、サイト下のすべてのドライブを公開します。
• OAuthClientId：AuthScheme がAzureServicePrincipal に、またはOAuthGrantType がCLIENT に設定されている場合は、OAuth アプリに関連付られているドライブが公開されます。

上記のいずれも指定されていない場合は、アクセスは認証ユーザーの個人用ドライブに制限されます。

どのワークブックとワークシートが公開されるか、またはどのドライブが公開されるかを制御するには：

• Workbook：ワークブックの名前またはId。認証されたユーザーは、Workbooks ビューに対してクエリを実行することで利用可能なワークブックに関する情報のリストを表示できます。
• UseSandbox：Sandbox アカウントでワークブックに接続している場合はTrue、そうでない場合は空白。
• BrowsableSchemas：公開するドライブ名のリスト。
• Tables：公開するテーブル名のリスト。

ワークシートデータに対するSQL の実行

ワークシートと範囲へのデータ操作SQL を実行する方法は、以下を参照してください。

• ExcelOnline データの選択
• ExcelOnline データの挿入
• ExcelOnline データの更新
• ExcelOnline データの削除
• 数式の使用

Sync App がワークシートとセルをテーブルとカラムにモデル化する方法について詳しくは、データモデル を参照してください。

SharePoint のExcel ファイルからデータを取得

SharePoint のExcel ファイルからデータを取得するには、SharepointURL 接続プロパティを自身のSharepoint サイトのURL に設定します。次に例を示します。

 SharepointURL=https://mysite.sharepoint.com/ 

ドライバーは自動的にSharePoint にある各ドキュメントライブラリを検索し、スキーマとしてリストします。個々のExcel ワークブックとワークシートは、対応するドキュメントライブラリの下にWorkbook_Worksheet の形式でテーブルとしてリストされます。これは、SharepointURL が設定されていない場合に、自身の個人的なExcel ドキュメントをリストするのと同じように機能します。

The following connection properties enable you to execute SELECT queries that closely match how your sheet is organized.

Selecting Column Headers

If your worksheet has column headers, you can set the Header property to use column names defined in a header row. Then you can query like so:

SELECT Id, Name, Item, Quantity, Amount FROM Test_xlsx_Sheet1 WHERE Amount = 50

The query above assumes that the first row of the worksheet has the column names Id, Name, Quantity, and Amount. The worksheet may have more columns than were selected and they can be in any order.

Selecting Alphabetical Columns

If a workbook does not have headers, or if you would like to ignore the headers, you can set the Header property to false. In this case each column is represented by alphabetical names. For example:

SELECT A, B, C, D FROM Test_xlsx_Sheet1 WHERE D = 50

Selecting Ranges

Instead of working with the spreadsheet as a single table, you can work with ranges as tables. Some examples: In a sparse workbook, you can use ranges to select data without the empty rows. Or, in a worksheet that is not top-left aligned, you can use a range to select data in the middle of the sheet.

To select a range of data on the worksheet, append the range to the table name with the # character. For example, the following command will select the range of cells between A1 and E5:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

To assign a table name to a range, and avoid specifying the range repeatedly, see the Tables property.

You can execute INSERT statements when working with worksheets as tables. You can specify the column names detected from a header row or specify the alphabetical column names in Excel Online. You can also configure how the Sync App parses the input values into Microsoft Excel Online cell formats.

Set the Header property to configure column names. Set ValueInputOption to configure input parsing.

Note that inserting to ranges is not supported. Use Batch Inserts or Temporary Tables instead.

Inserting with Headers

When the Header property is set to true, you can specify cells in a header row as the column names.

INSERT INTO Test_xlsx_Sheet1 (Name, Amount) VALUES ('Test', 10)

Inserting without Headers

When the Header property is set to false, provide the alphabetical column names.

INSERT INTO Test_xlsx_Sheet1 (A, B) VALUES ('Test', 10)

Configuring Input Parsing

By default, the Sync App parses all values you input in the SQL statement the same as if you entered the input in the Microsoft Excel Online UI. For example, strings may be converted to numbers, dates, etc.

To disable the parsing of input values, set ValueInputOption. Additionally, see 数式の使用 to configure formula evaluation.

Example: Bulk Inserts using Temporary Tables

If using temporary tables, they must be defined and inserted within the same connection. Closing the connection will clear out any temporary tables in memory.

Creating Temporary Tables

Insert the rows you need in a temporary table. Then insert all the rows from that temporary table into the actual table.

In UPDATE statements, you can specify the column names detected from a header row or specify the alphabetical column names in Microsoft Excel Online. You can also configure how the Sync App parses the input values into Microsoft Excel Online cell formats.

Set the Header property to configure column names. The primary key is the row number; specify the primary key with the Id column. Set ValueInputOption to configure input parsing.

Updating with Headers

When the Header property is set to true, you update columns by specifying the detected column names.

UPDATE Customers SET Col1='value' WHERE Id=7

Updating without Headers

When the Header is set to false, provide the alphabetical column names:

UPDATE Customers SET H='value' WHERE Id=7

Updating Ranges

Set the columns corresponding to the range and specify the row number as the Id:

UPDATE [Customers#A15:C15] SET A='Ana Trujilo', B='Northwind, Inc.', C='100,000' WHERE Id='15'

Configuring Input Parsing

By default, the Sync App parses all values you input in the SQL statement the same as if you entered the input in the Microsoft Excel Online UI. For example, strings may be converted to numbers, dates, etc.

To disable the parsing of input values, set ValueInputOption. Additionally, see 数式の使用 to configure formula evaluation.

When deleting an entire row of data, you will need to be sure to refresh the table data. This is because Ids are assigned based on the row. For example, if there are five rows, with Ids 1 through 5, and you delete row 3 then row 4 will become 3 and 5 will become 4.

Set the following properties to configure formula evaluation when executing SELECT, INSERT, and UPDATE statements.

Selecting Formulas

The Sync App can return either the result of the formula or the formula itself; configure this behavior with the ValueRenderOption connection property.

Inserting and Updating Formulas

Set AllowFormula to true to insert formulas (the default). Otherwise, all values used in inserts and updates are inserted as string literals.

For example, with AllowFormula set to true, the following will insert a formula into the B column that will sum cells B1:B5:

INSERT INTO Excel_Sheet (A, B) VALUES ('Bill', '=SUM(B1:B5)')

Note: If AllowFormula is set to true, every column containing a formula will be exposed as String type regardless of the set TypeDetectionScheme.

このセクションでは、Microsoft Excel Online Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

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

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Microsoft Excel Online にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

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

Workbooks as Tables

The Sync App models the worksheets and ranges in your workbooks as bidirectional tables. When you connect, the Sync App retrieves the metadata from Microsoft Excel Online and reflects any changes to the table schemas.

See the Getting Started section for quickstarts to executing SQL to the tables. This section provides additional details on the Sync App behavior.

Tables

This section provides more detail about how the Sync App models the テーブル. See カラム for details about column discovery.

Stored Procedures

In addition to working with the data in the workbook, you can use the available stored procedures to access functionality in the Microsoft Excel Online API that is not modeled as SELECT, INSERT, UPDATE, or DELETE statements; for example, the AddWorksheet stored procedure.

System Tables

Query the available システムテーブル to access the available Sync App metadata, including schema information.

Best Practices

1) If you currently have many workbooks or sheets in your account, it may take a long time to initially retrieve all the data. You may shorten this time by adding the Workbook connection property to your connection string.

2) If you will be running a SELECT operation after INSERT or BATCH INSERT then make sure to wait 3-5 seconds before running it. The API takes a few seconds to register all the data you're adding to the database, so waiting is required to avoid partial results.

The Sync App exposes worksheets from workbooks as tables. To do so, it exposes the drives containing these workbooks and worksheets as schemas for these tables. How drives are exposed as schemas is dependent on the connection propeties for the Sync App.

The following connection properties determine what drives are exposed as schemas by the driver. They are listed in order of precedence, where only the most precedent property is used to expose schemas:

• Drive: Set this to the ID of a specific drive. Only this drive is exposed as schema.
• SharepointURL: Set this to the browser URL of a SharePoint site. The driver will expose all drives under the site. All of these drives are exposed as schemas.
• OAuthClientId: If AuthScheme is set to AzureServicePrincipal or if OAuthGrantType is set to CLIENT, the drive associated with your OAuth app will be exposed. Only this drive is exposed as schema.
• If none of the above are specified, the personal drive for the authenticated user will be used. Only this drive is exposed as schema.

You can use the Drives and SharePointSites views to view all the sites and drives you have access to.

If you would like to filter the schemas the driver exposes, you can use, the BrowsableSchemas connection property. Supply a list of drive names to this property. The filtering is done client-side, so this means that the names supplied should be the names that would normally be returned by the Sync App for the drives.

The Sync App enables you to represent a top-left-oriented worksheet or a user-specified range as a database table.

Top-Left Oriented Worksheets

You can use the Sync App to start working right away with top-left-oriented worksheets:

• The table name for a top-left-oriented worksheet is the name of the worksheet.
• By default the Sync App will return all rows until the first empty row. Note: an empty row between data will prevent further data from being returned.
• The first row of data in the worksheet can contain the column names. See カラム for more information.

User-Specified Ranges

Range notation is only available in a SELECT or UPDATE statement. Ranges are not supported for DELETE and INSERT commands.

You can execute SELECT or UPDATE commands against a given range with a reference in the following format: WORKSHEET#RANGE. You can also set the Tables property to assign a table name to a range.

For example, the following command will select the range of cells between A1 and E5:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

Accessing shared documents as a database table

You can use the connection property ShowSharedDocuments to list shared excel workbooks as database tables. The tables will be listed along-side user owned workbooks.

Executing SQL to Worksheet Data

See the following to execute data manipulation SQL to worksheets and ranges:

• ExcelOnline データの選択
• ExcelOnline データの挿入
• ExcelOnline データの更新
• ExcelOnline データの削除
• 数式の使用

When you connect, the Sync App discovers the available columns and reflects both changes in Microsoft Excel Online and configuration changes you make with the following connection properties. See the following sections to configure aspects of column discovery specific to Microsoft Excel Online.

Configuring Column Name Detection

You can set Header to detect column names in a header row or you can reference columns alphabetically.

Header=True (Default)

Below are more specifics on how the Sync App detects column names from a header row when Header is set to true.

• The Sync App determines columns from the first row of the worksheet. If no values are provided for the first row of the worksheet, the Sync App creates unique, alphabetized column names that are available only within the scope of that request.
• Headers should not contain special characters.
• Due to a limitation of the Excel Online API, all column headers must be nonempty.

Header=False

When Header is set to false, alphabetical column names will be dynamically assigned.

Primary Key

The Sync App reports the row number as the primary key. The Id column for each row represents the row number from the top of the sheet.

For example, if you specify a range A3:E6, rows 3, 4, 5, and 6 will be returned.

Configuring Column Value Parsing

The ValueRenderOption and ValueInputOption connection properties can be used to configure how the Sync App parses the Microsoft Excel Online cell formats in SELECT, INSERT and UPDATE operations.

Value render options for SELECT operations

Set the ValueRenderOption to configure how the Sync App renders values in the output of a SELECT operation. The available value render options are as below.

• FormattedValue: Values will be calculated and formatted in the output according to the cell's formatting. Formatting is based on the workbook's locale, not the requesting user's locale. This is the default ValueRenderOption.
• UnformattedValue: Values will be calculated but not formatted in the output.
• Formula: Values will not be calculated and instead the output will include the formulas. For this reason, every column containing a formula will be exposed as String type regardless of the set TypeDetectionScheme.

Value input options for INSERT and UPDATE operations

Set the ValueInputOption to configure how the Sync App parses values the user submits to the Microsoft Excel Online source for INSERT and UPDATE operations. The available value input options are as below.

• UserEntered: The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc., following the same rules that are applied when entering text into a cell via the Microsoft Excel Online UI. This is the default ValueInputOption.
• Raw: The values the user has entered will not be parsed and will be stored as-is.

Configuring Data Type Detection

Set the TypeDetectionScheme to configure the data type detection method. The available type detection schemes are as below.

• RowScan: The Sync App will scan rows to heuristically determine the data type. The number of rows the Sync App will scan can be determinated by the RowScanDepth property. This is the default TypeDetectionScheme.
• ColumnFormat: The Sync App will report the data type based on the cell format of the column. This option is applicable only for the 'UnformattedValue' and 'Formula' ValueRenderOption-s. If the ValueRenderOption is set to 'FormattedValue', all columns will be exposed as String types.
• None: The Sync App will return all columns as the string type.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Microsoft Excel Online Connector for CData Sync ビュー

Name	Description
Drives	Retrieve a list of drive objects.
SharedDocuments	Retrieve the list of all shared documents. Not every item listed by this view can be used as a workbook since the driver will filter out non excel files. See the Workbook and Worksheets views for more information.
SharePointSites	Retrieve the list of all sites in your SharePoint account.
Workbooks	Retrieve a list of workbook objects.
Worksheets	Retrieve a list of worksheet objects. If listing sheets in a workbook which do not belong to the user's drive, please specify the drive id using the Drive connection property.

Retrieve a list of drive objects.

Select

The example query below will return the Drives with the specified SharePointSite Id.

SELECT * FROM Drives WHERE SiteId = 'rssbus.onmicrosoft.com,988a3-343a-4064-996a-d2a30559f,4233d-dfcd-4910-b7f0-71f1dc03a'

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the drive.
SiteId	String	SharePointSites.Id	The ID of the SharePoint site or subsite that this drive belongs to.
ListId	String		The ID of the list this drive corresponds to.
Name	String		The name of the drive.
Description	String		The description of the drive.
CreatedByName	String		The display name of the identity.
CreatedById	String		Unique identifier for the identity.
CreatedDateTime	Datetime		Date and time the drive was created.
LastModifiedDateTime	Datetime		Date and time the drive was last modified.
WebUrl	String		URL that displays the resource in the browser.

Retrieve the list of all shared documents. Not every item listed by this view can be used as a workbook since the driver will filter out non excel files. See the Workbook and Worksheets views for more information.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the shared document
SharedFileId	String		The shared file Id of the document.
DriveId	String		The drive Id where this document resides.
Name	String		The name of the shared document.
Size	String		The size of the shared document.
SharedByUserName	String		The name of the user who shared this document.
SharedDateTime	String		The date and time when this document was shared.
CreatedDateTime	Datetime		The date and time when this document was created.
LastModifiedDateTime	Datetime		The date and time when this document was last modified.
WebUrl	String		The web URL of this shared document.

Retrieve the list of all sites in your SharePoint account.

Table Specific Information

In contrast to almost every other exposed table and view, this view does not implement any Microsoft Graph endpoint, but rather the '/query/search' endpoint of the SharePoint REST API. For this reason, in most cases you will need to specify the SharepointURL connection property prior to initiating the OAuth flow. During the Authorization flow, the Sync App will get the necessary permissions to utilize your SharePoint resources.

Select

The Sync App will use the SharePoint REST API to process WHERE clause conditions built with almost every column except for Id, and only for the EQUALS (=) operator. The rest of the filter is executed client side within the Sync App.

The example query below will return the SharePoint Site with the specified SiteId and WebId.

SELECT SiteId, SiteName, Title, SiteDescription FROM SharePointSites WHERE SiteId = '9839b8a3-343a-4064-996a-d2a300bc559f' AND WebId = '427d733d-dfcd-4910-b7f0-771f1d4cc03a'

Restrictions

To query this view using the 'AzureAD' AuthScheme with the 'CLIENT' OAuthGrantType, or using the 'AzureServicePrincipal' AuthScheme, you must specify the OAuthJWTCert instead of the OAuthClientSecret connection property. The restriction is imposed by the SharePoint REST API, which does not accept any OAuthAccessToken retrieved when specifying an OAuthClientSecret for the aforementioned authentication flows.

For a guide on how to authentication using a Certificate for the 'AzureAD' and 'AzureServicePrincipal' AuthSchemes, see "Client Credentials" in "Getting Started".

Columns

Name	Type	References	Description
Id [KEY]	String		The full identifier of the site.
SiteId	String		The unique identifier of the site collection.
WebId	String		The Web Id of the site.
SiteName	String		The name of the site.
Title	String		The title of the site.
SiteDescription	String		The description of the site.
Description	String		The description of the item.
CreatedDateTime	Datetime		Date and time the site was created.
LastModifiedDateTime	Datetime		Date and time the site was last modified.
SPWebUrl	String		URL that displays the resource in the browser.
Author	String		The author of the site.
DocumentSignature	String		The document signature of the site.
FileExtension	String		The extension of the site's file.
SecondaryFileExtension	String		The secondary extension of the site's file.
FileType	String		The file type of the site.
DocId	Long		The unique identifier of the site within a geo location.
GeoLocationSource	String		The geo location of the site.
HitHighlightedSummary	String		The heighted summary of the site.
Importance	Long		The importance of the site.
IsContainer	Bool		Specifies whether the site is a folder.
IsDocument	Bool		Specifies whether the site is a document.
OriginalPath	String		The original site path.
Path	String		The current site path.
Rank	Double		The rank of the site.
RenderTemplateId	String		The site's control render template name.
SiteLogo	String		The URI of the site's logo.
ViewsLifeTime	Long		The total view count since the site was created.
ViewsRecent	Long		The total view count of the site in the last 14 days.
WebTemplate	String		The web temple from which the site is created.

Retrieve a list of workbook objects.

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the item within the Drive.
Name	String		The name of the item.
CreatedByName	String		The display name of the identity.
CreatedById	String		Unique identifier for the identity.
CreatedDateTime	Datetime		Date and time the item was created.
LastModifiedDateTime	Datetime		Date and time the item was last modified.
Size	Long		Size of the item in bytes.
WebUrl	String		URL that displays the resource in the browser.
DriveId	String	Drives.Id	The ID of the drive that this workbook belongs to.

Retrieve a list of worksheet objects. If listing sheets in a workbook which do not belong to the user's drive, please specify the drive id using the Drive connection property.

Columns

Name	Type	References	Description
Id [KEY]	String		Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved.
WorkbookId	String	Workbooks.Id	The Id of the workbook containing this worksheet.
Name	String		The display name of the worksheet.
Position	Integer		The zero-based position of the worksheet within the workbook.
Visibility	String		The visibility of the worksheet. Possible values are: Visible, Hidden, VeryHidden.

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

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
AuthScheme	Microsoft Excel Online に接続する際に使用する認証の種類。
UseSandbox	A boolean indicating if you are using a sandbox account. The provider makes requests to the production environment by default.

Connection

---

プロパティ	説明
DefineTables	Assign table names to ranges.
Workbook	The name or Id of the workbook.
Drive	The Id of the drive.
IncludeSharePointSites	Whether to retrieve drives for all SharePoint sites when querying Drives view. If 'true' the provider will retrieve all Site IDs recursively and for each of them issue a separate call to get their drives. Therefore, be aware that setting this property to 'true' may decrease performance for the Drives view. Note that the SharePointAccessToken or OAuthJWTCert connection property must be specified to query the SharePointSites view and other views if IncludeSharePointSites is set to 'true' when using the CLIENT OAuthGrantType or the AzureServicePrincipal AuthScheme.

Azure Authentication

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment	接続を確立するときに使用するAzure 環境。

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
State	追加のOAuth ステート情報を表すオプションの値。
OAuthGrantType	OAuth フローのグラント種別。

JWT OAuth

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
AllowFormula	Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates.
Header	Indicates whether or not the provider should detect column names from the first row.
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	The maximum number of results to return per page from Microsoft Excel Online when UsePagination is True.
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
SharepointURL	The base URL of your Sharepoint Server.
ShowSharedDocuments	Whether or not to show shared documents.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionScheme	Determines how to determine the data types of columns.
UsePagination	Whether or not the CData ADO.NET Provider for Microsoft Excel Online should use client side paging.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
ValueInputOption	Determines how the provider parses values the user submits to Microsoft Excel Online.
ValueRenderOption	Determines how the provider renders values in the output.

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

---

プロパティ	説明
AuthScheme	Microsoft Excel Online に接続する際に使用する認証の種類。
UseSandbox	A boolean indicating if you are using a sandbox account. The provider makes requests to the production environment by default.

Microsoft Excel Online に接続する際に使用する認証の種類。

解説

• AzureAD:Azure Active Directory OAuth 認証を実行する場合に設定。
• AzureMSI：Azure VM で実行しているときにマネージドサービスID のクレデンシャルを自動的に取得する場合に設定。
• AzureServicePrincipal：クライアントシークレットを使用してAzure Service Principal として認証する場合に設定。
• AzureServicePrincipalCert：証明書を使用してAzure Service Principal として認証する場合に設定。

A boolean indicating if you are using a sandbox account. The provider makes requests to the production environment by default.

解説

If you are using a production account, this property can be left blank. If you are using a developer test account, set this to true.

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

---

プロパティ	説明
DefineTables	Assign table names to ranges.
Workbook	The name or Id of the workbook.
Drive	The Id of the drive.
IncludeSharePointSites	Whether to retrieve drives for all SharePoint sites when querying Drives view. If 'true' the provider will retrieve all Site IDs recursively and for each of them issue a separate call to get their drives. Therefore, be aware that setting this property to 'true' may decrease performance for the Drives view. Note that the SharePointAccessToken or OAuthJWTCert connection property must be specified to query the SharePointSites view and other views if IncludeSharePointSites is set to 'true' when using the CLIENT OAuthGrantType or the AzureServicePrincipal AuthScheme.

Assign table names to ranges.

解説

This property is used to define the ranges within a worksheet that will appear as tables. The value is a semicolon-separated list of name-value pairs in the form [Table Name]=[Catalog].[Schema].[{Workbook Name}_{Worksheet Name}!{Range}]. The value can also be specified in the form [Table Name]=[{Workbook Name}_{Worksheet Name}!{Range}]. Note that in this case, the driver will attempt to push the defined table for each schema it identifies, should the specified workbook and worksheet exist in the schema. For specifications of DefineTables, some characters, like ., are reserved characters. To escape these characters and make sure that the name containing them is parsed properly, surround the containing name with brackets, as in [work.book_work.sheet!A1:Z50]. For this example, the driver would properly search for the workbook and worksheet identified by work.book_work.sheet, despite the specification containing reserved characters.

Here is an example DefineTables value:

DefineTables="Table1=Test_xlsx_Sheet1!A1:N25,Table2=[CData].[MySchema].[Spreadsheet1_Sheet2!C3:M53],Table4=xIsPcLs2-bF3AavQcSLCfzs3kGc_Sheet4!C20:N60"

After setting DefineTables, you can then issue queries that reference the specified table name. Note that you can also use the range syntax directly in the SQL statement: append the range to the worksheet name with the # character.

For example, the following command will select the range of cells between A1 and E5:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

The name or Id of the workbook.

解説

Specifies the name or Id of the workbook. A list of all workbooks is available from the Workbooks view.

The Id of the drive.

解説

Specifies the Id of the drive. A list of all drives is available from the Drives view. This property takes precedence over SharepointURL. This means that if SharepointURL and Drive are specified, a schema will only be identified for the drive specified by Drive, and tables will only be identified from the worksheets in workbooks in this drive.

Whether to retrieve drives for all SharePoint sites when querying Drives view. If 'true' the provider will retrieve all Site IDs recursively and for each of them issue a separate call to get their drives. Therefore, be aware that setting this property to 'true' may decrease performance for the Drives view. Note that the SharePointAccessToken or OAuthJWTCert connection property must be specified to query the SharePointSites view and other views if IncludeSharePointSites is set to 'true' when using the CLIENT OAuthGrantType or the AzureServicePrincipal AuthScheme.

解説

This property affects only Drives views.

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

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment	接続を確立するときに使用するAzure 環境。

データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

解説

データにアクセスするために使用されるMicrosoft Online テナント。例えば、contoso.onmicrosoft.com です。あるいは、 テナントId を指定します。この値は［Azure ポータル］->［Azure Active Directory］->［プロパティ］のディレクトリId です。

通常、Tenant を指定する必要はありません。OAuthGrantType をCODE（デフォルト）に設定している場合は、Microsoft が自動的に決定します。 ただし、ユーザーがマルチテナントに所属している場合は失敗する可能性があります。 例えば、ドメインA の管理者がドメインB のユーザーをゲストユーザーとして招待した場合。ユーザーは両方のテナントに属していることになります。 Tenant を指定するのはグッドプラクティスですが、一般的には指定しなくてもうまく動作するはずです。

OAuthGrantType をCLIENT に設定する場合は、AzureTenant が必須です。クライアント資格情報を使用する場合、ユーザーコンテキストはありません。 資格情報は、アプリ自体のコンテキストから取得されます。Microsoft ではTenant を指定せずにクライアント資格情報を取得することを許容していますが、使用する特定のテナントを選択する可能性ははるかに低くなっています。 このため、接続するドメインに適用される資格情報を確実に取得するために、すべてのクライアント資格情報接続に対してAzureTenant を明示的に指定する必要があります。

接続を確立するときに使用するAzure 環境。

解説

ほとんどの場合、環境をグローバルに設定したままにしておくとうまく機能します。ただし、 Azure アカウントが別の環境に追加されている場合は、AzureEnvironment を使用してどの環境かを 指定できます。利用可能な値はGLOBAL、CHINA、USGOVT、USGOVTDOD です。

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

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
State	追加のOAuth ステート情報を表すオプションの値。
OAuthGrantType	OAuth フローのグラント種別。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

追加のOAuth ステート情報を表すオプションの値。

解説

追加のOAuth ステート情報を表すオプションの値。

OAuth フローのグラント種別。

解説

次のオプションが利用可能です：CODE,CLIENT,PASSWORD

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

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

JWT 証明書のストア。

解説

クライアント証明書のための証明書ストア名。

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

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

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

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。

USER	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note：この種類はJava では利用できません。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note：この種類はJava では利用できません。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。 Note：この種類はJava のみで利用できます。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note：この種類はJava のみで利用できます。
PEMKEY_FILE	この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOB	この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILE	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOB	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILE	この証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOB	この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILE	この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILE	この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。
XMLFILE	この証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOB	この証明書ストアは、XML 形式の証明書を含む文字列の名前です。

OAuth JWT 証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

OAuth JWT 証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	Eメールアドレス

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

Java Web Token の発行者。

解説

Java Web Token の発行者。 ほとんどの場合、これはOAuth App Id（クライアントId）接続プロパティの値を使用するため、個別に設定する必要はありません。

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。 ほとんどの場合、これはOAuth App Id（クライアントId）接続プロパティの値を使用するため、個別に設定する必要はありません。

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

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

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

解説

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

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

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

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

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はMicrosoft Excel Online への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

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

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

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

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

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

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

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

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

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

ProxyServer プロキシへの認証に使われるユーザー名。

解説

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

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

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

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

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

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

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

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

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

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

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

Platform	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

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

---

プロパティ	説明
AllowFormula	Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates.
Header	Indicates whether or not the provider should detect column names from the first row.
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	The maximum number of results to return per page from Microsoft Excel Online when UsePagination is True.
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
SharepointURL	The base URL of your Sharepoint Server.
ShowSharedDocuments	Whether or not to show shared documents.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionScheme	Determines how to determine the data types of columns.
UsePagination	Whether or not the CData ADO.NET Provider for Microsoft Excel Online should use client side paging.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
ValueInputOption	Determines how the provider parses values the user submits to Microsoft Excel Online.
ValueRenderOption	Determines how the provider renders values in the output.

Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates.

解説

Set this value to true to treat values beginning with an equals (=) sign as formulas on inserts and updates. Set the value to false to treat all values used in inserts and updates as strings.

For example, with AllowFormula set to true, the following will insert a formula into the B column that will sum cells B1:B5:

INSERT INTO Excel_Sheet (A, B) VALUES ('Bill', '=SUM(B1:B5)')

Note: If True, every column containing a formula will be exposed as String type regardless of the set TypeDetectionScheme.

Indicates whether or not the provider should detect column names from the first row.

解説

If true, the first row will be used as a column header. Otherwise, the pseudo column names A, B, C, etc. will be used.

The Sync App will follow the additional specifications below to detect column headers:

• Headers should not contain special characters.
• Due to a limitation of the Excel Online API, all column headers must be nonempty.

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

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

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

The maximum number of results to return per page from Microsoft Excel Online when UsePagination is True.

解説

The Pagesize property affects the maximum number of results to return per page from Microsoft Excel Online. Setting a higher value may result in better performance at the cost of additional memory eaten up per page consumed. A value of -1 indicates the maximum possible page size for the driver.

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

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

解説

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

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

The base URL of your Sharepoint Server.

解説

To query the SharePointSites, this base URL of your Sharepoint Server must be specified. A protocol prefix, either "http://" or "https://", must be provided in the value supplied for this property.

For example: https://SomeTenantName.sharepoint.com. This property can also be used to control what drives, workbooks, and worksheets are exposed by the Sync App. If you specify SharepointURL and do not specify Drive, the Sync App will enumerate drives from the specified site as schemas, and enumerate all the worksheets from all the workbooks in each drive as tables in their respective schema. If this property is specified when using AzureServicePrincipal or AzureServicePrincipalCert authentication, the search endpoint will not be used. This property must be specified if working with a custom application that has Sites.Selected as its highest privilege.

Whether or not to show shared documents.

解説

Whether or not to show shared documents. If set to true, shared documents will be listed along-side user owned workbooks as database tables. Ultimately, the specific files should have been granted direct access or explicitly shared with the authenticated user.

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

Determines how to determine the data types of columns.

解説

The Sync App can detect data types with the cell format (number, currency, date, etc.) or by scanning rows.

None	Setting TypeDetectionScheme to None will return all columns as the string type.
RowScan	Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows the Sync App will scan.
ColumnFormat	Setting TypeDetectionScheme to ColumnFormat will report the data type based on the cell format of the column. Note: This option is applicable only for the 'UnformattedValue' and 'Formula' ValueRenderOption-s. If the ValueRenderOption is set to 'FormattedValue', all columns will be exposed as String types.

Whether or not the CData ADO.NET Provider for Microsoft Excel Online should use client side paging.

解説

Whether or not the CData Sync App should use client side paging. We suggest you set this to true in case of a large dataset.

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

指定されたパスは引用符で囲まれていないことに注意してください。

テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

解説

Microsoft Excel Online テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。

Determines how the provider parses values the user submits to Microsoft Excel Online.

解説

Determines how the Sync App parses values the user submits to Microsoft Excel Online.

Raw	The values the user has entered will not be parsed and will be stored as-is.
UserEntered	The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc., following the same rules that are applied when entering text into a cell via the Excel Online UI.

Determines how the provider renders values in the output.

解説

Determines how the Sync App renders values in the output.

FormattedValue	Values will be calculated and formatted in the reply according to the cell's formatting. Formatting is based on the workbook's locale, not the requesting user's locale. For example, if A1 is 1.23 and A2 is "=A1" and formatted as currency, then A2 would return "$1.23".
UnformattedValue	Values will be calculated but not formatted in the reply. For example, if A1 is 1.23 and A2 is "=A1" and formatted as currency, then A2 would return the number 1.23.
Formula	Values will not be calculated and instead the reply will include the formulas. For example, if A1 is 1.23 and A2 is "=A1" and formatted as currency, then A2 would return "=A1". For this reason, every column containing a formula will be exposed as String type regardless of the set TypeDetectionScheme.