Struct mz_adapter::catalog::CatalogEntry

pub struct CatalogEntry {
    pub item: CatalogItem,
    pub referenced_by: Vec<GlobalId>,
    pub used_by: Vec<GlobalId>,
    pub id: GlobalId,
    pub oid: u32,
    pub name: QualifiedItemName,
    pub owner_id: RoleId,
    pub privileges: PrivilegeMap,
}

Fields

item: CatalogItem

referenced_by: Vec<GlobalId>

used_by: Vec<GlobalId>

id: GlobalId

oid: u32

name: QualifiedItemName

owner_id: RoleId

privileges: PrivilegeMap

Implementations

impl CatalogEntry

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

Like CatalogEntry::desc_opt, but returns an error if the catalog entry is not of a type that has a description.

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

Reports the description of the rows produced by this catalog entry, if this catalog entry produces rows.

pub fn has_columns(&self) -> bool

Reports if the item has columns.

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

Returns the mz_sql::func::Func associated with this CatalogEntry.

pub fn index(&self) -> Option<&Index>

Returns the inner Index if this entry is an index, else None.

pub fn source(&self) -> Option<&Source>

Returns the inner Source if this entry is a source, else None.

pub fn sink(&self) -> Option<&Sink>

Returns the inner Sink if this entry is a sink, else None.

pub fn secret(&self) -> Option<&Secret>

Returns the inner Secret if this entry is a secret, else None.

pub fn connection(&self) -> Result<&Connection, CatalogError>

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

Returns the mz_storage_types::sources::SourceDesc associated with this CatalogEntry, if any.

pub fn is_connection(&self) -> bool

Reports whether this catalog entry is a connection.

pub fn is_table(&self) -> bool

Reports whether this catalog entry is a table.

pub fn is_source(&self) -> bool

Reports whether this catalog entry is a source. Note that this includes subsources.

pub fn is_subsource(&self) -> bool

Reports whether this catalog entry is a subsource.

pub fn is_progress_source(&self) -> bool

Reports whether this catalog entry is a progress source.

pub fn subsources(&self) -> BTreeSet<GlobalId>

Returns the GlobalId of all of this entry’s subsources.

pub fn progress_id(&self) -> Option<GlobalId>

Returns the GlobalId of all of this entry’s progress ID.

pub fn is_sink(&self) -> bool

Reports whether this catalog entry is a sink.

pub fn is_materialized_view(&self) -> bool

Reports whether this catalog entry is a materialized view.

pub fn is_view(&self) -> bool

Reports whether this catalog entry is a view.

pub fn is_secret(&self) -> bool

Reports whether this catalog entry is a secret.

pub fn is_introspection_source(&self) -> bool

Reports whether this catalog entry is an introspection source.

pub fn is_index(&self) -> bool

Reports whether this catalog entry is an index.

pub fn is_relation(&self) -> bool

Reports whether this catalog entry can be treated as a relation, it can produce rows.

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<GlobalId>

Collects the identifiers of the objects used by this CatalogEntry.

Like CatalogEntry::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 item(&self) -> &CatalogItem

Returns the CatalogItem associated with this catalog entry.

pub fn id(&self) -> GlobalId

Returns the global ID of this catalog entry.

pub fn oid(&self) -> u32

Returns the OID of this catalog entry.

pub fn name(&self) -> &QualifiedItemName

Returns the fully qualified name of this catalog entry.

pub fn referenced_by(&self) -> &[GlobalId]

Returns the identifiers of the dataflows that are directly referenced by this dataflow.

pub fn used_by(&self) -> &[GlobalId]

Returns the identifiers of the dataflows that depend upon this dataflow.

pub fn conn_id(&self) -> Option<&IdHandle<u32>>

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

pub fn owner_id(&self) -> &RoleId

Returns the role ID of the entry owner.

pub fn privileges(&self) -> &PrivilegeMap

Returns the privileges of the entry.

Trait Implementations

impl CatalogItem for CatalogEntry

fn name(&self) -> &QualifiedItemName

Returns the fully qualified name of the catalog item.

fn id(&self) -> GlobalId

Returns a stable ID for the catalog item.

fn oid(&self) -> u32

Returns the catalog item’s OID.

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

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

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

Returns the resolved function.

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

Returns the resolved source connection.

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

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) -> CatalogItemType

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 table_details(&self) -> Option<&[Expr<Aug>]>

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

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<GlobalId>

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

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

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

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

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

fn is_subsource(&self) -> bool

Reports whether this catalog item is a subsource.

fn is_progress_source(&self) -> bool

Reports whether this catalog item is a progress source.

fn subsources(&self) -> BTreeSet<GlobalId>

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

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

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<StorageInstanceId>

Returns the cluster the item belongs to.

impl Clone for CatalogEntry

fn clone(&self) -> CatalogEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogEntry

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

Formats the value using the given formatter.

impl Serialize for CatalogEntry

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

Serialize this value into the given Serde serializer.