Skip to main content

mkpipe-extractor-redshift

Amazon Redshift extractor plugin for MkPipe. Reads Redshift tables via JDBC.

Documentation

For more detailed documentation, please visit the GitHub repository.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.


Connection Configuration

connections:
  redshift_source:
    variant: redshift
    host: my-cluster.abc123.us-east-1.redshift.amazonaws.com
    port: 5439
    database: mydb
    schema: public
    user: myuser
    password: mypassword

Table Configuration

pipelines:
  - name: redshift_to_pg
    source: redshift_source
    destination: pg_target
    tables:
      - name: public.events
        target_name: stg_events
        replication_method: full
        fetchsize: 100000

Incremental Replication

      - name: public.events
        target_name: stg_events
        replication_method: incremental
        iterate_column: updated_at
        iterate_column_type: datetime
        partitions_column: id
        partitions_count: 8
        fetchsize: 50000

Custom SQL

      - name: public.events
        target_name: stg_events
        replication_method: full
        custom_query: "SELECT id, user_id, event_type FROM public.events WHERE {query_filter}"

Read Parallelism

Set partitions_column and partitions_count to read in parallel via multiple JDBC connections. Partitioning only applies to incremental replication.

Performance Notes

  • For large Redshift tables, using UNLOAD to S3 + Spark S3 read is significantly faster than JDBC. JDBC is suitable for moderate-sized extracts.
  • Keep fetchsize at 50,000–200,000 to balance memory usage and round-trips.

All Table Parameters

Parameter Type Default Description
name string required Redshift table name (include schema)
target_name string required Destination table name
replication_method full / incremental full Replication strategy
iterate_column string or list — Column(s) for incremental watermark. String for single column or SQL expression, list for multi-column OR logic
iterate_column_type int / datetime — Type of iterate_column
partitions_column string same as iterate_column Column to split JDBC reads on
partitions_count int 10 Number of parallel JDBC partitions
fetchsize int 100000 Rows per JDBC fetch
custom_query string — Override SQL with {query_filter} placeholder
custom_query_file string — Path to SQL file (relative to sql/ dir)
tags list [] Tags for selective pipeline execution
pass_on_error bool false Skip table on error instead of failing

Metadata

Release files for mkpipe-extractor-redshift 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkpipe-extractor-redshift 0.5.0
File Size Uploaded Provenance
mkpipe_extractor_redshift-0.5.0.tar.gz 7.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for mkpipe-extractor-redshift 0.5.0
File Interpreter ABI Platform
mkpipe_extractor_redshift-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 14.8 kB

Release files / mkpipe_extractor_redshift-0.5.0.tar.gz

Download URL mkpipe_extractor_redshift-0.5.0.tar.gz
Size 7.1 kB
Tags Source
SHA-256 checksum
How to use checksums
c96e21d94712bcd7b4aaee50ce6f57633da4b42161de42578b1002c5f5f27198
BLAKE2b-256 checksum
How to use checksums
ae3a6f025cf0447f3cb349d9c9480252fcf44cf1cd0a4a560412e50eb2aba834
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / mkpipe_extractor_redshift-0.5.0-py3-none-any.whl

Download URL mkpipe_extractor_redshift-0.5.0-py3-none-any.whl
Size 7.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
739b48a349aa14a102f88a9bc9d47ef754ecd5b605490fbe5abcaf06ff8f64b3
BLAKE2b-256 checksum
How to use checksums
d3b24aae94b4ef0ce5b1e72f112de1b083077d2668d105d4da0bc5b04cda2d2a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Security for mkpipe-extractor-redshift 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page