tap-google-sheets - Meltano Hub

Google Sheets

tap-google-sheets (matatika variant)🥇

Cloud Spreadsheets

The tap-google-sheets extractor pulls data from Google Sheets that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

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

Installation and configuration

Add the tap-google-sheets extractor to your project using
```
meltano add
```
:

meltano add extractor tap-google-sheets

Configure the tap-google-sheets settings using

meltano config

:

meltano config tap-google-sheets set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-google-sheets 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-google-sheets 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
batch
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-google-sheets 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:

child_sheet_name
key_properties
oauth_credentials.client_id
oauth_credentials.client_secret
oauth_credentials.refresh_token
output_name
range
sheet_id
sheets

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

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

Child Sheet Name (child_sheet_name)

Environment variable: TAP_GOOGLE_SHEETS_CHILD_SHEET_NAME

Optionally sync data from a different sheet in your Google Sheet

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set child_sheet_name [value]

Key Properties (key_properties)

Environment variable: TAP_GOOGLE_SHEETS_KEY_PROPERTIES

Optionally choose one or more primary key columns

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set key_properties [value]

OAuth Credentials Client ID (oauth_credentials.client_id)

Environment variable: TAP_GOOGLE_SHEETS_OAUTH_CREDENTIALS_CLIENT_ID

Your google client_id

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set oauth_credentials client_id [value]

OAuth Credentials Client Secret (oauth_credentials.client_secret)

Environment variable: TAP_GOOGLE_SHEETS_OAUTH_CREDENTIALS_CLIENT_SECRET

Your google client_secret

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set oauth_credentials client_secret [value]

OAuth Credentials Refresh Token (oauth_credentials.refresh_token)

Environment variable: TAP_GOOGLE_SHEETS_OAUTH_CREDENTIALS_REFRESH_TOKEN

Your google refresh token

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set oauth_credentials refresh_token [value]

Output Name (output_name)

Environment variable: TAP_GOOGLE_SHEETS_OUTPUT_NAME

Optionally rename your output file or table

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set output_name [value]

Range (range)

Environment variable: TAP_GOOGLE_SHEETS_RANGE

Optionally choose a range of data using cell start and end coordinates - see A1 notation for more information

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set range [value]

Sheet ID (sheet_id)

Environment variable: TAP_GOOGLE_SHEETS_SHEET_ID

Your google sheet id

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set sheet_id [value]

Sheets (sheets)

Environment variable: TAP_GOOGLE_SHEETS_SHEETS

The list of configs for each sheet/stream.

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set sheets [value]

Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

Environment variable: TAP_GOOGLE_SHEETS_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set batch_config encoding.compression [value]

Batch Encoding Format (batch_config.encoding.format)

Environment variable: TAP_GOOGLE_SHEETS_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set batch_config encoding.format [value]

Batch Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_GOOGLE_SHEETS_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set batch_config storage.prefix [value]

Batch Storage Root (batch_config.storage.root)

Environment variable: TAP_GOOGLE_SHEETS_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set batch_config storage.root [value]

Faker Locale (faker_config.locale)

Environment variable: TAP_GOOGLE_SHEETS_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-google-sheets set faker_config locale [value]

Faker Seed (faker_config.seed)

Environment variable: TAP_GOOGLE_SHEETS_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-google-sheets set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

Environment variable: TAP_GOOGLE_SHEETS_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

Environment variable: TAP_GOOGLE_SHEETS_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-google-sheets set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

Environment variable: TAP_GOOGLE_SHEETS_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-google-sheets set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_GOOGLE_SHEETS_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-google-sheets 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-google-sheets 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-google-sheets

Maintenance Status

Repo

https://github.com/Matatika/tap-google-sheets

Maintainer

Meltano Stats

Keywords