Cloud

Build 25.0.9434
  • Airtable
    • Getting Started
      • Establishing a Connection
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Information
        • Views
          • Bases
          • GroupCollaborators
          • GroupMembers
          • Groups
          • IndividualCollaborators
          • Tables
          • Users
        • Stored Procedures
      • SampleBase
        • Tables
          • SampleTable
        • Views
          • SampleTable_Attachments
          • SampleTable_Collaborators
        • Stored Procedures
          • SyncCSV
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • AuthScheme
        • Token
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • OAuthAccessToken
        • Scope
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
        • Schema
      • Miscellaneous
        • ArrayOutputFormat
        • DisplayObjectIds
        • DisplayValue
        • MaxRows
        • Pagesize
        • PathDelimiter
        • PseudoColumns
        • Timeout
        • UseSimpleNames
        • ValueDelimiter
    • Third Party Copyrights

Airtable - CData Cloud

Overview

CData Cloud offers access to Airtable across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Airtable through CData Cloud.

CData Cloud allows you to standardize and configure connections to Airtable as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: Airtable appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

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

Connecting to Airtable

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

Accessing Data from CData Cloud Services

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

CData Cloud

Establishing a Connection

Connect to Airtable 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.

Connecting to Airtable

The Cloud requests tables and views from Airtable. There is one optional connection property available: Schema.

The Schema property limits the shown tables and views to a particular base. If limitation is desired, set this property to the name of the schema that you want to use. (This corresponds to the name of the Base in Airtable.)

In addition to all Airtable Bases, a static schema named Information is also available. This schema enables the querying of static tables such as Bases, Tables, and Users. If DisplayObjectIds is set to True, you must set the value of Schema to the Airtable Base id, not the name.

Authenticating to Airtable

You can authenticate to Airtable using either a Personal Access Token or OAuth PKCE.

Personal Access Token

First, generate a personal access token, if you have not done so already:

  1. Log in to your user account.
  2. Navigate to the token creation page.
  3. Click Create new token.
  4. Under Scopes, click Add a scope to add each of the following:
    • data.records:read
    • data.records:write
    • schema.bases:read
  5. Under Access, add all the workspaces and bases that you want the token to have access to.
  6. Click Create token to generate the token. Copy and save the generated token, as it will only be shown once.
Next, set the following:
  • AuthScheme: PersonalAccessToken.
  • Token: The value of the personal access token that you generated earlier.

OAuth PKCE

Set AuthScheme to OAuthPKCE.

CData Cloud

SSL Configuration

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.

CData Cloud

Firewall and Proxy

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.

CData Cloud

Data Model

The CData Cloud models Airtable bases as easy-to-use SQL databases with tables, views, and stored procedures. Live connectivity to these objects means any changes to your Airtable account are immediately reflected when using the Cloud.

The Information schema Views section, which lists read-only SQL tables, contains samples of what you might have access to in your Airtable account.

The views included with the Cloud Information schema are:

View Description
Bases Retrieves a list of all bases the authenticated user has access to in Airtable, including their identifiers, names, and associated permissions.
GroupCollaborators Retrieves a list of collaborators in a specific Airtable group, including their identifiers, display names, permission levels, and whether base access is granted directly or inherited from workspace permissions.
GroupMembers Retrieves a list of members belonging to a specific Airtable user group, including their unique identifiers and associated group information.
Groups Retrieves a list of user groups within an Airtable workspace, including their unique identifiers and display names.
IndividualCollaborators Retrieves a list of individual collaborators for Airtable bases and workspaces, including their identifiers, contact details, permission levels, and whether base access is granted directly or inherited from workspace permissions.
Tables Retrieves a list of tables available in Airtable bases, including their identifiers, names, descriptions, primary fields, associated fields, and related views.
Users Retrieves a list of Airtable users, including their identifiers, status, names, creation dates, and associated groups.

The Cloud exposes each Airtable base as a separate schema. SampleBase is an example of a base schema.

CData Cloud

Information

The Information schema contains views related to Airtable users, bases, groups, collaborators, and tables. The stored procedures allow you to download attachments and manage OAuth access.

CData Cloud

