Index

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

add(StructField) - Method in class io.delta.kernel.types.StructType

add(String, DataType) - Method in class io.delta.kernel.types.StructType

add(String, DataType, boolean) - Method in class io.delta.kernel.types.StructType

add(String, DataType, boolean, FieldMetadata) - Method in class io.delta.kernel.types.StructType

add(String, DataType, FieldMetadata) - Method in class io.delta.kernel.types.StructType

addDomainMetadata(String, String) - Method in interface io.delta.kernel.Transaction

Commit the provided domain metadata as part of this transaction.

addMetadataColumn(String, MetadataColumnSpec) - Method in class io.delta.kernel.types.StructType

Add a predefined metadata column of MetadataColumnSpec to the struct type.

ALWAYS_FALSE - Static variable in class io.delta.kernel.expressions.AlwaysFalse

ALWAYS_TRUE - Static variable in class io.delta.kernel.expressions.AlwaysTrue

AlwaysFalse - Class in io.delta.kernel.expressions

Predicate which always evaluates to false.

AlwaysTrue - Class in io.delta.kernel.expressions

Predicate which always evaluates to true.

And - Class in io.delta.kernel.expressions

AND expression

And(Predicate, Predicate) - Constructor for class io.delta.kernel.expressions.And

appendNestedField(String) - Method in class io.delta.kernel.expressions.Column

Returns a new column that appends the input column name to the current column.

ARRAY_ELEMENT_NAME - Static variable in class io.delta.kernel.types.ArrayType

ArrayType - Class in io.delta.kernel.types

Represent array data type

ArrayType(DataType, boolean) - Constructor for class io.delta.kernel.types.ArrayType

ArrayType(StructField) - Constructor for class io.delta.kernel.types.ArrayType

ArrayValue - Interface in io.delta.kernel.data

Abstraction to represent a single array value in a ColumnVector.

at(int) - Method in class io.delta.kernel.types.StructType

atTimestamp(long, Snapshot) - Static method in class io.delta.kernel.CommitRangeBuilder.CommitBoundary

Creates a commit boundary based on a timestamp.

atTimestamp(long, Snapshot) - Method in interface io.delta.kernel.SnapshotBuilder

Configures the builder to resolve the table at a specific timestamp.

atVersion(long) - Static method in class io.delta.kernel.CommitRangeBuilder.CommitBoundary

Creates a commit boundary based on a specific version number.

atVersion(long) - Method in interface io.delta.kernel.SnapshotBuilder

Configures the builder to resolve the table at a specific version.

B

BasePrimitiveType - Class in io.delta.kernel.types

Base class for all primitive types DataType.

BINARY - Static variable in class io.delta.kernel.types.BinaryType

BinaryType - Class in io.delta.kernel.types

The data type representing byte[] values.

blockIfVariantDataTypeIsDefined(StructType) - Static method in interface io.delta.kernel.Transaction

Currently Kernel supports only metadata updates for variants (including shredded values).

BOOLEAN - Static variable in class io.delta.kernel.types.BooleanType

BooleanType - Class in io.delta.kernel.types

Data type representing boolean type values.

BREAK - Enum constant in enum class io.delta.kernel.utils.CloseableIterator.BreakableFilterResult

Indicates that the iteration should stop immediately and that no further elements should be processed by CloseableIterator.breakableFilter(Function).

breakableFilter(Function<T, CloseableIterator.BreakableFilterResult>) - Method in interface io.delta.kernel.utils.CloseableIterator

Returns a new CloseableIterator that applies a CloseableIterator.BreakableFilterResult-based filtering function to determine whether elements of this iterator should be included or excluded, or whether the iteration should terminate.

build() - Method in interface io.delta.kernel.ScanBuilder

build() - Method in class io.delta.kernel.types.FieldMetadata.Builder

build(Engine) - Method in interface io.delta.kernel.CommitRangeBuilder

Builds and returns a CommitRange instance with the configured specifications.

build(Engine) - Method in interface io.delta.kernel.SnapshotBuilder

Constructs the Snapshot using the provided engine.

build(Engine) - Method in interface io.delta.kernel.transaction.CreateTableTransactionBuilder

Build the transaction for creating the Delta table.

build(Engine) - Method in interface io.delta.kernel.transaction.ReplaceTableTransactionBuilder

Build the transaction for replacing the Delta table.

build(Engine) - Method in interface io.delta.kernel.transaction.UpdateTableTransactionBuilder

Build the transaction for updating the Delta table.

build(Engine) - Method in interface io.delta.kernel.TransactionBuilder

Build the transaction.

buildCreateTableTransaction(String, StructType, String) - Static method in interface io.delta.kernel.TableManager

Creates a CreateTableTransactionBuilder to build a create table transaction.

builder() - Static method in class io.delta.kernel.types.FieldMetadata

Builder() - Constructor for class io.delta.kernel.types.FieldMetadata.Builder

buildPaginated(long, Optional<Row>) - Method in interface io.delta.kernel.ScanBuilder

Build a Paginated Scan with a required page size and an optional page token.

buildUpdateTableTransaction(String, Operation) - Method in interface io.delta.kernel.Snapshot

BYTE - Static variable in class io.delta.kernel.types.ByteType

ByteType - Class in io.delta.kernel.types

The data type representing byte type values.

C

CATALOG_CREATE - Enum constant in enum class io.delta.kernel.commit.CommitMetadata.CommitType

Creating a new catalog-managed table

CATALOG_DOWNGRADE_TO_FILESYSTEM - Enum constant in enum class io.delta.kernel.commit.CommitMetadata.CommitType

Downgrading a catalog-managed table to a filesystem-managed table

CATALOG_WRITE - Enum constant in enum class io.delta.kernel.commit.CommitMetadata.CommitType

Writing to an existing catalog-managed table

CatalogCommitter - Interface in io.delta.kernel.commit

Committer sub-interface for catalog-managed tables.

CatalogCommitterUtils - Class in io.delta.kernel.commit

checkpoint(Engine, long) - Method in interface io.delta.kernel.Table

Checkpoint the table at given version.

CHECKPOINT - Enum constant in enum class io.delta.kernel.hook.PostCommitHook.PostCommitHookType

Writes a new checkpoint at the version committed by the transaction.

CheckpointAlreadyExistsException - Exception in io.delta.kernel.exceptions

Thrown when trying to create a checkpoint at version v, but there already exists a checkpoint at version v.

CheckpointAlreadyExistsException(long) - Constructor for exception io.delta.kernel.exceptions.CheckpointAlreadyExistsException

checksum(Engine, long) - Method in interface io.delta.kernel.Table

Computes and writes a checksum file for the table at given version.

CHECKSUM_FULL - Enum constant in enum class io.delta.kernel.hook.PostCommitHook.PostCommitHookType

Writes a checksum file at the version committed by the transaction.

CHECKSUM_SIMPLE - Enum constant in enum class io.delta.kernel.hook.PostCommitHook.PostCommitHookType

Writes a checksum file at the version committed by the transaction.

close() - Method in interface io.delta.kernel.data.ColumnVector

Cleans up memory for this column vector.

CloseableIterable<T> - Interface in io.delta.kernel.utils

Extend the Java Iterable interface to provide a way to close the iterator.

CloseableIterator<T> - Interface in io.delta.kernel.utils

Closeable extension of Iterator

CloseableIterator.BreakableFilterResult - Enum Class in io.delta.kernel.utils

Represents the result of applying the filter condition in the CloseableIterator.breakableFilter(Function) method of a CloseableIterator.

clustered(List<Column>) - Static method in class io.delta.kernel.transaction.DataLayoutSpec

Creates a data layout specification for a clustered table.

CollationIdentifier - Class in io.delta.kernel.types

Identifies collation for string type.

COLLATIONS_METADATA_KEY - Static variable in class io.delta.kernel.types.StructField

column(int) - Method in class io.delta.kernel.types.StructType

Creates a Column expression for the field at the given ordinal

Column - Class in io.delta.kernel.expressions

An expression type that refers to a column (case-sensitive) in the input.

Column(String) - Constructor for class io.delta.kernel.expressions.Column

Create a column expression for referring to a column.

Column(String[]) - Constructor for class io.delta.kernel.expressions.Column

Create a column expression to refer to a nested column.

ColumnarBatch - Interface in io.delta.kernel.data

Represents zero or more rows of records with same schema type.

ColumnVector - Interface in io.delta.kernel.data

Represents zero or more values of a single column.

combine(CloseableIterator<T>) - Method in interface io.delta.kernel.utils.CloseableIterator

Combine the current iterator with another iterator.

commit(Engine, CloseableIterable<Row>) - Method in interface io.delta.kernel.Transaction

Commit the transaction including the data action rows generated by Transaction.generateAppendActions(io.delta.kernel.engine.Engine, io.delta.kernel.data.Row, io.delta.kernel.utils.CloseableIterator<io.delta.kernel.utils.DataFileStatus>, io.delta.kernel.DataWriteContext).

commit(Engine, CloseableIterator<Row>, CommitMetadata) - Method in interface io.delta.kernel.commit.Committer

Commits the given finalizedActions and commitMetadata to the table.

CommitActions - Interface in io.delta.kernel

Represents all actions from a single commit version in a table.

CommitFailedException - Exception in io.delta.kernel.commit

Exception raised by Committer.commit(io.delta.kernel.engine.Engine, io.delta.kernel.utils.CloseableIterator<io.delta.kernel.data.Row>, io.delta.kernel.commit.CommitMetadata).

CommitFailedException(boolean, boolean, String) - Constructor for exception io.delta.kernel.commit.CommitFailedException

CommitFailedException(boolean, boolean, String, Throwable) - Constructor for exception io.delta.kernel.commit.CommitFailedException

CommitMetadata - Class in io.delta.kernel.commit

Contains all information (excluding the iterator of finalized actions) required to commit changes to a Delta table.

CommitMetadata(long, String, CommitInfo, List<DomainMetadata>, Supplier<Map<String, String>>, Optional<Tuple2<Protocol, Metadata>>, Optional<Protocol>, Optional<Metadata>, Optional<Long>) - Constructor for class io.delta.kernel.commit.CommitMetadata

CommitMetadata.CommitType - Enum Class in io.delta.kernel.commit

Represents the different types of commits based on filesystem-managed and catalog-managed state transitions.

CommitRange - Interface in io.delta.kernel

Represents a range of contiguous commits in a Delta Lake table with a defined start and end version.

CommitRangeBuilder - Interface in io.delta.kernel

A builder for creating CommitRange instances that define a contiguous range of commits in a Delta Lake table.

CommitRangeBuilder.CommitBoundary - Class in io.delta.kernel

Defines a boundary (start or end) of a commit range in a Delta Lake table.

CommitRangeNotFoundException - Exception in io.delta.kernel.exceptions

Exception thrown when Kernel cannot find any commit files in the requested version range.

CommitRangeNotFoundException(String, long, Optional<Long>) - Constructor for exception io.delta.kernel.exceptions.CommitRangeNotFoundException

CommitResponse - Class in io.delta.kernel.commit

Response container for the result of a commit operation.

CommitResponse(ParsedDeltaData) - Constructor for class io.delta.kernel.commit.CommitResponse

CommitStateUnknownException - Exception in io.delta.kernel.exceptions

Exception thrown when the Delta transaction commit system cannot determine whether a previous commit attempt succeeded or failed, making it unsafe to continue with automatic retries.

