DynamoDB

tap-dynamodb (singer-io variant)🥈

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
  3. Configure the tap-dynamodb settings using
    meltano config
    :
  4. meltano config tap-dynamodb set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. 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:

  • catalog
  • discover
  • state

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.

Account ID (account_id)

  • Environment variable: TAP_DYNAMODB_ACCOUNT_ID

The AWS account ID used to connect to DynamoDB.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set account_id [value]

External ID (external_id)

  • Environment variable: TAP_DYNAMODB_EXTERNAL_ID

The AWS external ID used for connecting to DynamoDB from a third party. https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set external_id [value]

Region Name (region_name)

  • Environment variable: TAP_DYNAMODB_REGION_NAME

The AWS region name


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set region_name [value]

Request Timeout (Seconds) (request_timeout)

  • Environment variable: TAP_DYNAMODB_REQUEST_TIMEOUT

The boto3.client connect_timeout and read_timeout used when connecting to DynamoDB. Defaults to 300.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set request_timeout [value]

Role Name (role_name)

  • Environment variable: TAP_DYNAMODB_ROLE_NAME

The AWS role used to connect to DynamoDB.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set role_name [value]

Use Local Dynamo (use_local_dynamo)

  • Environment variable: TAP_DYNAMODB_USE_LOCAL_DYNAMO

Whether to use a local DynamoDB instance. If this is set to True then http://localhost:8000 will be used as the endpoint_url.


Configure this setting directly using the following Meltano command:

meltano config tap-dynamodb set use_local_dynamo [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

Maintenance Status

  • Maintenance Status

Repo

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

Maintainer

  • Stitch Data

Meltano Stats

  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • databaseaws