Load Data from Looker to Google Cloud Storage Using dlt in Python

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.

Looker is a modern data platform that enables businesses to explore, analyze, and share real-time business analytics easily. It provides powerful tools for data visualization, dashboards, and interactive reports. Looker helps businesses make data-driven decisions by connecting directly to their databases and allowing users to create custom queries and visualizations without needing extensive SQL knowledge. This documentation explains how to load data from Looker to Google Cloud Storage using the open-source Python library dlt. The Google Cloud Storage destination stores data on the Google Cloud Platform, facilitating the creation of data lakes. You can upload data as JSONL, Parquet, or CSV. Further information about Looker is available at https://looker.com.

dlt Key Features

• Governance Support: dlt pipelines offer robust governance through pipeline metadata, schema enforcement, and schema change alerts. Learn more.
• Readers Source and Filesystem: Stream files from AWS s3, GCS, Azure, or local filesystem using the reader source. Learn more.
• Google Storage Integration: Use Google Cloud Storage as a destination with dlt, sharing credentials with BigQuery if needed. Learn more.
• Snowflake Staging Support: Utilize s3 and gcs as file staging destinations for Snowflake, with support for parquet and jsonl formats. Learn more.
• Write Disposition Options: Handle write dispositions with append, replace, and merge options in the filesystem destination. Learn more.

Getting started with your pipeline locally

OpenAPI Source Generator dlt-init-openapi

This walkthrough makes use of the dlt-init-openapi generator cli tool. You can read more about it here. The code generated by this tool uses the dlt rest_api verified source, docs for this are here.

0. Prerequisites

dlt and dlt-init-openapi requires Python 3.9 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 and dlt-init-openapi

First you need to install the dlt-init-openapi cli tool.

pip install dlt-init-openapi

The dlt-init-openapi cli is a powerful generator which you can use to turn any OpenAPI spec into a dlt source to ingest data from that api. The quality of the generator source is dependent on how well the API is designed and how accurate the OpenAPI spec you are using is. You may need to make tweaks to the generated code, you can learn more about this here.

# generate pipeline
# NOTE: add_limit adds a global limit, you can remove this later
# NOTE: you will need to select which endpoints to render, you 
# can just hit Enter and all will be rendered.
dlt-init-openapi looker --url https://raw.githubusercontent.com/dlt-hub/openapi-specs/main/open_api_specs/Business/looker.yaml --global-limit 2
cd looker_pipeline
# install generated requirements
pip install -r requirements.txt

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

dlt>=0.4.12

You now have the following folder structure in your project:

looker_pipeline/
├── .dlt/
│   ├── config.toml          # configs for your pipeline
│   └── secrets.toml         # secrets for your pipeline
├── rest_api/                # The rest api verified source
│   └── ...
├── looker/                
│   └── __init__.py          # TODO: possibly tweak this file
├── looker_pipeline.py        # your main pipeline script
├── requirements.txt         # dependencies for your pipeline
└── .gitignore               # ignore files for git (not required)

1.1. Tweak looker/__init__.py

This file contains the generated configuration of your rest_api. You can continue with the next steps and leave it as is, but you might want to come back here and make adjustments if you need your rest_api source set up in a different way. The generated file for the looker source will look like this:

Click to view full file (169 lines)

from typing import List

import dlt
from dlt.extract.source import DltResource
from rest_api import rest_api_source
from rest_api.typing import RESTAPIConfig


