The tap-looker
extractor
pulls data from
Looker that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Alternate Implementations
- Airbyte🥉
- Bytecode IO
- Stitch Data (default)🥈
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-looker extractor to your
project using
:meltano add
-
Configure the tap-looker
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-looker --variant airbyte
meltano config tap-looker set --interactive
meltano config tap-looker test
Next steps
Follow the remaining steps of the Getting Started guide:
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:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
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:
airbyte_config.client_id
airbyte_config.client_secret
airbyte_config.domain
airbyte_config.run_look_ids
airbyte_spec.image
airbyte_spec.tag
docker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-looker 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.
Airbyte Config Client Id (airbyte_config.client_id)
-
Environment variable:
TAP_LOOKER_AIRBYTE_CONFIG_CLIENT_ID
The Client ID is first part of an API3 key that is specific to each Looker user. See the docs for more information on how to generate this key.
Configure this setting directly using the following Meltano command:
meltano config tap-looker set airbyte_config client_id [value]
Airbyte Config Client Secret (airbyte_config.client_secret)
-
Environment variable:
TAP_LOOKER_AIRBYTE_CONFIG_CLIENT_SECRET
The Client Secret is second part of an API3 key.
Configure this setting directly using the following Meltano command:
meltano config tap-looker set airbyte_config client_secret [value]
Airbyte Config Domain (airbyte_config.domain)
-
Environment variable:
TAP_LOOKER_AIRBYTE_CONFIG_DOMAIN
Domain for your Looker account, e.g. airbyte.cloud.looker.com,looker.[clientname].com,IP address
Configure this setting directly using the following Meltano command:
meltano config tap-looker set airbyte_config domain [value]
Airbyte Config Run Look Ids (airbyte_config.run_look_ids)
-
Environment variable:
TAP_LOOKER_AIRBYTE_CONFIG_RUN_LOOK_IDS
The IDs of any Looks to run (optional)
Configure this setting directly using the following Meltano command:
meltano config tap-looker set airbyte_config run_look_ids [value]
Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_LOOKER_AIRBYTE_SPEC_IMAGE
-
Default Value:
airbyte/source-looker
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-looker set airbyte_spec image [value]
Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_LOOKER_AIRBYTE_SPEC_TAG
-
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-looker set airbyte_spec tag [value]
Docker Mounts (docker_mounts)
-
Environment variable:
TAP_LOOKER_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-looker set docker_mounts [value]
Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_LOOKER_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-looker set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_LOOKER_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-looker set flattening_max_depth [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_LOOKER_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-looker set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_LOOKER_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-looker set stream_maps [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.