Struct mz_catalog::memory::objects::CatalogCollectionEntry

pub struct CatalogCollectionEntry {
    entry: CatalogEntry,
    version: RelationVersionSelector,
}

A CatalogEntry that is associated with a specific “collection” of data. A single item in the catalog may be associated with multiple “collections”.

Here “collection” generally means a pTVC, e.g. a Persist Shard, an Index, a currently running dataflow, etc.

Items in the Catalog have a stable name -> ID mapping, in other words for the entire lifetime of an object its CatalogItemId will never change. Similarly, we need to maintain a stable mapping from GlobalId to pTVC. This presents a challenge when ALTER-ing an object, e.g. adding columns to a table. We can’t just change the schema of the underlying Persist Shard because that would be rebinding the GlobalId of the pTVC. Instead we allocate a new GlobalId to refer to the new version of the table, and then the CatalogEntry tracks the GlobalId for each version.

TODO(ct): Add a note here if we end up using this for associating continual tasks with a single catalog item.

Fields

entry: CatalogEntry

version: RelationVersionSelector

Trait Implementations

impl CatalogCollectionItem for CatalogCollectionEntry

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

Returns a description of the result set produced by the catalog item.

fn global_id(&self) -> GlobalId

The GlobalId for this item.

impl CatalogItem for CatalogCollectionEntry

fn name(&self) -> &QualifiedItemName

Returns the fully qualified name of the catalog item.

fn id(&self) -> CatalogItemId

Returns the CatalogItemId for the item.

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

Returns the GlobalIds associated with this item.

fn oid(&self) -> u32

Returns the catalog item’s OID.

fn func(&self) -> Result<&'static Func, SqlCatalogError>

Returns the resolved function.

fn source_desc( &self, ) -> Result<Option<&SourceDesc<ReferencedConnection>>, SqlCatalogError>

Returns the resolved source connection.

fn connection( &self, ) -> Result<Connection<ReferencedConnection>, SqlCatalogError>

Returns the resolved connection.

fn create_sql(&self) -> &str

A normalized SQL statement that describes how to create the catalog item.

fn item_type(&self) -> SqlCatalogItemType

Returns the type of the catalog item.

fn index_details(&self) -> Option<(&[MirScalarExpr], GlobalId)>

Returns the index details associated with the catalog item, if the catalog item is an index.

fn writable_table_details(&self) -> Option<&[Expr<Aug>]>

Returns the column defaults associated with the catalog item, if the catalog item is a table that accepts writes.

fn type_details(&self) -> Option<&CatalogTypeDetails<IdReference>>

Returns the type information associated with the catalog item, if the catalog item is a type.

fn references(&self) -> &ResolvedIds

Returns the IDs of the catalog items upon which this catalog item directly references.

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

Returns the IDs of the catalog items upon which this catalog item depends.

fn referenced_by(&self) -> &[CatalogItemId]

Returns the IDs of the catalog items that directly reference this catalog item.

fn used_by(&self) -> &[CatalogItemId]

Returns the IDs of the catalog items that depend upon this catalog item.

fn subsource_details( &self, ) -> Option<(CatalogItemId, &UnresolvedItemName, &SourceExportDetails)>

Reports whether this catalog entry is a subsource and, if it is, the ingestion it is an export of, as well as the item it exports.

fn source_export_details( &self, ) -> Option<(CatalogItemId, &UnresolvedItemName, &SourceExportDetails, &SourceExportDataConfig<ReferencedConnection>)>

Reports whether this catalog entry is a source export and, if it is, the ingestion it is an export of, as well as the item it exports.

fn is_progress_source(&self) -> bool

Reports whether this catalog item is a progress source.

fn progress_id(&self) -> Option<CatalogItemId>

If this catalog item is a source, it return the IDs of its progress collection.

fn owner_id(&self) -> RoleId

Returns the ID of the owning role.

fn privileges(&self) -> &PrivilegeMap

Returns the privileges associated with the item.

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

Returns the cluster the item belongs to.

fn at_version( &self, version: RelationVersionSelector, ) -> Box<dyn CatalogCollectionItem>

Returns the CatalogCollectionItem for a specific version of this CatalogItem.

impl Clone for CatalogCollectionEntry

fn clone(&self) -> CatalogCollectionEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogCollectionEntry

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

Formats the value using the given formatter.