Databricks

Meltano Community

tap-databricks (dron-a variant)

Open source connector supported by the Meltano Community, a growing community of over 5500+ data engineers.

Open source Join Slack community

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

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-databricks extractor to your project using 
    meltano add
     : 
    2. meltano add tap-databricks
  2. Configure the tap-databricks settings using 
    meltano config
     : 
    3. meltano config tap-databricks set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-databricks test

Next steps

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

Capabilities

The current capabilities for tap-databricks 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
  • activate-version
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps
  • structured-logging

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

Settings

The tap-databricks 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 also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-databricks 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.

Access Token (access_token)

  • Environment variable: TAP_DATABRICKS_ACCESS_TOKEN

Databricks personal access token


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set access_token [value]

Catalog (catalog)

  • Environment variable: TAP_DATABRICKS_CATALOG

Unity Catalog catalog to extract from


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set catalog [value]

Client ID (client_id)

  • Environment variable: TAP_DATABRICKS_CLIENT_ID

Service principal Client ID (M2M auth)


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set client_id [value]

Client Secret (client_secret)

  • Environment variable: TAP_DATABRICKS_CLIENT_SECRET

Service principal OAuth secret (M2M auth)


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set client_secret [value]

Max Key Length (flattening_max_key_length)

  • Environment variable: TAP_DATABRICKS_FLATTENING_MAX_KEY_LENGTH

The maximum length of a flattened key.


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set flattening_max_key_length [value]

Flattening Separator (flattening_separator)

  • Environment variable: TAP_DATABRICKS_FLATTENING_SEPARATOR

The separator to use when flattening keys.


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set flattening_separator [value]

HTTP Path (http_path)

  • Environment variable: TAP_DATABRICKS_HTTP_PATH

SQL Warehouse / cluster HTTP path, e.g. /sql/1.0/warehouses/abc123


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set http_path [value]

Schema (schema)

  • Environment variable: TAP_DATABRICKS_SCHEMA

Optional schema to scope extraction; if omitted, all schemas in the catalog are discovered


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set schema [value]

Server Hostname (server_hostname)

  • Environment variable: TAP_DATABRICKS_SERVER_HOSTNAME

Workspace hostname, e.g. dbc-xxxx.cloud.databricks.com (no https://)


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set server_hostname [value]

Use Singer Decimal (use_singer_decimal)

  • Environment variable: TAP_DATABRICKS_USE_SINGER_DECIMAL

Whether to use use strings with x-singer.decimal format for decimals in the discovered schema. This is useful to avoid precision loss when working with large numbers.


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set use_singer_decimal [value]
Expand To Show SDK Settings

Faker Locale (faker_config.locale)

  • Environment variable: TAP_DATABRICKS_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set faker_config locale [value]

Faker Seed (faker_config.seed)

  • Environment variable: TAP_DATABRICKS_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

  • Environment variable: TAP_DATABRICKS_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

  • Environment variable: TAP_DATABRICKS_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-databricks set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

  • Environment variable: TAP_DATABRICKS_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-databricks set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_DATABRICKS_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-databricks 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?

If you're having trouble getting the tap-databricks 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.
Meltano Cloud

For ambitious analytics engineering teams that want an efficient, fully managed solution with personalised expert support, explore Meltano Cloud

  • No maintenance overhead
  • Rigorously tested
  • Expert support from Meltano
Learn more Book a demo

Install

meltano add tap-databricks

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/dron-a/tap-databricks
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • dron-a

Keywords

  • meltano_sdk