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

Smartsheet への接続

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

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

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

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

Smartsheet への接続

Smartsheet は、以下の認証メソッドによる接続をサポートしています。

• 個人用アクセストークンの使用

個人用アクセストークン

個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得する方法は次のとおりです。

1. Smartsheet にログインします。
2. ［アカウント］をクリックして［個人用の設定］を選択します。
3. ［API アクセス］をクリックし、フォームを使用して新しいアクセストークンを生成するか、既存のアクセストークンを管理します。

Synch 接続

• OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
• OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

Smartsheet への接続 をクリックして、デフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

ドライバーは、以下のようにOAuth プロセスを完了します。

• コールバックURL からアクセストークンを取得します。
• 古いトークンの期限が切れたときは、新しいアクセストークンを取得します。
• OAuth 値を保存し、接続間で永続化します。

SSL 設定のカスタマイズ

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

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

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 はSmartsheet データを使いやすいSQL データベースとしてモデル化します。

テーブル

Cloud のデータモデルは動的です。これは、Cloud を使用して接続すると、新しいテーブルの追加、新しいカラムの追加、カラムのデータ型の変更など、Smartsheet UIで行ったあらゆる変更が自動的にCloud のスキーマに含まれることを意味します。

ただし、ワークスペースやフォルダなど、一部のテーブルやビューは静的です。これらは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。静的なテーブルとビューには'Info_' という接頭辞が付きます。

一般的なテーブルには以下のものが含まれます。

ストアドプロシージャ

ストアドプロシージャ は、SQLクエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、シートや添付ファイルの管理、OAuth 資格情報の取得などのより高度なタスクも実行します。

API の制限

このセクションでは、API の制限および要件について説明します。

You can add hyperlink columns to table schema files generated by the CreateSchema stored procedure.

After generating a schema file from the desired table, add a new column (attr) as follows:

