The CData Sync App provides a straightforward way to continuously pipeline your Airtable data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Airtable connector can be used from the CData Sync application to pull data from Airtable and move it to any of the supported destinations.
The Sync App leverages the Airtable Web API to enable bidirectional access to Airtable tables and views.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The Sync App 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.
You can authenticate to Airtable using either a Personal Access Token or OAuth PKCE.
First, generate a personal access token, if you have not done so already:
Set AuthScheme to OAuthPKCE.
This section details a selection of advanced features of the Airtable Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App 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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App 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 Sync App.
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 Sync App 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 Sync App exposes each Airtable base as a separate schema. SampleBase is an example of a base schema.
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.
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.
| 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. |
Retrieves a list of all bases the authenticated user has access to in Airtable, including their identifiers, names, and associated permissions.
SELECT * FROM [Information].[Bases]
| 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. |
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.
Note: This view is only available to users with an Airtable Enterprise plan.
-- Retrieve all group collaborators
SELECT * FROM [Information].[GroupCollaborators];
-- Filter collaborators by base ID
SELECT * FROM [Information].[GroupCollaborators]
WHERE BaseId = 'appWJ6DP3C7Guh9fS';
| 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. |
Retrieves a list of members belonging to a specific Airtable user group, including their unique identifiers and associated group information.
Note: This view is only available to users with an Airtable Enterprise plan.
-- Retrieve all group members
SELECT * FROM [Information].[GroupMembers];
-- Retrieve member IDs by group
SELECT GroupId, Id FROM [Information].[GroupMembers];
| 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. |
Retrieves a list of user groups within an Airtable workspace, including their unique identifiers and display names.
Note: This view is only available to users with an Airtable Enterprise plan.
-- Retrieve all groups
SELECT * FROM [Information].[Groups];
-- Retrieve group IDs and names
SELECT Id, DisplayName FROM [Information].[Groups];
| 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. |
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.
Note: This view is only available to users with an Airtable Enterprise plan.
-- Retrieve all individual collaborators
SELECT * FROM [Information].[IndividualCollaborators];
-- Filter collaborators by base ID
SELECT * FROM [Information].[IndividualCollaborators]
WHERE BaseId = 'appWJ6DP3C7Guh9fS';
| 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. |
Retrieves a list of tables available in Airtable bases, including their identifiers, names, descriptions, primary fields, associated fields, and related views.
SELECT * FROM [Information].[Tables]
SELECT * FROM [Information].[Tables] WHERE BaseId = 'appWJ6DP3C7Guh9fS'
| 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. |
Retrieves a list of Airtable users, including their identifiers, status, names, creation dates, and associated groups.
Note: This view is only available to users with an Airtable Enterprise plan.
-- Retrieve all users
SELECT * FROM [Information].[Users]
-- Retrieve user emails and roles
SELECT Id, Email, Role FROM [Information].[Users];
| 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. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App 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.
| Name | Description |
Downloads an attachment from a table by providing the table name or ID (depending on the DisplayObjectIds connection property) and attachment ID.
| Name | Type | Required | Description |
| SchemaIdentifier | String | False | The name or unique identifier of the schema or base that contains the target table. Supplying this value helps prevent ambiguity when working with multiple bases containing similarly named tables. |
| TableIdentifier | String | False | The name or unique identifier of the table where the attachment is stored. |
| AttachmentId | String | False | The unique identifier of the specific attachment to download. |
| LocalPath | String | False | The complete file path on the local system where the downloaded attachment will be stored. |
| Name | Type | Description |
| FileData | String | If both the local save path and output stream are not provided, the attachment’s file data is returned encoded as a Base64 string for direct use or decoding. |
| Success | String | Indicates whether the attachment download finished successfully without errors. |
| Details | String | Provides detailed information about the download operation, such as progress notes, warnings, or error messages. |
Retrieve the OAuth access token to be used for authentication with Airtable using OAuth.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| CallbackUrl | String | False | The URI for the authorize response redirect. Must exactly match a redirect URI associated with your integration. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Airtable server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Scope | String | False | The permissions required by your integration. A string that is a space delimited list of unique scopes. All scopes must be valid, Airtable defined scopes that have been selected for your integration in the integration management page. You must request at least one scope. |
| PKCEVerifier | String | False | The PKCEVerifier returned by GetOAuthAuthorizationURL. |
| Verifier | String | False | The grant code returned from Airtable after the user has authorized your app to have access to their data. This value will be returned as a code parameter to the callback URL. |
| Name | Type | Description |
| TokenType | String | The type of the generated token. |
| Scope | String | A string that is a space delimited list of scopes granted to this access token. |
| OAuthAccessToken | String | A token that is used to make requests to the Airtable API on behalf of the user. |
| ExpiresIn | String | Time in seconds until the access token expires. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| RefreshExpiresIn | String | Time in seconds until the refresh token expires. |
Generate the OAuth authorization URL used for authentication with Airtable using OAuth.
| Name | Type | Required | Description |
| CallbackURL | String | False | The URI for the authorize response redirect. Must exactly match a redirect URI associated with your integration. |
| Scope | String | False | The permissions required by your integration. A string that is a space delimited list of unique scopes. All scopes must be valid, Airtable defined scopes that have been selected for your integration in the integration management page. You must request at least one scope. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Airtable server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The URL to complete user authorization. |
| PKCEVerifier | String | A random value used as input for GetOAuthAccessToken. |
Exchanges a refresh token for a new access token.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned from the original authorization code exchange. |
| Name | Type | Description |
| TokenType | String | The type of the generated token. |
| Scope | String | A string that is a space delimited list of scopes granted to this access token. |
| OAuthAccessToken | String | A token that is used to make requests to the Airtable API on behalf of the user. |
| ExpiresIn | String | Time in seconds until the access token expires. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| RefreshExpiresIn | String | Time in seconds until the refresh token expires. |
| State | String | This field indicates any state that may be useful to your application upon receipt of the response. |
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.
The Sync App models the data in Airtable as a list of tables in a relational database that can be queried using standard SQL statements.
| 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. |
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.
| 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. |
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.
| 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. |
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.
| 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. |
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.
| 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. |
| String | The email address associated with the collaborator's Airtable account. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App 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.
| 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. |
Creates a schema file for a specified Airtable table or view, allowing its structure and metadata to be saved for use in integrations or development workflows.
Creates a local schema file (.rsd) from an existing table or view in the data model.
The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.
The Sync App checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the Sync App.
| Name | Type | Required | Description |
| TableName | String | True | The name of the Airtable table or view for which the schema file will be generated. |
| FileName | String | True | The complete file path and name where the generated schema file will be saved, for example 'C:\Users\User\Desktop\Filters\Filters.rsd.' |
| Name | Type | Description |
| Result | String | Indicates whether the schema file creation process completed successfully or failed. |
Download an attachment from a table by providing the table name or ID (depending on the DisplayObjectIds connection property) and attachment ID.
| Name | Type | Required | Description |
| SchemaIdentifier | String | False | The name or unique identifier of the schema or base that contains the target table. Supplying this value helps prevent ambiguity when working with multiple bases containing similarly named tables. |
| TableIdentifier | String | False | The name or unique identifier of the table where the attachment is stored. |
| AttachmentId | String | False | The unique identifier of the specific attachment to download. |
| LocalPath | String | False | The complete file path on the local system where the downloaded attachment will be stored. |
| Name | Type | Description |
| FileData | String | If both the local save path and output stream are not provided, the attachment’s file data is returned encoded as a Base64 string for direct use or decoding. |
| Success | String | Indicates whether the attachment download finished successfully without errors. |
| Details | String | Provides detailed information about the download operation, such as progress notes, warnings, or error messages. |
Retrieve the OAuth access token to be used for authentication with Airtable using OAuth.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| CallbackUrl | String | False | The URI for the authorize response redirect. Must exactly match a redirect URI associated with your integration. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Airtable server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Scope | String | False | The permissions required by your integration. A string that is a space delimited list of unique scopes. All scopes must be valid, Airtable defined scopes that have been selected for your integration in the integration management page. You must request at least one scope. |
| PKCEVerifier | String | False | The PKCEVerifier returned by GetOAuthAuthorizationURL. |
| Verifier | String | False | The grant code returned from Airtable after the user has authorized your app to have access to their data. This value will be returned as a code parameter to the callback URL. |
| Name | Type | Description |
| TokenType | String | The type of the generated token. |
| Scope | String | A string that is a space delimited list of scopes granted to this access token. |
| OAuthAccessToken | String | A token that is used to make requests to the Airtable API on behalf of the user. |
| ExpiresIn | String | Time in seconds until the access token expires. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| RefreshExpiresIn | String | Time in seconds until the refresh token expires. |
Generate the OAuth authorization URL used for authentication with Airtable using OAuth.
| Name | Type | Required | Description |
| CallbackURL | String | False | The URI for the authorize response redirect. Must exactly match a redirect URI associated with your integration. |
| Scope | String | False | The permissions required by your integration. A string that is a space delimited list of unique scopes. All scopes must be valid, Airtable defined scopes that have been selected for your integration in the integration management page. You must request at least one scope. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Airtable server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The URL to complete user authorization. |
| PKCEVerifier | String | A random value used as input for GetOAuthAccessToken. |
Exchanges a refresh token for a new access token.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned from the original authorization code exchange. |
| Name | Type | Description |
| TokenType | String | The type of the generated token. |
| Scope | String | A string that is a space delimited list of scopes granted to this access token. |
| OAuthAccessToken | String | A token that is used to make requests to the Airtable API on behalf of the user. |
| ExpiresIn | String | Time in seconds until the access token expires. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| RefreshExpiresIn | String | Time in seconds until the refresh token expires. |
| State | String | This field indicates any state that may be useful to your application upon receipt of the response. |
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.
EXECUTE SyncCSV SyncTable='tblPZyUrow0RLLpm2', SyncId='JToTgCMw', FileData='Y29sMSxjb2wyLGNvbDMsY29sNSxjb2w0DQp2MSx2Mix2Myxhc2QsdGVzdA=='
EXECUTE SyncCSV SyncTable='tblPZyUrow0RLLpm2', SyncId='JToTgCMw', LocalFile='/temp/sample.csv'
| 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. |
| 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. |
Uploads a file to an attachment field in Airtable by specifying the target record’s identifier and the attachment field’s name or unique identifier. The file can be provided from a local path, an input stream, or as Base64-encoded data.
| Name | Type | Required | Description |
| RecordId | String | True | The unique identifier of the record where the attachment will be added. |
| AttachmentFieldIdentifier | String | True | The name or unique identifier of the attachment field in which the file will be stored. |
| LocalPath | String | False | The complete file path on the local system to the file being uploaded. |
| FileData | String | False | A Base64-encoded representation of the file’s data, required when neither a local file path nor an input stream is provided. |
| FileName | String | True | The name of the file being uploaded, as it should appear in Airtable. |
| Name | Type | Description |
| Success | String | Indicates whether the attachment upload operation completed successfully. |
| Details | String | Provides additional details about the upload process, such as file processing information, warnings, or error messages. |
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.
| Property | Description |
| AuthScheme | Specifies the type of authentication to use when connecting to Airtable. |
| Token | The Personal Access Token for authenticating to Airtable. This token can be generated through the Airtable user interface. |
| Property | Description |
| 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. |
| 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.). |
| 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. |
| 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. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Schema | Restricts access to data within the specified schema. |
| Property | Description |
| ArrayOutputFormat | An optional override for the column value output format of elements that are arrays of primitive values. |
| DisplayObjectIds | A boolean value that determines whether the names of schemas, tables, views, and columns are substituted with their respective internal IDs. |
| DisplayValue | Determines how the field values are returned by the Airtable API. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Airtable. |
| PathDelimiter | Determines the character used as a delimiter for building column names based on paths. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Specifies whether or not 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 | Specifies the type of authentication to use when connecting to Airtable. |
| Token | The Personal Access Token for authenticating to Airtable. This token can be generated through the Airtable user interface. |
Specifies the type of authentication to use when connecting to Airtable.
Airtable provides two authentication mechanisms to access its API:
The Personal Access Token for authenticating to Airtable. This token can be generated through the Airtable user interface.
The PAT can be generated from https://airtable.com/create/tokens.
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 (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. |
| 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.). |
| 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. |
| 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. |
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.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App 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.
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.).
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:
For more information on how this property is used when configuring a connection, see Establishing a Connection
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.
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 Sync App uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the Sync App 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.
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.
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.
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.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Airtable. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Airtable. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Airtable. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Schema | Restricts access to data within the specified schema. |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\Airtable Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
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.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
Restricts access to data within the specified schema.
By default, the Sync App 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.
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 | A boolean value that determines whether the names of schemas, tables, views, and columns are substituted with their respective internal IDs. |
| DisplayValue | Determines how the field values are returned by the Airtable API. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Airtable. |
| PathDelimiter | Determines the character used as a delimiter for building column names based on paths. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Specifies whether or not 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.
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.
A boolean value that determines whether the names of schemas, tables, views, and columns are substituted with their respective internal IDs.
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.
Determines how the field values are returned by the Airtable API.
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.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of records per page the provider returns when requesting data from Airtable.
When processing a query, instead of requesting all of the queried data at once from Airtable, the Sync App can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Sync App requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.
Determines the character used as a delimiter for building column names based on paths.
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.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App 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 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.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
Specifies whether or not simple names should be used for tables and columns.
Airtable tables can include special characters in their names that are typically not allowed in standard databases. This property makes the Sync App 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:
Indicates what separator to use when pushing values of an array as a single string.
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.
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.