The tap-cassandra extractor pulls data from Cassandra 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-cassandra extractor to your
project using
:meltano add -
Configure the tap-cassandra
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-cassandrameltano config tap-cassandra set --interactivemeltano config tap-cassandra testNext 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-cassandra
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-cassandra 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:
fetch_sizehostskeyspacelocal_dcmax_attemptspasswordportprotocol_versionreconnect_delayrequest_timeoutskip_hot_partitionsstart_dateusername
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-cassandra 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.
Fetch Size (fetch_size)
-
Environment variable:
TAP_CASSANDRA_FETCH_SIZE -
Default Value:
10000
The fetch size when syncing data from Cassandra.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set fetch_size [value]Hosts (hosts)
-
Environment variable:
TAP_CASSANDRA_HOSTS
The list of contact points to try connecting for cluster discovery.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set hosts [value]Keyspace (keyspace)
-
Environment variable:
TAP_CASSANDRA_KEYSPACE
Keyspace will be the default keyspace for operations on the Session.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set keyspace [value]Local Dc (local_dc)
-
Environment variable:
TAP_CASSANDRA_LOCAL_DC
The local_dc parameter should be the name of the datacenter.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set local_dc [value]Max Attempts (max_attempts)
-
Environment variable:
TAP_CASSANDRA_MAX_ATTEMPTS -
Default Value:
5
Should be a total number of attempts to be made before giving up.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set max_attempts [value]Password (password)
-
Environment variable:
TAP_CASSANDRA_PASSWORD
The password passed as a PlainTextAuthProvider password.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set password [value]Port (port)
-
Environment variable:
TAP_CASSANDRA_PORT -
Default Value:
9042
The server-side port to open connections to. Defaults to 9042. .
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set port [value]Protocol Version (protocol_version)
-
Environment variable:
TAP_CASSANDRA_PROTOCOL_VERSION
The maximum version of the native protocol to use.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set protocol_version [value]Reconnect Delay (reconnect_delay)
-
Environment variable:
TAP_CASSANDRA_RECONNECT_DELAY -
Default Value:
60
Floating point number of seconds to wait inbetween each attempt.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set reconnect_delay [value]Request Timeout (request_timeout)
-
Environment variable:
TAP_CASSANDRA_REQUEST_TIMEOUT
Request timeout used when not overridden in Session.execute().
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set request_timeout [value]Skip Hot Partitions (skip_hot_partitions)
-
Environment variable:
TAP_CASSANDRA_SKIP_HOT_PARTITIONS -
Default Value:
false
When set to True skipping partitions when faced ReadTimout or ReadFailure errors.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set skip_hot_partitions [value]Start Date (start_date)
-
Environment variable:
TAP_CASSANDRA_START_DATE
The earliest record date to sync.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set start_date [value]Username (username)
-
Environment variable:
TAP_CASSANDRA_USERNAME
The username passed as a PlainTextAuthProvider username.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set username [value]Expand To Show SDK Settings
Batch Config Encoding Compression (batch_config.encoding.compression)
-
Environment variable:
TAP_CASSANDRA_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set batch_config encoding.compression [value]Batch Config Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_CASSANDRA_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set batch_config encoding.format [value]Batch Config Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_CASSANDRA_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set batch_config storage.prefix [value]Batch Config Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_CASSANDRA_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set batch_config storage.root [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_CASSANDRA_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_CASSANDRA_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-cassandra set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_CASSANDRA_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-cassandra set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_CASSANDRA_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-cassandra 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-yellow){kind=icon}
-67-c0c0c4){kind=icon}
-5-c0c0c4){kind=icon}