• Set other:columnid to a unique value (any string that isn't already taken by another column).
• Add an other:hyperlink attribute to the column. Set this attribute to the value in the name attribute of the column you want your new hyperlink column to display hyperlinks for.

  These two values must match exactly.

For example, suppose you have this column in your schema file:

<attr name="MyColumnName" xs:type="string" ... other:columnid="5555555555555555"/>

Your new hyperlink column attached to this column should look like this:

<attr name="nameLink" xs:type="string" ... other:columnid="YourUniqueIDHere" other:hyperlink="MyColumnName"/>

Cloud はSmartsheet のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Smartsheet テーブル

Retrieve detailed information about Smartsheet attachments, which can be associated with comments, rows, or sheets, providing a comprehensive view of file dependencies.

Table Specific Information

Select

When getting data from this table the queries might be slow if you have a lot of sheets. To counter this, specifying SheetId is recommended. Also other parameters like DiscussionId, RowId, CommentId can be specified to get Attachments to the related object.

Retrieve all Attachments from all Sheets.

SELECT * FROM Info_Attachments

Retrieve all Attachments related to a Sheet.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308'

Retrieve all Attachments related to a discussion.

SELECT * FROM Info_Attachments WHERE SHEETId = '2940085806098308' AND DiscussionId = '8206230771525508'

Retrieve all Attachments related to a Row.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172'

Retrieve all Attachments related to a Comment.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308' AND CommentId = '1322606759569284'

Retrieve details of a specific Attachment.

SELECT * FROM Info_Attachments WHERE Id = '3053958945105796' AND SheetId = '2940085806098308'

Insert

You can attach a file to a specific row in a specific sheet. Fields required for Insert are SheetId, RowId, Name of the file and either FilePath or ContentEncoded.

INSERT INTO Info_Attachments (SheetId, RowId, Name, FilePath) VALUES ('8179839304787844', '4728727909230468', 'TestSheet.xlsx', 'G:\\\\TestSheet.xlsx')

INSERT INTO Info_Attachments (SheetId, RowId, Name, ContentEncoded) VALUES ('8179839304787844', '4728727909230468', 'TestSheet.xlsx', 'dGVzdGluZyBlbmNvZGVkIHRleHQ=')

Columns

Access comments within discussions in Smartsheet, providing insights into collaboration history.

Table Specific Information

Select

This view returns details for Columns of a specified Discussion. The SheetId parameter is always required.

Retrieve all comments from a sheet.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308'

Retrieve details of a specified Comment.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308' AND Id = '1322606759569284'

Insert

You can insert a comment to a discussion by providing SheetId, DiscussionId and Text.

INSERT INTO Info_Comments (SheetId, DiscussionId, Text) VALUES ('568679927703428', '4661021235275652', 'This is a comment 3')

Columns

Analyze discussion threads, including comments, tied to specific rows or sheets for better communication tracking.

Table Specific Information

Select

This view returns a list of Discussions. The SheetId parameter is always required.

Retrieve all Discussions related to a Sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308'

Retrieve Discussions related to a specific Row of a Sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172'

Retrieve details of a specified Comment.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308' AND Id = '8206230771525508'

Insert

You can insert a discussion to a sheet by providing SheetId and FirstDiscussionComment. To add a discussion to a row, provide RowId, SheetId, and FirstDiscussionComment.

INSERT INTO Info_Discussions (SheetId, FirstDiscussionComment) VALUES ('568679927703428', 'This is a comment 1')

INSERT INTO Info_Discussions (RowId, SheetId, FirstDiscussionComment) VALUES ('1889077216995204', '568679927703428', 'This is a comment 2')

Columns

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Manage and analyze the Sheet_Content_Calendar, designed for scheduling and content tracking.

Columns

Track and analyze historical customer order data using the Sheet_Customer_Order_Tracking_History.

Columns

Plan, budget, and track event-related data with the Sheet_Event_Plan_Budget table.

Columns

Manage and analyze expense reports effectively using the Sheet_Expense_Report table.

Columns

Track and manage projects with fixed deadlines using a Gantt-style layout in this Smartsheet table.

Columns

Track and manage job candidate progress and information with the Sheet_Job_Candidate_Tracker table.

Columns

Monitor sales activity by representative and month with the Sheet_Sales_Activity_Tracking_by_Rep_Month table.

Columns

Simplify sales tracking using the Sheet_Simple_Sales_Pipeline table for streamlined data management.

Columns

Monitor and track team objectives efficiently using the Sheet_Team_Objectives_Tracker.

Columns

Prioritize and manage team tasks with the Sheet_Team_Task_List_by_Priority table.

Columns

Test and analyze web form data integration using the Sheet_WebFormTest table.

Columns

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

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

CData Cloud - Smartsheet ビュー

Access the historical changes of specific cells in Smartsheet, enabling detailed audit and tracking capabilities.

Table Specific Information

Select

To get data from this view a SheetId, RowId, and ColumnId are always required.

Retrieve Cell History.

SELECT * FROM Info_CellHistory WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172' AND ColumnId = '7999197812156292'

Columns

Explore individual cell data in Smartsheet rows, offering granular insights into sheet contents.

Table Specific Information

Select

This view returns details for Cells of a specified Row. The SheetId and RowId parameters are always required.

Retrieve Cells.

SELECT * FROM Info_Cells WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172'

Columns

Retrieve metadata and properties of columns in Smartsheet sheets or reports, essential for understanding sheet structures.

Table Specific Information

Select

This view returns details for Columns of a specified Sheet. The SheetId parameter is always required.

Retrieve Columns.

SELECT * FROM Info_Columns WHERE SheetId = '2940085806098308'

Retrieve details of the specified Columns.

SELECT * FROM Info_Columns WHERE SheetId = '2940085806098308' AND Id = '7999197812156292'

Columns

Query Smartsheet user contact details, facilitating management of personal and shared connections.

Table Specific Information

Select

This view returns details for Contacts.

Retrieve Contacts.

SELECT * FROM Info_Contacts

Retrieve details of a specified Contact.

SELECT * FROM Info_Contacts WHERE Id = '1322606759569284'

Columns

Retrieve a user's favorite items in Smartsheet, helping prioritize frequently accessed content.

Table Specific Information

Select

This view returns a list of Favorite objects.

Retrieve all Favorite objects.

SELECT * FROM Info_Favorites

Columns

Explore folder structures in Smartsheet, including user-level folders and workspace organization.

Table Specific Information

Select

Retrieve all Folders.

SELECT * FROM Info_Folders

Retrieve details for a Folder.

SELECT * FROM Info_Folders WHERE Id = '2035256120371076'

Retrieve Folders of a specified Workspace.

SELECT * FROM Info_Folders WHERE WorkspaceId = '2940085806098308'

Columns

Retrieve group information for enhanced user management and role-based permissions in Smartsheet.

Table Specific Information

Select

Retrieve all Groups.

SELECT * FROM Info_Groups

Retrieve details for a Group.

SELECT * FROM Info_Groups WHERE Id = '2035256120371076'

Columns

Access items available on the Smartsheet Home tab, offering a centralized view of user-permissible objects.

Table Specific Information

Select

Retrieve all objects located on the Home tab:

SELECT * FROM Info_Home

Columns

Query Smartsheet reports, providing insights into custom aggregated data across sheets.

Table Specific Information

Select

Retrieve all Reports.

SELECT * FROM Info_Reports

Retrieve Reports located in a specific Workspace.

SELECT * FROM Info_Reports WHERE WorkspaceId = '6773684447799172'

Retrieve Reports located in a specific Folder.

SELECT * FROM Info_Reports WHERE FolderId = '6773684447799172'

Columns

Retrieve detailed row data, including cells, discussions, and attachments, for enhanced row-level analysis.

Table Specific Information

Select

This view returns a list of Sheet Rows. The SheetId parameter is always required.

Retrieve all Rows of a Sheet.

SELECT * FROM Info_Rows WHERE SheetId = '2940085806098308'

Retrieve details of a specified Row.

SELECT * FROM Info_Rows WHERE SheetId = '2940085806098308' AND Id = '8206230771525508'

Columns

Access Smartsheet server information and application constants, useful for API integrations.

Table Specific Information

Select

Retrieve Server Information:

SELECT * FROM Info_ServerInformation

Columns

Retrieve sharing configurations for Smartsheet reports, sheets, and workspaces to manage access controls.

Table Specific Information

Select

This view returns a list of Shares. Either the SheetId or WorkspaceId parameter is always required.

Retrieve all Shares related to a Sheet.

SELECT * FROM Info_Shares WHERE SheetId = '2940085806098308'

Retrieve all Shares related to a Workspace.

SELECT * FROM Info_Shares WHERE WorkspaceId = '1630085806098114'

Retrieve details of a Share related to a specified Sheet.

SELECT * FROM Info_Shares WHERE SheetId = '2940085806098308' AND Id = '1928085806875098'

Retrieve details of a Share related to a specified Workspace.

SELECT * FROM Info_Shares WHERE WorkspaceId = '1630085806098114' AND Id = '2928085806875091'

Columns

Explore detailed metadata and structure of Smartsheet sheets, including their components like columns, rows, and attachments.

Table Specific Information

Select

Retrieve all Sheets.

SELECT * FROM Info_Sheets

Retrieve Sheets located in a specific Folder.

SELECT * FROM Info_Sheets WHERE FolderId = '2928085806875091'

Retrieve Sheets located in a specific Workspace.

SELECT * FROM Info_Sheets WHERE WorkspaceId = '1928085806875098'

Columns

Retrieve Smartsheet template information to streamline the creation of standardized sheets.

Table Specific Information

Select

By default this view returns all Templates created by the user. If the TemplateType filter is set to 'public' , the public templates will be returned.

Retrieve all Templates.

SELECT * FROM Info_Templates

Retrieve all other public Templates.

SELECT * FROM Info_Templates WHERE TemplateType = 'public'

Retrieve Templates located on a specific folder.

SELECT * FROM Info_Templates WHERE FolderId = '2928085806875091'

Retrieve Templates located on a specific Workspace.

SELECT * FROM Info_Templates WHERE WorkspaceId = '1928085806875098'

Columns

Query user data within an organization for administrative and reporting purposes.

Table Specific Information

Select

Retrieve all Users.

SELECT * FROM Info_Users

Retrieve all Users of a specific Group.

SELECT * FROM Info_Users WHERE GroupId = '2928085806875091'

Columns

Access workspace-level details, including sheets and folders, for better organizational insights.

Table Specific Information

Select

Retrieve all Workspaces.

SELECT * FROM Info_Workspaces

Retrieve all details for a specific Workspace.

SELECT * FROM Info_Workspaces WHERE Id = '2928085806875091'

Columns

Analyze sales activities and team objectives using a dedicated Smartsheet report for performance tracking.

Columns

Access detailed task and event data within a Smartsheet report for efficient planning and monitoring.

Columns

ストアドプロシージャはファンクションライクなインターフェースで、Smartsheet の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSmartsheet から関連するレスポンスデータを返します。

CData Cloud - Smartsheet ストアドプロシージャ

Copy rows from one Smartsheet to another, streamlining data reorganization.

Input

Result Set Columns

Duplicate an existing sheet and relocate it to a specified folder, home directory, or workspace.

Input

Result Set Columns

Create a new sheet in Smartsheet for data organization and tracking.

Note：このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。

Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

以下の表では、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。

Input

Result Set Columns

Remove a specified attachment from Smartsheet to maintain data integrity.

Input

Result Set Columns

Delete a specific sheet from Smartsheet to manage space and relevance.

Input

Result Set Columns

Import CSV or XLSX files into Smartsheet, specifying the target folder or workspace.

Input

Result Set Columns

Move rows between Smartsheets for efficient data organization and management.

Input

Result Set Columns

Relocate a sheet to a new folder, home directory, or workspace for better accessibility.

Input

Result Set Columns

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

スキーマテーブル

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

• 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：バッチ処理または単一の更新に関する情報を返す。

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

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

SELECT * FROM sys_catalogs

Columns

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

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

          SELECT * FROM sys_schemas
          

Columns

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

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

          SELECT * FROM sys_tables
          

Columns

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

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

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

Columns

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

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

          SELECT * FROM sys_procedures
          

Columns

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

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

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

Columns

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

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

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

Columns

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

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

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

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

         SELECT * FROM sys_primarykeys
          

Columns

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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

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

データソースのSELECT 機能

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Columns

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

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

         SELECT * FROM sys_identity
          

Columns

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

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

SELECT * FROM sys_information

Columns

データ型マッピング

Cloud は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピング（TypeDetectionScheme がRowScan に設定された場合のデフォルトの動作）を説明します。

Smartsheet のデータ型の詳細については、Smartsheet API リファレンスのColumn Types を参照してください。

Authentication

Connection

OAuth

SSL

Logging

Schema

Miscellaneous

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

Specifies the authentication method to use when connecting to Smartsheet.

Possible Values

データ型

string

デフォルト値

"PersonalAccessToken"

解説

This property specifies whether to use Personal Access Token (PAT) or OAuth for authenticating with Smartsheet. When using PersonalAccessToken, ensure you have a valid token available. For OAuth, configure the necessary OAuth settings, such as OAuthClientId, OAuthClientSecret, and CallbackURL, to enable the provider to perform OAuth-based authentication. Choose the authentication method based on your access requirements and Smartsheet's supported security protocols.

Specifies the Personal Access Token for authenticating with Smartsheet. This token can be generated through the Smartsheet user interface.

データ型

string

デフォルト値

""

解説

Ensure that the token is valid and matches the credentials required for the connection. If your token expires or becomes invalid, update this property with a new token.

This property is useful for secure and efficient authentication, particularly for automated workflows and integrations with the Smartsheet API.

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

Specifies the hosting region for your Smartsheet account.

Possible Values

データ型

string

デフォルト値

"GLOBAL"

解説

This property specifies the region where your Smartsheet account is hosted to ensure that the provider connects to the appropriate Smartsheet data center. The available options are:

• GLOBAL: Connects to the default global Smartsheet region.
• EU: Connects to Smartsheet accounts hosted in the European Union.
• GOV: Connects to Smartsheet accounts hosted in the U.S. Government cloud.

This property is useful for aligning your connection with compliance and performance requirements specific to your account's hosting region.

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

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

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

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

データ型

string

デフォルト値

""

解説

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

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

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

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

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

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

データ型

string

デフォルト値

"1"

解説

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

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

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

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

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

データ型

string

デフォルト値

""

解説

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

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

Specifies whether the first row of the data is treated as column headers or not.

データ型

bool

デフォルト値

false

解説

This property determines how the provider handles the first row of data when assigning column names. If set to true, the first row is used as column headers, allowing for more descriptive column names. If set to false, the provider assigns generic names, which may be less intuitive but avoids relying on the contents of the data.

When interpreting the first row as headers, certain conditions must be met. Column headers should not contain special characters, as these may cause parsing errors. Additionally, all column headers must be non-empty to ensure proper detection and assignment. While meaningful column names can simplify query writing and improve data readability, users should ensure that the first row in the dataset truly represents headers to avoid misinterpretation.

Specifies whether to hide formatting characters, such as currency symbols and percentage signs, in numeric values. When enabled, numeric columns are converted from varchar to double.

データ型

bool

デフォルト値

false

解説

This property removes formatting characters from numeric values and converts them into a numerical data type (double). It works only when TypeDetectionScheme is set to RowScan and the first RowScanDepth rows in a column are convertible to double. If these conditions are not met, the column retains its original format as varchar.

This property is useful for users who need clean, numeric data for calculations or analysis. By standardizing numeric values into a consistent data type, it ensures compatibility with analytical tools and simplifies data processing workflows.

Specifies whether the deletion operation should proceed if any specified Row IDs are not found.

データ型

bool

デフォルト値

false

解説

This property determines how the driver handles cases where specified Row IDs are not found during a deletion operation. If set to false, no rows are deleted, and a "not found" error is returned if any of the Row IDs are missing. If set to true, the operation proceeds, ignoring any missing Row IDs.

This property is useful for ensuring the integrity of delete operations, particularly when precise control over the affected rows is required. It can prevent unintended results caused by missing or incorrect Row IDs.

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

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

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

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

Smartsheet から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

データ型

int

デフォルト値

500

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

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

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

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

Specifies the level of compatibility for the returned data, determining the format and functionality provided in query results.

Possible Values

データ型

string

デフォルト値

"2"

解説

This property specifies the compatibility level of returned data, allowing you to choose between legacy formats or newer, feature-rich data formats such as multi-contact or multi-picklist data. Choose a compatibility level based on your application's needs:

• 0 (Backwards-compatible): Returns data in a legacy text format for maximum compatibility with older systems.
• 1 (Multi-contact data): Returns multi-contact data in a format optimized for standard processing but not specifically for report tables.
• 2 (Report-compatible multi-contact data): Returns multi-contact data in a format specifically designed for report tables.
• 3 (Multi-picklist data): Returns data in a format that supports multi-picklist fields for advanced use cases.

To retrieve data for report tables, the compatibility level must be set to at least 2. Adjust this property based on your application’s requirements to balance compatibility with advanced functionality.

This property is useful for managing how Smartsheet data is processed and consumed. Use it to align your data retrieval with application-specific needs, such as maintaining compatibility with older systems or leveraging advanced data structures for more complex use cases.

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

データ型

int

デフォルト値

100

解説

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

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

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

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

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

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

Specifies the method used to determine the data types of columns, such as by scanning rows, analyzing column formats, or treating all columns as strings.

Possible Values

データ型

string

デフォルト値

"RowScan"

解説

This property defines how the driver determines column data types during query execution:

• None: All columns are treated as strings. Column names are still scanned if the Header property is set to True.
• RowScan: The driver scans rows to infer data types based on the data content. The number of rows scanned is determined by the RowScanDepth property.
• ColumnFormat: Data types are determined based on the column's format in the dataset.

This property is useful for adapting the driver to different data structures or optimizing performance based on your dataset's characteristics.

If precision is critical, such as when working with mixed data types, use RowScan to ensure accurate type detection. For simpler datasets or when type consistency is not required, None can streamline processing. Use ColumnFormat when the dataset includes predefined formats for columns.

Specifies whether table and view names corresponding to sheets and reports should include the full file path or only the file name.

データ型

bool

デフォルト値

false

解説

This property controls the naming convention for tables and views exposed by the driver. If set to true, table and view names include the full file path, providing greater context for each dataset. For example, a table representing a sheet might be named SalesSheets_Agents_MonthlyReports_Sheet_JuneSheet. If set to false, only the file name is used in the table and view names. For example, Sheet_JuneSheet.

This property is useful when working with datasets that may contain files with similar names in different directories. Including the full file path helps to distinguish between files and provides additional clarity. However, for simpler datasets or use cases where shorter table names are preferred, setting this property to false can improve readability and simplify queries.

Specifies whether sheet and report IDs, rather than their names, are used as table identifiers.

データ型

bool

デフォルト値

false

解説

When this property is set to true, the driver uses sheet or report IDs as table identifiers instead of their names. For example, instead of referencing a table as Sheet_SheetName, you would use Sheet_SheetId, such as in the query:

SELECT * FROM Sheet_3759298161102724.

This property is useful in scenarios where sheet and report names are ambiguous, frequently changed, or not unique. Using IDs ensures consistent and reliable table references, even if file names are updated.

Note: The properties UseFullFilePathsAsTableNames and UseIdAsTableName cannot both be enabled at the same time. If both are set to true, an error occurs.

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

データ型

bool

デフォルト値

false

解説

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

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

Specifies whether the driver retrieves cell values from the Value fields, the DisplayValue field, or automatically selects based on availability.

Possible Values

データ型

string

デフォルト値

"Auto"

解説

This property specifies how cell values are retrieved from the data, based on the selected source field:

• When set to Auto, the driver automatically selects the field that is not empty.
• When set to Value, the driver retrieves data specifically from the Value field.
• When set to DisplayValue, the driver retrieves data from the DisplayValue field.

This property is useful for customizing how cell data is interpreted, particularly when working with data that includes both raw values and formatted display representations.