Looker

tap-looker from singer-io

Business Intelligence (BI) & Data Analytics Platform

The tap-looker extractor pulls data from Looker that can then be sent to a destination using a loader.

Available Variants

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-looker extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-looker
  3. Configure the tap-looker settings using
    meltano config
    :
  4. meltano config tap-looker set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-looker test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-looker may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-looker settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Client Secret (client_secret)

  • Environment variable: TAP_LOOKER_CLIENT_SECRET

Your API3 Keys client secret.

Start Date (start_date)

  • Environment variable: TAP_LOOKER_START_DATE

Currently not used because the Looker API doesnt support query filtering, sorting, pagination. Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

User Agent (user_agent)

  • Environment variable: TAP_LOOKER_USER_AGENT

The user agent to send with requests.

Subdomain (subdomain)

  • Environment variable: TAP_LOOKER_SUBDOMAIN

The leading part of Looker URL before .looker.com; https://.looker.com

API Port (api_port)

  • Environment variable: TAP_LOOKER_API_PORT

The API port for the Looker instance. Uusually 19999, unless you are hosting Looker internally and are using a different port for the API.

Domain (domain)

  • Environment variable: TAP_LOOKER_DOMAIN

Is usually looker.com, unless you have your own white-labeled URL.

Client ID (client_id)

  • Environment variable: TAP_LOOKER_CLIENT_ID

Your API3 Keys client ID.

Commands

The tap-looker extractor supports the following commands that can be used with
meltano invoke
:

Additional Notes

This tap uses Looker's API v3.1 https://developers.looker.com/api/explorer/3.1.

  • All endpoints replicate FULL_TABLE (ALL records, every time). Currently, the Looker API does not support paginating, sorting, filtering, or providing audit fields (like created/modified datetimes).
  • Primary Key field(s): Almost all endpoint have an id primary key
    • lookml_models, models, git_branches use a combination key of name and project_name
    • git_branches use a combination key of name and project_id
    • project_files use id and project_id
    • connections use name
    • user_attribute_values use user_id and user_attribute_id
    • group_attribute_values use group_id and attribute_value_id
  • Transformations: Remove can nodes; IDs to string; fix JSON validation errors (datatypes)
  • ALL JSON schema generated from Looker API Swagger Definitions

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-looker extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-looker

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api