From 5f8c4cfa748e846cd20965d6ab04c3115ce41833 Mon Sep 17 00:00:00 2001 From: Amar3tto Date: Fri, 21 Aug 2026 13:12:53 +0000 Subject: [PATCH] Update managed-io.md for release 2.76.0-RC4. --- .../content/en/documentation/io/managed-io.md | 774 ++++++++---------- 1 file changed, 362 insertions(+), 412 deletions(-) diff --git a/website/www/site/content/en/documentation/io/managed-io.md b/website/www/site/content/en/documentation/io/managed-io.md index 70b5efe9ed17..38c73cbf45af 100644 --- a/website/www/site/content/en/documentation/io/managed-io.md +++ b/website/www/site/content/en/documentation/io/managed-io.md @@ -59,30 +59,31 @@ and Beam SQL is invoked via the Managed API under the hood. Write Configuration - DELTA - - table (str)
- hadoop_config (map[str, str])
- timestamp (str)
- version (int64)
- - - Unavailable - - - - DELTA_CDC + KAFKA - table (str)
- start_version (int64)
- start_timestamp (str)
- end_version (int64)
- end_timestamp (str)
- hadoop_config (map[str, str])
- include_metadata_columns (list[str])
+ bootstrap_servers (str)
+ topic (str)
+ allow_duplicates (boolean)
+ confluent_schema_registry_subject (str)
+ confluent_schema_registry_url (str)
+ consumer_config_updates (map[str, str])
+ file_descriptor_path (str)
+ format (str)
+ message_name (str)
+ offset_deduplication (boolean)
+ redistribute_by_record_key (boolean)
+ redistribute_num_keys (int32)
+ redistributed (boolean)
+ schema (str)
- Unavailable + bootstrap_servers (str)
+ format (str)
+ topic (str)
+ file_descriptor_path (str)
+ message_name (str)
+ producer_config_updates (map[str, str])
+ schema (str)
@@ -111,34 +112,7 @@ and Beam SQL is invoked via the Managed API under the hood. sort_fields (list[str])
table_properties (map[str, str])
triggering_frequency_seconds (int32)
- - - - KAFKA - - bootstrap_servers (str)
- topic (str)
- allow_duplicates (boolean)
- confluent_schema_registry_subject (str)
- confluent_schema_registry_url (str)
- consumer_config_updates (map[str, str])
- file_descriptor_path (str)
- format (str)
- message_name (str)
- offset_deduplication (boolean)
- redistribute_by_record_key (boolean)
- redistribute_num_keys (int32)
- redistributed (boolean)
- schema (str)
- - - bootstrap_servers (str)
- format (str)
- topic (str)
- file_descriptor_path (str)
- message_name (str)
- producer_config_updates (map[str, str])
- schema (str)
+ write_properties (map[str, str])
@@ -152,22 +126,56 @@ and Beam SQL is invoked via the Managed API under the hood. filter (str)
from_snapshot (int64)
from_timestamp (int64)
+ include_metadata_columns (list[str])
keep (list[str])
poll_interval_seconds (int32)
starting_strategy (str)
streaming (boolean)
to_snapshot (int64)
to_timestamp (int64)
+ watermark_column (str)
+ watermark_column_time_unit (str)
Unavailable - POSTGRES + DELTA + + table (str)
+ hadoop_config (map[str, str])
+ timestamp (str)
+ version (int64)
+ + + Unavailable + + + + BIGQUERY + + kms_key (str)
+ query (str)
+ row_restriction (str)
+ fields (list[str])
+ table (str)
+ + + table (str)
+ drop (list[str])
+ keep (list[str])
+ kms_key (str)
+ only (str)
+ triggering_frequency_seconds (int64)
+ + + + SQLSERVER jdbc_url (str)
connection_properties (str)
+ disable_auto_commit (boolean)
fetch_size (int32)
location (str)
num_partitions (int32)
@@ -189,11 +197,10 @@ and Beam SQL is invoked via the Managed API under the hood. - SQLSERVER + POSTGRES jdbc_url (str)
connection_properties (str)
- disable_auto_commit (boolean)
fetch_size (int32)
location (str)
num_partitions (int32)
@@ -214,24 +221,6 @@ and Beam SQL is invoked via the Managed API under the hood. write_statement (str)
- - BIGQUERY - - kms_key (str)
- query (str)
- row_restriction (str)
- fields (list[str])
- table (str)
- - - table (str)
- drop (list[str])
- keep (list[str])
- kms_key (str)
- only (str)
- triggering_frequency_seconds (int64)
- - MYSQL @@ -265,7 +254,7 @@ and Beam SQL is invoked via the Managed API under the hood. ## Configuration Details -### `DELTA` Read +### `KAFKA` Write
@@ -276,52 +265,85 @@ and Beam SQL is invoked via the Managed API under the hood. + + + + + + + + + + + + + + +
- table + bootstrap_servers str - Identifier of the Delta Lake table. + A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. | Format: host1:port1,host2:port2,...
- hadoop_config + format - map[str, str] + str - Properties passed to the Hadoop Configuration. + The encoding format for the data stored in Kafka. Valid options are: RAW,JSON,AVRO,PROTO
- timestamp + topic str - Timestamp of the Delta Lake table to read. + n/a
- version + file_descriptor_path - int64 + str - Version of the Delta Lake table to read. + The path to the Protocol Buffer File Descriptor Set file. This file is used for schema definition and message serialization. +
+ message_name + + str + + The name of the Protocol Buffer message to be used for schema extraction and data conversion. +
+ producer_config_updates + + map[str, str] + + A list of key-value pairs that act as configuration parameters for Kafka producers. Most of these configurations will not be needed, but if you need to customize your Kafka producer, you may use this. See a detailed list: https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html +
+ schema + + str + + n/a
-### `DELTA_CDC` Read +### `KAFKA` Read
@@ -332,79 +354,156 @@ and Beam SQL is invoked via the Managed API under the hood. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- table + bootstrap_servers str - Identifier of the Delta Lake table. + A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form `host1:port1,host2:port2,...`
- start_version + topic - int64 + str - Start version of the Delta Lake table to read changes from. Either start_version or start_timestamp must be set. + n/a
- start_timestamp + allow_duplicates - str + boolean - Start timestamp of the Delta Lake table to read changes from. Either start_version or start_timestamp must be set. + If the Kafka read allows duplicates.
- end_version + confluent_schema_registry_subject - int64 + str - End version of the Delta Lake table to read changes up to. + n/a
- end_timestamp + confluent_schema_registry_url str - End timestamp of the Delta Lake table to read changes up to. + n/a
- hadoop_config + consumer_config_updates map[str, str] - Properties passed to the Hadoop Configuration. + A list of key-value pairs that act as configuration parameters for Kafka consumers. Most of these configurations will not be needed, but if you need to customize your Kafka consumer, you may use this. See a detailed list: https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html
- include_metadata_columns + file_descriptor_path - list[str] + str + + The path to the Protocol Buffer File Descriptor Set file. This file is used for schema definition and message serialization. +
+ format + + str + + The encoding format for the data stored in Kafka. Valid options are: RAW,STRING,AVRO,JSON,PROTO +
+ message_name + + str + + The name of the Protocol Buffer message to be used for schema extraction and data conversion. +
+ offset_deduplication + + boolean + + If the redistribute is using offset deduplication mode. +
+ redistribute_by_record_key - Metadata columns to include in the output rows. Supported columns are: _change_type, _commit_version, and _commit_timestamp. + boolean + + If the redistribute keys by the Kafka record key. +
+ redistribute_num_keys + + int32 + + The number of keys for redistributing Kafka inputs. +
+ redistributed + + boolean + + If the Kafka read should be redistributed. +
+ schema + + str + + The schema in which the data is encoded in the Kafka topic. For AVRO data, this is a schema defined with AVRO schema syntax (https://avro.apache.org/docs/1.10.2/spec.html#schemas). For JSON data, this is a schema defined with JSON-schema syntax (https://json-schema.org/). If a URL to Confluent Schema Registry is provided, then this field is ignored, and the schema is fetched from Confluent Schema Registry.
@@ -677,10 +776,21 @@ For more information on table properties, please visit https://iceberg.apache.or For a streaming pipeline, sets the frequency at which snapshots are produced. + + + write_properties + + + map[str, str] + + + Properties applied to the underlying file writer (e.g. Parquet write properties like 'write.parquet.bloom-filter-enabled.column.'). + +
-### `KAFKA` Read +### `ICEBERG_CDC` Read
@@ -691,251 +801,257 @@ For more information on table properties, please visit https://iceberg.apache.or -
- bootstrap_servers + table str - A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form `host1:port1,host2:port2,...` + Identifier of the Iceberg table.
- topic + catalog_name str - n/a + Name of the catalog containing the table.
- allow_duplicates + catalog_properties - boolean + map[str, str] - If the Kafka read allows duplicates. + Properties used to set up the Iceberg catalog.
- confluent_schema_registry_subject + config_properties - str + map[str, str] - n/a + Properties passed to the Hadoop Configuration.
- confluent_schema_registry_url + drop - str + list[str] - n/a + A subset of column names to exclude from reading. If null or empty, all columns will be read.
- consumer_config_updates + filter - map[str, str] + str - A list of key-value pairs that act as configuration parameters for Kafka consumers. Most of these configurations will not be needed, but if you need to customize your Kafka consumer, you may use this. See a detailed list: https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html + SQL-like predicate to filter data at scan time. Example: "id > 5 AND status = 'ACTIVE'". Uses Apache Calcite syntax: https://calcite.apache.org/docs/reference.html
- file_descriptor_path + from_snapshot - str + int64 - The path to the Protocol Buffer File Descriptor Set file. This file is used for schema definition and message serialization. + Starts reading from this snapshot ID (inclusive).
- format + from_timestamp - str + int64 - The encoding format for the data stored in Kafka. Valid options are: RAW,STRING,AVRO,JSON,PROTO + Starts reading from the first snapshot (inclusive) that was created after this timestamp (in milliseconds).
- message_name + include_metadata_columns - str + list[str] - The name of the Protocol Buffer message to be used for schema extraction and data conversion. + List of top-level metadata columns to include with CDC output rows. Supported columns: +- `_change_type` +- `_row_id` +- `_last_updated_sequence_number` +- `_commit_snapshot_id` +- `_commit_snapshot_sequence_number` +
- offset_deduplication + keep - boolean + list[str] - If the redistribute is using offset deduplication mode. + A subset of column names to read exclusively. If null or empty, all columns will be read.
- redistribute_by_record_key + poll_interval_seconds - boolean + int32 - If the redistribute keys by the Kafka record key. + The interval at which to poll for new snapshots. Defaults to 60 seconds.
- redistribute_num_keys + starting_strategy - int32 + str - The number of keys for redistributing Kafka inputs. + The source's starting strategy. Valid options are: "earliest" or "latest". Can be overriden by setting a starting snapshot or timestamp. Defaults to earliest for batch, and latest for streaming.
- redistributed + streaming boolean - If the Kafka read should be redistributed. + Enables streaming reads, where source continuously polls for snapshots forever.
- schema + to_snapshot - str + int64 - The schema in which the data is encoded in the Kafka topic. For AVRO data, this is a schema defined with AVRO schema syntax (https://avro.apache.org/docs/1.10.2/spec.html#schemas). For JSON data, this is a schema defined with JSON-schema syntax (https://json-schema.org/). If a URL to Confluent Schema Registry is provided, then this field is ignored, and the schema is fetched from Confluent Schema Registry. + Reads up to this snapshot ID (inclusive).
-
- -### `KAFKA` Write - -
- - - - - - +
ConfigurationTypeDescription
- bootstrap_servers + to_timestamp - str + int64 - A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. | Format: host1:port1,host2:port2,... + Reads up to the latest snapshot (inclusive) created before this timestamp (in milliseconds).
- format + watermark_column str - The encoding format for the data stored in Kafka. Valid options are: RAW,JSON,AVRO,PROTO + Column used to derive the source's output watermark. Must be an existing, required, top-level column of type 'long' or 'timestamp'. If not set, the watermark advances according to snapshot commit timestamp.
- topic + watermark_column_time_unit str - n/a + Time unit used to interpret watermark column of type LONG. One of NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS. Defaults to MICROSECONDS.
+
+ +### `DELTA` Read + +
+ + + + + +
ConfigurationTypeDescription
- file_descriptor_path + table str - The path to the Protocol Buffer File Descriptor Set file. This file is used for schema definition and message serialization. + Identifier of the Delta Lake table.
- message_name + hadoop_config - str + map[str, str] - The name of the Protocol Buffer message to be used for schema extraction and data conversion. + Properties passed to the Hadoop Configuration.
- producer_config_updates + timestamp - map[str, str] + str - A list of key-value pairs that act as configuration parameters for Kafka producers. Most of these configurations will not be needed, but if you need to customize your Kafka producer, you may use this. See a detailed list: https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html + Timestamp of the Delta Lake table to read.
- schema + version - str + int64 - n/a + Version of the Delta Lake table to read.
-### `ICEBERG_CDC` Read +### `BIGQUERY` Read
@@ -946,162 +1062,141 @@ For more information on table properties, please visit https://iceberg.apache.or - - - - - - - - - - +
- table + kms_key str - Identifier of the Iceberg table. + Use this Cloud KMS key to encrypt your data
- catalog_name + query str - Name of the catalog containing the table. -
- catalog_properties - - map[str, str] - - Properties used to set up the Iceberg catalog. + The SQL query to be executed to read from the BigQuery table.
- config_properties + row_restriction - map[str, str] + str - Properties passed to the Hadoop Configuration. + Read only rows that match this filter, which must be compatible with Google standard SQL. This is not supported when reading via query.
- drop + fields list[str] - A subset of column names to exclude from reading. If null or empty, all columns will be read. + Read only the specified fields (columns) from a BigQuery table. Fields may not be returned in the order specified. If no value is specified, then all fields are returned. Example: "col1, col2, col3"
- filter + table str - SQL-like predicate to filter data at scan time. Example: "id > 5 AND status = 'ACTIVE'". Uses Apache Calcite syntax: https://calcite.apache.org/docs/reference.html -
- from_snapshot - - int64 - - Starts reading from this snapshot ID (inclusive). + The fully-qualified name of the BigQuery table to read from. Format: [${PROJECT}:]${DATASET}.${TABLE}
+
+ +### `BIGQUERY` Write + +
+ - - - + + +
- from_timestamp - - int64 - - Starts reading from the first snapshot (inclusive) that was created after this timestamp (in milliseconds). - ConfigurationTypeDescription
- keep + table - list[str] + str - A subset of column names to read exclusively. If null or empty, all columns will be read. + The bigquery table to write to. Format: [${PROJECT}:]${DATASET}.${TABLE}
- poll_interval_seconds + drop - int32 + list[str] - The interval at which to poll for new snapshots. Defaults to 60 seconds. + A list of field names to drop from the input record before writing. Is mutually exclusive with 'keep' and 'only'.
- starting_strategy + keep - str + list[str] - The source's starting strategy. Valid options are: "earliest" or "latest". Can be overriden by setting a starting snapshot or timestamp. Defaults to earliest for batch, and latest for streaming. + A list of field names to keep in the input record. All other fields are dropped before writing. Is mutually exclusive with 'drop' and 'only'.
- streaming + kms_key - boolean + str - Enables streaming reads, where source continuously polls for snapshots forever. + Use this Cloud KMS key to encrypt your data
- to_snapshot + only - int64 + str - Reads up to this snapshot ID (inclusive). + The name of a single record field that should be written. Is mutually exclusive with 'keep' and 'drop'.
- to_timestamp + triggering_frequency_seconds int64 - Reads up to the latest snapshot (inclusive) created before this timestamp (in milliseconds). + Determines how often to 'commit' progress into BigQuery. Default is every 5 seconds.
-### `POSTGRES` Read +### `SQLSERVER` Read
@@ -1132,6 +1227,17 @@ For more information on table properties, please visit https://iceberg.apache.or Used to set connection properties passed to the JDBC driver not already defined as standalone parameter (e.g. username and password can be set using parameters above accordingly). Format of the string must be "key1=value1;key2=value2;". + + + + +
+ disable_auto_commit + + boolean + + Whether to disable auto commit on read. Defaults to true if not provided. The need for this config varies depending on the database platform. Informix requires this to be set to false while Postgres requires this to be set to true. +
fetch_size @@ -1223,7 +1329,7 @@ For more information on table properties, please visit https://iceberg.apache.or
-### `POSTGRES` Write +### `SQLSERVER` Write
@@ -1323,7 +1429,7 @@ For more information on table properties, please visit https://iceberg.apache.or
-### `SQLSERVER` Write +### `POSTGRES` Write
@@ -1423,7 +1529,7 @@ For more information on table properties, please visit https://iceberg.apache.or
-### `SQLSERVER` Read +### `POSTGRES` Read
@@ -1454,17 +1560,6 @@ For more information on table properties, please visit https://iceberg.apache.or Used to set connection properties passed to the JDBC driver not already defined as standalone parameter (e.g. username and password can be set using parameters above accordingly). Format of the string must be "key1=value1;key2=value2;". - - - - -
- disable_auto_commit - - boolean - - Whether to disable auto commit on read. Defaults to true if not provided. The need for this config varies depending on the database platform. Informix requires this to be set to false while Postgres requires this to be set to true. -
fetch_size @@ -1556,7 +1651,7 @@ For more information on table properties, please visit https://iceberg.apache.or
-### `BIGQUERY` Read +### `MYSQL` Write
@@ -1567,135 +1662,101 @@ For more information on table properties, please visit https://iceberg.apache.or -
- kms_key + jdbc_url str - Use this Cloud KMS key to encrypt your data + Connection URL for the JDBC sink.
- query + autosharding - str + boolean - The SQL query to be executed to read from the BigQuery table. + If true, enables using a dynamically determined number of shards to write.
- row_restriction + batch_size - str + int64 - Read only rows that match this filter, which must be compatible with Google standard SQL. This is not supported when reading via query. + n/a
- fields + connection_init_sql list[str] - Read only the specified fields (columns) from a BigQuery table. Fields may not be returned in the order specified. If no value is specified, then all fields are returned. Example: "col1, col2, col3" + Sets the connection init sql statements used by the Driver. Only MySQL and MariaDB support this.
- table + connection_properties str - The fully-qualified name of the BigQuery table to read from. Format: [${PROJECT}:]${DATASET}.${TABLE} + Used to set connection properties passed to the JDBC driver not already defined as standalone parameter (e.g. username and password can be set using parameters above accordingly). Format of the string must be "key1=value1;key2=value2;".
-
- -### `BIGQUERY` Write - -
- - - - - - - - - - - - - - - -
ConfigurationTypeDescription
- table + location str - The bigquery table to write to. Format: [${PROJECT}:]${DATASET}.${TABLE} -
- drop - - list[str] - - A list of field names to drop from the input record before writing. Is mutually exclusive with 'keep' and 'only'. -
- keep - - list[str] - - A list of field names to keep in the input record. All other fields are dropped before writing. Is mutually exclusive with 'drop' and 'only'. + Name of the table to write to.
- kms_key + password str - Use this Cloud KMS key to encrypt your data + Password for the JDBC source.
- only + username str - The name of a single record field that should be written. Is mutually exclusive with 'keep' and 'drop'. + Username for the JDBC source.
- triggering_frequency_seconds + write_statement - int64 + str - Determines how often to 'commit' progress into BigQuery. Default is every 5 seconds. + SQL query used to insert records into the JDBC sink.
@@ -1845,114 +1906,3 @@ For more information on table properties, please visit https://iceberg.apache.or
-### `MYSQL` Write - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ConfigurationTypeDescription
- jdbc_url - - str - - Connection URL for the JDBC sink. -
- autosharding - - boolean - - If true, enables using a dynamically determined number of shards to write. -
- batch_size - - int64 - - n/a -
- connection_init_sql - - list[str] - - Sets the connection init sql statements used by the Driver. Only MySQL and MariaDB support this. -
- connection_properties - - str - - Used to set connection properties passed to the JDBC driver not already defined as standalone parameter (e.g. username and password can be set using parameters above accordingly). Format of the string must be "key1=value1;key2=value2;". -
- location - - str - - Name of the table to write to. -
- password - - str - - Password for the JDBC source. -
- username - - str - - Username for the JDBC source. -
- write_statement - - str - - SQL query used to insert records into the JDBC sink. -
-
-