CommitStateUnknownException(long, int, CommitFailedException) - Constructor for exception io.delta.kernel.exceptions.CommitStateUnknownException

Committer - Interface in io.delta.kernel.commit

Interface for committing changes to Delta tables, supporting both filesystem-managed and catalog-managed tables.

ConcurrentTransactionException - Exception in io.delta.kernel.exceptions

Thrown when concurrent transaction both attempt to update the table with same transaction identifier set through TransactionBuilder.withTransactionId(Engine, String, long) (String)}.

ConcurrentTransactionException(String, long, long) - Constructor for exception io.delta.kernel.exceptions.ConcurrentTransactionException

ConcurrentWriteException - Exception in io.delta.kernel.exceptions

Thrown when a concurrent transaction has written data after the current transaction has started.

ConcurrentWriteException() - Constructor for exception io.delta.kernel.exceptions.ConcurrentWriteException

ConcurrentWriteException(String) - Constructor for exception io.delta.kernel.exceptions.ConcurrentWriteException

ConcurrentWriteException(String, Throwable) - Constructor for exception io.delta.kernel.exceptions.ConcurrentWriteException

contains(MetadataColumnSpec) - Method in class io.delta.kernel.types.StructType

contains(String) - Method in class io.delta.kernel.types.FieldMetadata

containsNull() - Method in class io.delta.kernel.types.ArrayType

copyFileAtomically(String, String, boolean) - Method in interface io.delta.kernel.engine.FileSystemClient

Atomically copy a file from source path to destination path.

CREATE_TABLE - Enum constant in enum class io.delta.kernel.Operation

Recorded when the table is created.

createMetadataColumn(String, MetadataColumnSpec) - Static method in class io.delta.kernel.types.StructField

Creates a metadata column of the given colSpec with the given name.

createPrimitive(String) - Static method in class io.delta.kernel.types.BasePrimitiveType

Create a primitive type DataType

createSelectionVector(boolean[], int, int) - Method in interface io.delta.kernel.engine.ExpressionHandler

Create a selection vector, a boolean type ColumnVector, on top of the range of values given in values array.

CreateTableTransactionBuilder - Interface in io.delta.kernel.transaction

Builder for creating a Transaction to create a new Delta table.

createTransactionBuilder(Engine, String, Operation) - Method in interface io.delta.kernel.Table

Create a TransactionBuilder which can create a Transaction object to mutate the table.

D

DataFileStatistics - Class in io.delta.kernel.statistics

Encapsulates statistics for a data file in a Delta Lake table and provides methods to serialize those stats to JSON with basic physical-type validation.

DataFileStatistics(long, Map<Column, Literal>, Map<Column, Literal>, Map<Column, Long>, Optional<Boolean>) - Constructor for class io.delta.kernel.statistics.DataFileStatistics

Create a new instance of DataFileStatistics.

DataFileStatus - Class in io.delta.kernel.utils

Extends FileStatus to include additional details such as column level statistics of the data file in the Delta Lake table.

DataFileStatus(String, long, long, Optional<DataFileStatistics>) - Constructor for class io.delta.kernel.utils.DataFileStatus

Create a new instance of DataFileStatus.

DataLayoutSpec - Class in io.delta.kernel.transaction

Specification for the data layout of a Delta table, including partitioning and clustering configurations.

dataType - Variable in enum class io.delta.kernel.types.MetadataColumnSpec

DataType - Class in io.delta.kernel.types

Base class for all data types.

DataType() - Constructor for class io.delta.kernel.types.DataType

DataWriteContext - Interface in io.delta.kernel

Contains the context for writing data to Delta table.

DATE - Static variable in class io.delta.kernel.types.DateType

DateType - Class in io.delta.kernel.types

A date type, supporting "0001-01-01" through "9999-12-31".

DecimalType - Class in io.delta.kernel.types

The data type representing java.math.BigDecimal values.

DecimalType(int, int) - Constructor for class io.delta.kernel.types.DecimalType

DEFAULT_ALGORITHM - Static variable in class io.delta.kernel.types.GeographyType

DEFAULT_ROW_INDEX_COLUMN - Static variable in class io.delta.kernel.types.StructField

The default row index metadata column used by Kernel.

DEFAULT_SRID - Static variable in class io.delta.kernel.types.GeographyType

DEFAULT_SRID - Static variable in class io.delta.kernel.types.GeometryType

delete(String) - Method in interface io.delta.kernel.engine.FileSystemClient

Delete the file at given path.

DELTA_TYPE_CHANGES_KEY - Static variable in class io.delta.kernel.types.StructField

DeltaOperationReport - Interface in io.delta.kernel.metrics

Defines the common fields that are shared by reports for Delta operations

deserializeFromJson(String, StructType) - Static method in class io.delta.kernel.statistics.DataFileStatistics

Utility method to deserialize statistics from a JSON string with full type information.

DomainDoesNotExistException - Exception in io.delta.kernel.exceptions

Thrown when attempting to remove a domain metadata that does not exist in the read snapshot.

DomainDoesNotExistException(String, String, long) - Constructor for exception io.delta.kernel.exceptions.DomainDoesNotExistException

DOUBLE - Static variable in class io.delta.kernel.types.DoubleType

DoubleType - Class in io.delta.kernel.types

The data type representing double type values.

E

empty() - Static method in class io.delta.kernel.types.FieldMetadata

emptyIterable() - Static method in interface io.delta.kernel.utils.CloseableIterable

Return an CloseableIterable object for an empty collection.

Engine - Interface in io.delta.kernel.engine

Interface encapsulating all clients needed by the Delta Kernel in order to read the Delta table.

EPOCH - Static variable in class io.delta.kernel.statistics.DataFileStatistics

equals(Object) - Method in class io.delta.kernel.expressions.Column

equals(Object) - Method in class io.delta.kernel.expressions.Literal

equals(Object) - Method in class io.delta.kernel.expressions.Predicate

equals(Object) - Method in class io.delta.kernel.statistics.DataFileStatistics

equals(Object) - Method in class io.delta.kernel.types.ArrayType

equals(Object) - Method in class io.delta.kernel.types.BasePrimitiveType

equals(Object) - Method in class io.delta.kernel.types.CollationIdentifier

Collation identifiers are identical when the provider, name, and version are the same.

equals(Object) - Method in class io.delta.kernel.types.DataType

equals(Object) - Method in class io.delta.kernel.types.DecimalType

equals(Object) - Method in class io.delta.kernel.types.FieldMetadata

equals(Object) - Method in class io.delta.kernel.types.GeographyType

equals(Object) - Method in class io.delta.kernel.types.GeometryType

equals(Object) - Method in class io.delta.kernel.types.MapType

equals(Object) - Method in class io.delta.kernel.types.StringType

equals(Object) - Method in class io.delta.kernel.types.StructField

equals(Object) - Method in class io.delta.kernel.types.StructType

equals(Object) - Method in class io.delta.kernel.types.TypeChange

equals(Object) - Method in class io.delta.kernel.utils.FileStatus

equalsIgnoreKeys(FieldMetadata, Set<String>) - Method in class io.delta.kernel.types.FieldMetadata

Are the metadata same, ignoring the specified keys?

equivalent(DataType) - Method in class io.delta.kernel.types.ArrayType

equivalent(DataType) - Method in class io.delta.kernel.types.DataType

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

equivalent(DataType) - Method in class io.delta.kernel.types.MapType

equivalent(DataType) - Method in class io.delta.kernel.types.StringType

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

equivalent(DataType) - Method in class io.delta.kernel.types.StructType

eval(ColumnarBatch) - Method in interface io.delta.kernel.expressions.ExpressionEvaluator

Evaluate the expression on given ColumnarBatch data.

eval(ColumnarBatch, Optional<ColumnVector>) - Method in interface io.delta.kernel.expressions.PredicateEvaluator

Evaluate the predicate on given inputData.

Evolving - Annotation Interface in io.delta.kernel.annotation

APIs that are meant to evolve towards becoming stable APIs, but are not stable APIs yet.

EXCLUDE - Enum constant in enum class io.delta.kernel.utils.CloseableIterator.BreakableFilterResult

Indicates that the current element should be excluded from the resulting iterator produced by CloseableIterator.breakableFilter(Function).

Experimental - Annotation Interface in io.delta.kernel.annotation

APIs that are still under active development and are expected to change.

Expression - Interface in io.delta.kernel.expressions

Base interface for all Kernel expressions.

ExpressionEvaluator - Interface in io.delta.kernel.expressions

Interface for implementing an Expression evaluator.

ExpressionHandler - Interface in io.delta.kernel.engine

Provides expression evaluation capability to Delta Kernel.

extractProtocolProperties(Protocol) - Static method in class io.delta.kernel.commit.CatalogCommitterUtils

Extract protocol-related properties from the given protocol.

F

FIELD_PATH_KEY - Static variable in class io.delta.kernel.types.StructField

FieldMetadata - Class in io.delta.kernel.types

The metadata for a given StructField.

FieldMetadata.Builder - Class in io.delta.kernel.types

Builder class for FieldMetadata.

fieldNames() - Method in class io.delta.kernel.types.StructType

fields() - Method in class io.delta.kernel.types.StructType

FileReadRequest - Interface in io.delta.kernel.engine

Represents a request to read a range of bytes from a given file.

FileReadResult - Class in io.delta.kernel.engine

The result of reading a batch of data in a file.

FileReadResult(ColumnarBatch, String) - Constructor for class io.delta.kernel.engine.FileReadResult

Constructs a FileReadResult object with the given data and file path.

FileSizeHistogramResult - Interface in io.delta.kernel.metrics

Stores the file size histogram information to track file size distribution and their counts.

FileStatus - Class in io.delta.kernel.utils

Class for encapsulating metadata about a file in Delta Lake table.

FILESYSTEM_CREATE - Enum constant in enum class io.delta.kernel.commit.CommitMetadata.CommitType

Creating a new filesystem-managed table

FILESYSTEM_UPGRADE_TO_CATALOG - Enum constant in enum class io.delta.kernel.commit.CommitMetadata.CommitType

Upgrading a filesystem-managed table to a catalog-managed table

FILESYSTEM_WRITE - Enum constant in enum class io.delta.kernel.commit.CommitMetadata.CommitType

Writing to an existing filesystem-managed table

FileSystemClient - Interface in io.delta.kernel.engine

Provides file system related functionalities to Delta Kernel.

filter(Function<T, Boolean>) - Method in interface io.delta.kernel.utils.CloseableIterator

Returns a new CloseableIterator that includes only the elements of this iterator for which the given mapper function returns true.

FilteredColumnarBatch - Class in io.delta.kernel.data

Represents a filtered version of ColumnarBatch.

FilteredColumnarBatch(ColumnarBatch, Optional<ColumnVector>) - Constructor for class io.delta.kernel.data.FilteredColumnarBatch

FilteredColumnarBatch(ColumnarBatch, Optional<ColumnVector>, String, int) - Constructor for class io.delta.kernel.data.FilteredColumnarBatch

flatMap(Function<T, CloseableIterator<U>>) - Method in interface io.delta.kernel.utils.CloseableIterator

Returns a new CloseableIterator that applies a function to each element of this iterator, where each element is transformed into another iterator, and the results are flattened into a single iterator.

FLOAT - Static variable in class io.delta.kernel.types.FloatType

FloatType - Class in io.delta.kernel.types

The data type representing float type values.

forEach(Consumer<? super T>) - Method in interface io.delta.kernel.utils.CloseableIterable