@dlt.source(name="looker_source", max_table_nesting=2)
def looker_source(
        base_url: str = dlt.config.value,
) -> List[DltResource]:

    # source configuration
    source_config: RESTAPIConfig = {
        "client": {
            "base_url": base_url,
        },
        "resources": 
        [
        # Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
        {
            "name": "resourceget_iam_policy",
            "table_name": "audit_config",
            "endpoint": {
                "data_selector": "auditConfigs",
                "path": "/v1/{resource}:getIamPolicy",
                "params": {
                    # the parameters below can optionally be configured
                    # "$.xgafv": "OPTIONAL_CONFIG",
                    # "access_token": "OPTIONAL_CONFIG",
                    # "alt": "OPTIONAL_CONFIG",
                    # "callback": "OPTIONAL_CONFIG",
                    # "fields": "OPTIONAL_CONFIG",
                    # "key": "OPTIONAL_CONFIG",
                    # "oauth_token": "OPTIONAL_CONFIG",
                    # "prettyPrint": "OPTIONAL_CONFIG",
                    # "quotaUser": "OPTIONAL_CONFIG",
                    # "upload_protocol": "OPTIONAL_CONFIG",
                    # "uploadType": "OPTIONAL_CONFIG",
                    # "options.requestedPolicyVersion": "OPTIONAL_CONFIG",

                },
                "paginator": "auto",
            }
        },
        # Lists Instances in a given project and location.
        {
            "name": "instances",
            "table_name": "instance",
            "endpoint": {
                "data_selector": "instances",
                "path": "/v1/{parent}/instances",
                "params": {
                    "parent": "FILL_ME_IN", # TODO: fill in required path parameter
                    # the parameters below can optionally be configured
                    # "$.xgafv": "OPTIONAL_CONFIG",
                    # "access_token": "OPTIONAL_CONFIG",
                    # "alt": "OPTIONAL_CONFIG",
                    # "callback": "OPTIONAL_CONFIG",
                    # "fields": "OPTIONAL_CONFIG",
                    # "key": "OPTIONAL_CONFIG",
                    # "oauth_token": "OPTIONAL_CONFIG",
                    # "prettyPrint": "OPTIONAL_CONFIG",
                    # "quotaUser": "OPTIONAL_CONFIG",
                    # "upload_protocol": "OPTIONAL_CONFIG",
                    # "uploadType": "OPTIONAL_CONFIG",
                    # "pageSize": "OPTIONAL_CONFIG",
                    # "pageToken": "OPTIONAL_CONFIG",

                },
                "paginator": "auto",
            }
        },
        # Lists information about the supported locations for this service.
        {
            "name": "locations",
            "table_name": "location",
            "primary_key": "name",
            "write_disposition": "merge",
            "endpoint": {
                "data_selector": "locations",
                "path": "/v1/{name}/locations",
                "params": {
                    "name": "FILL_ME_IN", # TODO: fill in required path parameter
                    # the parameters below can optionally be configured
                    # "$.xgafv": "OPTIONAL_CONFIG",
                    # "access_token": "OPTIONAL_CONFIG",
                    # "alt": "OPTIONAL_CONFIG",
                    # "callback": "OPTIONAL_CONFIG",
                    # "fields": "OPTIONAL_CONFIG",
                    # "key": "OPTIONAL_CONFIG",
                    # "oauth_token": "OPTIONAL_CONFIG",
                    # "prettyPrint": "OPTIONAL_CONFIG",
                    # "quotaUser": "OPTIONAL_CONFIG",
                    # "upload_protocol": "OPTIONAL_CONFIG",
                    # "uploadType": "OPTIONAL_CONFIG",
                    # "filter": "OPTIONAL_CONFIG",
                    # "pageSize": "OPTIONAL_CONFIG",
                    # "pageToken": "OPTIONAL_CONFIG",

                },
                "paginator": "auto",
            }
        },
        # Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
        {
            "name": "",
            "table_name": "operation",
            "primary_key": "name",
            "write_disposition": "merge",
            "endpoint": {
                "data_selector": "$",
                "path": "/v1/{name}",
                "params": {
                    "name": "FILL_ME_IN", # TODO: fill in required path parameter
                    # the parameters below can optionally be configured
                    # "$.xgafv": "OPTIONAL_CONFIG",
                    # "access_token": "OPTIONAL_CONFIG",
                    # "alt": "OPTIONAL_CONFIG",
                    # "callback": "OPTIONAL_CONFIG",
                    # "fields": "OPTIONAL_CONFIG",
                    # "key": "OPTIONAL_CONFIG",
                    # "oauth_token": "OPTIONAL_CONFIG",
                    # "prettyPrint": "OPTIONAL_CONFIG",
                    # "quotaUser": "OPTIONAL_CONFIG",
                    # "upload_protocol": "OPTIONAL_CONFIG",
                    # "uploadType": "OPTIONAL_CONFIG",

                },
                "paginator": "auto",
            }
        },
        # Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
        {
            "name": "operations",
            "table_name": "operation",
            "primary_key": "name",
            "write_disposition": "merge",
            "endpoint": {
                "data_selector": "operations",
                "path": "/v1/{name}/operations",
                "params": {
                    "name": "FILL_ME_IN", # TODO: fill in required path parameter
                    # the parameters below can optionally be configured
                    # "$.xgafv": "OPTIONAL_CONFIG",
                    # "access_token": "OPTIONAL_CONFIG",
                    # "alt": "OPTIONAL_CONFIG",
                    # "callback": "OPTIONAL_CONFIG",
                    # "fields": "OPTIONAL_CONFIG",
                    # "key": "OPTIONAL_CONFIG",
                    # "oauth_token": "OPTIONAL_CONFIG",
                    # "prettyPrint": "OPTIONAL_CONFIG",
                    # "quotaUser": "OPTIONAL_CONFIG",
                    # "upload_protocol": "OPTIONAL_CONFIG",
                    # "uploadType": "OPTIONAL_CONFIG",
                    # "filter": "OPTIONAL_CONFIG",
                    # "pageSize": "OPTIONAL_CONFIG",
                    # "pageToken": "OPTIONAL_CONFIG",

                },
                "paginator": "auto",
            }
        },
        ]
    }

    return rest_api_source(source_config)

