Class StructField

A field inside a StructType.

Param: name

The name of this field.

Param: dataType

The data type of this field.

Param: nullable

Indicates if values of this field can be null values.

Param: metadata

The metadata of this field. The metadata should be preserved during transformation if the content of the column is not modified, e.g, in selection.

Since

1.0.0

Author

Kent Yao yao@apache.org

Index

Constructors

Properties

name dataType nullable metadata

Accessors

Methods

toString getComment sql toDDL fromProto

Constructors

constructor

new StructField(
    name: string,
    dataType: DataType,
    nullable?: boolean,
    metadata?: Metadata,
): StructField
Parameters
- name: string
- dataType: DataType
- nullable: boolean = true
- metadata: Metadata = ...
Returns StructField
- Defined in src/org/apache/spark/sql/types/StructField.ts:38

Properties

name

name: string

dataType

dataType: DataType

nullable

nullable: boolean = true

metadata

metadata: Metadata = ...

Accessors

metadataMap

get metadataMap(): Map<string, string>
Returns Map<string, string>
- Defined in src/org/apache/spark/sql/types/StructField.ts:73

Methods

toString

toString(): string
Returns string
- Defined in src/org/apache/spark/sql/types/StructField.ts:45

getComment

getComment(): undefined | string
Returns undefined | string
- Defined in src/org/apache/spark/sql/types/StructField.ts:49

sql

sql(): string
Returns string
- Defined in src/org/apache/spark/sql/types/StructField.ts:62

toDDL

toDDL(): string
Returns string
- Defined in src/org/apache/spark/sql/types/StructField.ts:67

`Static`fromProto

fromProto(proto: DataType_StructField): StructField
Parameters
- proto: DataType_StructField
Returns StructField
- Defined in src/org/apache/spark/sql/types/StructField.ts:81