Views

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 - Airtable Views

Name Description
Bases Retrieves a list of all bases the authenticated user has access to in Airtable, including their identifiers, names, and associated permissions.
GroupCollaborators Retrieves a list of collaborators in a specific Airtable group, including their identifiers, display names, permission levels, and whether base access is granted directly or inherited from workspace permissions.
GroupMembers Retrieves a list of members belonging to a specific Airtable user group, including their unique identifiers and associated group information.
Groups Retrieves a list of user groups within an Airtable workspace, including their unique identifiers and display names.
IndividualCollaborators Retrieves a list of individual collaborators for Airtable bases and workspaces, including their identifiers, contact details, permission levels, and whether base access is granted directly or inherited from workspace permissions.
Tables Retrieves a list of tables available in Airtable bases, including their identifiers, names, descriptions, primary fields, associated fields, and related views.
Users Retrieves a list of Airtable users, including their identifiers, status, names, creation dates, and associated groups.

CData Cloud

Bases

Retrieves a list of all bases the authenticated user has access to in Airtable, including their identifiers, names, and associated permissions.

View-Specific Information

SELECT Examples


SELECT * FROM [Information].[Bases]

Columns

Name Type Description
Id [KEY] String The unique identifier assigned to each Airtable base, used to reference the base in API calls, integrations, and scripts.
Name String The display name of the base as it appears in the Airtable workspace interface.
PermissionLevel String The permission level granted to the authenticated user or integration for this base, such as read-only, editor, or creator access.

CData Cloud

GroupCollaborators

Retrieves a list of collaborators in a specific Airtable group, including their identifiers, display names, permission levels, and whether base access is granted directly or inherited from workspace permissions.

View-Specific Information

Note: This view is only available to users with an Airtable Enterprise plan.

SELECT Examples


-- Retrieve all group collaborators
SELECT * FROM [Information].[GroupCollaborators];

-- Filter collaborators by base ID
SELECT * FROM [Information].[GroupCollaborators] 
WHERE BaseId = 'appWJ6DP3C7Guh9fS';

Columns

Name Type Description
WorkspaceId [KEY] String The unique identifier for the Airtable workspace that contains the base and defines overarching access permissions.
BaseId [KEY] String The unique identifier for the Airtable base to which the group has been granted access.
BaseName String The display name of the base as presented in the Airtable interface.
GroupId [KEY] String The unique identifier for the group that has been assigned permissions to the base.
GroupName String The display name of the group as defined within the Airtable workspace.
GrantedByUserId String The unique identifier of the user who assigned or modified the group’s permissions for the base.
PermissionLevel String The specific permission level granted to the group for the base, such as read-only, editor, or creator access.
IsAccessedFromWorkspace Boolean Indicates whether the group’s access to the base is inherited automatically from workspace-level permissions, rather than being granted directly at the base level.

CData Cloud

GroupMembers

Retrieves a list of members belonging to a specific Airtable user group, including their unique identifiers and associated group information.

View-Specific Information

Note: This view is only available to users with an Airtable Enterprise plan.

SELECT Examples


-- Retrieve all group members
SELECT * FROM [Information].[GroupMembers];

-- Retrieve member IDs by group
SELECT GroupId, Id FROM [Information].[GroupMembers];

Columns

Name Type Description
GroupId [KEY] String The unique identifier for the Airtable user group whose members are being retrieved.
Id [KEY] String The unique identifier of a member belonging to the specified user group.

CData Cloud

Groups

Retrieves a list of user groups within an Airtable workspace, including their unique identifiers and display names.

View-Specific Information

Note: This view is only available to users with an Airtable Enterprise plan.

SELECT Examples


-- Retrieve all groups
SELECT * FROM [Information].[Groups];

-- Retrieve group IDs and names
SELECT Id, DisplayName FROM [Information].[Groups];

Columns

Name Type Description
Id [KEY] String The unique identifier for the Airtable user group.
DisplayName String The display name of the group as defined within the Airtable workspace.

CData Cloud

IndividualCollaborators

Retrieves a list of individual collaborators for Airtable bases and workspaces, including their identifiers, contact details, permission levels, and whether base access is granted directly or inherited from workspace permissions.

