Skip to main content

Catalog

Struct Catalog 

Source
pub struct Catalog { /* private fields */ }
Expand description

RAII wrapper for a duckdb_catalog.

Automatically destroyed when dropped.

Implementations§

Source§

impl Catalog

Source

pub const fn as_raw(&self) -> duckdb_catalog

Returns the raw handle for use with CatalogEntry::lookup.

Source

pub fn type_name(&self) -> Option<&str>

Returns the type name of this catalog: "duckdb" for every catalog DuckDB provides itself (the database’s, temp and system), or a storage extension’s name like "sqlite".

Returns None if the name is not valid UTF-8.

Source

pub unsafe fn get_entry( &self, context: duckdb_client_context, schema: &CStr, name: &CStr, entry_type: CatalogEntryType, ) -> Result<Option<CatalogEntry>, ExtensionError>

Look up a catalog entry by type, schema, and name.

Returns Ok(None) if no such entry exists.

§Errors

Returns an error, without calling DuckDB, for a lookup that would abort the process; see CatalogEntry::lookup.

§Safety
  • context must be a valid duckdb_client_context.
  • Must be called from within an active transaction context.
  • The database this catalog belongs to must still be attached, and the transaction in which ClientContext::catalog returned it must still be active. A duckdb_catalog is a plain reference to DuckDB’s Catalog (CCatalogWrapper, catalog-c.cpp): after a DETACH, a lookup through it read freed memory and crashed in testing.

Trait Implementations§

Source§

impl Debug for Catalog

Source§

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

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

impl Drop for Catalog

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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