forPath(Engine, String) - Static method in interface io.delta.kernel.Table

Instantiate a table object for the Delta Lake table at the given path.

FROM_TYPE_KEY - Static variable in class io.delta.kernel.types.StructField

fromMetadata(FieldMetadata) - Method in class io.delta.kernel.types.FieldMetadata.Builder

Adds all metadata from meta.metadata to the builder's metadata.

fromString(String) - Static method in class io.delta.kernel.types.CollationIdentifier

fromString(String) - Static method in enum class io.delta.kernel.types.MetadataColumnSpec

FULL - Enum constant in enum class io.delta.kernel.Snapshot.ChecksumWriteMode

Checksum info is not loaded in this Snapshot and requires replaying the delta log since the latest checksum (if present) to compute.

G

generateAppendActions(Engine, Row, CloseableIterator<DataFileStatus>, DataWriteContext) - Static method in interface io.delta.kernel.Transaction

For given data files, generate Delta actions that can be committed in a transaction.

generateNewStagedCommitFilePath() - Method in class io.delta.kernel.commit.CommitMetadata

Returns a new staged commit file path with a unique UUID for this commit.

GeographyType - Class in io.delta.kernel.types

The data type representing geography values.

GeographyType(String, String) - Constructor for class io.delta.kernel.types.GeographyType

Create a GeographyType with the specified SRID and algorithm.

GeometryType - Class in io.delta.kernel.types

The data type representing geometry values.

GeometryType(String) - Constructor for class io.delta.kernel.types.GeometryType

Create a GeometryType with the specified SRID.

get(String) - Method in class io.delta.kernel.types.FieldMetadata

get(String) - Method in class io.delta.kernel.types.StructType

getActions() - Method in interface io.delta.kernel.CommitActions

Returns an iterator over the action batches for this commit.

getActions(Engine, Snapshot, Set<DeltaLogActionUtils.DeltaAction>) - Method in interface io.delta.kernel.CommitRange

Returns an iterator of the requested actions for the commits in this commit range.

getAlgorithm() - Method in class io.delta.kernel.types.GeographyType

Get the algorithm for geometric calculations.

getAllPrimitiveTypes() - Static method in class io.delta.kernel.types.BasePrimitiveType

For testing only

getArray(int) - Method in interface io.delta.kernel.data.ColumnVector

Return the array value located at rowId.

getArray(int) - Method in interface io.delta.kernel.data.Row

Return array value of the column located at the given ordinal.

getAscendingCatalogCommits() - Method in class io.delta.kernel.commit.PublishMetadata

getBaseSnapshotVersion() - Method in interface io.delta.kernel.metrics.TransactionReport

The version of the table the transaction was created from.