View-Specific Information

Note: This view is only available to users with an Airtable Enterprise plan.

SELECT Examples


-- Retrieve all individual collaborators
SELECT * FROM [Information].[IndividualCollaborators];

-- Filter collaborators by base ID
SELECT * FROM [Information].[IndividualCollaborators] 
WHERE BaseId = 'appWJ6DP3C7Guh9fS';

Columns

Name Type Description
WorkspaceId [KEY] String The unique identifier for the Airtable workspace that contains the base and manages overarching access.
BaseId [KEY] String The unique identifier for the Airtable base to which the collaborator has access.
BaseName String The display name of the base as shown in the Airtable interface.
UserId [KEY] String The unique identifier for the collaborator who has been granted permissions.
UserEmail String The email address associated with the collaborator’s Airtable account.
GrantedByUserId String The unique identifier of the user who assigned or modified the collaborator’s permissions for the base.
PermissionLevel String The specific permission level granted to the collaborator for this base, such as read-only, editor, or creator access.
IsAccessedFromWorkspace Boolean Indicates whether the collaborator’s access to the base is inherited automatically from workspace-level permissions, rather than being granted directly at the base level.

CData Cloud

Tables

Retrieves a list of tables available in Airtable bases, including their identifiers, names, descriptions, primary fields, associated fields, and related views.

View-Specific Information

SELECT Examples


    SELECT * FROM [Information].[Tables]
    SELECT * FROM [Information].[Tables] WHERE BaseId = 'appWJ6DP3C7Guh9fS'

Columns

Name Type Description
BaseId [KEY] String The unique identifier for the Airtable base that contains the table and defines its structure and data.
BaseName String The display name of the base as shown in the Airtable interface, helping identify where the table belongs.
Id [KEY] String The unique identifier assigned to the table within its base, used to reference the table in API calls and integrations.
Name String The display name of the table as defined in the base, typically reflecting the type of data it stores.
Description String A descriptive summary explaining the table’s purpose, the type of records it contains, or how it is used within workflows.
PrimaryFieldId String The unique identifier for the table’s primary field, which acts as the main reference column and is often used for record naming or linking.
Fields String A collection of fields (columns) that make up the table, including details such as field names, data types, formatting, and configuration options.
Views String A collection of views created from the table, each offering a specific way to display, filter, sort, or group the table’s records.

CData Cloud

Users

Retrieves a list of Airtable users, including their identifiers, status, names, creation dates, and associated groups.

View-Specific Information

Note: This view is only available to users with an Airtable Enterprise plan.

SELECT Examples


-- Retrieve all users
SELECT * FROM [Information].[Users]

-- Retrieve user emails and roles
SELECT Id, Email, Role FROM [Information].[Users];

Columns

Name Type Description
Id [KEY] String The unique identifier assigned to the Airtable user, used to reference the account in API calls and integrations.
Active Bool Indicates whether the user account is currently active or has been deactivated.
UserName String The username chosen by the user for their Airtable account.
GivenName String The given (first) name associated with the user’s profile.
FamilyName String The family (last) name associated with the user’s profile.
CreatedAt Timestamp The date and time when the user account was created in Airtable.
Groups String A JSON-formatted list of user groups the account is a member of, including each group’s identifiers and names.

CData Cloud

Stored Procedures

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

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

CData Cloud - Airtable Stored Procedures

Name Description

CData Cloud

SampleBase

Airtable exposes each base as a separate schema, where the schema corresponds to the structure of that individual base. Within a schema, each table in the base appears as its own entity, with fields represented as columns that preserve their data types. This is a sample base schema.

CData Cloud

Tables

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

CData Cloud - Airtable Tables

Name Description
SampleTable Provides a randomly selected sample table from a random Airtable base, containing a range of field types to demonstrate different column configurations and data formats.

CData Cloud

SampleTable

Provides a randomly selected sample table from a random Airtable base, containing a range of field types to demonstrate different column configurations and data formats.

Columns

Name Type ReadOnly Description
Internal_Id [KEY] String True

The unique identifier automatically assigned to each record in the sample table, used to reference the record in API calls and integrations.

