Struct mz_coord::catalog::CatalogEntry

pub struct CatalogEntry {
    item: CatalogItem,
    used_by: Vec<GlobalId>,
    id: GlobalId,
    oid: u32,
    name: QualifiedObjectName,
}

Fields

item: CatalogItem

used_by: Vec<GlobalId>

id: GlobalId

oid: u32

name: QualifiedObjectName

Implementations

impl CatalogEntry

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

Reports the description of the datums produced by this catalog item.

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

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, SqlCatalogError>

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

Returns the mz_storage::client::sources::SourceDesc associated with this CatalogEntry.

pub fn is_table(&self) -> bool

Reports whether this catalog entry is a table.

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

Collects the identifiers of the dataflows that this dataflow depends upon.

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) -> &QualifiedObjectName

Returns the fully qualified name of this catalog entry.

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

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

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

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

Trait Implementations

impl CatalogItem for CatalogEntry

fn name(&self) -> &QualifiedObjectName

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: &FullObjectName
) -> Result<Cow<'_, RelationDesc>, SqlCatalogError>

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

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

Returns the resolved function.

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

Returns the resolved source connection.

fn connection(&self) -> Result<&Connection, 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 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 uses(&self) -> &[GlobalId]

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

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

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

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

Formats the value using the given formatter.