Skip to main content

Load Data from google sheets to azure synapse using Python and dlt

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 Adrian.

This page provides technical documentation on how to load data from Google Sheets to Azure Synapse using an open-source Python library, dlt. Google Sheets is a versatile online spreadsheet application that allows for secure, real-time data sharing from any device. On the other hand, Azure Synapse is a comprehensive analytics service, combining enterprise data warehousing and Big Data analytics. The dlt library facilitates this data interaction, providing an efficient bridge between these two platforms. For more information about Google Sheets, visit https://www.google.com/sheets/about/.

dlt Key Features​

  • Automated Maintenance: With schema inference and evolution and alerts, and with short declarative code, maintenance becomes simple. Learn more here.

  • User-friendly Interface: dlt provides a user-friendly, declarative interface that removes knowledge obstacles for beginners while empowering senior professionals. Learn more here.

  • Run it anywhere Python runs: You can run dlt on Airflow, serverless functions, notebooks. No external APIs, backends or containers, scales on micro and large infra alike. Learn more here.

  • Google Sheets Data Pipeline: Learn how to load Google Sheets data using Python and the dlt library. It covers working with Google API, using built in credentials, using union of credentials, and creating dynamically generated resources. Learn more here.

  • Governance Support in dlt Pipelines: dlt pipelines offer robust governance support through three key mechanisms: pipeline metadata utilization, schema enforcement and curation, and schema change alerts. Learn more 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 Azure Synapse:

pip install "dlt[synapse]"

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 Azure Synapse. You can run the following commands to create a starting point for loading data from Google Sheets to Azure Synapse:

# create a new directory
mkdir my-google_sheets-pipeline
cd my-google_sheets-pipeline
# initialize a new pipeline with your source and destination
dlt init google_sheets synapse
# 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[synapse]>=0.3.25

You now have the following folder structure in your project:

my-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:

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!

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.synapse]
create_indexes = false
default_table_index_type = "heap"
staging_use_msi = false

[destination.synapse.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!
port = 1433
connect_timeout = 15
driver = "driver" # please set me up!
Further help setting up your source and destinations

Please consult the detailed setup instructions for the Azure Synapse destination in the dlt destinations documentation.

Likewise you can find the setup instructions for Google Sheets source in the dlt verifed sources documentation.

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='synapse',
        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='synapse',
        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='synapse',
        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='synapse',
        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='synapse',
        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 Azure Synapse 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 provides a way to deploy your pipelines using Github Actions. This allows you to automate your workflows and run them on a schedule or in response to events.
  • Deploy with Airflow: You can also deploy your dlt pipelines using Airflow, a popular open-source platform used to author, schedule and monitor workflows.
  • Deploy with Google Cloud Functions: dlt supports deployment with Google Cloud Functions, enabling you to run your pipelines in a serverless environment.
  • Other Deployment Options: For other deployment methods, you can check out the deployment documentation on the dlt website.

The running in production section will teach you about:​

  • Monitor your pipeline: dlt provides you with the ability to monitor your pipeline and keep track of its performance and status. You can check out the guide on how to monitor your pipeline for more details.
  • Set up alerts: With dlt, you can set up alerts to get notified about any issues or changes in your pipeline. This allows you to take immediate action whenever necessary. Learn how to set up alerts with dlt.
  • Set up tracing: Tracing is an important aspect of running dlt in production. It allows you to understand the flow of data and identify any potential bottlenecks or issues. Check out the guide on how to set up tracing for more information.

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.