Skip to content
This repository has been archived by the owner on Nov 25, 2023. It is now read-only.

Latest commit

 

History

History
98 lines (66 loc) · 2.82 KB

README.md

File metadata and controls

98 lines (66 loc) · 2.82 KB

target-s3

target-s3 is a Singer target for s3 for writing parquet files to s3. This target uses pyarrow to write data in the parquet format to s3 and no Athena-databases or Glue catalogs are required.

Build with the Meltano Target SDK.

Installation

Install from GitHub:

pipx install git+https://github.com/ORG_NAME/target-s3.git@main

Configuration

Accepted Config Options

A full list of supported settings and capabilities for this target is available by running:

target-s3 --about

Configure using environment variables

This Singer target will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

Source Authentication and Authorization

If you are using this tap with an S3 bucket that do not have public access, you need to first create a user and give it necessary access to S3. You then need to generate access keys that this target then will use to authenticate. Always store your credentials in a safe way.

Usage

You can easily run target-s3 by itself or in a pipeline using Meltano.

Executing the Target Directly

target-s3 --version
target-s3 --help
# Test using the "Carbon Intensity" sample:
tap-carbon-intensity | target-s3 --config /path/to/target-s3-config.json

Testing with Meltano

Note: This target will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd target-s3
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke target-s3 --version
# OR run a test `elt` pipeline with the Carbon Intensity sample tap:
meltano elt tap-carbon-intensity target-s3

SDK Dev Guide

See the dev guide for more instructions on how to use the Meltano Singer SDK to develop your own Singer taps and targets.