Struct mz_storage_types::sources::SourceReferenceResolver

pub struct SourceReferenceResolver {
    inner: BTreeMap<Ident, BTreeMap<Ident, BTreeMap<Ident, usize>>>,
}

Stores and resolves references to a &[T: ExternalCatalogReference].

This is meant to provide an API to quickly look up a source’s subsources.

For sources that do not provide any subsources, use the Default implementation, which is empty and will not be able to resolve any references.

Fields

inner: BTreeMap<Ident, BTreeMap<Ident, BTreeMap<Ident, usize>>>

Implementations

impl<'a> SourceReferenceResolver

pub fn new<T: ExternalCatalogReference>( database: &str, referenceable_items: &'a [T], ) -> Result<SourceReferenceResolver, ExternalReferenceResolutionError>

Constructs a new SourceReferenceResolver from a slice of T: SubsourceCatalogReference.

Errors

• If any &str provided cannot be taken to an Ident.

pub fn resolve( &self, name: &[Ident], canonicalize_to_width: usize, ) -> Result<(UnresolvedItemName, usize), ExternalReferenceResolutionError>

Returns the canonical reference and index from which it originated in the referenceable_items provided to Self::new.

Args

• name is &[Ident] to let users provide the inner element of UnresolvedItemName.
• canonicalize_to_width limits the number of elements in the returned UnresolvedItemName;this is useful if the source type requires contriving database and schema names that a subsource should not persist as its reference.

Errors

• If name does not resolve to an item in self.inner.

Panics

• If canonicalize_to_width`` is not in 1..=3`.

pub fn resolve_idx( &self, name: &[Ident], ) -> Result<usize, ExternalReferenceResolutionError>

Returns the index from which it originated in the referenceable_items provided to Self::new.

Args

name is &[Ident] to let users provide the inner element of UnresolvedItemName.

Errors

• If name does not resolve to an item in self.inner.

fn resolve_inner<'name: 'a>( &'a self, name: &'name [Ident], ) -> Result<(&'a Ident, &'a Ident, usize), ExternalReferenceResolutionError>

Returns the index from which it originated in the referenceable_items provided to Self::new.

Args

name is &[Ident] to let users provide the inner element of UnresolvedItemName.

Return

Returns a tuple whose elements are:

1. The “database”- or top-level namespace of the reference.
2. The “schema”- or second-level namespace of the reference.
3. The index to find the item in referenceable_items argument provided to SourceReferenceResolver::new.

Errors

• If name does not resolve to an item in self.inner.

Trait Implementations

impl Clone for SourceReferenceResolver

fn clone(&self) -> SourceReferenceResolver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceReferenceResolver

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

Formats the value using the given formatter.

impl Default for SourceReferenceResolver

fn default() -> SourceReferenceResolver

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceReferenceResolver

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SourceReferenceResolver

fn eq(&self, other: &SourceReferenceResolver) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SourceReferenceResolver

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SourceReferenceResolver

impl StructuralPartialEq for SourceReferenceResolver