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 and Description
ScanStateRow(java.util.HashMap<Integer,Object> valueMap)

Method Summary

Modifier and Type	Method and Description
static String	getColumnMappingMode(Row scanState) Get the column mapping mode from the scan state Row returned by Scan.getScanState(TableClient).
static StructType	getLogicalSchema(TableClient tableClient, Row scanState) Utility method to get the logical schema from the scan state Row returned by Scan.getScanState(TableClient).
static java.util.List<String>	getPartitionColumns(Row scanState) Get the list of partition column names from the scan state Row returned by Scan.getScanState(TableClient).
static StructType	getPhysicalDataReadSchema(TableClient tableClient, Row scanState) Utility method to get the physical data read schema from the scan state Row returned by Scan.getScanState(TableClient).
static StructType	getPhysicalSchema(TableClient tableClient, Row scanState) Utility method to get the physical schema from the scan state Row returned by Scan.getScanState(TableClient).
static String	getTableRoot(Row scanState) Get the table root from scan state Row returned by Scan.getScanState(TableClient)
static ScanStateRow	of(Metadata metadata, Protocol protocol, String readSchemaLogicalJson, String readSchemaPhysicalJson, String readPhysicalDataSchemaJson, 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 Object

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

Constructor Detail

ScanStateRow

public ScanStateRow(java.util.HashMap<Integer,Object> valueMap)

Method Detail

of

public static ScanStateRow of(Metadata metadata,
                              Protocol protocol,
                              String readSchemaLogicalJson,
                              String readSchemaPhysicalJson,
                              String readPhysicalDataSchemaJson,
                              String tablePath)

getLogicalSchema

public static StructType getLogicalSchema(TableClient tableClient,
                                          Row scanState)

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

Parameters:

tableClient - instance of TableClient to use.

scanState - Scan state Row

Returns:

Logical schema to read from the data files.

getPhysicalSchema

public static StructType getPhysicalSchema(TableClient tableClient,
                                           Row scanState)

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

Parameters:

tableClient - instance of TableClient to use.

scanState - Scan state Row

Returns:

Physical schema to read from the data files.

getPhysicalDataReadSchema

public static StructType getPhysicalDataReadSchema(TableClient tableClient,
                                                   Row scanState)

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

Parameters:

tableClient - instance of TableClient to use.

scanState - Scan state Row

Returns:

Physical schema to read from the data files.

getPartitionColumns

public static java.util.List<String> getPartitionColumns(Row scanState)

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

Parameters:

scanState - Scan state Row

Returns:

List of partition column names according to the scan state.

getColumnMappingMode

public static String getColumnMappingMode(Row scanState)

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

getTableRoot

public static String getTableRoot(Row scanState)

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

Parameters:

scanState - Scan state Row

Returns:

Fully qualified path to the location of the table.