CreatedTime Datetime True

Timestamp specifying when the field was created.

Name String False

A single-line text field containing the name or label for the record, often used as the primary way to identify it within the table.

Number Double False

A numeric field that stores integer or decimal values, which can be used for calculations, metrics, or other quantitative data.

MultipleSelectTypeColumn String False

A multi-select field that allows choosing multiple predefined options from a set list, useful for categorization or tagging.

AttachmentTypeColumn String False

A field designed to store one or more file attachments, such as images, documents, or other media files, which can be viewed or downloaded directly from the record.

CollaboratorTypeColumn String False

A collaborator field that assigns one or more Airtable users to the record, often used for task ownership, responsibility tracking, or collaboration purposes.

BaseId String True

The Id of the Airtable Base where this table exists.

TableId String True

The Id of this table.

CData Cloud

Views

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 - Airtable Views

Name Description
SampleTable_Attachments A child view of the SampleTable table, automatically generated to display the contents of attachment-type fields. This view provides detailed metadata for each file attached to records in SampleTable, including file properties and thumbnail information.
SampleTable_Collaborators A child view of the SampleTable table, automatically generated to display the contents of collaborator-type fields. This view provides detailed information about each collaborator assigned to records in SampleTable, including their names and email addresses.

CData Cloud

SampleTable_Attachments

A child view of the SampleTable table, automatically generated to display the contents of attachment-type fields. This view provides detailed metadata for each file attached to records in SampleTable, including file properties and thumbnail information.

Columns

Name Type Description
Internal_Id String The unique identifier assigned to each attachment record in this view.
CreatedTime Datetime Timestamp specifying when the field was created.
RowId String The unique identifier of the parent record in SampleTable to which the attachment belongs.
ColumnName String The name of the attachment-type column in SampleTable where the file is stored.
FileName String The original name of the attached file.
Size Long The size of the attached file, measured in bytes.
Type String The MIME type of the attached file, indicating its format, such as image/jpeg or application/pdf.
URL String The direct URL link to access or download the attached file.
thumbnails_full_height Int The height, in pixels, of the full-size thumbnail image generated for the attachment.
thumbnails_full_url String The URL for the full-size thumbnail image of the attachment.
thumbnails_full_width Int The width, in pixels, of the full-size thumbnail image generated for the attachment.
thumbnails_large_height Int The height, in pixels, of the large thumbnail image generated for the attachment.
thumbnails_large_url String The URL for the large thumbnail image of the attachment.
thumbnails_large_width Int The width, in pixels, of the large thumbnail image generated for the attachment.
thumbnails_small_height Int The height, in pixels, of the small thumbnail image generated for the attachment.
thumbnails_small_url String The URL for the small thumbnail image of the attachment.
thumbnails_small_width Int The width, in pixels, of the small thumbnail image generated for the attachment.

CData Cloud

SampleTable_Collaborators

A child view of the SampleTable table, automatically generated to display the contents of collaborator-type fields. This view provides detailed information about each collaborator assigned to records in SampleTable, including their names and email addresses.

Columns

Name Type Description
Internal_Id String The unique identifier assigned to each collaborator record in this view.
CreatedTime Datetime Timestamp specifying when the field was created.
RowId String The unique identifier of the parent record in SampleTable to which the collaborator is linked.
ColumnName String The name of the collaborator-type column in SampleTable where the collaborator information is stored.
Name String The display name of the collaborator as defined in Airtable.
Email String The email address associated with the collaborator's Airtable account.

CData Cloud

Stored Procedures

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

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

CData Cloud - Airtable Stored Procedures

Name Description
SyncCSV Synchronizes raw CSV data into a designated Sync API table in Airtable, allowing bulk data import through a specified file path, input stream, or Base64-encoded content.

CData Cloud

SyncCSV

Synchronizes raw CSV data into a designated Sync API table in Airtable, allowing bulk data import through a specified file path, input stream, or Base64-encoded content.

Note: This procedure is only supported when AuthScheme is set to PersonalAccessToken.

You can obtain the SyncId during the setup process when creating a new Sync API table, or from the settings of an existing synced table.

