Struct StaticTable

pub struct StaticTable(/* private fields */);

StaticTable is a read-only table struct that can be created from a metadata file or from TableMetaData without a catalog. It can only be used to read metadata and for table scan.

Examples

let metadata_file_location = "s3://bucket_name/path/to/metadata.json";
let file_io = FileIO::from_path(&metadata_file_location)
    .unwrap()
    .build()
    .unwrap();
let static_identifier = TableIdent::from_strs(["static_ns", "static_table"]).unwrap();
let static_table =
    StaticTable::from_metadata_file(&metadata_file_location, static_identifier, file_io)
        .await
        .unwrap();
let snapshot_id = static_table
    .metadata()
    .current_snapshot()
    .unwrap()
    .snapshot_id();

Implementations

impl StaticTable

pub async fn from_metadata( metadata: TableMetadata, table_ident: TableIdent, file_io: FileIO, ) -> Result<Self>

Creates a static table from a given TableMetadata and FileIO

pub async fn from_metadata_file( metadata_location: &str, table_ident: TableIdent, file_io: FileIO, ) -> Result<Self>

Creates a static table directly from metadata file and FileIO

pub fn scan(&self) -> TableScanBuilder<'_>

Create a TableScanBuilder for the static table.

pub fn metadata(&self) -> TableMetadataRef

Get TableMetadataRef for the static table

pub fn into_table(self) -> Table

Consumes the StaticTable and return it as a Table Please use this method carefully as the Table it returns remains detached from a catalog and can’t be used to perform modifications on the table.

pub fn reader_builder(&self) -> ArrowReaderBuilder

Create a reader for the table.

Trait Implementations

impl Clone for StaticTable

fn clone(&self) -> StaticTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StaticTable

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

Formats the value using the given formatter.