Skip to main content

Python Data Loading from airtable to aws s3 using dlt Library

Need help deploying these pipelines, or figuring out how to run them in your data stack?

Join our Slack community or book a call with our support engineer Violetta.

Welcome to the technical documentation on how to load data from airtable to AWS S3 using the open-source Python library, dlt. airtable is a cloud-based platform that combines the functionalities of spreadsheets and databases, making data management and collaboration easy. On the other hand, AWS S3 is a filesystem destination that allows you to store data on AWS S3 in various formats such as JSONL, Parquet, or CSV, making it ideal for creating datalakes. This guide will provide you with step-by-step instructions on how to effectively use dlt to transfer data from airtable to AWS S3. For more information on airtable, please visit https://www.airtable.com/.

dlt Key Features

  • Automated maintenance: With schema inference and evolution, alerts, and short declarative code, maintenance becomes simple. Learn more here.
  • Runs where Python runs: dlt can be run on Airflow, serverless functions, notebooks, and more. It doesn't require any external APIs, backends, or containers, and can scale on both micro and large infrastructure. Learn more here.
  • User-friendly, declarative interface: dlt provides a user-friendly, declarative interface that removes knowledge obstacles for beginners while empowering senior professionals. Learn more here.
  • Flexible initialization options: dlt allows you to deploy from a branch of the verified-sources repo or from another repo. You can find more about this in the advanced usage guide.
  • Supports various destinations: dlt supports a variety of destinations, including remote file systems and bucket storages like S3, Google Storage, and Azure Blob Storage. More details can be found here.

Getting started with your pipeline locally

0. Prerequisites

dlt requires Python 3.8 or higher. Additionally, you need to have the pip package manager installed, and we recommend using a virtual environment to manage your dependencies. You can learn more about preparing your computer for dlt in our installation reference.

1. Install dlt

First you need to install the dlt library with the correct extras for AWS S3:

pip install "dlt[filesystem]"

The dlt cli has a useful command to get you started with any combination of source and destination. For this example, we want to load data from Airtable to AWS S3. You can run the following commands to create a starting point for loading data from Airtable to AWS S3:

# create a new directory
mkdir airtable_pipeline
cd airtable_pipeline
# initialize a new pipeline with your source and destination
dlt init airtable filesystem
# install the required dependencies
pip install -r requirements.txt

The last command will install the required dependencies for your pipeline. The dependencies are listed in the requirements.txt:


pyairtable~=2.1
dlt[filesystem]>=0.3.25

You now have the following folder structure in your project:

airtable_pipeline/
├── .dlt/
│ ├── config.toml # configs for your pipeline
│ └── secrets.toml # secrets for your pipeline
├── airtable/ # folder with source specific files
│ └── ...
├── airtable_pipeline.py # your main pipeline script
├── requirements.txt # dependencies for your pipeline
└── .gitignore # ignore files for git (not required)

2. Configuring your source and destination credentials

The dlt cli will have created a .dlt directory in your project folder. This directory contains a config.toml file and a secrets.toml file that you can use to configure your pipeline. The automatically created version of these files look like this:

generated config.toml

# put your configuration values here

[runtime]
log_level="WARNING" # the system log level of dlt
# use the dlthub_telemetry setting to enable/disable anonymous usage data reporting, see https://dlthub.com/docs/telemetry
dlthub_telemetry = true

[sources.airtable]
base_id = "base_id" # please set me up!

generated secrets.toml

# put your secret values and credentials here. do not share this file and do not push it to github

[sources.airtable]
access_token = "access_token" # please set me up!

[destination.filesystem]
dataset_name = "dataset_name" # please set me up!
bucket_url = "bucket_url" # please set me up!

[destination.filesystem.credentials]
aws_access_key_id = "aws_access_key_id" # please set me up!
aws_secret_access_key = "aws_secret_access_key" # please set me up!

2.1. Adjust the generated code to your usecase

Further help setting up your source and destinations
  • Read more about setting up the Airtable source in our docs.
  • Read more about setting up the AWS S3 destination in our docs.

By default, the filesystem destination will store your files as JSONL. You can tell your pipeline to choose a different format with the loader_file_format property that you can set directly on the pipeline or via your config.toml. Available values are jsonl, parquet and csv:

[pipeline] # in ./dlt/config.toml
loader_file_format="parquet"

3. Running your pipeline for the first time

