io.delta.kernel.types

Class StructField

java.lang.Object

io.delta.kernel.types.StructField

public class StructField
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static StructField	ROW_INDEX_COLUMN
static java.lang.String	ROW_INDEX_COLUMN_NAME The name of a row index metadata column.

Constructor Summary

Constructors

Constructor and Description
StructField(java.lang.String name, DataType dataType, boolean nullable, java.util.Map<java.lang.String,java.lang.String> metadata)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
DataType	getDataType()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getName()
int	hashCode()
boolean	isDataColumn()
boolean	isMetadataColumn()
boolean	isNullable()
java.lang.String	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ROW_INDEX_COLUMN_NAME

public static java.lang.String 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.

ROW_INDEX_COLUMN

public static StructField ROW_INDEX_COLUMN

Constructor Detail

StructField

public StructField(java.lang.String name,
                   DataType dataType,
                   boolean nullable,
                   java.util.Map<java.lang.String,java.lang.String> metadata)

Method Detail

getName

public java.lang.String getName()

Returns:

the name of this field

getDataType

public DataType getDataType()

Returns:

the data type of this field

getMetadata

public java.util.Map<java.lang.String,java.lang.String> 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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJson

public java.lang.String toJson()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object