Skip to content

Commit

Permalink
Source Airtable: docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
@artem1205
artem1205 committed Mar 5, 2023
1 parent cea584a commit 4b5dbf8
Showing 1 changed file with 57 additions and 58 deletions.
115 changes: 57 additions & 58 deletions docs/integrations/sources/airtable.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ This source syncs data from the [Airtable API](https://airtable.com/api).
## Prerequisites

* An active Airtable account
* API Key (Personal Access Token)
* [Personal Access Token](https://airtable.com/developers/web/guides/personal-access-tokens) with next scopes:
- `data.records:read`
- `data.recordComments:read`
- `schema.bases:read`

## Setup guide
### Step 1: Set up Airtable
Expand All @@ -16,77 +19,73 @@ This source syncs data from the [Airtable API](https://airtable.com/api).
1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account.
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
3. On the Set up the source page, enter the name for the Airtable connector and select **Airtable** from the Source type dropdown.
4. Enter your `API Key` obtained by following [these steps](https://airtable.com/developers/web/guides/personal-access-tokens)
5. Log in and Authorize to the Airtable account and click `Set up source`.
4. You can use OAuth or an API key to authenticate your Airtable account. We recommend using OAuth for Airbyte Cloud.
- To authenticate using OAuth, select **OAuth2.0** from the Authentication dropdown click **Authenticate your Airtable account** to sign in with Airtable, select required workspaces you want to sync and authorize your account.
- To authenticate using an API key, select **API key** from the Authentication dropdown and enter the Access Token for your Airtable account.
5. Click `Set up source`.

### For Airbyte OSS:

1. Navigate to the Airbyte Open Source dashboard
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
3. On the Set up the source page, enter the name for the Airtable connector and select **Airtable** from the Source type dropdown.
4. Click **Authenticate your Airtable account**.
5. Proceed with `login` and `grant the permissions` to the target `bases` you need the access to, we recommend to use `All Workspaces and bases`.
6. Log in and Authorize to the Airtable account and click `Set up source`.
4. Select **API key** from the Authentication dropdown and enter the Access Token for your Airtable account.
5. Click `Set up source`.


## Supported sync modes

The airtable source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):

| Feature | Supported?\(Yes/No\) | Notes |
| :---------------- | :------------------- | :---- |
|:------------------|:---------------------|:------|
| Full Refresh Sync | Yes | |
| Incremental Sync | No | |


## Supported Tables and Plans

This source allows you to pull all available tables and bases using `Metadata API` for a given authenticated user. In case you you rename or add a column to any existing table, you will need to recreate the source to update the Airbyte catalog.
This source allows you to pull all available tables and bases using `Metadata API` for a given authenticated user. In case you rename or add a column to any existing table, you will need to recreate the source to update the Airbyte catalog.

Currently, this source connector works with `standard` subscription plan only.

Standard Scopes required for the successfull authentication:
* data.records:read
* data.recordComments:read
* schema.bases:read

The `Enterprise` level accounts are not supported yet.

## Data type map

| Integration Type | Airbyte Type | Nullable |
| :--------------------- | :------------------------------------------------------ | -------- |
| `multipleAttachments` | `string` | Yes |
| `autoNumber` | `string` | Yes |
| `barcode` | `string` | Yes |
| `button` | `string` | Yes |
| `checkbox` | `boolean` | Yes |
| `singleCollaborator` | `string` | Yes |
| `count` | `number` | Yes |
| `createdBy` | `string` | Yes |
| `createdTime` | `datetime`, `format: date-time` | Yes |
| `currency` | `number` | Yes |
| `email` | `string` | Yes |
| `date` | `string`, `format: date` | Yes |
| `duration` | `number` | Yes |
| `lastModifiedBy` | `string` | Yes |
| `lastModifiedTime` | `datetime`, `format: date-time` | Yes |
| `multipleRecordLinks` | `array with strings` | Yes |
| `multilineText` | `string` | Yes |
| `multipleCollaborators`| `array with strings` | Yes |
| `multipleSelects` | `array with strings` | Yes |
| `number` | `number` | Yes |
| `percent` | `number` | Yes |
| `phoneNumber` | `string` | Yes |
| `rating` | `number` | Yes |
| `richText` | `string` | Yes |
| `singleLineText` | `string` | Yes |
| `externalSyncSource` | `string` | Yes |
| `url` | `string` | Yes |
| `formula` | `array with any` | Yes |
| `lookup` | `array with any` | Yes |
| `multipleLookupValues` | `array with any` | Yes |
| `rollup` | `array with any` | Yes |
| Integration Type | Airbyte Type | Nullable |
|:------------------------|:--------------------------------|----------|
| `multipleAttachments` | `string` | Yes |
| `autoNumber` | `string` | Yes |
| `barcode` | `string` | Yes |
| `button` | `string` | Yes |
| `checkbox` | `boolean` | Yes |
| `singleCollaborator` | `string` | Yes |
| `count` | `number` | Yes |
| `createdBy` | `string` | Yes |
| `createdTime` | `datetime`, `format: date-time` | Yes |
| `currency` | `number` | Yes |
| `email` | `string` | Yes |
| `date` | `string`, `format: date` | Yes |
| `duration` | `number` | Yes |
| `lastModifiedBy` | `string` | Yes |
| `lastModifiedTime` | `datetime`, `format: date-time` | Yes |
| `multipleRecordLinks` | `array with strings` | Yes |
| `multilineText` | `string` | Yes |
| `multipleCollaborators` | `array with strings` | Yes |
| `multipleSelects` | `array with strings` | Yes |
| `number` | `number` | Yes |
| `percent` | `number` | Yes |
| `phoneNumber` | `string` | Yes |
| `rating` | `number` | Yes |
| `richText` | `string` | Yes |
| `singleLineText` | `string` | Yes |
| `externalSyncSource` | `string` | Yes |
| `url` | `string` | Yes |
| `formula` | `array with any` | Yes |
| `lookup` | `array with any` | Yes |
| `multipleLookupValues` | `array with any` | Yes |
| `rollup` | `array with any` | Yes |

* All the fields are `nullable` by default, meaning that the field could be empty.
* The `array with any` - represents the classic array with one of the other Airtable data types inside, such as:
Expand All @@ -101,15 +100,15 @@ See information about rate limits [here](https://airtable.com/developers/web/api

## Changelog

| Version | Date | Pull Request | Subject |
|:--------|:-----------|:---------------------------------------------------------|:-------------------------------------------------------|
| 2.0.3 | 2023-02-02 | [22311](https://github.com/airbytehq/airbyte/pull/22311) | Fix for `singleSelect` types when discovering the schema
| 2.0.2 | 2023-02-01 | [22245](https://github.com/airbytehq/airbyte/pull/22245) | Fix for empty `result` object when discovering the schema
| 2.0.1 | 2023-02-01 | [22224](https://github.com/airbytehq/airbyte/pull/22224) | Fixed broken `API Key` authentication
| 2.0.0 | 2023-01-27 | [21962](https://github.com/airbytehq/airbyte/pull/21962) | Added casting of native Airtable data types to JsonSchema types
| 1.0.2 | 2023-01-25 | [20934](https://github.com/airbytehq/airbyte/pull/20934) | Added `OAuth2.0` authentication support
| 1.0.1 | 2023-01-10 | [21215](https://github.com/airbytehq/airbyte/pull/21215) | Fix field names |
| 1.0.0 | 2022-12-22 | [20846](https://github.com/airbytehq/airbyte/pull/20846) | Migrated to Metadata API for dynamic schema generation |
| 0.1.3 | 2022-10-26 | [18491](https://github.com/airbytehq/airbyte/pull/18491) | Improve schema discovery logic |
| 0.1.2 | 2022-04-30 | [12500](https://github.com/airbytehq/airbyte/pull/12500) | Improve input configuration copy |
| 0.1.1 | 2021-12-06 | [8425](https://github.com/airbytehq/airbyte/pull/8425) | Update title, description fields in spec |
| Version | Date | Pull Request | Subject |
|:--------|:-----------|:---------------------------------------------------------|:----------------------------------------------------------------|
| 2.0.3 | 2023-02-02 | [22311](https://github.com/airbytehq/airbyte/pull/22311) | Fix for `singleSelect` types when discovering the schema |
| 2.0.2 | 2023-02-01 | [22245](https://github.com/airbytehq/airbyte/pull/22245) | Fix for empty `result` object when discovering the schema |
| 2.0.1 | 2023-02-01 | [22224](https://github.com/airbytehq/airbyte/pull/22224) | Fixed broken `API Key` authentication |
| 2.0.0 | 2023-01-27 | [21962](https://github.com/airbytehq/airbyte/pull/21962) | Added casting of native Airtable data types to JsonSchema types |
| 1.0.2 | 2023-01-25 | [20934](https://github.com/airbytehq/airbyte/pull/20934) | Added `OAuth2.0` authentication support |
| 1.0.1 | 2023-01-10 | [21215](https://github.com/airbytehq/airbyte/pull/21215) | Fix field names |
| 1.0.0 | 2022-12-22 | [20846](https://github.com/airbytehq/airbyte/pull/20846) | Migrated to Metadata API for dynamic schema generation |
| 0.1.3 | 2022-10-26 | [18491](https://github.com/airbytehq/airbyte/pull/18491) | Improve schema discovery logic |
| 0.1.2 | 2022-04-30 | [12500](https://github.com/airbytehq/airbyte/pull/12500) | Improve input configuration copy |
| 0.1.1 | 2021-12-06 | [8425](https://github.com/airbytehq/airbyte/pull/8425) | Update title, description fields in spec |

0 comments on commit 4b5dbf8

Please sign in to comment.