The tap-singer-jsonl extractor pulls data from Singer JSONL 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:
Installation and configuration
-
Add the tap-singer-jsonl extractor to your
project using
:meltano add
-
Configure the tap-singer-jsonl
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-singer-jsonl
meltano config tap-singer-jsonl set --interactive
meltano config tap-singer-jsonl 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-singer-jsonl
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:
- discover
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-singer-jsonl
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
with the meltano config
list
subcommand:
meltano config tap-singer-jsonl 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.
Source (source)
-
Environment variable:
TAP_SINGER_JSONL_SOURCE
-
Default Value:
local
The source configuration to use when reading .singer.gz
files. Currently local
and s3
are supported.
Configure this setting directly using the following Meltano command:
meltano config tap-singer-jsonl set source [value]
Add Record Metadata (add_record_metadata)
-
Environment variable:
TAP_SINGER_JSONL_ADD_RECORD_METADATA
-
Default Value:
true
Whether to inject _sdc_*
metadata columns.
Configure this setting directly using the following Meltano command:
meltano config tap-singer-jsonl set add_record_metadata [value]
Folders (local.folders)
-
Environment variable:
TAP_SINGER_JSONL_LOCAL_FOLDERS
Array of directory paths to scan for .singer.gz
files.
Configure this setting directly using the following Meltano command:
meltano config tap-singer-jsonl set local folders [value]
Recursive (local.recursive)
-
Environment variable:
TAP_SINGER_JSONL_LOCAL_RECURSIVE
-
Default Value:
false
Whether to scan directories recursively when discovering .singer.gz
files.
Configure this setting directly using the following Meltano command:
meltano config tap-singer-jsonl set local recursive [value]
Paths (local.paths)
-
Environment variable:
TAP_SINGER_JSONL_LOCAL_PATHS
Array of file paths to singer-formatted files. Note: extension is ignored, and compression is inferred automatically by smart_open
. Both local.folders
and local.paths
can be specified together.
Configure this setting directly using the following Meltano command:
meltano config tap-singer-jsonl set local paths [value]
Bucket (s3.bucket)
-
Environment variable:
TAP_SINGER_JSONL_S3_BUCKET
S3 bucket name.
Configure this setting directly using the following Meltano command:
meltano config tap-singer-jsonl set s3 bucket [value]
Prefix (s3.prefix)
-
Environment variable:
TAP_SINGER_JSONL_S3_PREFIX
S3 key prefix. Note: key prefixes will be scanned recursively.
Configure this setting directly using the following Meltano command:
meltano config tap-singer-jsonl set s3 prefix [value]
Paths (s3.paths)
-
Environment variable:
TAP_SINGER_JSONL_S3_PATHS
S3 file paths to singer-formatted files. Note: extension is ignored, and compression is inferred automatically by smart_open
. Both s3.prefix
and s3.paths
can be specified together.
Configure this setting directly using the following Meltano command:
meltano config tap-singer-jsonl set s3 paths [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.