Package io.deephaven.iceberg.location

Class IcebergTableParquetLocationKey

java.lang.Object

io.deephaven.engine.table.impl.locations.impl.PartitionedTableLocationKey

io.deephaven.engine.table.impl.locations.local.URITableLocationKey

io.deephaven.parquet.table.location.ParquetTableLocationKey

io.deephaven.iceberg.location.IcebergTableParquetLocationKey

All Implemented Interfaces:

LogOutputAppendable, ImmutableTableLocationKey, TableLocationKey, IcebergTableLocationKey, NamedImplementation, Comparable<TableLocationKey>

@InternalUseOnly
public class IcebergTableParquetLocationKey
extends ParquetTableLocationKey
implements IcebergTableLocationKey

TableLocationKey implementation for use with data stored in Iceberg tables in the parquet format.

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.engine.table.impl.locations.impl.PartitionedTableLocationKey

PartitionedTableLocationKey.PartitionsComparator, PartitionedTableLocationKey.PartitionsFormatter

Field Summary

Fields inherited from class io.deephaven.engine.table.impl.locations.local.URITableLocationKey

order, uri

Fields inherited from class io.deephaven.engine.table.impl.locations.impl.PartitionedTableLocationKey

partitions

Constructor Summary

Constructors

Constructor

Description

IcebergTableParquetLocationKey(@Nullable String catalogName, @Nullable UUID tableUuid, @NotNull org.apache.iceberg.catalog.TableIdentifier tableIdentifier, @NotNull org.apache.iceberg.PartitionSpec manifestPartitionSpec, @NotNull org.apache.iceberg.ManifestFile manifestFile, @NotNull org.apache.iceberg.DataFile dataFile, @NotNull URI fileUri, int order, @Nullable Map<String,Comparable<?>> partitions, @NotNull ParquetInstructions readInstructions, @NotNull SeekableChannelsProvider channelsProvider, @NotNull List<SortColumn> sortedColumns)

Construct a new IcebergTableParquetLocationKey for the supplied fileUri and partitions.

Method Summary

Modifier and Type	Method	Description
int	compareTo(@NotNull TableLocationKey other)	When comparing with another IcebergTableParquetLocationKey, precedence-wise this implementation compares: order catalogName uuid tableIdentifier dataSequenceNumber fileSequenceNumber manifestSequenceNumber dataFilePos uri Otherwise, it delegates to the parent class.
boolean	equals(@Nullable Object other)
String	getImplementationName()	Get a name for the implementing class.
int	hashCode()
org.apache.iceberg.PartitionSpec	manifestPartitionSpec()
ParquetInstructions	readInstructions()	Get the read instructions for the location.

Methods inherited from class io.deephaven.parquet.table.location.ParquetTableLocationKey

clear, getFileMetadata, getFileReader, getMetadata, getRowGroupIndices, getSchema, setFileReader, setMetadata, setRowGroupIndices

Methods inherited from class io.deephaven.engine.table.impl.locations.local.URITableLocationKey

append, getURI, toString

Methods inherited from class io.deephaven.engine.table.impl.locations.impl.PartitionedTableLocationKey

getPartitionKeys, getPartitionValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.engine.table.impl.locations.ImmutableTableLocationKey

makeImmutable

Methods inherited from interface io.deephaven.base.log.LogOutputAppendable

append

Methods inherited from interface io.deephaven.engine.table.impl.locations.TableLocationKey

clear, getPartitionKeys, getPartitionValue

Constructor Details

IcebergTableParquetLocationKey

public IcebergTableParquetLocationKey(@Nullable
 @Nullable String catalogName,
 @Nullable
 @Nullable UUID tableUuid,
 @NotNull
 @NotNull org.apache.iceberg.catalog.TableIdentifier tableIdentifier,
 @NotNull
 @NotNull org.apache.iceberg.PartitionSpec manifestPartitionSpec,
 @NotNull
 @NotNull org.apache.iceberg.ManifestFile manifestFile,
 @NotNull
 @NotNull org.apache.iceberg.DataFile dataFile,
 @NotNull
 @NotNull URI fileUri,
 int order,
 @Nullable
 @Nullable Map<String,Comparable<?>> partitions,
 @NotNull
 @NotNull ParquetInstructions readInstructions,
 @NotNull
 @NotNull SeekableChannelsProvider channelsProvider,
 @NotNull
 @NotNull List<SortColumn> sortedColumns)

Construct a new IcebergTableParquetLocationKey for the supplied fileUri and partitions.

Parameters:

catalogName - The name of the catalog using which the table is accessed

tableUuid - The UUID of the table, or null if not available

tableIdentifier - The table identifier used to access the table

manifestFile - The manifest file from which the data file was discovered

dataFile - The data file that backs the keyed location

fileUri - The URI for the file that backs the keyed location

order - Explicit ordering index, taking precedence over other fields

partitions - The table partitions enclosing the table location keyed by this. Note that if this parameter is null, the location will be a member of no partitions. An ordered copy of the map will be made, so the calling code is free to mutate the map after this call

readInstructions - the instructions for customizations while reading

channelsProvider - the provider for reading the file

sortedColumns - an ordered list of columns this location is sorted by.

Method Details

manifestPartitionSpec

public org.apache.iceberg.PartitionSpec manifestPartitionSpec()

getImplementationName

public String getImplementationName()

Description copied from interface: NamedImplementation

Get a name for the implementing class. Useful for abstract classes that implement LogOutputAppendable or override toString.

The default implementation is correct, but not suitable for high-frequency usage.

Specified by:

getImplementationName in interface NamedImplementation

Overrides:

getImplementationName in class ParquetTableLocationKey

Returns:

A name for the implementing class

readInstructions

public ParquetInstructions readInstructions()

Description copied from interface: IcebergTableLocationKey

Get the read instructions for the location.

Specified by:

readInstructions in interface IcebergTableLocationKey

Returns:

the read instructions

compareTo

public int compareTo(@NotNull
 @NotNull TableLocationKey other)

When comparing with another IcebergTableParquetLocationKey, precedence-wise this implementation compares:

• order
• catalogName
• uuid
• tableIdentifier
• dataSequenceNumber
• fileSequenceNumber
• manifestSequenceNumber
• dataFilePos
• uri

Otherwise, it delegates to the parent class.

When comparing with another URITableLocationKey, precedence-wise this implementation compares order, then applies a PartitionedTableLocationKey.PartitionsComparator to partitions, then compares uri. Otherwise, it delegates to parent class.

By default, compare fully qualified class names of the implementing classes. This method is a fallback where the implementing classes are not directly comparable, and should help establish a consistent ordering between distinct implementations.

Specified by:

compareTo in interface Comparable<TableLocationKey>

Specified by:

compareTo in interface TableLocationKey

Overrides:

compareTo in class URITableLocationKey

equals

public boolean equals(@Nullable
 @Nullable Object other)

Overrides:

equals in class URITableLocationKey

hashCode

public int hashCode()

Overrides:

hashCode in class URITableLocationKey