Skip to main content

Singer.io target for writing JSON Line files and upload to S3

Project description

target-s3-jsonl

GitHub - License Python package builder codecov PyPI - Python Version PyPI version PyPi project installs

Singer target that uploads loads data to S3 in JSONL format following the Singer spec.

How to use it

target-s3-jsonl is a Singer Target which intend to work with regular Singer Tap. It take the output of the tap and export it as a JSON Lines files.

It re-uses PipelineWise pipelinewise-target-s3-csv s3 client logic to upload the JSONL file directly to S3.

Install

First, make sure Python 3 is installed on your system or follow these installation instructions for Mac or Ubuntu.

It's recommended to use a virtualenv:

Defaults

python -m venv venv
. venv/bin/activate
pip install --upgrade pip
pip install target-s3-jsonl

Head

python -m venv venv
. venv/bin/activate
pip install --upgrade pip
pip install --upgrade https://github.com/ome9ax/target-s3-jsonl/archive/main.tar.gz

Isolated virtual environment

python -m venv ~/.virtualenvs/target-s3-jsonl
source ~/.virtualenvs/target-s3-jsonl/bin/activate
pip install target-s3-jsonl
deactivate

To run

Like any other target that's following the singer specificiation:

some-singer-tap | target-s3-jsonl --config [config.json]

It's reading incoming messages from STDIN and using the properites in config.json to upload data into Postgres.

Note: To avoid version conflicts run tap and targets in separate virtual environments.

Configuration settings

Running the the target connector requires a config.json file. An example with the minimal settings:

{
    "s3_bucket": "my_bucket"
}

Profile based authentication

Profile based authentication used by default using the default profile. To use another profile set aws_profile parameter in config.json or set the AWS_PROFILE environment variable.

Non-Profile based authentication

For non-profile based authentication set aws_access_key_id , aws_secret_access_key and optionally the aws_session_token parameter in the config.json. Alternatively you can define them out of config.json by setting AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN environment variables.

Full list of options in config.json:

Property Type Mandatory? Description
aws_access_key_id String S3 Access Key Id. If not provided, AWS_ACCESS_KEY_ID environment variable will be used.
aws_secret_access_key String S3 Secret Access Key. If not provided, AWS_SECRET_ACCESS_KEY environment variable will be used.
aws_session_token String AWS Session token. If not provided, AWS_SESSION_TOKEN environment variable will be used.
aws_endpoint_url String AWS endpoint URL.
aws_profile String AWS profile name for profile based authentication. If not provided, AWS_PROFILE environment variable will be used.
s3_bucket String Yes S3 Bucket name
s3_key_prefix String (Default: None) A static prefix before the generated S3 key names. Using prefixes you can
encryption_type String (Default: 'none') The type of encryption to use. Current supported options are: 'none' and 'KMS'.
encryption_key String A reference to the encryption key to use for data encryption. For KMS encryption, this should be the name of the KMS encryption key ID (e.g. '1234abcd-1234-1234-1234-1234abcd1234'). This field is ignored if 'encryption_type' is none or blank.
compression String The type of compression to apply before uploading. Supported options are none (default), gzip, and lzma. For gzipped files, the file extension will automatically be changed to .jsonl.gz for all files. For lzma compression, the file extension will automatically be changed to .jsonl.xz for all files.
naming_convention String (Default: None) Custom naming convention of the s3 key. Replaces tokens date, stream, and timestamp with the appropriate values.

Supports "folders" in s3 keys e.g. folder/folder2/{stream}/export_date={date}/{timestamp}.jsonl.

Honors the s3_key_prefix, if set, by prepending the "filename". E.g. naming_convention = folder1/my_file.jsonl and s3_key_prefix = prefix_ results in folder1/prefix_my_file.jsonl
timezone_offset Integer Use offset 0 hours is you want the naming_convention to use utc time zone. The null values is used by default.
temp_dir String (Default: platform-dependent) Directory of temporary JSONL files with RECORD messages.
local Boolean Keep the file in the temp_dir directory without uploading the files on s3.
memory_buffer Integer Memory buffer's size used before storing the data into the temporary file. 64Mb used by default if unspecified.

Test

Run pytest

python -m pytest -p no:cacheprovider

License

Apache License Version 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

target-s3-jsonl-0.0.5.tar.gz (15.8 kB view hashes)

Uploaded source

Built Distribution

target_s3_jsonl-0.0.5-py3-none-any.whl (13.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page