class DeltaColumnBuilder extends AnyRef
Builder to specify a table column.
See DeltaTableBuilder for examples.
- Annotations
- @Evolving()
- Since
1.0.0
- Alphabetic
- By Inheritance
- DeltaColumnBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
def
Evolving API
build(): StructField
Build the column as a structField.
- Annotations
- @Evolving()
- Since
1.0.0
-
def
Evolving API
comment(comment: String): DeltaColumnBuilder
Specify a column comment.
- comment
string column description
- Annotations
- @Evolving()
- Since
1.0.0
-
def
Evolving API
dataType(dataType: DataType): DeltaColumnBuilder
Specify the column data type.
- dataType
DataType column data type
- Annotations
- @Evolving()
- Since
1.0.0
-
def
Evolving API
dataType(dataType: String): DeltaColumnBuilder
Specify the column data type.
- dataType
string column data type
- Annotations
- @Evolving()
- Since
1.0.0
-
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
-
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
-
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
-
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
-
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
-
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