Sample:


 EXECUTE SyncCSV SyncTable='tblPZyUrow0RLLpm2', SyncId='JToTgCMw', FileData='Y29sMSxjb2wyLGNvbDMsY29sNSxjb2w0DQp2MSx2Mix2Myxhc2QsdGVzdA=='
 EXECUTE SyncCSV SyncTable='tblPZyUrow0RLLpm2', SyncId='JToTgCMw', LocalFile='/temp/sample.csv'

Input

Name Type Required Description
SyncTable String True The name or unique identifier of the Sync API table where the CSV data will be imported.
SyncId String True The unique Sync API identifier for the target table, which can be obtained during the setup process when creating a new Sync API table or from the synced table’s settings.
LocalPath String False The complete file path to the local CSV file containing the data to be synced.
FileData String False A Base64-encoded string containing the CSV data, used when neither a local file path nor an input stream is specified.

Result Set Columns

Name Type Description
Success String Indicates whether the CSV sync operation completed successfully.
Details String Provides additional details about the sync process, such as processing statistics, warnings, or error messages.

CData Cloud

System Tables

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 Airtable:

  • 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.

CData Cloud

sys_catalogs

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.

CData Cloud

sys_schemas

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.

CData Cloud

sys_tables

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.

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the SampleTable_1 table:

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

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.

CData Cloud

sys_procedures

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.

CData Cloud

sys_procedureparameters

Describes stored procedure parameters.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'CreateSchema' 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 = 'CreateSchema' 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 Airtable 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.

CData Cloud

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the SampleTable_1 table:

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

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.

CData Cloud

sys_foreignkeys

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.

CData Cloud

sys_primarykeys

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.

CData Cloud

sys_indexes

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.

CData Cloud

sys_connection_props

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.

CData Cloud

sys_sqlinfo

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.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported 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_FUNCTIONSSupported 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_FUNCTIONSSupported 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_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA 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_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll 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_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates 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.

CData Cloud

sys_identity

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.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Connection String Options

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


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to Airtable.
TokenThe Personal Access Token for authenticating to Airtable. This token can be generated through the Airtable user interface.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessTokenSpecifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

SSL


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

Logging


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

Schema


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
SchemaRestricts access to data within the specified schema.

Miscellaneous


PropertyDescription
ArrayOutputFormatAn optional override for the column value output format of elements that are arrays of primitive values.
DisplayObjectIdsA boolean value that determines whether the names of schemas, tables, views, and columns are substituted with their respective internal IDs.
DisplayValueDetermines how the field values are returned by the Airtable API.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Airtable.
PathDelimiterDetermines the character used as a delimiter for building column names based on paths.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSimpleNamesSpecifies whether or not simple names should be used for tables and columns.
ValueDelimiterIndicates what separator to use when pushing values of an array as a single string.
CData Cloud

Authentication

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


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to Airtable.
TokenThe Personal Access Token for authenticating to Airtable. This token can be generated through the Airtable user interface.
CData Cloud

AuthScheme

Specifies the type of authentication to use when connecting to Airtable.

Possible Values

PersonalAccessToken, OAuthPKCE

Data Type

string

Default Value

"OAuthPKCE"

Remarks

Airtable provides two authentication mechanisms to access its API:

  • OAuthPKCE is intended for clients who cannot securely store a client's secret. It enables OAuth 2.0 authentication with Airtable using the Proof Key for Code Exchange (PKCE) flow. When this property is set to OAuthPKCE, DisplayValue is required.
  • PersonalAccessToken uses the Token obtained from Airtable to ensure secure access to Airtable's API.

CData Cloud

Token

The Personal Access Token for authenticating to Airtable. This token can be generated through the Airtable user interface.

Data Type

string

Default Value

""

Remarks

The PAT can be generated from https://airtable.com/create/tokens.

CData Cloud

OAuth

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


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessTokenSpecifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
CData Cloud

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Cloud

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

CData Cloud

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. The timeout is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The Cloud uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the Cloud refreshes the token immediately.

Note: Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Cloud

Scope

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Data Type

string

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

CData Cloud

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

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.

CData Cloud

Logging

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


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