The dlt cli has also created a main pipeline script for you at airtable_pipeline.py, as well as a folder airtable that contains additional python files for your source. These files are your local copies which you can modify to fit your needs. In some cases you may find that you only need to do small changes to your pipelines or add some configurations, in other cases these files can serve as a working starting point for your code, but will need to be adjusted to do what you need them to do.

The main pipeline script will look something like this:


from typing import List, Dict, Any

import dlt

from airtable import airtable_source


def load_entire_base(base_id: str, resources_to_apply_hints: Dict[str, Any]) -> None:
"""
Loads all tables from the specified Airtable base.

Args:
base_id (str): The id of the base. Obtain it, e.g. from the URL in your web browser.
It starts with "app". See https://support.airtable.com/docs/finding-airtable-ids
resources_to_apply_hints (dict): Dict of table names and fields we want to apply hints.

Note:
- The base_id can either be passed directly or set up in ".dlt/config.toml".
"""
# configure the pipeline with your destination details
pipeline = dlt.pipeline(
pipeline_name="airtable", destination='filesystem', dataset_name="airtable_data"
)

# Retrieve data from Airtable using airtable_source.
airtables = airtable_source(base_id=base_id)

# typing columns to silence warnings
for resource_name, field_names in resources_to_apply_hints.items():
for field_name in field_names:
airtables.resources[resource_name].apply_hints(
columns={field_name: {"name": field_name, "data_type": "text"}}
)

load_info = pipeline.run(airtables, write_disposition="replace")
print(load_info)


def load_select_tables_from_base_by_id(base_id: str, table_names: List[str]) -> None:
"""
Load specific table IDs from Airtable to a data pipeline.

Args:
base_id (str): The id of the base. Obtain it, e.g. from the URL in your web browser.
It starts with "app". See https://support.airtable.com/docs/finding-airtable-ids
table_names (List[str]): A list of table IDs or table names to load. Unless specified otherwise,
all tables in the schema are loaded. Names are freely user-defined. IDs start with "tbl".
See https://support.airtable.com/docs/finding-airtable-ids
resources_to_apply_hints (dict): Dict of table names and fields we want to apply hints.

Note:
- Filtering by names is less reliable than filtering on IDs because names can be changed by Airtable users.
- Example in this Airtable URL: https://airtable.com/app7RlqvdoOmJm9XR/tblKHM5s3AujfSbAH
- Table ID: "tblKHM5s3AujfSbAH"
- The base_id and table_names can either be passed directly or set up in ".dlt/config.toml".
"""

# configure the pipeline with your destination details
pipeline = dlt.pipeline(
pipeline_name="airtable", destination='filesystem', dataset_name="airtable_data"
)

airtables = airtable_source(
base_id=base_id,
table_names=table_names,
)

load_info = pipeline.run(airtables, write_disposition="replace")
print(load_info)


def load_select_tables_from_base_by_name(
base_id: str, table_names: List[str], resources_to_apply_hints: Dict[str, Any]
) -> None:
"""
Loads specific table names from an Airtable base.

Args:
base_id (str): The id of the base. Obtain it, e.g. from the URL in your web browser.
It starts with "app". See https://support.airtable.com/docs/finding-airtable-ids
table_names (List[str]): A list of table IDs or table names to load. Unless specified otherwise,
all tables in the schema are loaded. Names are freely user-defined. IDs start with "tbl".
See https://support.airtable.com/docs/finding-airtable-idss
resources_to_apply_hints (dict): Dict of table names and fields we want to apply hints.

Note:
- Filtering by names is less reliable than filtering on IDs because names can be changed by Airtable users.
- Example in this Airtable URL: https://airtable.com/app7RlqvdoOmJm9XR/tblKHM5s3AujfSbAH
- Table ID: "tblKHM5s3AujfSbAH"
- The base_id and table_names can either be passed directly or set up in ".dlt/config.toml".
"""
pipeline = dlt.pipeline(
pipeline_name="airtable", destination='filesystem', dataset_name="airtable_data"
)

airtables = airtable_source(
base_id=base_id,
table_names=table_names,
)

# typing columns to silence warnings
for resource_name, field_names in resources_to_apply_hints.items():
for field_name in field_names:
airtables.resources[resource_name].apply_hints(
columns={field_name: {"name": field_name, "data_type": "text"}}
)

load_info = pipeline.run(airtables, write_disposition="replace")
print(load_info)


