This page provides a guide to Establishing a Connection to Quickbase in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Quickbase

Establishing a Connection shows how to authenticate to Quickbase and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Quickbase through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Quickbase by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

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.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to 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

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 Tables section, which details standard SQL tables.

Views

The Views section, which details standard SQL views.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. In the Information schema, they perform operation related to the exposed entities.

The Cloud models the data in Quickbase as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Quickbase Tables

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.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Quickbase Views

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.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Quickbase.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Quickbase, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Quickbase Stored Procedures

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 The allowed values are 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.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Quickbase.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Quickbase, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Quickbase Stored Procedures

Name	Description

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Quickbase:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the [CData].[QuickBase].SampleTable_1 table:

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

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

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

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Quickbase procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

Describes the primary and foreign keys.

The following query retrieves the primary key for the [CData].[QuickBase].SampleTable_1 table:

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

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported 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	Supported 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	Supported date/time 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	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	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	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
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	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
ApplicationToken	The application token used to authenticate the user.

Connection

---

Property	Description
Schema	Specify the Quickbase database you want to work with.
IncludeTableReports	Determines if Quickbase table reports should be listed as views.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
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	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the number of concurrent requests.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Quickbase.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseDefaultOrderBy	Indicates if a default order by should be applied if none is specified in the query.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
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	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
ApplicationToken	The application token used to authenticate the user.

The type of authentication to use when connecting to Quickbase.

Possible Values

Basic, Token

Data Type

string

Default Value

"Basic"

Remarks

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.

Data Type

string

Default Value

""

Remarks

Your Quickbase domain name. Ex: quickbase.com

The user token used to authenticate the user.

Data Type

string

Default Value

""

Remarks

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

Specifies the authenticating user's user ID.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the authenticating user's password.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

The application token used to authenticate the user.

Data Type

string

Default Value

""

Remarks

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

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

---

Property	Description
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.

Data Type

string

Default Value

""

Remarks

Specify the Quickbase database you want to work with.

Determines if Quickbase table reports should be listed as views.

Data Type

bool

Default Value

false

Remarks

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.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
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	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the number of concurrent requests.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Quickbase.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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.

Data Type

int

Default Value

10000

Remarks

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.

Data Type

string

Default Value

"UTF-8"

Remarks

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

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the number of concurrent requests.

Data Type

int

Default Value

5

Remarks

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

Specifies the maximum number of records per page the provider returns when requesting data from Quickbase.

Data Type

int

Default Value

1000

Remarks

When processing a query, instead of requesting all of the queried data at once from Quickbase, the Cloud can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Cloud requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

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

Data Type

bool

Default Value

true

Remarks

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.