Skip to main content

Loading Data from Looker to Timescale Using dlt in Python

tip

We will be using the dlt PostgreSQL destination to connect to Timescale. You can get the connection string for your timescale database as described in the Timescale Docs.

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 designed for businesses to explore, analyze, and share real-time analytics with ease. It offers robust tools for data visualization, dashboards, and interactive reports, enabling data-driven decision-making. By connecting directly to databases, Looker allows users to create custom queries and visualizations without extensive SQL knowledge. On the other hand, Timescale is built on PostgreSQL and is engineered to handle demanding workloads such as time series, vector, events, and analytics data. It offers expert support at no extra charge. Using the open-source Python library dlt, you can efficiently load data from Looker to Timescale. This documentation will guide you through the process of setting up and executing data pipelines using dlt to transfer data seamlessly between these platforms. For more details about Looker, visit Looker.

dlt Key Features

  • Fetching data from the GitHub API: Learn how to extract data from the GitHub API using dlt. Read more
  • Understanding and managing data loading behaviors: Discover how to handle different data loading strategies. Read more
  • Incrementally loading new data and deduplicating existing data: Implement incremental loading to ensure only new data is fetched and loaded. Read more
  • Making our data fetch more dynamic and reducing code redundancy: Learn to optimize your data fetching process and minimize code repetition. Read more
  • Securely handling secrets: Understand how to manage and secure sensitive information in your data pipeline. Read 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 postgres 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 Timescale destination in our docs.

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 Timescale 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: Learn how to deploy a pipeline using GitHub Actions, a free CI/CD runner. Follow the detailed guide here.
  • Deploy with Airflow: Discover how to deploy a pipeline with Airflow and Google Composer. This guide provides step-by-step instructions here.
  • Deploy with Google Cloud Functions: Explore the process of deploying a pipeline with Google Cloud Functions. Detailed information can be found here.
  • Other Deployment Methods: For more deployment options and methods, check out the comprehensive list here.

The running in production section will teach you about:

  • How to Monitor your pipeline: Learn to monitor your dlt pipeline to ensure it runs smoothly and efficiently. How to Monitor your pipeline
  • Set up alerts: Configure alerts to stay informed about the status and performance of your dlt pipelines. Set up alerts
  • Set up tracing: Implement tracing to get detailed insights into the execution of your dlt pipelines. 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 NameWrite DispositionDescription
instanceappendRepresents an instance in Looker, containing configuration details and status of the instance.
audit_configappendContains audit configurations, which track user activities and changes within Looker.
locationappendDetails regarding the geographical location and associated settings of the Looker instance.
operationappendRepresents various operations performed within Looker, including their status and metadata.

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.