Skip to main content

SchemaManager

Struct SchemaManager 

Source
pub struct SchemaManager;

Implementations§

Source§

impl SchemaManager

Source

pub fn new() -> Self

Source

pub fn bootstrap( &self, conn: &Connection, ) -> Result<BootstrapReport, SchemaError>

Bootstrap the database schema, applying any pending migrations.

§Errors

Returns SchemaError if any migration or metadata-table SQL fails, or SchemaError::VersionMismatch if the database has been migrated to a version newer than this engine supports.

Source

pub fn current_version(&self) -> SchemaVersion

Source

pub fn migrations(&self) -> &'static [Migration]

Source

pub fn initialize_connection( &self, conn: &Connection, ) -> Result<(), SchemaError>

Set the recommended SQLite connection pragmas for fathomdb.

§Errors

Returns SchemaError if any PRAGMA fails to execute.

Source

pub fn initialize_reader_connection( &self, conn: &Connection, ) -> Result<(), SchemaError>

Initialize a read-only connection with PRAGMAs that are safe for readers.

Skips journal_mode (requires write; the writer already set WAL), synchronous (irrelevant for readers), and journal_size_limit (requires write).

§Errors

Returns SchemaError if any PRAGMA fails to execute.

Source

pub fn ensure_vector_profile( &self, _conn: &Connection, _profile: &str, _table_name: &str, _dimension: usize, ) -> Result<(), SchemaError>

§Errors

Always returns SchemaError::MissingCapability when the sqlite-vec feature is not compiled in.

Source

pub fn ensure_vec_kind_profile( &self, _conn: &Connection, _kind: &str, _dimension: usize, ) -> Result<(), SchemaError>

§Errors

Always returns SchemaError::MissingCapability when the sqlite-vec feature is not compiled in.

Trait Implementations§

Source§

impl Clone for SchemaManager

Source§

fn clone(&self) -> SchemaManager

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SchemaManager

Source§

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

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

impl Default for SchemaManager

Source§

fn default() -> SchemaManager

Returns the “default value” for a type. 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> 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> Same for T

Source§

type Output = T

Should always be Self
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.