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.

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. Specify the following to connect.

• BaseId (optional): You can optionally specify either this property or BaseName to limit the shown tables and views to a particular base. Set this to your base ID.
  • To find this value, navigate to the Airtable API Reference and select a base. In the introduction section of the Airtable documentation for the selected base, note the value specified in The ID of this base is <Id>.
• BaseName (optional): You can optionally specify either this property or BaseId to limit the shown tables and views to a particular base. Set this to the name of the schema, which corresponds to the name of the Base in Airtable, that you want to use.

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: Set this to PersonalAccessToken.
• OAuthAccessToken: Set this to the value of personal access token that you generated earlier.

OAuth PKCE

Set AuthScheme to OAuthPKCE.

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 Airtable APIs.

Key Features

• The Cloud models Airtable bases as relational databases, allowing you to write SQL to query Airtable data.
• Stored procedures allow you to execute operations to Airtable
• Live connectivity to these objects means any changes to your Airtable account are immediately reflected when using the Cloud.

The information schema contains information on Airtable users, groups collaborators and more.

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	Query available bases.
GroupCollaborators	Query group collaborators for airtable bases and workspaces.
GroupMembers	Query group members.
Groups	Query user groups.
IndividualCollaborators	Query individual collaborators for airtable bases and workspaces.
Tables	Query available tables in airtable bases.
Users	Query users.

Query available bases.

View-Specific Information

SELECT Examples

SELECT * FROM [INFORMATION_SCHEMA].[Bases]

Columns

Name	Type	Description
Id [KEY]	String	The Base ID, a unique identifier for a base.
Name	String	The name of the base.
PermissionLevel	String	The permission level on this base.

Query group collaborators for airtable bases and workspaces.

View-Specific Information

Note: Querying this view requires an Airtable Enterprise plan.

SELECT Examples

    SELECT * FROM [INFORMATION_SCHEMA].[GroupCollaborators]
    SELECT * FROM [INFORMATION_SCHEMA].[GroupCollaborators] WHERE BaseId = 'appWJ6DP3C7Guh9fS'

Columns

Name	Type	Description
WorkspaceId [KEY]	String	The Workspace ID, a unique identifier for the Airtable workspace.
BaseId [KEY]	String	The Base ID, a unique identifier for the Airtable base.
BaseName	String	The name of the base.
GroupId [KEY]	String	The ID of the group.
GroupName	String	The name of the group.
GrantedByUserId	String	The ID of the user that granted permissions.
PermissionLevel	String	The permission level.
IsAccessedFromWorkspace	Boolean	Boolean indicating if this group is granted access to the base implicitly by being granted access to the workspace.

Query group members.

Columns

Name	Type	Description
GroupId [KEY]	String	The user group ID.
Id [KEY]	String	The ID of the member.

Query user groups.

Columns

Name	Type	Description
Id [KEY]	String	The user group ID.
DisplayName	String	The display name of the group.

Query individual collaborators for airtable bases and workspaces.

View-Specific Information

Note: Querying this view requires an Airtable Enterprise plan.

SELECT Examples

    SELECT * FROM [INFORMATION_SCHEMA].[IndividualCollaborators]
    SELECT * FROM [INFORMATION_SCHEMA].[IndividualCollaborators] WHERE BaseId = 'appWJ6DP3C7Guh9fS'

Columns

Name	Type	Description
WorkspaceId [KEY]	String	The Workspace ID, a unique identifier for the Airtable workspace.
BaseId [KEY]	String	The Base ID, a unique identifier for the Airtable base.
BaseName	String	The name of the base.
UserId [KEY]	String	The ID of the collaborator.
UserEmail	String	The email of the collaborator.
GrantedByUserId	String	The ID of the user that granted permissions.
PermissionLevel	String	The permission level.
IsAccessedFromWorkspace	Boolean	Boolean indicating if this user is granted access to the base implicitly by being granted access to the workspace.

Query available tables in airtable bases.

View-Specific Information

SELECT Examples

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

Columns

Name	Type	Description
BaseId [KEY]	String	The Base ID, a unique identifier for the base owner of the table.
BaseName	String	The name of the base.
Id [KEY]	String	The Table ID, a unique identifier for the table.
Name	String	The name of the table.
Description	String	The description of the table.
PrimaryFieldId	String	The id of the primary field.
Fields	String	The fields of the table.
Views	String	The views deriving from the table.

Query users.

View-Specific Information

SELECT Examples

SELECT * FROM [INFORMATION_SCHEMA].[Users]

Columns

Name	Type	Description
Id [KEY]	String	The user ID.
Active	Bool	Indicates if the user is active or deactivated.
UserName	String	The username of the user.
GivenName	String	The given name of the user.
FamilyName	String	The family name of the user.
CreatedAt	Timestamp	The datetime when the user was created.
Groups	String	The JSON list of groups the user is part of.

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

The driver exposes each Airtable base as a separate schema. This is a sample base.

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	Sample of a random table in a random base.

Sample of a random table in a random base.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False
Name	String	False
Number	Int	False
MultipleSelectTypeColumn	String	False
LinkToAnotherRecordTypeColumn	String	False
AttachmentTypeColumn	String	False
CollaboratorTypeColumn	String	False

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	Child view of the SampleTable table. This is autogenerated view in order to expose values of attachments type columns for SampleTable table.
SampleTable_Collaborators	Child view of the SampleTable table. This is autogenerated view in order to expose values of collaborators type columns for SampleTable table.

