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

Quickbase への接続

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

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

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

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

Authenticating to Quickbase

User Authentication

Set the AuthScheme to Basic to authenticate with this method.

To authenthenticate with user credentials, specify the following connection properties:

1. Set the Quickbase User and Password.
2. If your application requires an ApplicationToken, you must provide it otherwise an error will be thrown. You can find the ApplicationToken under MyAppName > Settings > App properties > Advanced settings > Security options > Require Application Tokens > Manage Application Token.

User Token

Set the AuthScheme to Token to authenticate with this method.

To authenthenticate with a user token, specify the following connection properties:

1. Set UserToken and you are ready to connect. You can find the UserToken under Quick Base > My Preferences > My User Information > Manage User Tokens.

Other Properties

• IncludeTableReports: Determines if table reports should be listed as views.

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 に設定します。

Overview

This section shows the available API objects and provides more information on executing SQL to Quickbase APIs.

Key Features

• The Cloud models Quickbase entities like documents, folders, and groups as relational views, allowing you to write SQL to query Quickbase data.
• Stored procedures allow you to execute operations to Quickbase
• Live connectivity to these objects means any changes to your Quickbase account are immediately reflected when using the Cloud.

Tables

Tables are automatically determined from the Quickbase.

Views

Views will be listed for table reports if IncludeTableReports is set to true.

Stored Procedures

ストアドプロシージャ are function-like interfaces to Quickbase. Stored procedures allow you to execute operations to Quickbase, including downloading documents and moving envelopes.

The Information Schema provides access to metadata entities like tables and fields, enabling users to query Quickbase API objects with SQL. Its data model is composed of three elements: tables, views, and stored procedures.

Tables

The テーブル section, which details standard SQL tables.

Views

The ビュー section, which details standard SQL views.

Stored Procedures

ストアドプロシージャ are actions that are invoked via SQL queries. In the Information schema, they perform operation related to the exposed entities.

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

CData Cloud - Quickbase テーブル

Name	Description
Apps	Retrieve the main properties of an application.
FieldDefinitions	Retrieve the properties for all fields in a specific table.
TableDefinitions	Retrieve information for the tables belonging to a given application.

Retrieve the main properties of an application.

Table Specific Information

Select

The Apps table fetches the primary features of an application.

The Cloud uses the Quickbase API to process search criteria when filtering by the Id column. All other filters are applied client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM [Apps] 
SELECT * FROM [Apps] WHERE [Id] = 'bvadwmxrn';

Insert

The Quickbase Cloud adds a new row to the Apps table with the specified column values.

For example:

INSERT INTO [Apps](Name, Description, AssignToken, SecurityPropertiesAllowClone, SecurityPropertiesAllowExport, SecurityPropertiesEnableAppTokens, SecurityPropertiesHideFromPublic,  SecurityPropertiesMustBeRealmApproved, SecurityPropertiesUseIPFilter, Variables) VALUES('MyApp2', 'app2 description', true, false, false, false, false, true, true, '[{"name":"Variable1","value":"Value1"},{"name":"Variable2","value":"Value2"}]');

Update

The Quickbase Cloud modifies the row in the Apps table, where Id matches the specified value.

For example:

UPDATE [Apps] SET Name='MyAppFromAPI2', Description='Description of MyAppFromAPI2', Variables='[{"name":"Variable1","value":"ValueOfVariable1"},{"name":"Variable3","value":"Value3"}]' WHERE [Id] = 'bvajvby2n'

Note: Updating a non-existing app variable will insert it as a new app variable.

Delete

The Quickbase Cloud removes rows from the Apps table where both the Id and Name match.

For example:

