From cb99eab61a7879227cfba6c1fe4d5c173eef642e Mon Sep 17 00:00:00 2001 From: Baz Date: Tue, 10 Jan 2023 15:09:42 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=89=20Source=20Airtable:=20update=20`r?= =?UTF-8?q?eleaseStage`=20to=20`beta`=20(#20935)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../resources/seed/source_definitions.yaml | 2 +- docs/integrations/sources/airtable.md | 57 +++++++++++++++---- 2 files changed, 46 insertions(+), 13 deletions(-) diff --git a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml index e98249090058..ffba8f0adc0e 100644 --- a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml +++ b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml @@ -21,7 +21,7 @@ documentationUrl: https://docs.airbyte.com/integrations/sources/airtable icon: airtable.svg sourceType: api - releaseStage: alpha + releaseStage: beta - name: Aha sourceDefinitionId: 81ca39dc-4534-4dd2-b848-b0cfd2c11fce dockerRepository: airbyte/source-aha diff --git a/docs/integrations/sources/airtable.md b/docs/integrations/sources/airtable.md index ea0a3b371456..52a529dfc95c 100644 --- a/docs/integrations/sources/airtable.md +++ b/docs/integrations/sources/airtable.md @@ -1,33 +1,66 @@ # Airtable -## Features +This page contains the setup guide and reference information for the Airtable source connector. +This source syncs data from the [Airtable API](https://airtable.com/api). + +## Prerequisites + +* An active Airtable account +* API Key (Personal Access Token) + +## Setup guide +### Step 1: Set up Airtable + +### For Airbyte Cloud: + +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`. + +### 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. 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`. + + +## 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 | | -This source syncs data from the [Airtable API](https://airtable.com/api). -## Supported Tables +## 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 configure any table in your Airtable base. 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. +Currently, this source connector works with `standard` subscription plan only. -## Getting started +Standard Scopes required for the successfull authentication: +* data.records:read +* data.recordComments:read +* schema.bases:read -### Requirements +The `Enterprise` level accounts are not supported yet. -* An Airtable account & API key +## Data type map -### Setup guide -1. To find your API key, navigate to your [account page](https://airtable.com/account). On your account overview page, under the API heading, there's a button that says "Generate API key." -![img.png](../../.gitbook/assets/airtable_api_key1.png) -2. Generate an API key by clicking the button. If one already exists, click the key to reveal it and copy it. ![img.png](../../.gitbook/assets/airtable_api_key2.png). See [here](https://support.airtable.com/hc/en-us/articles/219046777-How-do-I-get-my-API-key-) for more information on managing your API keys. +| Integration Type | Airbyte Type | +| :--------------------- | :----------- | +| `Any` | `string` | ### Performance Considerations (Airbyte Open-Source) -See information about rate limits [here](https://support.airtable.com/hc/en-us/articles/203313985-Public-REST-API). +See information about rate limits [here](https://airtable.com/developers/web/api/rate-limits). ## Changelog