Package io.delta.kernel.types

Class StructType

Object

io.delta.kernel.types.DataType

io.delta.kernel.types.StructType

@Evolving
public final class StructType
extends DataType

Struct type which contains one or more columns.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
StructType()
StructType(List<StructField> fields)

Method Summary

Modifier and Type	Method	Description
StructType	add(StructField field)
StructType	add(String name, DataType dataType)
StructType	add(String name, DataType dataType, boolean nullable)
StructType	add(String name, DataType dataType, boolean nullable, FieldMetadata metadata)
StructType	add(String name, DataType dataType, FieldMetadata metadata)
StructField	at(int index)
Column	column(int ordinal)	Creates a Column expression for the field at the given ordinal
boolean	equals(Object o)
boolean	equivalent(DataType dataType)	Are the data types same? The metadata or column names could be different.
List<String>	fieldNames()
List<StructField>	fields()
StructField	get(String fieldName)
int	hashCode()
int	indexOf(String fieldName)
int	length()
String	toJson()	Convert the struct type to Delta protocol specified serialization format.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StructType

public StructType()

StructType

public StructType(List<StructField> fields)

Method Details

add

public StructType add(StructField field)

add

public StructType add(String name,
 DataType dataType)

add

public StructType add(String name,
 DataType dataType,
 boolean nullable)

add

public StructType add(String name,
 DataType dataType,
 FieldMetadata metadata)

add

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

fields

public List<StructField> fields()

Returns:

array of fields

fieldNames

public List<String> fieldNames()

Returns:

array of field names

length

public int length()

Returns:

the number of fields

indexOf

public int indexOf(String fieldName)

Returns:

the index of the field with the given name, or -1 if not found

get

public StructField get(String fieldName)

at

public StructField at(int index)

column

public Column column(int ordinal)

Creates a Column expression for the field at the given ordinal

Parameters:

ordinal - the ordinal of the StructField to create a column for

Returns:

a Column expression for the StructField with ordinal ordinal

toJson

public String toJson()

Convert the struct type to Delta protocol specified serialization format.

Returns:

serialized in JSON format.

equivalent

public boolean equivalent(DataType dataType)

Description copied from class: DataType

Are the data types same? The metadata or column names could be different.

Overrides:

equivalent in class DataType

Returns:

toString

public String toString()

Specified by:

toString in class DataType

equals

public boolean equals(Object o)

Specified by:

equals in class DataType

hashCode

public int hashCode()

Specified by:

hashCode in class DataType