Skip to main content

Crate ducklake

Crate ducklake 

Source

Macros§

set_end_snapshot
Sets end_snapshot to the current snapshot ID for rows matching the given conditions. This marks records as “deleted” (soft delete) for snapshot-based versioning.

Structs§

AuthorInfo
Information about the author of a transaction. The fields are attached to the snapshot created when the transaction is committed.
Column
A column in a table schema.
ColumnName
Path to a column in a table, consisting of a top-level column name and zero or more nested component names.
ConnectOptions
Options for connecting to an existing DuckLake instance.
CreateOptions
Options for creating a new DuckLake instance.
DataFilePathGenerator
Generator for paths of new data files within a table’s data directory.
DataFileStatistics
Statistics describing the contents of a data file.
Ducklake
Client for interacting with a DuckLake.
FileColumnStats
Statistics describing a single column within a data file.
Interval
A calendar interval composed of a number of months and a sub-month time delta.
PartitionColumn
A column used to partition a table along with the transform applied to its values.
ScanDataFile
A data file that needs to be read as part of a ScanResult.
ScanDeleteFile
A delete file that needs to be applied to a data file.
ScanResult
Result of scanning a table at a specific snapshot.
SnapshotMetadata
Metadata for a snapshot in the catalog.
Table
Handle to a table in the DuckLake catalog.
TableMetadata
Resolved metadata configuration for a single table, combining global, schema-level, and table-level metadata overrides.
TableName
Fully-qualified name of a table, consisting of a schema and a table name.
Tag
A key-value tag attached to a table or column.
TimeWithTimezone
A wall-clock time with an associated UTC offset.
Transaction
Transaction to make changes to the DuckLake.
TransactionTable
Handle to a table within an active transaction.
WriteDataFile
Description of a data file that should be committed to a table.

Enums§

ColumnDefault
The default value of a column.
DataType
A DuckLake data type.
DucklakeError
Error type returned by all fallible DuckLake operations.
PartitionTransform
A transform applied to a column’s values to derive partition values.
TimestampPrecision
The precision of a DataType::Timestamp value.
Value
A typed DuckLake value.

Traits§

IntoColumnName
Convenience trait alias for any type that can be converted into a ColumnName.

Type Aliases§

DucklakeResult
Result type returned by all fallible DuckLake operations.