c

io.delta.tables

DeltaColumnBuilder

class DeltaColumnBuilder extends AnyRef

Evolving API

Builder to specify a table column.

See DeltaTableBuilder for examples.

Annotations
@Evolving()
Since

1.0.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeltaColumnBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def Evolving API build(): StructField

    Build the column as a structField.

    Annotations
    @Evolving()
    Since

    1.0.0

  2. def Evolving API comment(comment: String): DeltaColumnBuilder

    Specify a column comment.

    comment

    string column description

    Annotations
    @Evolving()
    Since

    1.0.0

  3. def Evolving API dataType(dataType: DataType): DeltaColumnBuilder

    Specify the column data type.

    dataType

    DataType column data type

    Annotations
    @Evolving()
    Since

    1.0.0

  4. def Evolving API dataType(dataType: String): DeltaColumnBuilder

    Specify the column data type.

    dataType

    string column data type

    Annotations
    @Evolving()
    Since

    1.0.0

  5. def Evolving API generatedAlwaysAs(expr: String): DeltaColumnBuilder

    Specify a expression if the column is always generated as a function of other columns.

    expr

    string the the generation expression

    Annotations
    @Evolving()
    Since

    1.0.0

  6. def Evolving API generatedAlwaysAsIdentity(start: Long, step: Long): DeltaColumnBuilder

    Specify a column as an identity column that is always generated by the system (i.e. does not allow user-specified values).

    start

    the start value of the identity column

    step

    the increment step of the identity column

    Annotations
    @Evolving()
    Since

    3.3.0

  7. def Evolving API generatedAlwaysAsIdentity(): DeltaColumnBuilder

    Specify a column as an identity column with default values that is always generated by the system (i.e. does not allow user-specified values).

    Annotations
    @Evolving()
    Since

    3.3.0

  8. def Evolving API generatedByDefaultAsIdentity(start: Long, step: Long): DeltaColumnBuilder

    Specify a column as an identity column that allows user-specified values.

    start

    the start value of the identity column

    step

    the increment step of the identity column

    Annotations
    @Evolving()
    Since

    3.3.0

  9. def Evolving API generatedByDefaultAsIdentity(): DeltaColumnBuilder

    Specify a column as an identity column that allows user-specified values such that the generated values use default start and step values.

    Annotations
    @Evolving()
    Since

    3.3.0

  10. def Evolving API nullable(nullable: Boolean): DeltaColumnBuilder

    Specify whether the column can be null.

    nullable

    boolean whether the column can be null or not.

    Annotations
    @Evolving()
    Since

    1.0.0