def load_and_customize_write_disposition(
base_id: str, table_names: List[str], resources_to_apply_hints: Dict[str, Any]
) -> None:
"""
Loads data from a specific Airtable base's table with customized write disposition("merge") using field_name.

Args:
base_id (str): The id of the base. Obtain it, e.g. from the URL in your web browser.
It starts with "app". See https://support.airtable.com/docs/finding-airtable-ids
table_names (List[str]): A list of table IDs or table names to load. Unless specified otherwise,
all tables in the schema are loaded. Names are freely user-defined. IDs start with "tbl".
See https://support.airtable.com/docs/finding-airtable-ids
resources_to_apply_hints (dict): Dict of table names and fields we want to apply hints.


Note:
- Filtering by names is less reliable than filtering on IDs because names can be changed by Airtable users.
- Example in this Airtable URL: https://airtable.com/app7RlqvdoOmJm9XR/tblKHM5s3AujfSbAH
- Table ID: "tblKHM5s3AujfSbAH"
- The base_id and table_names can either be passed directly or set up in ".dlt/config.toml".

"""
pipeline = dlt.pipeline(
pipeline_name="airtable", destination='filesystem', dataset_name="airtable_data"
)

airtables = airtable_source(
base_id=base_id,
table_names=table_names,
)

# typing columns to silence warnings
for resource_name, field_names in resources_to_apply_hints.items():
for field_name in field_names:
airtables.resources[resource_name].apply_hints(
primary_key=field_name,
columns={field_name: {"name": field_name, "data_type": "text"}},
write_disposition="merge",
)

load_info = pipeline.run(airtables)
print(load_info)


if __name__ == "__main__":
load_entire_base(
base_id="app7RlqvdoOmJm9XR",
resources_to_apply_hints={
"🎤 Speakers": ["Name"],
"📆 Schedule": ["Activity"],
"🪑 Attendees": ["Name"],
"💰 Budget": ["Item"],
},
)
load_select_tables_from_base_by_id(
base_id="app7RlqvdoOmJm9XR",
table_names=["tblKHM5s3AujfSbAH", "tbloBrS8PnoO63aMP"],
)
load_select_tables_from_base_by_name(
"app7RlqvdoOmJm9XR",
table_names=["💰 Budget"],
resources_to_apply_hints={"💰 Budget": ["Item"]},
)
load_and_customize_write_disposition(
base_id="appcChDyP0pZeC76v",
table_names=["tbl1sN4CpPv8pBll4"],
resources_to_apply_hints={"Sheet1": ["Name"]},
)

Provided you have set up your credentials, you can run your pipeline like a regular python script with the following command:

python airtable_pipeline.py

4. Inspecting your load result

You can now inspect the state of your pipeline with the dlt cli:

dlt pipeline airtable info

You can also use streamlit to inspect the contents of your AWS S3 destination for this:

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline airtable show

5. Next steps to get your pipeline running in production

One of the beauties of dlt is, that we are just a plain Python library, so you can run your pipeline in any environment that supports Python >= 3.8. We have a couple of helpers and guides in our docs to get you there:

The Deploy section will show you how to deploy your pipeline to

  • Deploy with GitHub Actions: Use GitHub Actions to run your dlt pipelines on a CI/CD runner. Follow the guide here.
  • Deploy with Airflow and Google Composer: Leverage Airflow and Google Composer to manage your dlt pipelines. Learn more here.
  • Deploy with Google Cloud Functions: Utilize Google Cloud Functions for serverless deployment of your dlt pipelines. See the detailed instructions here.
  • Explore other deployment options: Discover various other methods to deploy your dlt pipelines. Check out the comprehensive guide here.

The running in production section will teach you about:

  • How to Monitor your pipeline: Learn how to effectively monitor your dlt pipeline in production by following the How to Monitor your pipeline guide.
  • Set up alerts: Ensure you are promptly notified of any issues or changes by setting up alerts. Follow the instructions in the Set up alerts guide.
  • And set up tracing: Implement tracing to gain detailed insights into your pipeline's performance and execution. Check out the And set up tracing guide.

Additional pipeline guides

This demo works on codespaces. Codespaces is a development environment available for free to anyone with a Github account. You'll be asked to fork the demo repository and from there the README guides you with further steps.
The demo uses the Continue VSCode extension.

Off to codespaces!

DHelp

Ask a question

Welcome to "Codex Central", your next-gen help center, driven by OpenAI's GPT-4 model. It's more than just a forum or a FAQ hub – it's a dynamic knowledge base where coders can find AI-assisted solutions to their pressing problems. With GPT-4's powerful comprehension and predictive abilities, Codex Central provides instantaneous issue resolution, insightful debugging, and personalized guidance. Get your code running smoothly with the unparalleled support at Codex Central - coding help reimagined with AI prowess.