getBinary(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the binary type value for rowId.

getBinary(int) - Method in interface io.delta.kernel.data.Row

Return binary value of the column located at the given ordinal.

getBoolean(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the boolean type value for rowId.

getBoolean(int) - Method in interface io.delta.kernel.data.Row

Return boolean value of the column located at the given ordinal.

getBoolean(String) - Method in class io.delta.kernel.types.FieldMetadata

getBooleanArray(String) - Method in class io.delta.kernel.types.FieldMetadata

getByte(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the byte type value for rowId.

getByte(int) - Method in interface io.delta.kernel.data.Row

Return byte value of the column located at the given ordinal.

getCheckpointVersion() - Method in interface io.delta.kernel.metrics.SnapshotReport

getChecksumWriteMode() - Method in interface io.delta.kernel.statistics.SnapshotStatistics

Determines the appropriate mode for writing a checksum file for this Snapshot.

getChild(int) - Method in interface io.delta.kernel.data.ColumnVector

Get the child vector associated with the given ordinal.

getChildren() - Method in class io.delta.kernel.expressions.Column

getChildren() - Method in interface io.delta.kernel.expressions.Expression

getChildren() - Method in class io.delta.kernel.expressions.Literal

getChildren() - Method in class io.delta.kernel.expressions.PartitionValueExpression

getChildren() - Method in class io.delta.kernel.expressions.ScalarExpression

getClusteringColumns() - Method in interface io.delta.kernel.metrics.TransactionReport

Get the list of clustering columns the table data is expected to be clustered by.

getClusteringColumns() - Method in class io.delta.kernel.transaction.DataLayoutSpec

Returns the clustering columns for this layout.

getCollationIdentifier() - Method in class io.delta.kernel.expressions.Predicate

Returns the collation identifier used for this predicate, if specified.

getCollationIdentifier() - Method in class io.delta.kernel.types.StringType

getColumn() - Method in class io.delta.kernel.expressions.StGeometryBoxesIntersect

getColumnVector(int) - Method in interface io.delta.kernel.data.ColumnarBatch

Return the ColumnVector for the given ordinal in the columnar batch.

getCommitActions(Engine, Snapshot, Set<DeltaLogActionUtils.DeltaAction>) - Method in interface io.delta.kernel.CommitRange

Returns an iterator of commits in this commit range, where each commit is represented as a CommitActions object.

getCommitDomainMetadatas() - Method in class io.delta.kernel.commit.CommitMetadata

The DomainMetadatas that are being written as part of this commit.

getCommitInfo() - Method in class io.delta.kernel.commit.CommitMetadata

The CommitInfo that is being written as part of this commit.

getCommitLogData() - Method in class io.delta.kernel.commit.CommitResponse

The parsed log data resulting from the commit operation.

getCommittedVersion() - Method in interface io.delta.kernel.metrics.TransactionReport

getCommitter() - Method in interface io.delta.kernel.Transaction

getCommitterProperties() - Method in class io.delta.kernel.commit.CommitMetadata

Returns custom properties provided by the connector to be passed through to the committer.

getCommitType() - Method in class io.delta.kernel.commit.CommitMetadata

Determines the type of commit based on whether this is a table creation and the catalog-managed status of the table before and after the commit.

getComputeTimestampToVersionTotalDurationNs() - Method in interface io.delta.kernel.metrics.SnapshotMetricsResult

getCurrentPageToken() - Method in interface io.delta.kernel.PaginatedScanFilesIterator

Returns an optional page token representing the starting position of next page.

getData() - Method in class io.delta.kernel.data.FilteredColumnarBatch

Return the data as ColumnarBatch.

getData() - Method in class io.delta.kernel.engine.FileReadResult

getDataSkippingFilter() - Method in interface io.delta.kernel.metrics.ScanReport

getDataType() - Method in interface io.delta.kernel.data.ColumnVector

getDataType() - Method in class io.delta.kernel.expressions.Literal

Get the datatype of the literal object.

getDataType() - Method in class io.delta.kernel.expressions.PartitionValueExpression

Get the data type of the partition value.

getDataType() - Method in class io.delta.kernel.types.StructField

getDecimal(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the decimal type value for rowId.

getDecimal(int) - Method in interface io.delta.kernel.data.Row

Return decimal value of the column located at the given ordinal.

getDeltaLogDirPath() - Method in class io.delta.kernel.commit.CommitMetadata

The path to the Delta log directory, located at <table_root>/_delta_log.

getDescription() - Method in enum class io.delta.kernel.Operation

Returns the string that will be recorded in the transaction log.

getDomainMetadata(String) - Method in interface io.delta.kernel.Snapshot

Returns the configuration for the provided domain if it exists in the snapshot.

getDouble(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the double type value for rowId.

getDouble(int) - Method in interface io.delta.kernel.data.Row

Return double value of the column located at the given ordinal.

getDouble(String) - Method in class io.delta.kernel.types.FieldMetadata

getDoubleArray(String) - Method in class io.delta.kernel.types.FieldMetadata

getEarliestAvailableVersion() - Method in exception io.delta.kernel.exceptions.StartVersionNotFoundException

getEffectiveMetadata() - Method in class io.delta.kernel.commit.CommitMetadata

Returns the effective Metadata that will be in place after this commit.

getEffectiveProtocol() - Method in class io.delta.kernel.commit.CommitMetadata

Returns the effective Protocol that will be in place after this commit.

getElementField() - Method in class io.delta.kernel.types.ArrayType

getElements() - Method in interface io.delta.kernel.data.ArrayValue

A ColumnVector containing the array elements with exactly ArrayValue.getSize() elements.

getElementType() - Method in class io.delta.kernel.types.ArrayType

getEndVersion() - Method in interface io.delta.kernel.CommitRange

Returns the ending version number (inclusive) of this commit range.

getEndVersion() - Method in exception io.delta.kernel.exceptions.CommitRangeNotFoundException

getEngineInfo() - Method in interface io.delta.kernel.metrics.TransactionReport

getEntries() - Method in class io.delta.kernel.types.FieldMetadata

getEvaluator(StructType, Expression, DataType) - Method in interface io.delta.kernel.engine.ExpressionHandler

Create an ExpressionEvaluator that can evaluate the given expression on ColumnarBatchs with the given batchSchema.

getException() - Method in interface io.delta.kernel.metrics.DeltaOperationReport

getExpressionHandler() - Method in interface io.delta.kernel.engine.Engine

Get the connector provided ExpressionHandler.

getFileCounts() - Method in interface io.delta.kernel.metrics.FileSizeHistogramResult

The total number of files in each bin of FileSizeHistogramResult.getSortedBinBoundaries()

getFilePath() - Method in class io.delta.kernel.data.FilteredColumnarBatch

Returns the file path from which the data originates, if available.

getFilePath() - Method in class io.delta.kernel.engine.FileReadResult

getFileStatus(String) - Method in interface io.delta.kernel.engine.FileSystemClient

Get the metadata of the file at the given path.

getFileSystemClient() - Method in interface io.delta.kernel.engine.Engine

Get the connector provided FileSystemClient.

getFilter() - Method in interface io.delta.kernel.metrics.ScanReport

getFloat(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the float type value for rowId.

getFloat(int) - Method in interface io.delta.kernel.data.Row

Return float value of the column located at the given ordinal.

getFrom() - Method in class io.delta.kernel.types.TypeChange

getInListElements() - Method in class io.delta.kernel.expressions.In

getInput() - Method in class io.delta.kernel.expressions.PartitionValueExpression

Get the expression reference to the serialized partition value.

getInt(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the int type value for rowId.

getInt(int) - Method in interface io.delta.kernel.data.Row

Return integer value of the column located at the given ordinal.

getIsFullyConsumed() - Method in interface io.delta.kernel.metrics.ScanReport

Whether the scan file iterator had been fully consumed when it was closed.

getJsonHandler() - Method in interface io.delta.kernel.engine.Engine

Get the connector provided JsonHandler.

getKeyField() - Method in class io.delta.kernel.types.MapType

getKeys() - Method in interface io.delta.kernel.data.MapValue

A ColumnVector containing the keys.

getKeyType() - Method in class io.delta.kernel.types.MapType

getLatestSnapshot() - Method in class io.delta.kernel.CommitRangeBuilder.CommitBoundary

Returns the latest snapshot used for timestamp resolution in timestamp-based boundaries.

getLatestSnapshot(Engine) - Method in interface io.delta.kernel.Table

Get the latest snapshot of the table.

getLeft() - Method in class io.delta.kernel.expressions.And

getLeft() - Method in class io.delta.kernel.expressions.Or

getLoadCrcTotalDurationNs() - Method in interface io.delta.kernel.metrics.SnapshotMetricsResult

getLoadLogSegmentTotalDurationNs() - Method in interface io.delta.kernel.metrics.SnapshotMetricsResult

getLoadProtocolMetadataTotalDurationNs() - Method in interface io.delta.kernel.metrics.SnapshotMetricsResult

getLoadSnapshotTotalDurationNs() - Method in interface io.delta.kernel.metrics.SnapshotMetricsResult

getLogPath() - Method in class io.delta.kernel.commit.PublishMetadata

getLong(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the long type value for rowId.

getLong(int) - Method in interface io.delta.kernel.data.Row

Return long value of the column located at the given ordinal.

getLong(String) - Method in class io.delta.kernel.types.FieldMetadata

getLongArray(String) - Method in class io.delta.kernel.types.FieldMetadata

getMap(int) - Method in interface io.delta.kernel.data.ColumnVector

Return the map value located at rowId.

getMap(int) - Method in interface io.delta.kernel.data.Row

Return map value of the column located at the given ordinal.

getMaxKnownPublishedDeltaVersion() - Method in class io.delta.kernel.commit.CommitMetadata

Returns the maximum known published delta version at commit time.

getMaxValues() - Method in class io.delta.kernel.statistics.DataFileStatistics

Get the maximum values of the columns in the data file.

getMessage() - Method in exception io.delta.kernel.exceptions.TableAlreadyExistsException

getMetadata() - Method in class io.delta.kernel.types.StructField

getMetadata(String) - Method in class io.delta.kernel.types.FieldMetadata.Builder

getMetadata(String) - Method in class io.delta.kernel.types.FieldMetadata

getMetadataArray(String) - Method in class io.delta.kernel.types.FieldMetadata

getMetadataColumnSpec() - Method in class io.delta.kernel.types.StructField

Returns the type of metadata column if this is a metadata column, otherwise returns null.

getMetadataColumnSpec(String) - Method in class io.delta.kernel.types.FieldMetadata

getMetricsReporters() - Method in interface io.delta.kernel.engine.Engine

Get the engine's MetricsReporter instances to push reports to.

getMinValues() - Method in class io.delta.kernel.statistics.DataFileStatistics

Get the minimum values of the columns in the data file.

getModificationTime() - Method in class io.delta.kernel.utils.FileStatus

Get the modification time of the file in epoch millis.

getName() - Method in class io.delta.kernel.expressions.ScalarExpression

getName() - Method in class io.delta.kernel.types.CollationIdentifier

getName() - Method in class io.delta.kernel.types.StructField

getNames() - Method in class io.delta.kernel.expressions.Column

getNewMetadataOpt() - Method in class io.delta.kernel.commit.CommitMetadata

The Metadata that is being written as part of this commit.

getNewProtocolOpt() - Method in class io.delta.kernel.commit.CommitMetadata

The Protocol that is being written as part of this commit.

getNullCount() - Method in class io.delta.kernel.statistics.DataFileStatistics

Get the number of nulls of columns in the data file.

getNumActiveAddFiles() - Method in interface io.delta.kernel.metrics.ScanMetricsResult

getNumAddFiles() - Method in interface io.delta.kernel.metrics.TransactionMetricsResult

getNumAddFilesSeen() - Method in interface io.delta.kernel.metrics.ScanMetricsResult

getNumAddFilesSeenFromDeltaFiles() - Method in interface io.delta.kernel.metrics.ScanMetricsResult

getNumCommitAttempts() - Method in interface io.delta.kernel.metrics.TransactionMetricsResult

getNumDuplicateAddFiles() - Method in interface io.delta.kernel.metrics.ScanMetricsResult

Returns the number of duplicate AddFile actions seen during log replay.

getNumRecords() - Method in class io.delta.kernel.statistics.DataFileStatistics

Get the number of records in the data file.

getNumRecords(String) - Static method in class io.delta.kernel.statistics.DataFileStatistics

Utility method to extract only the numRecords field from a statistics JSON string.

getNumRemoveFiles() - Method in interface io.delta.kernel.metrics.TransactionMetricsResult

getNumRemoveFilesSeenFromDeltaFiles() - Method in interface io.delta.kernel.metrics.ScanMetricsResult

getNumTotalActions() - Method in interface io.delta.kernel.metrics.TransactionMetricsResult

getOperation() - Method in interface io.delta.kernel.metrics.TransactionReport

getOperationType() - Method in interface io.delta.kernel.metrics.DeltaOperationReport

getOperationType() - Method in interface io.delta.kernel.metrics.ScanReport

getOperationType() - Method in interface io.delta.kernel.metrics.SnapshotReport

getOperationType() - Method in interface io.delta.kernel.metrics.TransactionReport

getParquetHandler() - Method in interface io.delta.kernel.engine.Engine

Get the connector provided ParquetHandler.

getPartitionColumnNames() - Method in interface io.delta.kernel.Snapshot

Get the names of the partition columns in the Delta table at this snapshot.

getPartitionColumns() - Method in class io.delta.kernel.transaction.DataLayoutSpec

Returns the partition columns for this layout.

getPartitionColumns(Engine) - Method in interface io.delta.kernel.Transaction

Get the list of logical names of the partition columns.

getPartitionColumnsAsStrings() - Method in class io.delta.kernel.transaction.DataLayoutSpec

Returns the partition columns for this layout as strings.

getPartitionPredicate() - Method in interface io.delta.kernel.metrics.ScanReport

getPath() - Method in interface io.delta.kernel.engine.FileReadRequest

Get the fully qualified path of the file from which to read the data.

getPath() - Method in interface io.delta.kernel.Snapshot

getPath() - Method in class io.delta.kernel.utils.FileStatus

Get the path to the file.

getPath(Engine) - Method in interface io.delta.kernel.Table

The fully qualified path of this Table instance.

getPostCommitHooks() - Method in class io.delta.kernel.TransactionCommitResult

Operations for connector to trigger post-commit.

getPostCommitSnapshot() - Method in class io.delta.kernel.TransactionCommitResult

Return the snapshot at the committed version.

getPrecision() - Method in class io.delta.kernel.types.DecimalType

getPreComputedNumSelectedRows() - Method in class io.delta.kernel.data.FilteredColumnarBatch

getPredicateEvaluator(StructType, Predicate) - Method in interface io.delta.kernel.engine.ExpressionHandler

Create a PredicateEvaluator that can evaluate the given predicate expression and return a selection vector (ColumnVector of boolean type).

getProvidedTimestamp() - Method in interface io.delta.kernel.metrics.SnapshotReport

getProvider() - Method in class io.delta.kernel.types.CollationIdentifier

getPublishedDeltaFilePath() - Method in class io.delta.kernel.commit.CommitMetadata

Returns the corresponding published Delta log file path for this commit, which is in the form of <table_path>/_delta_log/0000000000000000000<version>.json.

getQueryEndBoundary() - Method in interface io.delta.kernel.CommitRange

Returns the original query boundary used to define the end boundary of this commit range, if available.

getQueryMax() - Method in class io.delta.kernel.expressions.StGeometryBoxesIntersect

getQueryMin() - Method in class io.delta.kernel.expressions.StGeometryBoxesIntersect

getQueryStartBoundary() - Method in interface io.delta.kernel.CommitRange

Returns the original query boundary used to define the start boundary of this commit range.

getReadLength() - Method in interface io.delta.kernel.engine.FileReadRequest

Get the length of the data to read from the file starting at the startOffset.

getReadMetadataOpt() - Method in class io.delta.kernel.commit.CommitMetadata

The Metadata that was read at the beginning of the commit.

getReadProtocolOpt() - Method in class io.delta.kernel.commit.CommitMetadata

The Protocol that was read at the beginning of the commit.

getReadSchema() - Method in interface io.delta.kernel.metrics.ScanReport

getReadTableVersion() - Method in interface io.delta.kernel.Transaction

Gets the latest version of the table used as the base of this transaction.

getRemainingFilter() - Method in interface io.delta.kernel.Scan

Get the remaining filter that is not guaranteed to be satisfied for the data Delta Kernel returns.

getReportUUID() - Method in interface io.delta.kernel.metrics.DeltaOperationReport

getRequiredTableProperties() - Method in interface io.delta.kernel.commit.CatalogCommitter

Returns required catalog table properties that must be set in the Delta metadata.

getRight() - Method in class io.delta.kernel.expressions.And

getRight() - Method in class io.delta.kernel.expressions.Or

getRows() - Method in interface io.delta.kernel.data.ColumnarBatch

getRows() - Method in class io.delta.kernel.data.FilteredColumnarBatch

Iterator of rows that survived the filter.

getScale() - Method in class io.delta.kernel.types.DecimalType

getScanBuilder() - Method in interface io.delta.kernel.Snapshot

getScanFiles(Engine) - Method in interface io.delta.kernel.PaginatedScan

Get a paginated iterator of Scan files for the current page.

getScanFiles(Engine) - Method in interface io.delta.kernel.Scan

Get an iterator of data files to scan.

getScanMetrics() - Method in interface io.delta.kernel.metrics.ScanReport

getScanState(Engine) - Method in interface io.delta.kernel.Scan

Get the scan state associated with the current scan.

getSchema() - Method in interface io.delta.kernel.data.ColumnarBatch

getSchema() - Method in interface io.delta.kernel.data.Row

getSchema() - Method in interface io.delta.kernel.Snapshot

getSchema(Engine) - Method in interface io.delta.kernel.Transaction

Get the schema of the table.

getSelectionVector() - Method in class io.delta.kernel.data.FilteredColumnarBatch

Optional selection vector containing one entry for each row in data indicating whether a row is selected or not selected.

getShort(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the short type value for rowId.

getShort(int) - Method in interface io.delta.kernel.data.Row

Return short value of the column located at the given ordinal.

getSize() - Method in interface io.delta.kernel.data.ArrayValue

The number of elements in the array

getSize() - Method in interface io.delta.kernel.data.ColumnarBatch

getSize() - Method in interface io.delta.kernel.data.ColumnVector

getSize() - Method in interface io.delta.kernel.data.MapValue

The number of elements in the map

getSize() - Method in class io.delta.kernel.utils.FileStatus

Get the size of the file in bytes.

getSnapshotAsOfTimestamp(Engine, long) - Method in interface io.delta.kernel.Table

Get the snapshot of the table at the given timestamp.

getSnapshotAsOfVersion(Engine, long) - Method in interface io.delta.kernel.Table

Get the snapshot at the given versionId.

getSnapshotMetrics() - Method in interface io.delta.kernel.metrics.SnapshotReport

getSnapshotReportUUID() - Method in interface io.delta.kernel.metrics.ScanReport

getSnapshotReportUUID() - Method in interface io.delta.kernel.metrics.TransactionReport

getSnapshotVersion() - Method in class io.delta.kernel.commit.PublishMetadata

getSortedBinBoundaries() - Method in interface io.delta.kernel.metrics.FileSizeHistogramResult

Sorted list of bin boundaries where each element represents the start of the bin (inclusive) and the next element represents the end of the bin (exclusive).

getSRID() - Method in class io.delta.kernel.types.GeographyType

Get the Spatial Reference System Identifier.

getSRID() - Method in class io.delta.kernel.types.GeometryType

Get the Spatial Reference System Identifier.

getStartOffset() - Method in interface io.delta.kernel.engine.FileReadRequest

Get the start offset in the file from where to start reading the data.

getStartVersion() - Method in interface io.delta.kernel.CommitRange

Returns the starting version number (inclusive) of this commit range.

getStartVersion() - Method in exception io.delta.kernel.exceptions.CommitRangeNotFoundException

getStartVersionRequested() - Method in exception io.delta.kernel.exceptions.StartVersionNotFoundException

getStatistics() - Method in interface io.delta.kernel.Snapshot

getStatistics() - Method in class io.delta.kernel.utils.DataFileStatus

Get the statistics of the data file encapsulated in this object.

getStatisticsColumns() - Method in interface io.delta.kernel.DataWriteContext

Returns the list of Column that the connector can optionally collect statistics.

getString(int) - Method in interface io.delta.kernel.data.ColumnVector

Returns the string type value for rowId.

getString(int) - Method in interface io.delta.kernel.data.Row

Return string value of the column located at the given ordinal.

getString(String) - Method in class io.delta.kernel.types.FieldMetadata

getStringArray(String) - Method in class io.delta.kernel.types.FieldMetadata

getStruct(int) - Method in interface io.delta.kernel.data.Row

Return struct value of the column located at the given ordinal.

getTableFileSizeHistogram() - Method in interface io.delta.kernel.metrics.TransactionMetricsResult

getTablePath() - Method in exception io.delta.kernel.exceptions.CommitRangeNotFoundException

getTablePath() - Method in exception io.delta.kernel.exceptions.StartVersionNotFoundException

getTablePath() - Method in exception io.delta.kernel.exceptions.TableNotFoundException

getTablePath() - Method in exception io.delta.kernel.exceptions.UnsupportedProtocolVersionException

getTablePath() - Method in exception io.delta.kernel.exceptions.UnsupportedTableFeatureException

getTablePath() - Method in interface io.delta.kernel.metrics.DeltaOperationReport

getTableProperties() - Method in interface io.delta.kernel.Snapshot

Get all table properties for the Delta table at this snapshot.

getTableSchema() - Method in interface io.delta.kernel.metrics.ScanReport

getTableVersion() - Method in interface io.delta.kernel.metrics.ScanReport

getTargetDirectory() - Method in interface io.delta.kernel.DataWriteContext

Returns the target directory where the data should be written.

getTightBounds() - Method in class io.delta.kernel.statistics.DataFileStatistics

Get the tight bounds information for the data file.

getTimestamp() - Method in interface io.delta.kernel.CommitActions

Returns the commit timestamp in milliseconds since Unix epoch.

getTimestamp() - Method in class io.delta.kernel.CommitRangeBuilder.CommitBoundary

Returns the timestamp for timestamp-based boundaries.

getTimestamp(Engine) - Method in interface io.delta.kernel.Snapshot

Get the timestamp (in milliseconds since the Unix epoch) of the latest commit in this snapshot.

getTo() - Method in class io.delta.kernel.types.TypeChange

getTotalAddFilesSizeInBytes() - Method in interface io.delta.kernel.metrics.TransactionMetricsResult

getTotalBytes() - Method in interface io.delta.kernel.metrics.FileSizeHistogramResult

The total number of bytes in each bin of FileSizeHistogramResult.getSortedBinBoundaries()

getTotalCommitDurationNs() - Method in interface io.delta.kernel.metrics.TransactionMetricsResult

getTotalPlanningDurationNs() - Method in interface io.delta.kernel.metrics.ScanMetricsResult

Returns the total duration to find, filter, and consume the scan files.

getTotalRemoveFilesSizeInBytes() - Method in interface io.delta.kernel.metrics.TransactionMetricsResult

getTransactionMetrics() - Method in interface io.delta.kernel.metrics.TransactionReport

getTransactionReport() - Method in class io.delta.kernel.TransactionCommitResult

getTransactionState(Engine) - Method in interface io.delta.kernel.Transaction

Get the state of the transaction.

getType() - Method in interface io.delta.kernel.hook.PostCommitHook

getTypeChanges() - Method in class io.delta.kernel.types.StructField

Returns the list of type changes for this field.

getUnsupportedFeatures() - Method in exception io.delta.kernel.exceptions.UnsupportedTableFeatureException

getValue() - Method in class io.delta.kernel.expressions.Literal

Get the literal value.

getValueExpression() - Method in class io.delta.kernel.expressions.In

getValueField() - Method in class io.delta.kernel.types.MapType

getValues() - Method in interface io.delta.kernel.data.MapValue

A ColumnVector containing the values.

getValueType() - Method in class io.delta.kernel.types.MapType

getVersion() - Method in class io.delta.kernel.commit.CommitMetadata

The version of the Delta table this commit is targeting.

getVersion() - Method in interface io.delta.kernel.CommitActions

Returns the commit version number.

getVersion() - Method in class io.delta.kernel.CommitRangeBuilder.CommitBoundary

Returns the version number for version-based boundaries.

getVersion() - Method in exception io.delta.kernel.exceptions.UnsupportedProtocolVersionException

getVersion() - Method in interface io.delta.kernel.metrics.SnapshotReport

For a time-travel by version query, this is the version provided.

getVersion() - Method in interface io.delta.kernel.Snapshot

getVersion() - Method in class io.delta.kernel.TransactionCommitResult

Contains the version of the transaction committed as.

getVersion() - Method in class io.delta.kernel.types.CollationIdentifier

getVersionType() - Method in exception io.delta.kernel.exceptions.UnsupportedProtocolVersionException

getWriteContext(Engine, Row, Map<String, Literal>) - Static method in interface io.delta.kernel.Transaction

Get the context for writing data into a table.

H

hasClustering() - Method in class io.delta.kernel.transaction.DataLayoutSpec

Returns true if this layout specification includes clustering.

hashCode() - Method in class io.delta.kernel.expressions.Column

hashCode() - Method in class io.delta.kernel.expressions.Predicate

hashCode() - Method in class io.delta.kernel.statistics.DataFileStatistics

hashCode() - Method in class io.delta.kernel.types.ArrayType

hashCode() - Method in class io.delta.kernel.types.BasePrimitiveType

hashCode() - Method in class io.delta.kernel.types.DataType

hashCode() - Method in class io.delta.kernel.types.DecimalType

hashCode() - Method in class io.delta.kernel.types.FieldMetadata

hashCode() - Method in class io.delta.kernel.types.GeographyType

hashCode() - Method in class io.delta.kernel.types.GeometryType

hashCode() - Method in class io.delta.kernel.types.MapType

hashCode() - Method in class io.delta.kernel.types.StructField

hashCode() - Method in class io.delta.kernel.types.StructType

hashCode() - Method in class io.delta.kernel.types.TypeChange

hashCode() - Method in class io.delta.kernel.utils.FileStatus

hasNext() - Method in interface io.delta.kernel.utils.CloseableIterator

Returns true if the iteration has more elements.

hasNoDataLayoutSpec() - Method in class io.delta.kernel.transaction.DataLayoutSpec

Returns true if this is a data layout spec with no special layout.

hasPartitioning() - Method in class io.delta.kernel.transaction.DataLayoutSpec

Returns true if this layout specification includes partitioning.

I

In - Class in io.delta.kernel.expressions

IN expression

In(Expression, List<Expression>) - Constructor for class io.delta.kernel.expressions.In

Creates an IN predicate expression.

In(Expression, List<Expression>, CollationIdentifier) - Constructor for class io.delta.kernel.expressions.In

Creates an IN predicate expression with collation support.

INCLUDE - Enum constant in enum class io.delta.kernel.utils.CloseableIterator.BreakableFilterResult

Indicates that the current element should be included in the resulting iterator produced by CloseableIterator.breakableFilter(Function).

indexOf(MetadataColumnSpec) - Method in class io.delta.kernel.types.StructType

indexOf(String) - Method in class io.delta.kernel.types.StructType

inMemoryIterable(CloseableIterator<T>) - Static method in interface io.delta.kernel.utils.CloseableIterable

Return an CloseableIterable object that is backed by an in-memory collection of given CloseableIterator.

INTEGER - Static variable in class io.delta.kernel.types.IntegerType

IntegerType - Class in io.delta.kernel.types

The data type representing integer type values.

InvalidConfigurationValueException - Exception in io.delta.kernel.exceptions

Thrown when an illegal value is specified for a table property.

InvalidConfigurationValueException(String, String, String) - Constructor for exception io.delta.kernel.exceptions.InvalidConfigurationValueException

InvalidTableException - Exception in io.delta.kernel.exceptions

Thrown when an invalid table is encountered; the table's log and/or checkpoint files are in an invalid state.

InvalidTableException(String, String) - Constructor for exception io.delta.kernel.exceptions.InvalidTableException

io.delta.kernel - package io.delta.kernel

Delta Kernel interfaces for constructing table object representing a Delta Lake table, getting snapshot from the table and building a scan object to scan a subset of the data in the table.

io.delta.kernel.annotation - package io.delta.kernel.annotation

io.delta.kernel.commit - package io.delta.kernel.commit

io.delta.kernel.data - package io.delta.kernel.data

Delta Kernel interfaces for representing data in columnar and row format.

io.delta.kernel.engine - package io.delta.kernel.engine

Interfaces to allow the connector to bring their own implementation of functions such as reading parquet files, listing files in a file system, parsing a JSON string etc.

io.delta.kernel.exceptions - package io.delta.kernel.exceptions

io.delta.kernel.expressions - package io.delta.kernel.expressions

Expressions framework that defines the most common expressions which the connectors can use to pass predicates to Delta Kernel.

io.delta.kernel.hook - package io.delta.kernel.hook

io.delta.kernel.metrics - package io.delta.kernel.metrics

io.delta.kernel.statistics - package io.delta.kernel.statistics

io.delta.kernel.transaction - package io.delta.kernel.transaction

io.delta.kernel.types - package io.delta.kernel.types

Data types defined by the Delta Kernel to exchange the type info between the Delta Kernel and the connectors.

io.delta.kernel.utils - package io.delta.kernel.utils

Utilities.

IS_INTERNAL_COLUMN_KEY - Static variable in class io.delta.kernel.types.StructField

Indicates that a column was requested for internal computations and should not be returned to the user.

isConflict() - Method in exception io.delta.kernel.commit.CommitFailedException

Returns whether the commit failed due to a conflict.

isDataColumn() - Method in class io.delta.kernel.types.StructField

isInternalColumn() - Method in class io.delta.kernel.types.StructField

isMetadataColumn() - Method in class io.delta.kernel.types.StructField

isNested() - Method in class io.delta.kernel.types.ArrayType

isNested() - Method in class io.delta.kernel.types.BasePrimitiveType

isNested() - Method in class io.delta.kernel.types.DataType

Returns true iff this data is a nested data type (it logically parameterized by other types).

isNested() - Method in class io.delta.kernel.types.DecimalType

isNested() - Method in class io.delta.kernel.types.GeographyType

isNested() - Method in class io.delta.kernel.types.GeometryType

isNested() - Method in class io.delta.kernel.types.MapType

isNested() - Method in class io.delta.kernel.types.StructType

isNullable() - Method in class io.delta.kernel.types.StructField

isNullAt(int) - Method in interface io.delta.kernel.data.ColumnVector

isNullAt(int) - Method in interface io.delta.kernel.data.Row

isPrimitiveType(String) - Static method in class io.delta.kernel.types.BasePrimitiveType

Is the given type name a primitive type?

isRetryable() - Method in exception io.delta.kernel.commit.CommitFailedException

Returns whether the commit can be retried.

isSparkUTF8BinaryCollation() - Method in class io.delta.kernel.types.CollationIdentifier

isTimestamp() - Method in class io.delta.kernel.CommitRangeBuilder.CommitBoundary

isTypeValueBinaryLike(DataType) - Static method in class io.delta.kernel.types.DataType

Returns true if the type value can be interpreted as raw bytes.

isUTF8BinaryCollated() - Method in class io.delta.kernel.types.StringType

isValueContainsNull() - Method in class io.delta.kernel.types.MapType

isVersion() - Method in class io.delta.kernel.CommitRangeBuilder.CommitBoundary

isWriteCompatible(DataType) - Method in class io.delta.kernel.types.ArrayType

Checks whether the given dataType is compatible with this type when writing data.

isWriteCompatible(DataType) - Method in class io.delta.kernel.types.DataType

Checks whether the given dataType is compatible with this type when writing data.

isWriteCompatible(DataType) - Method in class io.delta.kernel.types.MapType

Checks whether the given dataType is compatible with this type when writing data.

isWriteCompatible(DataType) - Method in class io.delta.kernel.types.StringType

Checks whether the given dataType is compatible with this type when writing data.

isWriteCompatible(DataType) - Method in class io.delta.kernel.types.StructType

Checks whether the given dataType is compatible with this type when writing data.

isWriteCompatible(StructField) - Method in class io.delta.kernel.types.StructField

Checks whether the given other is compatible with this StructField when writing data.

iterator() - Method in interface io.delta.kernel.utils.CloseableIterable

Overrides the default iterator method to return a CloseableIterator.

J

JsonHandler - Interface in io.delta.kernel.engine

Provides JSON handling functionality to Delta Kernel.

K

KernelEngineException - Exception in io.delta.kernel.exceptions

Throws when the Engine encountered an error while executing an operation.

KernelEngineException(String, Throwable) - Constructor for exception io.delta.kernel.exceptions.KernelEngineException

KernelException - Exception in io.delta.kernel.exceptions

Thrown when Kernel cannot execute the requested operation due to the operation being invalid or unsupported.

KernelException() - Constructor for exception io.delta.kernel.exceptions.KernelException

KernelException(String) - Constructor for exception io.delta.kernel.exceptions.KernelException

KernelException(String, Throwable) - Constructor for exception io.delta.kernel.exceptions.KernelException

KernelException(Throwable) - Constructor for exception io.delta.kernel.exceptions.KernelException

L

length() - Method in class io.delta.kernel.types.StructType

listFrom(String) - Method in interface io.delta.kernel.engine.FileSystemClient

List the paths in the same directory that are lexicographically greater or equal to (UTF-8 sorting) the given `path`.

Literal - Class in io.delta.kernel.expressions

A literal value.

loadCommitRange(String, CommitRangeBuilder.CommitBoundary) - Static method in interface io.delta.kernel.TableManager

Creates a builder for loading a CommitRange at a given path.

loadSnapshot(String) - Static method in interface io.delta.kernel.TableManager

Creates a builder for loading a snapshot at the given path.

LOG_COMPACTION - Enum constant in enum class io.delta.kernel.hook.PostCommitHook.PostCommitHookType

Writes a log compaction file that merges a range of commit JSON files into a single file.

LONG - Static variable in class io.delta.kernel.types.LongType

LongType - Class in io.delta.kernel.types

The data type representing long type values.

M

MANUAL_UPDATE - Enum constant in enum class io.delta.kernel.Operation

For any operation that doesn't fit the above categories.

map(Function<T, U>) - Method in interface io.delta.kernel.utils.CloseableIterator

MAP_KEY_NAME - Static variable in class io.delta.kernel.types.MapType

MAP_VALUE_NAME - Static variable in class io.delta.kernel.types.MapType

MapType - Class in io.delta.kernel.types

Data type representing a map type.

MapType(DataType, DataType, boolean) - Constructor for class io.delta.kernel.types.MapType

MapType(StructField, StructField) - Constructor for class io.delta.kernel.types.MapType

MapValue - Interface in io.delta.kernel.data

Abstraction to represent a single map value in a ColumnVector.

MaxCommitRetryLimitReachedException - Exception in io.delta.kernel.exceptions

MaxCommitRetryLimitReachedException(long, int, Exception) - Constructor for exception io.delta.kernel.exceptions.MaxCommitRetryLimitReachedException

METADATA_SPEC_KEY - Static variable in class io.delta.kernel.types.StructField

The existence of this key indicates that a column is a metadata column and its values indicates what kind of MetadataColumnSpec it is.

MetadataChangedException - Exception in io.delta.kernel.exceptions

Thrown when the metadata of the Delta table has changed between the time of transaction start and the time of commit.

MetadataChangedException() - Constructor for exception io.delta.kernel.exceptions.MetadataChangedException

MetadataColumnSpec - Enum Class in io.delta.kernel.types

Enumeration of metadata columns recognized by Delta Kernel.

METASTORE_LAST_COMMIT_TIMESTAMP - Static variable in class io.delta.kernel.commit.CatalogCommitterUtils

Property key that specifies the timestamp (in milliseconds since the Unix epoch) of the last commit that updated the catalog entry.

METASTORE_LAST_UPDATE_VERSION - Static variable in class io.delta.kernel.commit.CatalogCommitterUtils

Property key that specifies which version last updated the catalog entry.

MetricsReport - Interface in io.delta.kernel.metrics

Interface containing the metrics for a given operation.

MetricsReporter - Interface in io.delta.kernel.engine

Interface for reporting metrics for operations to a Delta table

mkdirs(String) - Method in interface io.delta.kernel.engine.FileSystemClient

Create a directory at the given path including parent directories.

N

NAME - Static variable in class io.delta.kernel.expressions.StGeometryBoxesIntersect

next() - Method in interface io.delta.kernel.utils.CloseableIterator

Returns the next element in the iteration.

noDataLayout() - Static method in class io.delta.kernel.transaction.DataLayoutSpec

Creates data layout spec with no special layout.

nullable - Variable in enum class io.delta.kernel.types.MetadataColumnSpec

O

of(String) - Static method in class io.delta.kernel.utils.FileStatus

Create a FileStatus with the given path with size and modification time set to 0.

of(String, long, long) - Static method in class io.delta.kernel.utils.FileStatus

Create a FileStatus with the given path, size and modification time.

ofAlgorithm(String) - Static method in class io.delta.kernel.types.GeographyType

Returns a GeographyType with the default SRID and the specified algorithm.

ofBinary(byte[]) - Static method in class io.delta.kernel.expressions.Literal

Create a binary type literal expression.

ofBoolean(boolean) - Static method in class io.delta.kernel.expressions.Literal

Create a boolean type literal expression.

ofByte(byte) - Static method in class io.delta.kernel.expressions.Literal

Create a byte type literal expression.

ofDate(int) - Static method in class io.delta.kernel.expressions.Literal

Create a date type literal expression.

ofDecimal(BigDecimal, int, int) - Static method in class io.delta.kernel.expressions.Literal

Create a decimal type literal expression.

ofDefault() - Static method in class io.delta.kernel.types.GeographyType

Returns a GeographyType with the default SRID and algorithm.

ofDefault() - Static method in class io.delta.kernel.types.GeometryType

Returns a GeometryType with the default SRID.

ofDouble(double) - Static method in class io.delta.kernel.expressions.Literal

Create a double type literal expression.

ofFloat(float) - Static method in class io.delta.kernel.expressions.Literal

Create a float type literal expression.

ofGeospatialWKT(String, DataType) - Static method in class io.delta.kernel.expressions.Literal

Create a geospatial Well-Known Text (WKT) literal with the given data type.

ofInt(int) - Static method in class io.delta.kernel.expressions.Literal

Create a integer type literal expression.

ofLong(long) - Static method in class io.delta.kernel.expressions.Literal

Create a long type literal expression.

ofNull(DataType) - Static method in class io.delta.kernel.expressions.Literal

Create null value literal.

ofShort(short) - Static method in class io.delta.kernel.expressions.Literal

Create a short type literal expression.

ofSRID(String) - Static method in class io.delta.kernel.types.GeographyType

Returns a GeographyType with the specified SRID and default algorithm.

ofSRID(String) - Static method in class io.delta.kernel.types.GeometryType

Returns a GeometryType with the specified SRID.

ofString(String) - Static method in class io.delta.kernel.expressions.Literal

Create a string type literal expression.

ofString(String, CollationIdentifier) - Static method in class io.delta.kernel.expressions.Literal

Create a string type literal expression with collated StringType.

ofTimestamp(long) - Static method in class io.delta.kernel.expressions.Literal

Create a timestamp type literal expression.

ofTimestampNtz(long) - Static method in class io.delta.kernel.expressions.Literal

Create a timestamp_ntz type literal expression.

Operation - Enum Class in io.delta.kernel

An operation that can be performed on a Delta table.

Or - Class in io.delta.kernel.expressions

OR expression

Or(Predicate, Predicate) - Constructor for class io.delta.kernel.expressions.Or

P

PaginatedScan - Interface in io.delta.kernel

Extension of Scan that supports pagination.

PaginatedScanFilesIterator - Interface in io.delta.kernel

An iterator over FilteredColumnarBatch, each representing a batch of Scan Files in a paginated scan.

ParquetHandler - Interface in io.delta.kernel.engine

Provides Parquet file related functionalities to Delta Kernel.

parseJson(ColumnVector, StructType, Optional<ColumnVector>) - Method in interface io.delta.kernel.engine.JsonHandler

Parse the given json strings and return the fields requested by outputSchema as columns in a ColumnarBatch.

partitioned(List<Column>) - Static method in class io.delta.kernel.transaction.DataLayoutSpec

Creates a data layout specification for a partitioned table.

partitionExists(Engine, Snapshot, Predicate) - Static method in class io.delta.kernel.utils.PartitionUtils

Check if a partition exists (i.e.

PartitionUtils - Class in io.delta.kernel.utils

PartitionValueExpression - Class in io.delta.kernel.expressions

Expression to decode the serialized partition value into partition type value according the Delta Protocol spec.

PartitionValueExpression(Expression, DataType) - Constructor for class io.delta.kernel.expressions.PartitionValueExpression

Create partition_value expression.

PostCommitHook - Interface in io.delta.kernel.hook

A hook for executing operation after a transaction commit.

PostCommitHook.PostCommitHookType - Enum Class in io.delta.kernel.hook

Predicate - Class in io.delta.kernel.expressions

Defines predicate scalar expression which is an extension of ScalarExpression that evaluates to true, false, or null for each input row.

Predicate(String, Expression) - Constructor for class io.delta.kernel.expressions.Predicate

Constructor for a unary Predicate expression

Predicate(String, Expression, Expression) - Constructor for class io.delta.kernel.expressions.Predicate

Constructor for a binary Predicate expression

Predicate(String, Expression, Expression, CollationIdentifier) - Constructor for class io.delta.kernel.expressions.Predicate

Constructor for a Predicate expression with collation support.

Predicate(String, List<Expression>) - Constructor for class io.delta.kernel.expressions.Predicate

Predicate(String, List<Expression>, CollationIdentifier) - Constructor for class io.delta.kernel.expressions.Predicate

Constructor for a Predicate expression with collation support.

PredicateEvaluator - Interface in io.delta.kernel.expressions

Special interface for evaluating Predicate on input batch and return a selection vector containing one value for each row in input batch indicating whether the row has passed the predicate or not.

ProtocolChangedException - Exception in io.delta.kernel.exceptions

Thrown when the protocol of the Delta table has changed between the time of transaction start and the time of commit.

ProtocolChangedException(long) - Constructor for exception io.delta.kernel.exceptions.ProtocolChangedException

publish(Engine) - Method in interface io.delta.kernel.Snapshot

Publishes all catalog commits at this table version.

publish(Engine, PublishMetadata) - Method in interface io.delta.kernel.commit.CatalogCommitter

Publishes catalog commits to the Delta log.

PublishFailedException - Exception in io.delta.kernel.commit

Exception thrown when publishing catalog commits to the Delta log fails.

PublishFailedException(String) - Constructor for exception io.delta.kernel.commit.PublishFailedException

Constructs a new PublishFailedException with the specified detail message.

PublishFailedException(String, Throwable) - Constructor for exception io.delta.kernel.commit.PublishFailedException

Constructs a new PublishFailedException with the specified detail message and cause.

PublishMetadata - Class in io.delta.kernel.commit

Metadata required for publishing catalog commits to the Delta log.

PublishMetadata(long, String, List<ParsedCatalogCommitData>) - Constructor for class io.delta.kernel.commit.PublishMetadata

putBoolean(String, boolean) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putBooleanArray(String, Boolean[]) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putDouble(String, double) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putDoubleArray(String, Double[]) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putFieldMetadata(String, FieldMetadata) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putFieldMetadataArray(String, FieldMetadata[]) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putLong(String, long) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putLongArray(String, Long[]) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putMetadataColumnSpec(String, MetadataColumnSpec) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putNull(String) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putString(String, String) - Method in class io.delta.kernel.types.FieldMetadata.Builder

putStringArray(String, String[]) - Method in class io.delta.kernel.types.FieldMetadata.Builder

R

READER - Enum constant in enum class io.delta.kernel.exceptions.UnsupportedProtocolVersionException.ProtocolVersionType

Reader protocol version

readFiles(CloseableIterator<FileReadRequest>) - Method in interface io.delta.kernel.engine.FileSystemClient

Return an iterator of byte streams one for each read request in readRequests.

readJsonFiles(CloseableIterator<FileStatus>, StructType, Optional<Predicate>) - Method in interface io.delta.kernel.engine.JsonHandler

Read and parse the JSON format file at given locations and return the data as a ColumnarBatch with the columns requested by physicalSchema.

readParquetFiles(CloseableIterator<FileStatus>, StructType, Optional<Predicate>) - Method in interface io.delta.kernel.engine.ParquetHandler

Read the Parquet format files at the given locations and return the data as a ColumnarBatch with the columns requested by physicalSchema.

remove(String) - Method in class io.delta.kernel.types.FieldMetadata.Builder

removeDomainMetadata(String) - Method in interface io.delta.kernel.Transaction

Mark the domain metadata with identifier domain as removed in this transaction.

REPLACE_TABLE - Enum constant in enum class io.delta.kernel.Operation

Recorded during REPLACE operation (may also be considered an overwrite)

ReplaceTableTransactionBuilder - Interface in io.delta.kernel.transaction

Builds a Transaction to replace an existing Delta table.

report(MetricsReport) - Method in interface io.delta.kernel.engine.MetricsReporter

Indicates that an operation is done by reporting a MetricsReport

resolvePath(String) - Method in interface io.delta.kernel.engine.FileSystemClient

Resolve the given path to a fully qualified path.

Row - Interface in io.delta.kernel.data

Represent a single record

ROW_COMMIT_VERSION - Enum constant in enum class io.delta.kernel.types.MetadataColumnSpec

ROW_ID - Enum constant in enum class io.delta.kernel.types.MetadataColumnSpec

ROW_INDEX - Enum constant in enum class io.delta.kernel.types.MetadataColumnSpec

S

ScalarExpression - Class in io.delta.kernel.expressions

Scalar SQL expressions which take zero or more inputs and for each input row generate one output value.

ScalarExpression(String, List<Expression>) - Constructor for class io.delta.kernel.expressions.ScalarExpression

Scan - Interface in io.delta.kernel

Represents a scan of a Delta table.

ScanBuilder - Interface in io.delta.kernel

Builder to construct Scan object.

ScanMetricsResult - Interface in io.delta.kernel.metrics

Stores the metrics results for a ScanReport

ScanReport - Interface in io.delta.kernel.metrics

Defines the metadata and metrics for a Scan MetricsReport

serializeAsJson(StructType) - Method in class io.delta.kernel.statistics.DataFileStatistics

Serializes the statistics as a JSON string.

SHORT - Static variable in class io.delta.kernel.types.ShortType

ShortType - Class in io.delta.kernel.types

The data type representing short type values.

SIMPLE - Enum constant in enum class io.delta.kernel.Snapshot.ChecksumWriteMode

Checksum info is already loaded in this Snapshot and can be written cheaply.

simpleString() - Method in class io.delta.kernel.types.GeographyType

Serialize this GeographyType to its string representation with minimal info.

simpleString() - Method in class io.delta.kernel.types.GeometryType

Serialize this GeometryType to its string representation with minimal info.

Snapshot - Interface in io.delta.kernel

Represents a snapshot of a Delta table at a specific version.

Snapshot.ChecksumWriteMode - Enum Class in io.delta.kernel

Indicates how a checksum file should be written for this Snapshot.

SnapshotBuilder - Interface in io.delta.kernel

Builder for constructing a Snapshot instance.

SnapshotMetricsResult - Interface in io.delta.kernel.metrics

Stores the metrics results for a SnapshotReport

SnapshotReport - Interface in io.delta.kernel.metrics

Defines the metadata and metrics for a snapshot construction MetricsReport

SnapshotStatistics - Interface in io.delta.kernel.statistics

Provides statistics and metadata about a Snapshot.

SPARK_UTF8_BINARY - Static variable in class io.delta.kernel.types.CollationIdentifier

The default Spark UTF8_BINARY collation.

spliterator() - Method in interface io.delta.kernel.utils.CloseableIterable

StartVersionNotFoundException - Exception in io.delta.kernel.exceptions

Exception thrown when the requested start version is not found in the Delta log.

StartVersionNotFoundException(String, long, Optional<Long>) - Constructor for exception io.delta.kernel.exceptions.StartVersionNotFoundException

StGeometryBoxesIntersect - Class in io.delta.kernel.expressions

A predicate that tests whether the bounding box of a geometry column intersects a given query bounding box.

StGeometryBoxesIntersect(Column, Literal, Literal) - Constructor for class io.delta.kernel.expressions.StGeometryBoxesIntersect

STREAMING_UPDATE - Enum constant in enum class io.delta.kernel.Operation

Recorded during streaming inserts.

STRING - Static variable in class io.delta.kernel.types.StringType

StringType - Class in io.delta.kernel.types

The data type representing string type values.

StringType(CollationIdentifier) - Constructor for class io.delta.kernel.types.StringType

StringType(String) - Constructor for class io.delta.kernel.types.StringType

StructField - Class in io.delta.kernel.types

Represents a subfield of StructType with additional properties and metadata.

StructField(String, DataType, boolean) - Constructor for class io.delta.kernel.types.StructField

StructField(String, DataType, boolean, FieldMetadata) - Constructor for class io.delta.kernel.types.StructField

StructType - Class in io.delta.kernel.types

Struct type which contains one or more columns.

StructType() - Constructor for class io.delta.kernel.types.StructType

StructType(List<StructField>) - Constructor for class io.delta.kernel.types.StructType

T

Table - Interface in io.delta.kernel

Represents the Delta Lake table for a given path.

TableAlreadyExistsException - Exception in io.delta.kernel.exceptions

Thrown when trying to create a Delta table at a location where a Delta table already exists.

TableAlreadyExistsException(String) - Constructor for exception io.delta.kernel.exceptions.TableAlreadyExistsException

TableAlreadyExistsException(String, String) - Constructor for exception io.delta.kernel.exceptions.TableAlreadyExistsException

TableManager - Interface in io.delta.kernel

The entry point for loading and creating Delta tables.

TableNotFoundException - Exception in io.delta.kernel.exceptions

Thrown when there is no Delta table at the given location.

TableNotFoundException(String) - Constructor for exception io.delta.kernel.exceptions.TableNotFoundException

TableNotFoundException(String, String) - Constructor for exception io.delta.kernel.exceptions.TableNotFoundException

takeWhile(Function<T, Boolean>) - Method in interface io.delta.kernel.utils.CloseableIterator

Returns a new CloseableIterator that includes elements from this iterator as long as the given mapper function returns true.

textValue - Variable in enum class io.delta.kernel.types.MetadataColumnSpec

threadSafeInvoke(Engine) - Method in interface io.delta.kernel.hook.PostCommitHook

Invokes the post commit operation whose implementation must be thread safe.

TIMESTAMP - Static variable in class io.delta.kernel.types.TimestampType

TIMESTAMP_FORMATTER - Static variable in class io.delta.kernel.statistics.DataFileStatistics

TIMESTAMP_NTZ - Static variable in class io.delta.kernel.types.TimestampNTZType

TimestampNTZType - Class in io.delta.kernel.types

The timestamp without time zone type represents a local time in microsecond precision, which is independent of time zone.

TimestampType - Class in io.delta.kernel.types

A timestamp type, supporting [0001-01-01T00:00:00.000000Z, 9999-12-31T23:59:59.999999Z] where the left/right-bound is a date and time of the proleptic Gregorian calendar in UTC+00:00.

TO_TYPE_KEY - Static variable in class io.delta.kernel.types.StructField

toInMemoryList() - Method in interface io.delta.kernel.utils.CloseableIterator

Collects all elements from this CloseableIterator into a List.

toJson() - Method in interface io.delta.kernel.metrics.MetricsReport

Converts this metrics report to a JSON string representation.

toJson() - Method in class io.delta.kernel.types.StructType

Convert the struct type to Delta protocol specified serialization format.

toString() - Method in exception io.delta.kernel.commit.CommitFailedException

toString() - Method in class io.delta.kernel.CommitRangeBuilder.CommitBoundary

toString() - Method in class io.delta.kernel.expressions.Column

toString() - Method in class io.delta.kernel.expressions.In

toString() - Method in class io.delta.kernel.expressions.Literal

toString() - Method in class io.delta.kernel.expressions.PartitionValueExpression

toString() - Method in class io.delta.kernel.expressions.Predicate

Returns string representation of the predicate.

toString() - Method in class io.delta.kernel.expressions.ScalarExpression

toString() - Method in class io.delta.kernel.statistics.DataFileStatistics

toString() - Method in class io.delta.kernel.types.ArrayType

toString() - Method in class io.delta.kernel.types.BasePrimitiveType

toString() - Method in class io.delta.kernel.types.CollationIdentifier

toString() - Method in class io.delta.kernel.types.DataType

toString() - Method in class io.delta.kernel.types.DecimalType

toString() - Method in class io.delta.kernel.types.FieldMetadata

toString() - Method in class io.delta.kernel.types.GeographyType

toString() - Method in class io.delta.kernel.types.GeometryType

toString() - Method in class io.delta.kernel.types.MapType

toString() - Method in enum class io.delta.kernel.types.MetadataColumnSpec

toString() - Method in class io.delta.kernel.types.StringType

Override is needed because toString() may be used for schema serialization and similar contexts, so collation information must be included.

toString() - Method in class io.delta.kernel.types.StructField

toString() - Method in class io.delta.kernel.types.StructType

toString() - Method in class io.delta.kernel.types.TypeChange

toString() - Method in class io.delta.kernel.utils.DataFileStatus

toString() - Method in class io.delta.kernel.utils.FileStatus

toStringWithoutVersion() - Method in class io.delta.kernel.types.CollationIdentifier

Transaction - Interface in io.delta.kernel

Represents a transaction to mutate a Delta table.

TransactionBuilder - Interface in io.delta.kernel

Builder for creating a Transaction to mutate a Delta table.

TransactionCommitResult - Class in io.delta.kernel

Contains the result of a successful transaction commit.

TransactionCommitResult(long, List<PostCommitHook>, TransactionReport, Optional<SnapshotImpl>) - Constructor for class io.delta.kernel.TransactionCommitResult

TransactionMetricsResult - Interface in io.delta.kernel.metrics

Stores the metrics results for a TransactionReport

TransactionReport - Interface in io.delta.kernel.metrics

Defines the metadata and metrics for a transaction MetricsReport

transformLogicalData(Engine, Row, CloseableIterator<FilteredColumnarBatch>, Map<String, Literal>) - Static method in interface io.delta.kernel.Transaction

Given the logical data that needs to be written to the table, convert it into the required physical data depending upon the table Delta protocol and features enabled on the table.

transformPhysicalData(Engine, Row, Row, CloseableIterator<ColumnarBatch>) - Static method in interface io.delta.kernel.Scan

Transform the physical data read from the table data file to the logical data that are expected out of the Delta table.

TypeChange - Class in io.delta.kernel.types

Represents a type change for a field, containing the original and new primitive types.

TypeChange(DataType, DataType) - Constructor for class io.delta.kernel.types.TypeChange

U

UnknownConfigurationException - Exception in io.delta.kernel.exceptions

Thrown when an unknown configuration key is specified.

UnknownConfigurationException(String) - Constructor for exception io.delta.kernel.exceptions.UnknownConfigurationException

UnsupportedProtocolVersionException - Exception in io.delta.kernel.exceptions

Exception thrown when Kernel encounters unsupported protocol versions.

UnsupportedProtocolVersionException(String, int, UnsupportedProtocolVersionException.ProtocolVersionType) - Constructor for exception io.delta.kernel.exceptions.UnsupportedProtocolVersionException

UnsupportedProtocolVersionException.ProtocolVersionType - Enum Class in io.delta.kernel.exceptions

Enum representing the type of Delta protocol version.

UnsupportedTableFeatureException - Exception in io.delta.kernel.exceptions

Base exception thrown when Kernel encounters unsupported table features.

UnsupportedTableFeatureException(String, String, String) - Constructor for exception io.delta.kernel.exceptions.UnsupportedTableFeatureException

UnsupportedTableFeatureException(String, Set<String>, String) - Constructor for exception io.delta.kernel.exceptions.UnsupportedTableFeatureException

UpdateTableTransactionBuilder - Interface in io.delta.kernel.transaction

Builds a Transaction to update an existing Delta table.

USER_DEFAULT - Static variable in class io.delta.kernel.types.DecimalType

V

VALID_ALGORITHMS - Static variable in class io.delta.kernel.types.GeographyType

valueOf(String) - Static method in enum class io.delta.kernel.commit.CommitMetadata.CommitType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.delta.kernel.exceptions.UnsupportedProtocolVersionException.ProtocolVersionType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.delta.kernel.hook.PostCommitHook.PostCommitHookType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.delta.kernel.Operation

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.delta.kernel.Snapshot.ChecksumWriteMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.delta.kernel.types.MetadataColumnSpec

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.delta.kernel.utils.CloseableIterator.BreakableFilterResult

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.delta.kernel.commit.CommitMetadata.CommitType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.delta.kernel.exceptions.UnsupportedProtocolVersionException.ProtocolVersionType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.delta.kernel.hook.PostCommitHook.PostCommitHookType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.delta.kernel.Operation

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.delta.kernel.Snapshot.ChecksumWriteMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.delta.kernel.types.MetadataColumnSpec

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.delta.kernel.utils.CloseableIterator.BreakableFilterResult

Returns an array containing the constants of this enum class, in the order they are declared.

VARIANT - Static variable in class io.delta.kernel.types.VariantType

VariantType - Class in io.delta.kernel.types

A logical variant type.

W

withClusteringColumns(Engine, List<Column>) - Method in interface io.delta.kernel.TransactionBuilder

Set the list of clustering columns when create a new clustered table.

withClusteringColumns(List<Column>) - Method in interface io.delta.kernel.transaction.UpdateTableTransactionBuilder

Update the clustering columns for the table and enable clustering if it is not already enabled.

withCommitter(Committer) - Method in interface io.delta.kernel.SnapshotBuilder

Provides a custom committer to use at transaction commit time.

withCommitter(Committer) - Method in interface io.delta.kernel.transaction.CreateTableTransactionBuilder

Provides a custom committer to use at transaction commit time.

withCommitterProperties(Supplier<Map<String, String>>) - Method in interface io.delta.kernel.Transaction

Adds custom properties that will be passed through to the committer.

withDataLayoutSpec(DataLayoutSpec) - Method in interface io.delta.kernel.transaction.CreateTableTransactionBuilder

Set the data layout specification for the new Delta table.

withDataLayoutSpec(DataLayoutSpec) - Method in interface io.delta.kernel.transaction.ReplaceTableTransactionBuilder

Set the data layout specification for the new table definition.

withDataType(DataType) - Method in class io.delta.kernel.types.StructField

Creates a copy of this StructField with the specified data type.

withDeletedColumnAt(int) - Method in interface io.delta.kernel.data.ColumnarBatch

Return a copy of this ColumnarBatch with the column at given ordinal removed.

withDomainMetadataSupported() - Method in interface io.delta.kernel.TransactionBuilder

Enables support for Domain Metadata on this table if it is not supported already.

withEndBoundary(CommitRangeBuilder.CommitBoundary) - Method in interface io.delta.kernel.CommitRangeBuilder

Configures the builder to end the commit range at a specific version or timestamp.

withFilter(Predicate) - Method in interface io.delta.kernel.ScanBuilder

Apply the given filter expression to prune any files that do not possibly contain the data that satisfies the given filter.

withLogCompactionInterval(int) - Method in interface io.delta.kernel.transaction.UpdateTableTransactionBuilder

Set the log compaction interval for optimizing the transaction log.

withLogCompactionInverval(int) - Method in interface io.delta.kernel.TransactionBuilder

Set the number of commits between log compactions.

withLogData(List<ParsedLogData>) - Method in interface io.delta.kernel.CommitRangeBuilder

Provides parsed log data to optimize the commit range construction.

withLogData(List<ParsedLogData>) - Method in interface io.delta.kernel.SnapshotBuilder

Provides parsed log data to optimize table resolution.

withMaxCatalogVersion(long) - Method in interface io.delta.kernel.CommitRangeBuilder

Specifies the maximum table version known by the catalog.

withMaxCatalogVersion(long) - Method in interface io.delta.kernel.SnapshotBuilder

Specifies the maximum table version known by the catalog.

withMaxRetries(int) - Method in interface io.delta.kernel.transaction.CreateTableTransactionBuilder

Set the maximum number of retries to retry the commit in the case of a retryable error.

withMaxRetries(int) - Method in interface io.delta.kernel.transaction.ReplaceTableTransactionBuilder

Set the maximum number of retries to retry the commit in the case of a retryable error.

withMaxRetries(int) - Method in interface io.delta.kernel.transaction.UpdateTableTransactionBuilder

Set the maximum number of retries for handling concurrent write conflicts.

withMaxRetries(int) - Method in interface io.delta.kernel.TransactionBuilder

Set the maximum number of times to retry a transaction if a concurrent write is detected.

withNewColumn(int, StructField, ColumnVector) - Method in interface io.delta.kernel.data.ColumnarBatch

Return a copy of the ColumnarBatch with given new column vector inserted at the given columnVector at given ordinal.

withNewMetadata(FieldMetadata) - Method in class io.delta.kernel.types.StructField

withNewSchema(StructType) - Method in interface io.delta.kernel.data.ColumnarBatch

Generate a copy of this ColumnarBatch with the given newSchema.

withoutTightBounds() - Method in class io.delta.kernel.statistics.DataFileStatistics

Returns a new DataFileStatistics instance with tightBounds set to false.

withPartitionColumns(Engine, List<String>) - Method in interface io.delta.kernel.TransactionBuilder

Set the list of partitions columns when create a new partitioned table.

withProtocolAndMetadata(Protocol, Metadata) - Method in interface io.delta.kernel.SnapshotBuilder

Provides protocol and metadata information to optimize table resolution.

withReadSchema(StructType) - Method in interface io.delta.kernel.ScanBuilder

Apply the given readSchema.

withSchema(Engine, StructType) - Method in interface io.delta.kernel.TransactionBuilder

Set the schema of the table.

withTableProperties(Engine, Map<String, String>) - Method in interface io.delta.kernel.TransactionBuilder

Set the table properties for the table.

withTableProperties(Map<String, String>) - Method in interface io.delta.kernel.transaction.CreateTableTransactionBuilder

Set table properties for the new Delta table.

withTableProperties(Map<String, String>) - Method in interface io.delta.kernel.transaction.ReplaceTableTransactionBuilder

Set table properties for the new table definition.

withTablePropertiesAdded(Map<String, String>) - Method in interface io.delta.kernel.transaction.UpdateTableTransactionBuilder

Add or update table properties (configuration).

withTablePropertiesRemoved(Set<String>) - Method in interface io.delta.kernel.transaction.UpdateTableTransactionBuilder

Remove table properties from the table configuration.

withTablePropertiesRemoved(Set<String>) - Method in interface io.delta.kernel.TransactionBuilder

Unset the provided table properties on the table.

withTransactionId(Engine, String, long) - Method in interface io.delta.kernel.TransactionBuilder

Set the transaction identifier for idempotent writes.

withTransactionId(String, long) - Method in interface io.delta.kernel.transaction.UpdateTableTransactionBuilder

Set a transaction identifier for idempotent operations.

withTypeChanges(List<TypeChange>) - Method in class io.delta.kernel.types.StructField

Creates a copy of this StructField with the specified type changes.

withUpdatedSchema(StructType) - Method in interface io.delta.kernel.transaction.UpdateTableTransactionBuilder

Set a new schema for the table, enabling schema evolution.

WRITE - Enum constant in enum class io.delta.kernel.Operation

Recorded during batch inserts.

writeCheckpoint(Engine) - Method in interface io.delta.kernel.Snapshot

Writes a checkpoint for the current snapshot.

writeChecksum(Engine, Snapshot.ChecksumWriteMode) - Method in interface io.delta.kernel.Snapshot

Writes a checksum file for this snapshot using the specified mode: SIMPLE: Uses pre-computed CRC information already loaded in memory.

writeJsonFileAtomically(String, CloseableIterator<Row>, boolean) - Method in interface io.delta.kernel.engine.JsonHandler

Serialize each Row in the iterator as JSON and write as a separate line in destination file.

writeParquetFileAtomically(String, CloseableIterator<FilteredColumnarBatch>) - Method in interface io.delta.kernel.engine.ParquetHandler

Write the given data as a Parquet file.

writeParquetFiles(String, CloseableIterator<FilteredColumnarBatch>, List<Column>) - Method in interface io.delta.kernel.engine.ParquetHandler

Write the given data batches to a Parquet files.

WRITER - Enum constant in enum class io.delta.kernel.exceptions.UnsupportedProtocolVersionException.ProtocolVersionType

Writer protocol version

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form