Verbosity

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.

CData Cloud

Schema

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


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
SchemaRestricts access to data within the specified schema.
CData Cloud

BrowsableSchemas

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.

CData Cloud

Schema

Restricts access to data within the specified schema.

Data Type

string

Default Value

""

Remarks

By default, the Cloud exposes all Airtable Bases as separate schemas. To restrict access to a specific schema, set this property to the desired schema name. This limits access to only that schema's objects, such as tables, views, and procedures.
In addition to all Airtable Bases, a static schema named Information is available. This schema allows querying static tables such as Bases, Tables, Users and more.
When DisplayObjectIds is set to TRUE, the value of Schema must be set to the Airtable Base id, not the name.

CData Cloud

Miscellaneous

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


PropertyDescription
ArrayOutputFormatAn optional override for the column value output format of elements that are arrays of primitive values.
DisplayObjectIdsA boolean value that determines whether the names of schemas, tables, views, and columns are substituted with their respective internal IDs.
DisplayValueDetermines how the field values are returned by the Airtable API.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Airtable.
PathDelimiterDetermines the character used as a delimiter for building column names based on paths.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSimpleNamesSpecifies whether or not simple names should be used for tables and columns.
ValueDelimiterIndicates what separator to use when pushing values of an array as a single string.
CData Cloud

ArrayOutputFormat

An optional override for the column value output format of elements that are arrays of primitive values.

Possible Values

AGGREGATE, DELIMITED

Data Type

string

Default Value

"AGGREGATE"

Remarks

The ArrayOutputFormat property determines how the column values of elements that are arrays of primitive values are displayed in the output.
If set to AGGREGATE, the output will show a single, combined value representing the entire array. If set to DELIMITED, the values will be formatted as a string, with individual elements separated by commas or semicolons.

CData Cloud

DisplayObjectIds

A boolean value that determines whether the names of schemas, tables, views, and columns are substituted with their respective internal IDs.

Data Type

bool

Default Value

false

Remarks

By default, the API response returns field objects with their field names as keys.
When DisplayObjectIds is set to TRUE, the API responds with field objects identified by their unique field IDs.

This property is useful for retrieving the unique identifiers that Airtable assigns to tables, fields, and views. This ensures reliable API integrations, schema mapping, and automation.

CData Cloud

DisplayValue

Determines how the field values are returned by the Airtable API.

Possible Values

FormattedValue, DisplayText

Data Type

string

Default Value

"FormattedValue"

Remarks

By default, the DisplayValue property returns values based on their data types.
When the value is set to DisplayText, values are returned as plain text strings displayed in the UI. This is useful for rendering formatted output. All columns that support value formatting will be pushed with data type STRING.

CData Cloud

MaxRows

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.

CData Cloud

Pagesize

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

Data Type

int

Default Value

100

Remarks

When processing a query, instead of requesting all of the queried data at once from Airtable, 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.

CData Cloud

PathDelimiter

Determines the character used as a delimiter for building column names based on paths.

Data Type

string

Default Value

"."

Remarks

If your column names contain the '.' character, choose a different character not present in any column names. This is important because using the same character can cause problems with INSERT and UPDATE statements.

CData Cloud

PseudoColumns

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:

*=*

CData Cloud

Timeout

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.

CData Cloud

UseSimpleNames

Specifies whether or not simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

Airtable tables can include special characters in their names that are typically not allowed in standard databases. This property makes the Cloud easier to use with traditional database tools.

Setting UseSimpleNames to True simplifies the names of the columns that are returned. It enforces a naming scheme where only alphanumeric characters and underscores are valid for displayed column names.

Notes:

  • Any non-alphanumeric characters are converted to underscores.
  • If the column or table names exceed 128 characters in length they are truncated to 128 characters to comply with SQL Server standards.

CData Cloud

ValueDelimiter

Indicates what separator to use when pushing values of an array as a single string.

Data Type

string

Default Value

","

Remarks

The default format for array elements is a comma-separated string when ArrayOutputFormat is set to DELIMITED. Modifying ValueDelimiter changes the separator to any character of your choice, providing flexibility in the presentation of the array elements.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434