DELETE FROM [Apps] WHERE [Id] = 'bvajvby2n' AND [Name] = 'MyAppFromAPI2'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Description
Id [KEY]	String	True		=	The unique identifier for this application.
Name	String	False		=	The name of the application.
Description	String	False			The description of the application.
TimeZone	String	True			The time zone used when displaying time values in this application.
DateFormat	String	True			The format used for displaying date values in the application.
Created	Datetime	True			The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
Updated	Datetime	True			The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
DataClassification	String	True			The data classification label assigned to the application.
HasEveryoneOnTheInternet	Boolean	True			Indicates if the application is accessible to everyone on the internet.
MemoryInfoEstMemory	Int64	True			The estimated memory usage of the application in gigabytes.
MemoryInfoEstMemoryInclDependentApps	Int64	True			The estimated memory usage including dependent applications in gigabytes.
SecurityPropertiesAllowClone	Boolean	False			Indicates if non-admin users can clone the application.
SecurityPropertiesAllowExport	Boolean	False			Indicates if non-admin users can export data from the application.
SecurityPropertiesEnableAppTokens	Boolean	False			Indicates if application tokens are required.
SecurityPropertiesHideFromPublic	Boolean	False			Indicates if the application is hidden from public searches.
SecurityPropertiesMustBeRealmApproved	Boolean	False			Indicates if only realm-approved users can access the application.
SecurityPropertiesUseIPFilter	Boolean	False			Indicates if access is restricted to approved IP addresses.
Variables	String	False			Variables available in this application.
AncestorId	String	True	Apps.Id		The Id of the source application from which this one was copied.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
AssignToken	Boolean	Indicates if the application should be assigned to the user token used during creation (default: false).

Retrieve the properties for all fields in a specific table.

Table Specific Information

Select

The FieldDefinitions table gathers the detailed attributes for each field within a designated table.

The Cloud retrieves field definitions from the FieldDefinitions table, accessing either all records pertaining to a table or a specific record when multiple criteria are applied. All other filters are executed client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM [FieldDefinitions] WHERE [TableId] = 'bvajv8gg2'
SELECT * FROM [FieldDefinitions] WHERE [Id] = '1' AND [TableId] = 'bvady68q6'

Insert

The Quickbase Cloud inserts a new record into the FieldDefinitions table, creating a new field definition.

For example:

INSERT INTO FieldDefinitions(Label, FieldType, NoWrap, Bold, AppearsByDefault, FindEnabled, FieldHelp, MaxLength, AppendOnly, SortAsGiven, Permissions, TableId) VALUES('Field1', 'text', false, false, false, true, 'field1 help', 0, false, false, '[{"role":"Viewer","permissionType":"View","roleId":10},{"role":"Participant","permissionType":"None","roleId":11},{"role":"Administrator","permissionType":"Modify","roleId":12}]', 'bvajv8gg2')

Update

The Quickbase Cloud updates an existing record in the FieldDefinitions table, modifying one or more properties of a field definition identified by specific criteria.

For example:

UPDATE FieldDefinitions SET Label='UpdatedField1' WHERE [Id] = '6' AND [TableId] = 'bvajv8gg2'

Delete

The Quickbase Cloud deletes a record from the FieldDefinitions table that matches the specified identifying criteria.

For example:

