The tap-dbf extractor pulls data from dBase Database Files 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-dbf extractor to your
project using
:meltano add
-
Configure the tap-dbf
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-dbf
meltano config tap-dbf set --interactive
meltano config tap-dbf 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-dbf
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-dbf
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-dbf 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.
Fs Root (fs_root)
-
Environment variable:
TAP_DBF_FS_ROOT
-
Default Value:
file://
The root of the filesystem to read from.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set fs_root [value]
Gcs Token (gcs.token)
-
Environment variable:
TAP_DBF_GCS_TOKEN
OAuth 2.0 token for GCS.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set gcs token [value]
Ignore Missing Memofile (ignore_missing_memofile)
-
Environment variable:
TAP_DBF_IGNORE_MISSING_MEMOFILE
-
Default Value:
false
Whether to proceed reading the file even if the [memofile] is not present.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set ignore_missing_memofile [value]
Path (path)
-
Environment variable:
TAP_DBF_PATH
Glob expression where the files are located. Stream names will be extracted from the file name.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set path [value]
S3 Endpoint URL (s3.endpoint_url)
-
Environment variable:
TAP_DBF_S3_ENDPOINT_URL
The S3 endpoint URL.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set s3 endpoint_url [value]
S3 Key (s3.key)
-
Environment variable:
TAP_DBF_S3_KEY
The AWS key ID.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set s3 key [value]
S3 Secret (s3.secret)
-
Environment variable:
TAP_DBF_S3_SECRET
The AWS secret key.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set s3 secret [value]
Expand To Show SDK Settings
Batch Config Encoding Compression (batch_config.encoding.compression)
-
Environment variable:
TAP_DBF_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set batch_config encoding.compression [value]
Batch Config Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_DBF_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set batch_config encoding.format [value]
Batch Config Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_DBF_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set batch_config storage.prefix [value]
Batch Config Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_DBF_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set batch_config storage.root [value]
Faker Config Locale (faker_config.locale)
-
Environment variable:
TAP_DBF_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-dbf set faker_config locale [value]
Faker Config Seed (faker_config.seed)
-
Environment variable:
TAP_DBF_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-dbf set faker_config seed [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_DBF_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_DBF_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-dbf set flattening_max_depth [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_DBF_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-dbf set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_DBF_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-dbf 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.