Integration
Amazon S3
Query CSV, Parquet, and JSON files stored in S3 buckets
- Category
- Files & storage
- Runs in
- The Phloem cloud — nothing to install
Lets you and Hamming query CSV, Parquet and JSON files in your S3 buckets with SQL.
What Phloem reads
- CSV, Parquet (
.parquet,.pqt) and JSON files in the buckets you pick - Each table's columns, listed in Trace
Files are read in place when queried. Nothing is copied into Phloem first.
What you need
An access key, or a role Phloem can assume, allowed to:
- list your buckets (
s3:ListAllMyBuckets) - list objects in the buckets you connect (
s3:ListBucket) - read those objects (
s3:GetObject)
For IAM Role (STS Assume Role), the role's trust policy must let Phloem assume it, with your external ID if you set one.
Connect
- In the console, open Connectors, choose Add connector, then Amazon S3.
- On AWS Credentials, choose an Authentication Method (Access Key & Secret or IAM Role (STS Assume Role)), fill in its fields, and pick an AWS Region. Session Token (Optional) is only for temporary credentials.
- Phloem tests the credentials by listing your buckets.
- On Select Buckets, pick the buckets to connect.
- On Discovered Tables, review the tables found. Untick any you don't want, or edit a table's Table Name, File Pattern (
raw/events/**/*.parquet) or Description (Optional). - On Save Connection, name the connection and save it.
What Hamming can do
- Run SQL over the connected tables: query, sample rows, count rows, list columns
Nothing it does changes your buckets.
Notes
- Discovery proposes one table per file. Set a File Pattern glob (
raw/events/**/*.parquet) to query many files as one table. - An assumed role's credentials last one hour and renew as needed.
- Credentials with a Session Token stop working when the token expires. Edit the connector with fresh ones.
#Connection fields
What the Add connector form asks for.
| Field | Type | Required |
|---|---|---|
| Authentication Method Choose how to authenticate with AWS | One of Access Key & Secret · IAM Role (STS Assume Role) | Yes |
AWS Access Key IDAKIAIOSFODNN7EXAMPLE | Text | — |
| AWS Secret Access Key | Secret | — |
| Session Token (Optional) Only needed for temporary credentials | Secret | — |
IAM Role ARNarn:aws:iam::123456789012:role/S3ReadRole | Text | — |
| External ID (Optional) Required if the role's trust policy requires an external ID Optional external ID for cross-account access | Text | — |
| AWS Region Select the AWS region where your S3 buckets are located | One of US East (N. Virginia) · US East (Ohio) · US West (N. California) · US West (Oregon) · Europe (Ireland) · Europe (London) · Europe (Paris) · Europe (Frankfurt) · Europe (Stockholm) · Asia Pacific (Tokyo) · Asia Pacific (Seoul) · Asia Pacific (Singapore) · Asia Pacific (Sydney) · Asia Pacific (Mumbai) · South America (São Paulo) · Canada (Central) | Yes |
| Path Prefix Filter (Optional) Only scan files under this prefix path data/exports/ | Text | — |
| File Formats Select file formats to include. You can add custom extensions. | Any of Parquet (.parquet) · CSV (.csv) · JSON (.json) · TSV (.tsv) · Avro (.avro) · ORC (.orc) · Excel (.xlsx) · Excel Legacy (.xls) | — |
| Scan Subfolders Recursively scan subfolders for files | On / off | — |
Updated