DELETE FROM [FieldDefinitions] WHERE [Id] = '6' AND [TableId] = 'bvajv8gg2'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Description
Id [KEY]	Int64	False		=	The Id of the field, unique to this table.
FieldType	String	False			The type of field.
Mode	String	True			For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.
Label	String	False			The label (name) of the field.
NoWrap	Boolean	False			Indicates if the field is configured to not wrap when displayed in the product.
Bold	Boolean	False			Indicates if the field is configured to display in bold in the product.
Required	Boolean	False			Indicates if the field is marked required.
AppearsByDefault	Boolean	False			Indicates if the field is marked as a default in reports.
FindEnabled	Boolean	False			Indicates if the field is marked as searchable.
Unique	Boolean	False			Indicates if the field is marked unique.
DoesDataCopy	Boolean	True			Indicates if the field data will copy when a user copies the record.
FieldHelp	String	False			The configured help text shown to users within the product.
Audited	Boolean	False			Indicates if the field is being tracked as part of Quickbase Audit Logs.
AllowMentions	Boolean	False			If someone can @mention users in the rich text field to generate an email notification.
Comments	String	False			The comments entered on the field properties by an administrator.
DoesTotal	Boolean	False			Whether this field totals in reports within the product.
AutoSave	Boolean	False			Whether the link field will auto save.
DefaultValueLuId	Int64	False			Default user Id value.
UseI18NFormat	Boolean	False			Whether phone numbers should be in E.164 standard international format.
MaxVersions	Int64	False			The maximum number of versions configured for a file attachment.
CarryChoices	Boolean	False			Whether the field should carry its multiple choice fields when copied.
Format	Int64	False			The format to display time.
MaxLength	Int64	False			The maximum number of characters allowed for entry in Quickbase for this field.
LinkText	String	False			The configured text value that replaces the URL that users see within the product.
ParentFieldId	Int64	False			The Id of the parent composite field, when applicable.
DisplayTimezone	Boolean	False			Indicates whether to display the timezone within the product.
SummaryTargetFieldId	Int64	True			The Id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn't require a field selection (like count).
AllowNewChoices	Boolean	False			Indicates if users can add new choices to a selection list.
MasterChoiceFieldId	Int64	True			The Id of the field that is the reference in the relationship.
DefaultToday	Boolean	False			Indicates if the field value is defaulted today for new records.
Units	String	False			The units label.
LookupTargetFieldId	Int64	True			The Id of the field that is the target on the master table for this lookup.
SummaryFunction	String	True			The summary accumulation function type.
SourceFieldId	Int64	False			The Id of the source field.
MasterTableTag	String	True			The table alias for the master table in the relationship this field is part of.
DoesAverage	Boolean	False			Whether this field averages in reports within the product.
Formula	String	False			The formula of the field as configured in Quickbase.
DecimalPlaces	Int64	False			The number of decimal places displayed in the product for this field.
DefaultCountryCode	String	False			Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.
SeeVersions	Boolean	False			Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.
DisplayMonth	String	False			Indicates how months should be displayed.
NumLines	Int64	False			The number of lines shown in Quickbase for this text field.
DisplayEmail	String	False			Indicates how email should be displayed.
DefaultKind	String	False			The user default type.
CoverText	String	False			An alternate user friendly text that can be used to display a link in the browser.
CurrencySymbol	String	False			The current symbol used when displaying field values within the product.
MasterChoiceTableId	String	False			The Id of the table that is the master in this relationship.
TargetFieldId	Int64	False			The Id of the target field.
DisplayUser	String	False			The configured option for how users display within the product.
BlankIsZero	Boolean	False			Whether a blank value is treated the same as 0 in calculations within the product.
Exact	Boolean	False			Whether an exact match is required for a report link.
StartField	Int64	False			The start field Id.
DefaultDomain	String	False			Default email domain.
DefaultValue	String	False			The default value configured for a field when a new record is added.
ChoicesLuId	String	False			List of user choices.
Abbreviate	Boolean	False			Displays the URL without the protocol.
XmlTag	String	True			The field's xml tag.
TargetTableName	String	False			The field's target table name.
NumberFormat	Int64	False			The format used for displaying numeric values in the product (decimal, separators, digit group).
AppearsAs	String	False			The link text, if empty, the url will be used as link text.
Width	Int64	False			The field's html input width in the product.
CurrencyFormat	String	False			The currency format used when displaying field values within the product.
ForeignKey	Boolean	False			Indicates if the field is a foreign key (or reference field) in a relationship.
DisplayDayOfWeek	Boolean	False			Indicates whether to display the day of the week within the product.
SummaryReferenceFieldId	Int64	True			The Id of the field that is the reference in the relationship for this summary.
CommaStart	Int64	False			The number of digits before commas display in the product, when applicable.
Choices	String	False			An array of entries that exist for a field that offers choices to the user.
TargetTableId	String	False		=	The Id of the target table.
DisplayRelative	Boolean	False			Whether to display time as relative.
CompositeFields	String	False			An array of the fields that make up a composite field (e.g., address).
DisplayCheckboxAsText	Boolean	False			Indicates whether the checkbox values will be shown as text in reports.
VersionMode	String	False			Version modes for files.
DisplayTime	Boolean	False			Indicates whether to display the time, in addition to the date.
DurationField	Int64	True			The duration field id.
SnapFieldId	Int64	False			The Id of the field that is used to snapshot values from, when applicable.
Hours24	Boolean	False			Indicates whether or not to display time in the 24-hour format within the product.
SortAlpha	Boolean	False			Whether to sort alphabetically, default sort is by record Id.
SortAsGiven	Boolean	False			Indicates if the listed entries sort as entered vs alphabetically.
HasExtension	Boolean	False			Whether this field has a phone extension.
WorkWeek	Int64	True			The work week type.
UseNewWindow	Boolean	False			Indicates if the URL should open a new window when a user clicks it within the product.
AppendOnly	Boolean	False			Indicates whether the field is append-only.
DisplayAsLink	Boolean	False			Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.
AllowHTML	Boolean	False			Indicates whether HTML content is allowed in this field.
LookupReferenceFieldId	Int64	False			The Id of the field that is the reference in the relationship for this lookup.
Permissions	String	False			Field Permissions for different roles.
TableId [KEY]	String	False	TableDefinitions.Id	=	The unique identifier (dbid) of the table.

