DynamoDB

tap-dynamodb (meltanolabs variant)🥇

AWS NoSQL Database

The tap-dynamodb extractor pulls data from DynamoDB 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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-dynamodb extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-dynamodb --variant meltanolabs
  2. Configure the tap-dynamodb settings using 
    meltano config
     : 
    3. meltano config tap-dynamodb set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-dynamodb test

Next steps

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

Capabilities

The current capabilities for tap-dynamodb 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-dynamodb 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-dynamodb 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.

AWS Access Key ID (aws_access_key_id)

  • Environment variable: TAP_DYNAMODB_AWS_ACCESS_KEY_ID

The access key for your AWS account.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set aws_access_key_id [value]

AWS Assume Role Arn (aws_assume_role_arn)

  • Environment variable: TAP_DYNAMODB_AWS_ASSUME_ROLE_ARN

The role ARN to assume.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set aws_assume_role_arn [value]

AWS Default Region (aws_default_region)

  • Environment variable: TAP_DYNAMODB_AWS_DEFAULT_REGION

The default AWS region name (e.g. us-east-1)


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set aws_default_region [value]

AWS Endpoint URL (aws_endpoint_url)

  • Environment variable: TAP_DYNAMODB_AWS_ENDPOINT_URL

The complete URL to use for the constructed client.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set aws_endpoint_url [value]

AWS Profile (aws_profile)

  • Environment variable: TAP_DYNAMODB_AWS_PROFILE

The AWS credentials profile name to use. The profile must be configured and accessible.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set aws_profile [value]

AWS Secret Access Key (aws_secret_access_key)

  • Environment variable: TAP_DYNAMODB_AWS_SECRET_ACCESS_KEY

The secret key for your AWS account.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set aws_secret_access_key [value]

AWS Session Token (aws_session_token)

  • Environment variable: TAP_DYNAMODB_AWS_SESSION_TOKEN

The session key for your AWS account. This is only needed when you are using temporary credentials.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set aws_session_token [value]

Infer Schema Sample Size (infer_schema_sample_size)

  • Environment variable: TAP_DYNAMODB_INFER_SCHEMA_SAMPLE_SIZE
  • Default Value: 100

The amount of records to sample when inferring the schema.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set infer_schema_sample_size [value]

Table Scan Kwargs (table_scan_kwargs)

  • Environment variable: TAP_DYNAMODB_TABLE_SCAN_KWARGS

A mapping of table name to the scan kwargs that should be used to override the default when querying that table.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set table_scan_kwargs [value]

Tables (tables)

  • Environment variable: TAP_DYNAMODB_TABLES

An array of table names to extract from.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set tables [value]

Use AWS Env Vars (use_aws_env_vars)

  • Environment variable: TAP_DYNAMODB_USE_AWS_ENV_VARS
  • Default Value: false

Whether to retrieve aws credentials from environment variables.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set use_aws_env_vars [value]
Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

  • Environment variable: TAP_DYNAMODB_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_DYNAMODB_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_DYNAMODB_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Storage Root (batch_config.storage.root)

  • Environment variable: TAP_DYNAMODB_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Faker Config Locale (faker_config.locale)

  • Environment variable: TAP_DYNAMODB_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-dynamodb set faker_config locale [value]

Faker Config Seed (faker_config.seed)

  • Environment variable: TAP_DYNAMODB_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-dynamodb set faker_config seed [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_DYNAMODB_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_DYNAMODB_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

  • Environment variable: TAP_DYNAMODB_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-dynamodb 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-dynamodb 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-dynamodb --variant meltanolabs

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/MeltanoLabs/tap-dynamodb
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Meltano

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • meltano_sdkdatabaseaws