Skip to content

🗄️ Using S3 as a Source in Ferry

Ferry allows you to ingest data from an S3 bucket and move it to different destinations like data warehouses, databases, or APIs.

📌 Prerequisites

Before using S3 as a source, ensure:

  • You have an AWS S3 bucket where the data is stored.
  • You have a valid AWS Access Key ID and Secret Access Key.
  • The required file(s) exist in the S3 bucket.
  • The AWS region of the bucket is known.

source_uri Format

To connect Ferry to an S3 bucket, use the following connection string format:

plaintext
  s3://<bucket-name>?access_key_id=<access_key_id>
  &access_key_secret=<access_key_secret>&region=<region>

Parameters:

  • bucket - Name of the S3 bucket where data is stored.
  • access_key_id (String) – AWS Access Key ID for authentication.
  • access_key_secret (String) – AWS Secret Access Key for authentication.
  • region (String) – AWS region where the bucket is hosted.
  • path (String, Optional) – Path to a specific file or folder inside the S3 bucket.

source_table_name Format

plaintext
    data/users.csv

Released under the MIT License.