Struct AlterTableTransactionBuilder 

pub struct AlterTableTransactionBuilder<S = Ready> { /* private fields */ }

Available on crate feature internal-api only.

Builder for constructing an AlterTableTransaction with schema evolution operations.

Uses a type-state pattern (S) to enforce at compile time:

• At least one schema operation must be queued before build() is callable.
• Only operations valid for the current state can be chained. This will disallow incompatible chaining.

Implementations

impl<S> AlterTableTransactionBuilder<S>

pub fn with_correlation_id(self, correlation_id: impl Into<Arc<str>>) -> Self

Attach an opaque, caller-supplied correlation id for joining the alter-table commit’s metric events to the caller’s own request or operation id. An empty id is treated as unset.

impl<S: Chainable> AlterTableTransactionBuilder<S>

pub fn add_column( self, field: StructField, ) -> AlterTableTransactionBuilder<Modifying>

Add a new top-level column to the table schema.

The field must not already exist in the schema (case-insensitive). The field must be nullable because existing data files do not contain this column and will read NULL for it. field and any of its nested fields must not carry delta.columnMapping.id or delta.columnMapping.physicalName annotations.

These constraints are validated during build().

pub fn set_nullable( self, column: ColumnName, ) -> AlterTableTransactionBuilder<Modifying>

Change a column’s nullability from NOT NULL to nullable. If the column is already nullable, the op is a no-op but still generates a commit.

Note: this matches Spark’s behavior.

impl AlterTableTransactionBuilder<Modifying>

pub fn build( self, _engine: &dyn Engine, committer: Box<dyn Committer>, ) -> DeltaResult<AlterTableTransaction>

Validate and apply schema operations, then build the AlterTableTransaction.

This method:

1. Validates the table supports writes
2. Applies each operation sequentially against the evolving schema
3. Constructs new Metadata action with evolved schema
4. Builds the evolved table configuration
5. Creates the transaction

Errors

• The table enables icebergCompatV3 or allowColumnDefaults, which ALTER TABLE does not yet support
• Any individual operation fails validation (see per-method errors above)
• Table does not support writes (unsupported features)
• The evolved schema requires protocol features not enabled on the table (e.g. adding a timestampNtz column without the timestampNtz feature)