io.delta.kernel.types

Class StructField

Object

io.delta.kernel.types.StructField

@Evolving
public class StructField
extends Object

Represents a subfield of StructType with additional properties and metadata.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static StructField	METADATA_ROW_INDEX_COLUMN
static String	METADATA_ROW_INDEX_COLUMN_NAME The name of a row index metadata column.

Constructor Summary

Constructors

Constructor and Description
StructField(String name, DataType dataType, boolean nullable)
StructField(String name, DataType dataType, boolean nullable, FieldMetadata metadata)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
DataType	getDataType()
FieldMetadata	getMetadata()
String	getName()
int	hashCode()
boolean	isDataColumn()
boolean	isMetadataColumn()
boolean	isNullable()
String	toJson()
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

METADATA_ROW_INDEX_COLUMN_NAME

public static String METADATA_ROW_INDEX_COLUMN_NAME

The name of a row index metadata column. When present this column must be populated with row index of each row when reading from parquet.

METADATA_ROW_INDEX_COLUMN

public static StructField METADATA_ROW_INDEX_COLUMN

Constructor Detail

StructField

public StructField(String name,
                   DataType dataType,
                   boolean nullable)

StructField

public StructField(String name,
                   DataType dataType,
                   boolean nullable,
                   FieldMetadata metadata)

Method Detail

getName

public String getName()

Returns:

the name of this field

getDataType

public DataType getDataType()

Returns:

the data type of this field

getMetadata

public FieldMetadata getMetadata()

Returns:

the metadata for this field

isNullable

public boolean isNullable()

Returns:

whether this field allows to have a null value.

isMetadataColumn

public boolean isMetadataColumn()

isDataColumn

public boolean isDataColumn()

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object