Skip to main content
GuideServerConfigure and deploy Tabsdata servers on your machine.TutorialsConfigure data integration workflows within a running Tabsdata server.Advanced TutorialsBuild end-to-end workflows between two specific systems.API ReferenceCLI ReferenceRelease Notes
Version: 2.0.1

Amazon S3

The Amazon S3 connector lets Tabsdata read files from and write files to Amazon S3.

The S3Src connector can be used by a publisher function to read data from Amazon S3 into a Tabsdata table.

The S3Dest connector can be used by a subscriber function to write data from a Tabsdata table into Amazon S3.

Supported formats

FormatPublishSubscribe
AUTOYesYes
CSVYesYes
JSONYesYes
AVROYesYes
PARQUETYesYes
LOGYesNo

Publishers and Subscribers

The S3Src connector can be used by a publisher function to read data from Amazon S3 into a Tabsdata table. See the full publisher walkthrough

Connection

Amazon S3 publishers use S3SrcConn to define the S3 bucket and credentials used by the publisher.

conn-s3.yaml
kind: connectionDef
apiVersion: '1.0'
type: tabsdatak.conn.s3:S3SrcConn
spec:
bucket: 'acme-ingest'
region: 'us-east-1'
credentials:
kind: awsAccessSecretKeyCredentials
apiVersion: '1.0'
type: tabsdatak.conn.common.types:AwsAccessSecretKey
spec:
access_key_id: 'secret:AKIAIOSFODNN7EXAMPLE'
secret_access_key: 'secret:wJalrXUtnFEMI0EXAMPLEKEY'
  • required
  • required
  • required
  • optional
  • optional

Connection Config Parameters

bucket

The name of the S3 bucket that contains the files to publish.

region

The AWS region where the S3 bucket is located, such as us-east-1.

credentials

The AWS credentials used to access the bucket. AwsAccessSecretKey requires an access_key_id and secret_access_key.

base_path

Sets the base path within the S3 bucket. All paths configured in S3Src are relative to this path.

base_path starts with /, cannot end with /, and cannot contain empty path segments. The default is /.

For example, with:

base_path: /hr

the source path:

employees/2026.csv

refers to:

/hr/employees/2026.csv

within the configured S3 bucket.

conn_cfg

Optional connector configuration overrides.

Publisher

Configure S3Src as the source of a publisher function to select the files that Tabsdata reads from S3.

publish_orders.py
from tabsdatak.api import publisher
from tabsdatak.conn.s3 import S3Src, SrcFileFormat

@publisher(
source=S3Src(
paths=[
"incoming/orders.parquet",
],
),
output_tables=["orders"],
)
def publish_orders(orders):
return orders
  • required
  • optional
  • optional
  • optional
  • optional

Function Config Parameters

paths

Defines the files that the publisher reads from S3.

Each path is relative to the base_path configured in S3SrcConn. Source paths:

  • cannot begin or end with /
  • cannot contain empty path segments
  • can contain a * glob in the final path segment

For example:

S3Src(
paths=[
"orders/2026/*.parquet",
"customers/customers.csv",
]
)

Each element in paths represents one source slot and maps positionally to an argument in the publisher function.

When a path uses a glob to match multiple files, the matching files are provided through the corresponding publisher input.

format

Sets the format used to read the source files.

Supported formats are AUTO, CSV, JSON, AVRO, PARQUET, and LOG. The default is AUTO, which determines the format from the file extension.

format_cfg

Sets format-specific reader options. Configuration is keyed by SrcFileFormat.

initial_last_modified

Sets the initial cutoff for incremental ingestion.

On the first run, Tabsdata imports files modified at or after the specified timestamp. The cutoff then advances so subsequent runs only import newer files.

src_cfg

Sets additional source configuration.

The following options are supported:

OptionDescription
tabsdata.file.chunk_sizeControls the size of chunks used when reading files.
tabsdata.src_metadata.dropWhen True, excludes the @td.file.path metadata column.

By default, rows read from S3 include a @td.file.path metadata column containing the s3:// URI of the file the row was read from.