Child view of the SampleTable table. This is autogenerated view in order to expose values of attachments type columns for SampleTable table.

Columns

Name	Type	Description
Id [KEY]	String
RowId	String
ColumnName	String
FileName	String
Size	String
Type	String
URL	String
thumbnails_full_height	String
thumbnails_full_url	String
thumbnails_full_width	String
thumbnails_large_height	String
thumbnails_large_url	String
thumbnails_large_width	String
thumbnails_small_height	String
thumbnails_small_url	String
thumbnails_small_width	String

Child view of the SampleTable table. This is autogenerated view in order to expose values of collaborators type columns for SampleTable table.

Columns

Name	Type	Description
Id [KEY]	String
RowId	String
ColumnName	String
Name	String
Email	String

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	Syncs raw CSV data into a Sync API table.

Syncs raw CSV data into a Sync API table.

Input

Name	Type	Required	Description
SyncTable	String	True	The name or ID of the sync table.
SyncId	String	True	The api sync id. Can be found in the setup flow when creating a new Sync API table, or from the synced table settings.
LocalPath	String	False	The absolute path of the CSV file to sync.
FileData	String	False	Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

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.

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

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 CreateSchema stored procedure:

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

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.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time 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.

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.

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 Airtable.
BaseId	Id of the base. This property is not required when the Metadata API is enabled, but specifying it restricts the metadata that will be retrieved.
BaseName	The schema to use - which corresponds to the name of the Base in Airtable. This property is only used when the Metadata API is enabled.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthAccessToken	A token received after authentication to the OAuth network, granting the user access. The access token is used in place of the user's login ID and password, which stay on the server.

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
ArrayOutputFormat	An optional override for the column value output format of elements that are arrays of primitive values.
DisplayObjectIds	Boolean determining if schema, table, view and column names should be replaced by their corresponding internal ID.
DisplayValue	Specifies the value format.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Pagesize	Specifies the maximum number of results to return from Airtable, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PathDelimiter	The character which will be used as delimiter for bulding column names based on paths.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.
ValueDelimiter	Indicates what separator to use when pushing values of an array as a single string.

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 Airtable.
BaseId	Id of the base. This property is not required when the Metadata API is enabled, but specifying it restricts the metadata that will be retrieved.
BaseName	The schema to use - which corresponds to the name of the Base in Airtable. This property is only used when the Metadata API is enabled.

The type of authentication to use when connecting to Airtable.

Possible Values

PersonalAccessToken, OAuthPKCE

Data Type

string

Default Value

"OAuthPKCE"

Remarks

• PersonalAccessToken: Set this to use Personal Access Token authentication.
• OAuthPKCE: Set this to use OAuth PKCE authentication.

Id of the base. This property is not required when the Metadata API is enabled, but specifying it restricts the metadata that will be retrieved.

Data Type

string

Default Value

""

Remarks

Id of the base. This property is not required when the Metadata API is enabled, but specifying it restricts the metadata that will be retrieved.

The schema to use - which corresponds to the name of the Base in Airtable. This property is only used when the Metadata API is enabled.

Data Type

string

Default Value

""

Remarks

The schema to use - which corresponds to the name of the Base in Airtable. This property is only used when the Metadata API is enabled.

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

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthAccessToken	A token received after authentication to the OAuth network, granting the user access. The access token is used in place of the user's login ID and password, which stay on the server.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

A token received after authentication to the OAuth network, granting the user access. The access token is used in place of the user's login ID and password, which stay on the server.

Data Type

string

Default Value

""

Remarks

The OAuth access token has a server-dependent timeout, limiting user access. This 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.

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 using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

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
ArrayOutputFormat	An optional override for the column value output format of elements that are arrays of primitive values.
DisplayObjectIds	Boolean determining if schema, table, view and column names should be replaced by their corresponding internal ID.
DisplayValue	Specifies the value format.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Pagesize	Specifies the maximum number of results to return from Airtable, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PathDelimiter	The character which will be used as delimiter for bulding column names based on paths.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.
ValueDelimiter	Indicates what separator to use when pushing values of an array as a single string.

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

This property decides how the column value of elements that are arrays of primitive values is displayed in the output. If set to AGGREGATE, the value will be the aggregate form of the array. If set to DELIMITED, the value will be a delimited string of the values.

Boolean determining if schema, table, view and column names should be replaced by their corresponding internal ID.

Data Type

bool

Default Value

false

Remarks

Boolean determining if schema, table, view and column names should be replaced by their corresponding internal ID. If this property and the Metadata API is also enabled, the description for tables, views and columns will include their corresponding display name.

Specifies the value format.

Possible Values

FormattedValue, DisplayText

Data Type

string

Default Value

"FormattedValue"

Remarks

• FormattedValue: Return values based on their data types.
• DisplayText: Return the text values as displayed in the UI. Columns that allow formatting will be pushed as type string.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the Cloud returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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

Specifies the maximum number of results to return from Airtable, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Data Type

int

Default Value

100

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

The character which will be used as delimiter for bulding column names based on paths.

Data Type

string

Default Value

"."

Remarks

If your columns already contain '.' character in their name, it is necessary to specify another character that is not used in column names, since it may risk breaking INSERT/UPDATE statements.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

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. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the Cloud waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Cloud cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Boolean determining if simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

Airtable tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Cloud easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.

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

Data Type

string

Default Value

","

Remarks

The column value for elements that are an array of primitive values is by default a comma-separated string of the values when ArrayOutputFormat is set to DELIMITED. Changing this property changes the separator to the desired character.