Retrieve information for the tables belonging to a given application.

Table Specific Information

Select

The TableDefinitions table gathers detailed information regarding the tables associated with a specific application. This involves retrieving metadata related to the entity, such as the table description, its storage space, and timezone information.

The Cloud uses the Quickbase API to retrieve TableDefinitions either for an entire application (by AppId) or for a specific table within that application (by Id and AppId). All other filters are applied client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM [TableDefinitions] WHERE [AppId] = 'bu99sj2wn'
SELECT * FROM [TableDefinitions] WHERE [Id] = 'bu99sj2wu' AND [AppId] = 'bu99sj2wn'

Insert

The Quickbase Cloud inserts a new row into the TableDefinitions table, creating a table definition with the specified name, description, record names, and associated AppId.

For example:

INSERT INTO TableDefinitions(Name, Description, SingleRecordName, PluralRecordName, AppId) VALUES('tableFromAPI1', 'description1', 'record', 'records', 'bvajvby2n')

Update

The Quickbase Cloud updates an existing row in the TableDefinitions table identified by the Id field while modifying its values.

For example:

UPDATE TableDefinitions Name='UpdatedTableUsingAPI1', Description='Updated description for UpdatedTableUsingAPI1' WHERE [Id] = 'bvajv8gg2' AND AppId = 'bvajvby2n'

Delete

The Quickbase Cloud deletes a row from the TableDefinitions table identified by the Id field based on specified criteria.

For example:

DELETE FROM [TableDefinitions] WHERE [Id] = 'bvajv8gg2' AND [AppId] = 'bvajvby2n'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Description
Id [KEY]	String	True		=	The unique identifier (dbid) of the table.
Name	String	False			The name of the table.
Alias	String	True			The automatically-created table alias for the table.
Description	String	False			The description of the table, as configured by an application administrator.
Created	Datetime	True			The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
Updated	Datetime	True			The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
NextRecordId	Int64	True			The incremental Record Id that will be used when the next record is created, as determined when the API call was ran.
NextFieldId	Int64	True			The incremental Field Id that will be used when the next field is created, as determined when the API call was ran.
DefaultSortFieldId	Int64	True			The id of the field that is configured for default sorting.
DefaultSortOrder	String	True			The configuration of the default sort order on the table.
KeyFieldId	Int64	True			The id of the field that is configured to be the key on this table, which is usually the Quickbase Record Id.
SingleRecordName	String	False			The builder-configured singular noun of the table.
PluralRecordName	String	False			The builder-configured plural noun of the table.
SizeLimit	String	True			The size limit for the table.
SpaceUsed	String	True			The amount of space currently being used by the table.
SpaceRemaining	String	True			The amount of space remaining for use by the table.
AppId	String	True	Apps.Id	=	The unique identifier for this application.

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

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

