The S3 Data Connector enables federated SQL querying on files stored in S3 or S3-compatible systems (e.g., MinIO, Cloudflare R2).
If a folder path is specified as the dataset source, all files within the folder will be loaded.
File formats are specified using the file_format parameter, as described in Object Store File Formats.
fromS3-compatible URI to a folder or file, in the format s3://<bucket>/<path>
Example: from: s3://my-bucket/path/to/file.parquet
nameThe dataset name. This will be used as the table name within Spice.
Example:
The dataset name cannot be a reserved keyword.
params| Parameter Name | Description |
|---|---|
file_format | Specifies the data format. Required if it cannot be inferred from the object URI. Options: parquet, csv, json. Refer to Object Store File Formats for details. |
s3_endpoint | S3 endpoint URL (e.g., for MinIO). Default is the region endpoint. E.g. s3_endpoint: https://my.minio.server |
s3_region | S3 bucket region. Default: us-east-1. |
client_timeout | Timeout for S3 operations. Default: 30s. |
hive_partitioning_enabled | Enable partitioning using hive-style partitioning from the folder structure. Defaults to false |
s3_auth | Authentication type. Options: public, and . Defaults to . |
For additional CSV parameters, see CSV Parameters
No authentication is required for public endpoints. For private buckets, set s3_auth to key or iam_role. For Kubernetes Service Accounts with assigned IAM roles, set s3_auth to iam_role. If using iam_role, the AWS IAM role of the running instance is used.
Minimum IAM policy for S3 access:
Refer to Object Store Data Types for data type mapping from object store files to arrow data type.
Create a dataset named taxi_trips from a public S3 folder.
Create a dataset named cool_dataset from a Parquet file stored in MinIO.
Hive partitioning is a data organization technique that improves query performance by storing data in a hierarchical directory structure based on partition column values. This allows for efficient data retrieval by skipping unnecessary data scans.
For example, a dataset partitioned by year, month, and day might have a directory structure like:
Spice can automatically infer these partition columns from the directory structure when hive_partitioning_enabled is set to true.
Use schema_source_path to speed up dataset registration by specifying a URL to use to infer the schema.
Spice integrates with multiple secret stores to help manage sensitive data securely. For detailed information on supported secret stores, refer to the secret stores documentation. Additionally, learn how to use referenced secrets in component parameters by visiting the using referenced secrets guide.
:::warning[Performance Considerations]
When using the S3 Data connector without acceleration, data is loaded into memory during query execution. Ensure sufficient memory is available, including overhead for queries and the runtime, especially with concurrent queries.
Memory limitations can be mitigated by storing acceleration data on disk, which is supported by duckdb and sqlite accelerators by specifying mode: file.
Each query retrieves data from the S3 source, which might result in significant network requests and bandwidth consumption. This can affect network performance and incur costs related to data transfer from S3.
:::
keyiam_rolepublics3_key | Access key (e.g. AWS_ACCESS_KEY_ID for AWS) |
s3_secret | Secret key (e.g. AWS_SECRET_ACCESS_KEY for AWS) |
s3_session_token | Session token (e.g. AWS_SESSION_TOKEN for AWS) for temporary credentials |
allow_http | Enables insecure HTTP connections to s3_endpoint. Defaults to false. |
schema_source_path | Specifies the URL used to infer the dataset schema. Default to the most recently modified file |