Python Data Loading from Google Sheets to Snowflake with dlt
Join our Slack community or book a call with our support engineer Violetta.
This page provides technical documentation on how to utilize dlt
, an open-source Python library, to load data from Google Sheets
into Snowflake
. Google Sheets
is an online spreadsheet application that allows for real-time, secure sharing and editing of data from any device. More information about Google Sheets
can be found here. On the other hand, Snowflake
is a cloud-based data warehousing platform capable of storing, processing, and analyzing large volumes of data. By using dlt
, one can effectively transfer data from Google Sheets
to Snowflake
, enabling efficient data management and analysis.
dlt
Key Features
- Google Sheets Integration:
dlt
provides a verified source for Google Sheets, allowing you to easily load data from your Google Sheets into your preferred data destination. Learn more about this feature here. - Snowflake Destination: With
dlt
, you can easily send your data to Snowflake, a popular cloud-based data warehousing platform. The library supports password authentication, key pair authentication, and external authentication for secure data transfer. Learn more here. - Data Preparation:
dlt
offers detailed guidelines on how to prepare your data for extraction from Google Sheets. This includes sharing the sheet with the appropriate email, providing the spreadsheet ID/URL and range names, and ensuring your data has headers and is in a well-structured table. Learn more here. - Google Sheets Data Pipeline Example:
dlt
provides a minimal example of how to load Google Sheets data using Python and thedlt
library. This example covers working with the Google API, using built-in credentials, union of credentials, and creating dynamically generated resources. Check out the example here. - Governance Support:
dlt
pipelines offer robust governance support through pipeline metadata utilization, schema enforcement and curation, and schema change alerts. These features contribute to better data management practices, compliance adherence, and overall data governance. Learn more about these features 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 Snowflake
:
pip install "dlt[snowflake]"
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 Google Sheets
to Snowflake
. You can run the following commands to create a starting point for loading data from Google Sheets
to Snowflake
:
# create a new directory
mkdir google_sheets_pipeline
cd google_sheets_pipeline
# initialize a new pipeline with your source and destination
dlt init google_sheets snowflake
# 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
:
google-api-python-client
dlt[snowflake]>=0.3.25
You now have the following folder structure in your project:
google_sheets_pipeline/
├── .dlt/
│ ├── config.toml # configs for your pipeline
│ └── secrets.toml # secrets for your pipeline
├── google_sheets/ # folder with source specific files
│ └── ...
├── google_sheets_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.google_sheets]
spreadsheet_url_or_id = "spreadsheet_url_or_id" # please set me up!
range_names =
["a", "b", "c"] # 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.google_sheets.credentials]
client_id = "client_id" # please set me up!
client_secret = "client_secret" # please set me up!
refresh_token = "refresh_token" # please set me up!
project_id = "project_id" # please set me up!
[destination.snowflake.credentials]
database = "database" # please set me up!
password = "password" # please set me up!
username = "username" # please set me up!
host = "host" # please set me up!
warehouse = "warehouse" # please set me up!
role = "role" # please set me up!
2.1. Adjust the generated code to your usecase
3. Running your pipeline for the first time
The dlt
cli has also created a main pipeline script for you at google_sheets_pipeline.py
, as well as a folder google_sheets
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 Sequence
import dlt
from google_sheets import google_spreadsheet
def load_pipeline_with_ranges(
spreadsheet_url_or_id: str, range_names: Sequence[str]
) -> None:
"""
Loads explicitly passed ranges
"""
pipeline = dlt.pipeline(
pipeline_name="google_sheets_pipeline",
destination='snowflake',
full_refresh=True,
dataset_name="test",
)
data = google_spreadsheet(
spreadsheet_url_or_id=spreadsheet_url_or_id,
range_names=range_names,
get_sheets=False,
get_named_ranges=False,
)
info = pipeline.run(data)
print(info)
def load_pipeline_with_sheets(spreadsheet_url_or_id: str) -> None:
"""
Will load all the sheets in the spreadsheet, but it will not load any of the named ranges in the spreadsheet.
"""
pipeline = dlt.pipeline(
pipeline_name="google_sheets_pipeline",
destination='snowflake',
full_refresh=True,
dataset_name="sample_google_sheet_data",
)
data = google_spreadsheet(
spreadsheet_url_or_id=spreadsheet_url_or_id,
get_sheets=True,
get_named_ranges=False,
)
info = pipeline.run(data)
print(info)
def load_pipeline_with_named_ranges(spreadsheet_url_or_id: str) -> None:
"""
Will not load the sheets in the spreadsheet, but it will load all the named ranges in the spreadsheet.
"""
pipeline = dlt.pipeline(
pipeline_name="google_sheets_pipeline",
destination='snowflake',
full_refresh=True,
dataset_name="sample_google_sheet_data",
)
data = google_spreadsheet(
spreadsheet_url_or_id=spreadsheet_url_or_id,
get_sheets=False,
get_named_ranges=True,
)
info = pipeline.run(data)
print(info)
def load_pipeline_with_sheets_and_ranges(spreadsheet_url_or_id: str) -> None:
"""
Will load all the sheets in the spreadsheet and all the named ranges in the spreadsheet.
"""
pipeline = dlt.pipeline(
pipeline_name="google_sheets_pipeline",
destination='snowflake',
full_refresh=True,
dataset_name="sample_google_sheet_data",
)
data = google_spreadsheet(
spreadsheet_url_or_id=spreadsheet_url_or_id,
get_sheets=True,
get_named_ranges=True,
)
info = pipeline.run(data)
print(info)
def load_with_table_rename_and_multiple_spreadsheets(
spreadsheet_url_or_id: str, range_names: Sequence[str]
) -> None:
"""Demonstrates how to load two spreadsheets in one pipeline and how to rename tables"""
pipeline = dlt.pipeline(
pipeline_name="google_sheets_pipeline",
destination='snowflake',
full_refresh=True,
dataset_name="sample_google_sheet_data",
)
# take data from spreadsheet 1
data = google_spreadsheet(
spreadsheet_url_or_id=spreadsheet_url_or_id,
range_names=[range_names[0]],
get_named_ranges=False,
)
# take data from spreadsheet 2
data_2 = google_spreadsheet(
spreadsheet_url_or_id=spreadsheet_url_or_id,
range_names=[range_names[1]],
get_named_ranges=False,
)
# apply the table name to the existing resource: the resource name is the name of the range
data.resources[range_names[0]].apply_hints(table_name="first_sheet_data")
data_2.resources[range_names[1]].apply_hints(table_name="second_sheet_data")
# load two spreadsheets
info = pipeline.run([data, data_2])
print(info)
# yes the tables are there
user_tables = pipeline.default_schema.data_tables()
# check if table is there
assert {t["name"] for t in user_tables} == {
"first_sheet_data",
"second_sheet_data",
"spreadsheet_info",
}
if __name__ == "__main__":
url_or_id = "1HhWHjqouQnnCIZAFa2rL6vT91YRN8aIhts22SUUR580"
range_names = ["hidden_columns_merged_cells", "Blank Columns"]
load_pipeline_with_ranges(url_or_id, range_names)
load_pipeline_with_sheets(url_or_id)
load_pipeline_with_named_ranges(url_or_id)
load_pipeline_with_sheets_and_ranges(url_or_id)
load_with_table_rename_and_multiple_spreadsheets(url_or_id, range_names)
Provided you have set up your credentials, you can run your pipeline like a regular python script with the following command:
python google_sheets_pipeline.py
4. Inspecting your load result
You can now inspect the state of your pipeline with the dlt
cli:
dlt pipeline google_sheets_pipeline info
You can also use streamlit to inspect the contents of your Snowflake
destination for this:
# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline google_sheets_pipeline 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:
dlt
supports deploying your pipelines using Github Actions. This involves setting up a Github Action that triggers your pipeline according to a specified schedule. - Deploy with Airflow: You can also deploy your
dlt
pipelines using Airflow. This involves setting up an Airflow DAG for your pipeline and customizing it according to your requirements. - Deploy with Google Cloud Functions:
dlt
allows you to deploy your pipelines using Google Cloud Functions. This involves setting up a Google Cloud Function that triggers your pipeline. - Other Deployment Options:
dlt
supports a variety of other deployment options. You can find more information on these options here.
The running in production section will teach you about:
- Monitor your pipeline:
dlt
provides comprehensive tools to monitor your pipeline's performance and status. You can inspect the load info and trace, save and alert on schema changes, and more. Learn more about it here. - Set up alerts:
dlt
allows you to set up alerts to notify you about the status of your pipeline. This feature is particularly useful for keeping track of any issues that may arise during the data extraction and loading process. Learn more about setting up alerts here. - Set up tracing: Tracing is an important aspect of running your pipeline in production. It allows you to track the execution of your pipeline and provides useful information for debugging and optimization. Learn more about setting up tracing here.
Additional pipeline guides
- Load data from Fivetran to EDB BigAnimal in python with dlt
- Load data from Keap to AWS S3 in python with dlt
- Load data from IBM Db2 to MotherDuck in python with dlt
- Load data from Keap to EDB BigAnimal in python with dlt
- Load data from Adobe Analytics to EDB BigAnimal in python with dlt
- Load data from Google Sheets to Timescale in python with dlt
- Load data from SAP HANA to DuckDB in python with dlt
- Load data from MySQL to ClickHouse in python with dlt
- Load data from Slack to PostgreSQL in python with dlt
- Load data from MongoDB to Timescale in python with dlt