Struct mz_catalog :: memory :: objects :: CatalogEntry Copy item path

impl CatalogEntry

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

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, 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 materialized_view(&self) -> Option<&MaterializedView>

Returns the inner MaterializedView if this entry is a materialized view, else None.

pub fn table(&self) -> Option<&Table>

Returns the inner Table if this entry is a table, 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<Option<&SourceDesc<ReferencedConnection>>, SqlCatalogError>

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

pub 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.

pub fn is_progress_source(&self) -> bool

Reports whether this catalog entry is a progress source.

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

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_continual_task(&self) -> bool

Reports whether this catalog entry is a continual task.

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

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

Returns the CatalogItemId of this catalog entry.

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

Returns all of the GlobalIds associated with this item.

pub fn latest_global_id(&self) -> GlobalId

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) -> &[CatalogItemId]

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

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

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

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

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) -> 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. Read more

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

Returns the resolved source connection. Read more

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

Returns the resolved connection. Read more

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 CatalogEntry

fn clone(&self) -> CatalogEntry

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for CatalogEntry

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

Formats the value using the given formatter. Read more

impl From<CatalogEntry> for Item

fn from(entry: CatalogEntry) -> Item

Converts to this type from the input type.

impl From<CatalogEntry> for TemporaryItem

fn from(entry: CatalogEntry) -> Self

Converts to this type from the input type.

impl Serialize for CatalogEntry

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl !UnwindSafe for CatalogEntry

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsAny for T
where T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, U> CastInto for T
where U: CastFrom<T>,

fn cast_into(self) -> U

Performs the cast.

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T, U> OverrideFrom<Option<&T>> for U
where U: OverrideFrom<T>,

fn override_from(self, layer: &Option<&T>) -> U

Override the configuration represented by Self with values from the given layer.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ProgressEventTimestamp for T
where T: Data + Debug + Any,

fn as_any(&self) -> &(dyn Any + 'static)

Upcasts this ProgressEventTimestamp to Any. Read more

fn type_name(&self) -> &'static str

Returns the name of the concrete type of this object. Read more

impl<P, R> ProtoType<R> for P
where R: RustType,

fn into_rust(self) -> Result<R, TryFromProtoError>

See RustType::from_proto.

fn from_rust(rust: &R) -> P

See RustType::into_proto.

impl<T> Same for T

type Output = T

Should always be Self

impl<'a, S, T> Semigroup<&'a S> for T
where T: Semigroup<S>,

fn plus_equals(&mut self, rhs: &&'a S)

The method of std::ops::AddAssign, for types that do not implement AddAssign.

impl<T> Serialize for T
where T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more