AWS S3 CSV

tap-s3-csv from transferwise

Extract CSV files from S3

The tap-s3-csv extractor pulls data from AWS S3 CSV that can then be sent to a destination using a loader.

Available Variants

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-s3-csv extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-s3-csv
  3. Configure the tap-s3-csv settings using
    meltano config
    :
  4. meltano config tap-s3-csv set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-s3-csv test

Next steps

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

Capabilities

The current capabilities for tap-s3-csv 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:

  • properties
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-s3-csv 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 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 S3 Access Key ID (aws_access_key_id)

  • Environment variable: TAP_S3_CSV_AWS_ACCESS_KEY_ID

S3 Access Key Id. If not provided, aws_profile or AWS_ACCESS_KEY_ID environment variable will be used.

AWS S3 Secret Access Key (aws_secret_access_key)

  • Environment variable: TAP_S3_CSV_AWS_SECRET_ACCESS_KEY

S3 Secret Access Key. If not provided, aws_profile or AWS_ACCESS_KEY_ID environment variable will be used.

Start Date (start_date)

  • Environment variable: TAP_S3_CSV_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

Bucket (bucket)

  • Environment variable: TAP_S3_CSV_BUCKET

AWS S3 bucket name

Tables (tables)

  • Environment variable: TAP_S3_CSV_TABLES

An array that consists of one or more objects that describe how to find files and emit records. Required - table_name and search_pattern. Optional - key_properties, search_prefix, date_overrides, delimiter.

AWS Endpoint URL (aws_endpoint_url)

  • Environment variable: TAP_S3_CSV_AWS_ENDPOINT_URL

The AWS endpoint URL.

AWS profile name (aws_profile)

  • Environment variable: TAP_S3_CSV_AWS_PROFILE

Optional - AWS profile name for profile based authentication. If not provided, AWS_PROFILE environment variable will be used.

AWS S3 Session Token (aws_session_token)

  • Environment variable: TAP_S3_CSV_AWS_SESSION_TOKEN

Optional - S3 AWS STS token for temporary credentials. If not provided, AWS_SESSION_TOKEN environment variable will be used.

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-s3-csv 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-s3-csv

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Wise

Meltano Stats

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

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api