CData Cloud - Quickbase ビュー

Name	Description
AppVariables	Retrieve the application variables.
FieldPermissions	Retrieve role-specific field permission.
ReportMetadata	Retrieve the schema (properties) of a table's reports.
Users	Retrieve all users in an account.

Retrieve the application variables.

Table Specific Information

Select

The AppVariables view accesses and gathers the various application variables to ensure all relevant data is retrieved for function and analysis.

The Cloud fetches all application variables linked to a specified application from the AppVariables view. Other filters are executed client-side within the Cloud.

For example, the following query is processed server side:

SELECT * FROM [AppVariables] WHERE [AppId] = 'bu99sj2wn'

Columns

Name	Type	References	SupportedOperators	Description
Name [KEY]	String			The name of the variable.
Value	String			The value assigned to the variable.
AppId [KEY]	String	Apps.Id	=	The unique identifier for this application.

Retrieve role-specific field permission.

Table Specific Information

Select

The FieldPermissions view obtains the permissions for specific fields based on the designated role.

The Cloud provides details about the fields of a specific table, retrieving all field definitions and obtaining permissions for a particular field. Other filters are executed client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM [FieldPermissions] WHERE [TableId] = 'bvady68q6'
SELECT * FROM [FieldPermissions] WHERE [FieldId] = 6 AND [TableId] = 'bvady68q6'

Columns

Name	Type	References	SupportedOperators	Description
PermissionRoleId	String			The Id of the role assigned to the permission.
PermissionAssociatedRole	String			The role linked to the permission for the field.
PermissionType	String			The type of permission granted to the role for the field.
FieldId	Int64	FieldDefinitions.Id	=	The unique Id of the field within the table.
TableId	String	TableDefinitions.Id	=	The unique identifier (dbid) of the table.

Retrieve the schema (properties) of a table's reports.

Table Specific Information

Select

The ReportMetadata view fetches information about all available reports in Quickbase.

The Cloud retrieves report metadata from the ReportMetadata view, either returning all metadata associated with a given table or retrieving a specific report's metadata within that table when additional criteria are applied. All other filters are executed client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM [ReportMetadata] WHERE [TableId] = 'bu99sj2wz';
SELECT * FROM [ReportMetadata] WHERE [TableId] = 'bu99sj2wz' AND [ReportId] = '52';

Columns

Name	Type	References	SupportedOperators	Description
ReportId	String		=	The identifier of the report, unique to the table.
Name	String			The configured name of the report.
Type	String			The type of report in Quickbase.
Description	String			The configured description of a report.
OwnerId	Int64			The user Id of report owner. Optional, showed only for personal reports.
QueryFilter	String			Filter criteria applied in the query to retrieve report data.
QueryFormulaFields	String			Formula-based fields included in the query results.
Properties	String			A list of properties specific to the report type.
UsedLast	String			The instant at which a report was last used.
UsedCount	Int64			The number of times a report has been used.
TableId	String	TableDefinitions.Id	=	The table identifier used in the query when the report is executed.

Retrieve all users in an account.

Table Specific Information

Select

The User view gathers a comprehensive list of all users associated with a specific account.

The Cloud uses the Quickbase API to process filters on EmailAddress, AccountId, or AppIds. Other filters are processed client-side.

For example, the following queries are processed server side:

SELECT * FROM [Users]
SELECT * FROM [Users] WHERE [EmailAddress] IN ('[email protected]', '[email protected]')
SELECT * FROM [Users] WHERE [AccountId] = 1
SELECT * FROM [Users] WHERE [AppIds] IN ('bu99sj2wn', 'bvadwmxrn')

