Skip to main content

CatalogEntryType

Enum CatalogEntryType 

Source
#[non_exhaustive]
pub enum CatalogEntryType { Invalid, Table, View, Index, Schema, PreparedStatement, Sequence, Collation, Type, Database, }
Expand description

Types of entries in the DuckDB catalog.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Invalid

Invalid catalog entry.

§

Table

A table.

§

View

A view.

§

Index

An index.

§

Schema

A schema.

§

PreparedStatement

A prepared statement.

§

Sequence

A sequence.

§

Collation

A collation.

§

Type

A user-defined type.

§

Database

A database.

Implementations§

Source§

impl CatalogEntryType

Source

pub fn may_autoload_extension(self, name: &str) -> bool

Whether a lookup of name as this kind of entry can make DuckDB autoload an extension — see the module docs.

DuckDB lower-cases the name before matching it against its lists, so this does too.

Source

pub const fn is_lookup_supported(self) -> bool

Whether duckdb_catalog_get_entry can look this kind of entry up.

Lookups go through a schema’s catalog sets, which exist only for tables, views, indexes, sequences, collations and types. For Schema, Database, PreparedStatement and Invalid, DuckDB 1.5.5 throws an InternalException (“Unsupported catalog type in schema”) from inside the C API with no try/catch, which aborts the Rust process. CatalogEntry::lookup therefore refuses them. (Type and Collation are supported, but a few of their names are refused too; see may_autoload_extension.)

Trait Implementations§

Source§

impl Clone for CatalogEntryType

Source§

fn clone(&self) -> CatalogEntryType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CatalogEntryType

Source§

impl Debug for CatalogEntryType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CatalogEntryType

Source§

impl PartialEq for CatalogEntryType

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CatalogEntryType

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.