Table API Connectors#

Use these pages for DDL, SQL type mappings, metadata columns, and planner-specific restrictions. Each Table connector maps onto the DataStream connector with the same name rather than providing a separate implementation. The corresponding DataStream connector page documents runtime behavior and builder-only features. The connector overview explains how to choose between the two APIs.

Capability map#

Pushdown describes bounded scans; the lookup column separately describes point-read behavior. Metadata stays with the direction that reads or writes it. Not applicable means that the capability does not fit the service’s role; it is not an implementation-status claim.

Connector pagesPrimary roleScan and pushdownSink changelogLookupCDC compositionMetadata
BigQuery: Quickstart, Table examples source, sink, and CDC, Table reference source, sink, and CDC, DataStream reference source and sinkAnalytics warehouseBounded; projection and filter pushdownInsert or keyed CDC upsert/delete; Experimental (#706)Not supported by the bounded Storage Read sourceConsumes an upsert/delete changelogSink-writable CDC sequence inputs; no readable metadata
Cloud Pub/Sub: Quickstart, Examples, DataStream (source, sink), Table (source, sink)MessagingUnboundedInsertNot applicableCarries a format-provided source changelogReadable and writable message metadata
Cloud Tasks: Quickstart, Examples, DataStream, TableTask deliveryNot applicable; sink onlyInsertNot applicableNot applicableWritable task and request metadata
Bigtable: Quickstart, Examples, DataStream source, sink, and Change Streams, Table source, sink, lookup, and Change StreamsWide-column storeBounded; projection and row-key filter pushdownUpsert; insert-only compatibility modeSync or async with partial cache; synchronous full cache; projected familiesEnvelope for transformation, or keyed upsert/delete directly to an upsert sinkReadable CDC and writable cell-timestamp metadata
Spanner: Quickstart, Examples, DataStream, TableRelational databaseBounded; projection and primary-key filter pushdownInsert or upsertSync or async; primary-key filter pushdown; partial cacheFull retract or keyed upsert/delete source to keyed sinkReadable CDC transaction metadata

The Bigtable and Spanner keyed source-to-sink paths describe compatible changelog shapes, not a stronger replication guarantee. For example, a Spanner Change Streams table in upsert mode can feed a separate primary-key Spanner sink table, but that sink remains at-least-once and does not guarantee the application order of successive writes to one key.