2. Configuring your source and destination credentials

info

dlt-init-openapi will try to detect which authentication mechanism (if any) is used by the API in question and add a placeholder in your secrets.toml.

• If you know your API needs authentication, but none was detected, you can learn more about adding authentication to the rest_api here.
• OAuth detection currently is not supported, but you can supply your own authentication mechanism as outlined here.

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

[runtime]
log_level="INFO"

[sources.looker]
# Base URL for the API
base_url = "https://looker.googleapis.com/"

generated secrets.toml

[sources.looker]
# secrets for your looker source
# example_api_key = "example value"

2.1. Adjust the generated code to your usecase

Further help setting up your source and destinations

At this time, the dlt-init-openapi cli tool will always create pipelines that load to a local duckdb instance. Switching to a different destination is trivial, all you need to do is change the destination parameter in looker_pipeline.py to filesystem and supply the credentials as outlined in the destination doc linked below.

• Read more about setting up the rest_api source in our docs.
• Read more about setting up the Google Cloud Storage destination in our docs.

The default filesystem destination is configured to connect to AWS S3. To load to Google Cloud Storage, update the [destination.filesystem.credentials] section in your secrets.toml.

[destination.filesystem.credentials]
client_email="Please set me up!"
private_key="Please set me up!"
project_id="Please set me up!"

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 looker_pipeline.py, as well as a folder looker 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:

import dlt

from looker import looker_source


if __name__ == "__main__":
    pipeline = dlt.pipeline(
        pipeline_name="looker_pipeline",
        destination='duckdb',
        dataset_name="looker_data",
        progress="log",
        export_schema_path="schemas/export"
    )
    source = looker_source()
    info = pipeline.run(source)
    print(info)

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

python looker_pipeline.py

4. Inspecting your load result

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

dlt pipeline looker_pipeline info

You can also use streamlit to inspect the contents of your Google Cloud Storage destination for this:

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline looker_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: Automate your deployment process using GitHub Actions. Follow the guide to set up a CI/CD pipeline with GitHub Actions.
• Deploy with Airflow: Use Google Composer to manage your Airflow environments and deploy pipelines. Learn more in the Airflow deployment guide.
• Deploy with Google Cloud Functions: Utilize Google Cloud Functions for serverless deployment of your pipelines. Check out the steps in the Google Cloud Functions deployment guide.
• Explore other deployment options: Discover various methods to deploy your dlt pipelines by visiting the deployment walkthroughs.

The running in production section will teach you about:

• How to Monitor your pipeline: Learn how to effectively monitor your dlt pipeline to ensure it runs smoothly in production. How to Monitor your pipeline
• Set up alerts: Set up alerts to get notified of any issues or changes in your dlt pipeline. Set up alerts
• Set up tracing: Implement tracing to track and debug your dlt pipeline's execution in detail. And set up tracing

Available Sources and Resources

For this verified source the following sources and resources are available

Source Looker

Streams Looker data including configurations, operations, and audit logs.

Resource Name	Write Disposition	Description
instance	append	Represents an instance in Looker, containing configuration details and status of the instance.
audit_config	append	Contains audit configurations, which track user activities and changes within Looker.
location	append	Details regarding the geographical location and associated settings of the Looker instance.
operation	append	Represents various operations performed within Looker, including their status and metadata.

Additional pipeline guides

• Load data from Adobe Commerce (Magento) to Supabase in python with dlt
• Load data from Keap to AlloyDB in python with dlt
• Load data from Google Sheets to DuckDB in python with dlt
• Load data from Klaviyo to Dremio in python with dlt
• Load data from Rest API to MotherDuck in python with dlt
• Load data from Qualtrics to Databricks in python with dlt
• Load data from DigitalOcean to Azure Synapse in python with dlt
• Load data from Bitbucket to AWS Athena in python with dlt
• Load data from Rest API to AlloyDB in python with dlt
• Load data from HubSpot to Timescale in python with dlt