Struct Table

pub struct Table {
    pub create_sql: Option<String>,
    pub desc: VersionedRelationDesc,
    pub collections: BTreeMap<RelationVersion, GlobalId>,
    pub conn_id: Option<ConnectionId>,
    pub resolved_ids: ResolvedIds,
    pub custom_logical_compaction_window: Option<CompactionWindow>,
    pub is_retained_metrics_object: bool,
    pub data_source: TableDataSource,
}

Fields

create_sql: Option<String>

Parse-able SQL that defines this table.

desc: VersionedRelationDesc

VersionedRelationDesc of this table, derived from the create_sql.

collections: BTreeMap<RelationVersion, GlobalId>

Versions of this table, and the GlobalIds that refer to them.

conn_id: Option<ConnectionId>

If created in the TEMPORARY schema, the ConnectionId for that session.

resolved_ids: ResolvedIds

Other catalog objects referenced by this table, e.g. custom types.

custom_logical_compaction_window: Option<CompactionWindow>

Custom compaction window, e.g. set via ALTER RETAIN HISTORY.

is_retained_metrics_object: bool

Whether the table’s logical compaction window is controlled by the ‘metrics_retention’ session variable.

data_source: TableDataSource

Where data for this table comes from, e.g. INSERT statements or an upstream source.

Implementations

impl Table

pub fn timeline(&self) -> Timeline

pub fn global_ids(&self) -> impl Iterator<Item = GlobalId> + '_

Returns all of the GlobalIds that this Table can be referenced by.

pub fn global_id_writes(&self) -> GlobalId

Returns the latest GlobalId for this Table which should be used for writes.

pub fn collection_descs( &self, ) -> impl Iterator<Item = (GlobalId, RelationVersion, RelationDesc)> + '_

Returns all of the collections and their RelationDescs associated with this Table.

pub fn desc_for(&self, id: &GlobalId) -> RelationDesc

Returns the RelationDesc for a specific GlobalId.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Serialize for Table

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.