Columns

Name	Type	References	SupportedOperators	Description
HashId [KEY]	String			The hashId of the user.
UserName	String			The username of the user.
FirstName	String			The first name of the user.
LastName	String			The last name of the user.
EmailAddress	String		=,IN	The email address of the user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
AccountId	Int64		The account id being used to get users. If no value is specified, the first account associated with the requesting user token is chosen.
AppIds	String		When provided, the returned users will be narrowed down only to the users assigned to the app id's provided in this list. The provided app id's should belong to the same account.

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

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

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

Name	Description
ManageGroupMembership	Adds or removes a list of users to a given group as members.

Adds or removes a list of users to a given group as members.

Procedure Specific Information

The Cloud executes the ManageGroupMembership stored procedure, which adds or removes users to update group membership.

For example:

EXEC [ManageGroupMembership] [GroupId] = '122789', [UserHashIDs] = '100000.be8s, 123456.ryyw, 423123.b3x5', [Mode] = 'remove';
EXEC [ManageGroupMembership] [GroupId] = '122789', [UserHashIDs] = '100000.be8s, 123456.ryyw, 423123.b3x5', [Mode] = 'add';

Input

Name	Type	Required	Description
GroupId	Int64	True	This is the ID of the group being modified.
UserHashIDs	String	True	A list of user HashIDs that will be added to a group.
Mode	String	True	Specify whether you want to add or remove members from the group 使用できる値は次のとおりです。add, remove

Result Set Columns

Name	Type	Description
Success	String	Shows if the download finished successfully.
UnprocessedUserId	String	Users that couldn't be added to the group. This represent an invalid user or user who is already been added to the group.
ProcessedUserId	String	User that is added to the group successfully.

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

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

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

Name	Description

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

スキーマテーブル

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

• 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

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

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

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

          SELECT * FROM sys_schemas
          

Columns

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

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

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

          SELECT * FROM sys_tables
          

Columns

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

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

次のクエリは、[CData].[QuickBase].SampleTable_1 テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1' AND CatalogName='CData' AND SchemaName='QuickBase'

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 が含まれます。

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

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

          SELECT * FROM sys_procedures
          

Columns

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

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

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

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

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' 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	プロシージャがネイティブのQuickbase プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

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

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

次のクエリは、[CData].[QuickBase].SampleTable_1 テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1' AND CatalogName='CData' AND SchemaName='QuickBase'
          

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	主キーのカラム名。

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

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

         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	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

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

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

         SELECT * FROM sys_primarykeys
          

Columns

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

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

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

          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	インデックスのカラムのシーケンスナンバー。

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

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

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	プロパティに関するその他のさまざまな情報。

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

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

データソースのSELECT 機能

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

名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	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_BY	GROUP 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_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加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_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

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

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

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

         SELECT * FROM sys_identity
          

Columns

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

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

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

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	製品名。
Version	String	製品のバージョン番号。
Datasource	String	製品が接続するデータソースの名前。
NodeId	String	製品がインストールされているマシンの固有識別子。
HelpURL	String	製品のヘルプドキュメントのURL。
License	String	製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
Location	String	製品のライブラリが格納されているファイルパスの場所。
Environment	String	製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersion	String	本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategory	String	CData Sync 機能のカテゴリ（例：Source、Destination）。

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

Authentication

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Quickbase.
Domain	Your Quickbase domain name.
UserToken	The user token used to authenticate the user.
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
ApplicationToken	The application token used to authenticate the user.

Connection

---

プロパティ	説明
Schema	Specify the Quickbase database you want to work with.
IncludeTableReports	Determines if Quickbase table reports should be listed as views.

SSL

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

