Package io.delta.kernel.internal.data

Class ScanStateRow

Object

io.delta.kernel.internal.data.GenericRow

io.delta.kernel.internal.data.ScanStateRow

All Implemented Interfaces:

Row

public class ScanStateRow
extends GenericRow

Encapsulate the scan state (common info for all scan files) as a Row

Constructor Summary

Constructors

Constructor	Description
ScanStateRow(HashMap<Integer,Object> valueMap)

Method Summary

Modifier and Type	Method	Description
static ColumnMapping.ColumnMappingMode	getColumnMappingMode(Row scanState)	Get the column mapping mode from the scan state Row returned by Scan.getScanState(Engine).
static Map<String,String>	getConfiguration(Row scanState)	Utility method to get the configuration map from the scan state Row returned by Scan.getScanState(Engine).
static StructType	getLogicalSchema(Row scanState)	Utility method to get the logical schema from the scan state Row returned by Scan.getScanState(Engine).
static List<String>	getPartitionColumns(Row scanState)	Get the list of partition column names from the scan state Row returned by Scan.getScanState(Engine).
static StructType	getPhysicalDataReadSchema(Row scanState)	Utility method to get the physical schema from the scan state Row returned by Scan.getScanState(Engine).
static Path	getTableRoot(Row scanState)	Get the table root from scan state Row returned by Scan.getScanState(Engine)
static ScanStateRow	of(Metadata metadata, Protocol protocol, String logicalSchemaJson, String physicalSchemaJson, String tablePath)

Methods inherited from class io.delta.kernel.internal.data.GenericRow

getArray, getBinary, getBoolean, getByte, getDecimal, getDouble, getFloat, getInt, getLong, getMap, getSchema, getShort, getString, getStruct, isNullAt

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScanStateRow

public ScanStateRow(HashMap<Integer,Object> valueMap)

Method Details

of

public static ScanStateRow of(Metadata metadata,
 Protocol protocol,
 String logicalSchemaJson,
 String physicalSchemaJson,
 String tablePath)

getConfiguration

public static Map<String,String> getConfiguration(Row scanState)

Utility method to get the configuration map from the scan state Row returned by Scan.getScanState(Engine).

Parameters:

scanState - Scan state Row

Returns:

Map of configuration key-value pairs.

getLogicalSchema

public static StructType getLogicalSchema(Row scanState)

Utility method to get the logical schema from the scan state Row returned by Scan.getScanState(Engine).

Parameters:

scanState - Scan state Row

Returns:

Logical schema to read from the data files.

getPhysicalDataReadSchema

public static StructType getPhysicalDataReadSchema(Row scanState)

Utility method to get the physical schema from the scan state Row returned by Scan.getScanState(Engine). This schema is used to request data from the scan files for the query.

Parameters:

scanState - Scan state Row

Returns:

Physical schema to read from the data files.

getPartitionColumns

public static List<String> getPartitionColumns(Row scanState)

Get the list of partition column names from the scan state Row returned by Scan.getScanState(Engine).

Parameters:

scanState - Scan state Row

Returns:

List of partition column names according to the scan state.

getColumnMappingMode

public static ColumnMapping.ColumnMappingMode getColumnMappingMode(Row scanState)

Get the column mapping mode from the scan state Row returned by Scan.getScanState(Engine).

getTableRoot

public static Path getTableRoot(Row scanState)

Get the table root from scan state Row returned by Scan.getScanState(Engine)

Parameters:

scanState - Scan state Row

Returns:

Fully qualified path to the location of the table.