Enum mz_catalog::memory::objects::CatalogItem

pub enum CatalogItem {
    Table(Table),
    Source(Source),
    Log(Log),
    View(View),
    MaterializedView(MaterializedView),
    Sink(Sink),
    Index(Index),
    Type(Type),
    Func(Func),
    Secret(Secret),
    Connection(Connection),
    ContinualTask(ContinualTask),
}

Variants

Table(Table)

Source(Source)

Log(Log)

View(View)

MaterializedView(MaterializedView)

Sink(Sink)

Index(Index)

Type(Type)

Func(Func)

Secret(Secret)

Connection(Connection)

ContinualTask(ContinualTask)

Implementations

impl CatalogItem

pub fn typ(&self) -> CatalogItemType

Returns a string indicating the type of this catalog entry.

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

Returns the GlobalIds that reference this item, if any.

pub fn latest_global_id(&self) -> GlobalId

Returns the most up-to-date GlobalId for this item.

Note: The only type of object that can have multiple GlobalIds are tables.

pub fn is_storage_collection(&self) -> bool

Whether this item represents a storage collection.

pub fn desc( &self, name: &FullItemName, ) -> Result<Cow<'_, RelationDesc>, SqlCatalogError>

pub fn desc_opt(&self) -> Option<Cow<'_, RelationDesc>>

pub fn func( &self, entry: &CatalogEntry, ) -> Result<&'static Func, SqlCatalogError>

pub fn source_desc( &self, entry: &CatalogEntry, ) -> Result<Option<&SourceDesc<ReferencedConnection>>, SqlCatalogError>

pub fn is_progress_source(&self) -> bool

Reports whether this catalog entry is a progress source.

pub fn references(&self) -> &ResolvedIds

Collects the identifiers of the objects that were encountered when resolving names in the item’s DDL statement.

pub fn uses(&self) -> BTreeSet<CatalogItemId>

Collects the identifiers of the objects used by this CatalogItem.

Like CatalogItem::references() but also includes objects that are not directly referenced. For example this will include any catalog objects used to implement functions and casts in the item.

pub fn conn_id(&self) -> Option<&ConnectionId>

Returns the connection ID that this item belongs to, if this item is temporary.

pub fn is_temporary(&self) -> bool

Indicates whether this item is temporary or not.

pub fn rename_schema_refs( &self, database_name: &str, cur_schema_name: &str, new_schema_name: &str, ) -> Result<CatalogItem, (String, String)>

pub fn rename_item_refs( &self, from: FullItemName, to_item_name: String, rename_self: bool, ) -> Result<CatalogItem, String>

Returns a clone of self with all instances of from renamed to to (with the option of including the item’s own name) or errors if request is ambiguous.

pub fn update_retain_history( &mut self, value: Option<Value>, window: CompactionWindow, ) -> Result<Option<WithOptionValue<Raw>>, ()>

Updates the retain history for an item. Returns the previous retain history value. Returns an error if this item does not support retain history.

pub fn update_sql<F, T>(&mut self, f: F) -> Result<T, ()>

where F: FnOnce(&mut Statement<Raw>) -> Result<T, ()>,

Updates the create_sql field of this item. Returns an error if this is a builtin item, otherwise returns f’s result.

pub fn is_compute_object_on_cluster(&self) -> Option<ClusterId>

If the object is considered a “compute object” (i.e., it is managed by the compute controller), this function returns its cluster ID. Otherwise, it returns nothing.

This function differs from cluster_id because while all compute objects run on a cluster, the converse is not true.

pub fn cluster_id(&self) -> Option<ClusterId>

pub fn custom_logical_compaction_window(&self) -> Option<CompactionWindow>

The custom compaction window, if any has been set. This does not reflect any propagated compaction window (i.e., source -> subsource).

pub fn custom_logical_compaction_window_mut( &mut self, ) -> Option<&mut Option<CompactionWindow>>

Mutable access to the custom compaction window, or None if this type does not support custom compaction windows. This does not reflect any propagated compaction window (i.e., source -> subsource).

pub fn initial_logical_compaction_window(&self) -> Option<CompactionWindow>

The initial compaction window, for objects that have one; that is, tables, sources, indexes, and MVs. This does not reflect any propagated compaction window (i.e., source -> subsource).

If custom_logical_compaction_window() returns something, use that. Otherwise, use a sensible default (currently 1s).

For objects that do not have the concept of compaction window, return None.

pub fn is_retained_metrics_object(&self) -> bool

Whether the item’s logical compaction window is controlled by the METRICS_RETENTION system var.

pub fn to_serialized( &self, ) -> (String, GlobalId, BTreeMap<RelationVersion, GlobalId>)

pub fn into_serialized( self, ) -> (String, GlobalId, BTreeMap<RelationVersion, GlobalId>)

Trait Implementations

impl Clone for CatalogItem

fn clone(&self) -> CatalogItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogItem

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

Formats the value using the given formatter.

impl Serialize for CatalogItem

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

where __S: Serializer,

Serialize this value into the given Serde serializer.