プロパティ	説明
BatchSize	The size of batches to submit when performing a bulk insert/update/delete operation.
Charset	Specifies the session character set for encoding and decoding character data transferred to and from the Quickbase API. The default value is UTF-8.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreads	Specifies the number of concurrent requests.
Pagesize	provider がQuickbase にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDefaultOrderBy	Indicates if a default order by should be applied if none is specified in the query.

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

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Quickbase.
Domain	Your Quickbase domain name.
UserToken	The user token used to authenticate the user.
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
ApplicationToken	The application token used to authenticate the user.

The type of authentication to use when connecting to Quickbase.

Possible Values

Basic, Token

データ型

string

デフォルト値

"Basic"

解説

The type of authentication to use when connecting to Quickbase.

• Basic: Set this to use BASIC user / password authentication.
• Token: Set this to perform Token Based Authentication.

Your Quickbase domain name.

データ型

string

デフォルト値

""

解説

Your Quickbase domain name. Ex: quickbase.com

The user token used to authenticate the user.

データ型

string

デフォルト値

""

解説

This value may be specified instead of User and Password to authenticate.

認証するユーザーのユーザーID を指定します。

データ型

string

デフォルト値

""

解説

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

認証するユーザーのパスワードを指定します。

データ型

string

デフォルト値

""

解説

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

The application token used to authenticate the user.

データ型

string

デフォルト値

""

解説

Used along with User, Password to authenticate with the server.

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

---

プロパティ	説明
Schema	Specify the Quickbase database you want to work with.
IncludeTableReports	Determines if Quickbase table reports should be listed as views.

Specify the Quickbase database you want to work with.

データ型

string

デフォルト値

""

解説

Specify the Quickbase database you want to work with.

Determines if Quickbase table reports should be listed as views.

データ型

bool

デフォルト値

false

解説

If this property is set to False, table-based reports are excluded from the API response.

When IncludeTableReports is set to True, almost all report types become accessible through the API, except for Kanban reports. However, the API will only return the columns that a user can see in the user interface. Any hidden columns will not appear in the report's metadata or results.

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

---

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

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

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

---

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

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

データ型

string

デフォルト値

"1"

解説

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

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

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

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

---

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

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

データ型

string

デフォルト値

""

解説

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

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

---

プロパティ	説明
BatchSize	The size of batches to submit when performing a bulk insert/update/delete operation.
Charset	Specifies the session character set for encoding and decoding character data transferred to and from the Quickbase API. The default value is UTF-8.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreads	Specifies the number of concurrent requests.
Pagesize	provider がQuickbase にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDefaultOrderBy	Indicates if a default order by should be applied if none is specified in the query.

The size of batches to submit when performing a bulk insert/update/delete operation.

データ型

int

デフォルト値

10000

解説

This connection property controls how many records will be submitted to the Quickbase at a time when performing mass inserts and update operations.

Specifies the session character set for encoding and decoding character data transferred to and from the Quickbase API. The default value is UTF-8.

データ型

string

デフォルト値

"UTF-8"

解説

Specifies the session character set for encoding and decoding character data transferred to and from the Quickbase API. The default value is UTF-8.

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

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

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

Specifies the number of concurrent requests.

データ型

int

デフォルト値

5

解説

This property allows you to issue multiple requests simultaneously, thereby improving performance.

provider がQuickbase にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

データ型

int

デフォルト値

1000

解説

クエリを処理する際、Quickbase でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。

Note：大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

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

データ型

string

デフォルト値

""

解説

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

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

Table1=Column1;Table1=Column2;Table2=Column3

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

*=*

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

データ型

int

デフォルト値

60

解説

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

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

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

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

Indicates if a default order by should be applied if none is specified in the query.

データ型

bool

デフォルト値

true

解説

By default, the CData Cloud applies an order by when none is specified. This ensures that duplicate records do not get output when returning data. However, this will have a significant impact on performance for very large tables. If your use case can handle the possibility of duplicate primary keys, it is recommended to turn this off if you would like to have better performance.

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.