Struct TableConfiguration 

pub struct TableConfiguration { /* private fields */ }

Available on crate feature internal-api only.

Holds all the configuration for a table at a specific version. This includes the supported reader and writer features, table properties, schema, version, and table root. This can be used to check whether a table supports a feature or has it enabled. For example, deletion vector support can be checked with TableConfiguration::is_deletion_vector_supported and deletion vector write enablement can be checked with TableConfiguration::is_deletion_vector_enabled.

TableConfiguration performs checks upon construction with TableConfiguration::try_new to validate that Metadata and Protocol are correctly formatted and mutually compatible. If try_new successfully returns TableConfiguration, it is also guaranteed that reading the table is supported.

Implementations

impl TableConfiguration

pub fn try_new( metadata: Metadata, protocol: Protocol, table_root: Url, version: Version, ) -> DeltaResult<Self>

Constructs a TableConfiguration for a table located in table_root at version. This validates that the Metadata and Protocol are compatible with one another and that the kernel supports reading from this table.

Note: This only returns successfully if kernel supports reading the table. It’s important to do this validation in try_new because all table accesses must first construct the TableConfiguration. This ensures that developers never forget to check that kernel supports reading the table, and that all table accesses are legal.

Note: In the future, we will perform stricter checks on the set of reader and writer features. In particular, we will check that: - Non-legacy features must appear in both reader features and writer features lists. If such a feature is present, the reader version and writer version must be 3, and 5 respectively. - Legacy reader features occur when the reader version is 3, but the writer version is either 5 or 6. In this case, the writer feature list must be empty. - Column mapping is the only legacy feature present in kernel. No future delta versions will introduce new legacy features. See: https://github.com/delta-io/delta-kernel-rs/issues/650

pub fn metadata(&self) -> &Metadata

The Metadata for this table at this version.

pub fn protocol(&self) -> &Protocol

The Protocol of this table at this version.

pub fn schema(&self) -> SchemaRef

The logical schema (SchemaRef) of this table at this version.

pub fn table_properties(&self) -> &TableProperties

The TableProperties of this table at this version.

pub fn column_mapping_mode(&self) -> ColumnMappingMode

The ColumnMappingMode for this table at this version.

pub fn table_root(&self) -> &Url

The Url of the table this TableConfiguration belongs to

pub fn version(&self) -> Version

The Version which this TableConfiguration belongs to.

pub fn ensure_write_supported(&self) -> DeltaResult<()>

Returns true if the kernel supports writing to this table. This checks that the protocol’s writer features are all supported.

pub fn is_cdf_read_supported(&self) -> bool

Returns true if kernel supports reading Change Data Feed on this table. See the documentation of TableChanges for more details.

pub fn is_deletion_vector_supported(&self) -> bool

Returns true if deletion vectors is supported on this table. To support deletion vectors, a table must support reader version 3, writer version 7, and the deletionVectors feature in both the protocol’s readerFeatures and writerFeatures.

See: https://github.com/delta-io/delta/blob/master/PROTOCOL.md#deletion-vectors

pub fn is_deletion_vector_enabled(&self) -> bool

Returns true if writing deletion vectors is enabled for this table. This is the case when the deletion vectors is supported on this table and the delta.enableDeletionVectors table property is set to true.

See: https://github.com/delta-io/delta/blob/master/PROTOCOL.md#deletion-vectors

Trait Implementations

impl Clone for TableConfiguration

fn clone(&self) -> TableConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TableConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for TableConfiguration

fn eq(&self, other: &TableConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TableConfiguration

impl StructuralPartialEq for TableConfiguration