Package io.github.flink.gcp.connector.bigquery.sink

Class SchemaUpdateOptions

java.lang.Object

io.github.flink.gcp.connector.bigquery.sink.SchemaUpdateOptions

All Implemented Interfaces:

Serializable

@Public
public final class SchemaUpdateOptions
extends Object
implements Serializable

Options gating connector-driven destination table schema updates.

When the serializer's schema (from BigQueryProtoSerializationSchema.getTableSchema(io.github.flink.gcp.connector.bigquery.sink.TableDestination)) evolves past the destination table's schema, the sink can update the table itself via the BigQuery API before continuing to write. The update is a union: existing table fields are never dropped or reordered, new fields are appended, and field type changes are always rejected. What the union may change is gated by these flags:

• SchemaUpdateOptions.Builder.allowNewFields() — serializer fields missing from the table are appended. BigQuery cannot add REQUIRED columns to an existing table, so new fields are always added as NULLABLE even when the serializer declares them REQUIRED.
• SchemaUpdateOptions.Builder.allowFieldRelaxation() — a table field declared REQUIRED is relaxed to NULLABLE when the serializer does not declare it REQUIRED. REPEATED fields are never changed.

Both flags default to off, in which case the sink never modifies table schemas (schema changes made externally — for example via DDL — are still picked up reactively). Enabling updates requires the bigquery.tables.get and bigquery.tables.update permissions.

Schema unionization is deliberately opt-in: BigQuery columns can never be dropped again, so a single malformed record shipping an unexpected field could otherwise poison a table permanently.

Instances are immutable and serializable. Use defaults() to keep updates disabled.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SchemaUpdateOptions.Builder	Builder for SchemaUpdateOptions.

Method Summary

Modifier and Type	Method	Description
static SchemaUpdateOptions.Builder	builder()	Creates a new SchemaUpdateOptions.Builder.
static SchemaUpdateOptions	defaults()	Returns options with connector-driven schema updates disabled.
boolean	equals(Object o)
int	hashCode()
boolean	isAllowFieldRelaxation()	Returns whether REQUIRED table fields may be relaxed to NULLABLE.
boolean	isAllowNewFields()	Returns whether missing serializer fields may be appended to the table.
boolean	isEnabled()	Returns whether any connector-driven schema update is enabled.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

defaults

public static SchemaUpdateOptions defaults()

Returns options with connector-driven schema updates disabled.

builder

public static SchemaUpdateOptions.Builder builder()

Creates a new SchemaUpdateOptions.Builder.

Returns:

a new builder

isAllowNewFields

public boolean isAllowNewFields()

Returns whether missing serializer fields may be appended to the table.

isAllowFieldRelaxation

public boolean isAllowFieldRelaxation()

Returns whether REQUIRED table fields may be relaxed to NULLABLE.

isEnabled

public boolean isEnabled()

Returns whether any connector-driven schema update is enabled.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object