Struct cindy::Database

source ·
pub struct Database<T = Connection>(_);
Expand description

Database wrapper.

Dereferences to a Connection, but provides additional methods.

Implementations§

source§

impl<T: Handle> Database<T>

source

pub fn hash_add(&self, hash: &Hash) -> Result<(), Error>

Add hash to database.

source

pub fn hash_remove(&self, hash: &Hash) -> Result<(), Error>

Remove file hash from database, including all tags.

source

pub fn hash_exists(&self, hash: &Hash) -> Result<bool, Error>

Check if a hash exists.

source

pub fn hash_tags( &self, hash: &Hash, name: Option<&str>, value: Option<&str> ) -> Result<BTreeSet<Tag>, Error>

source

pub fn tag_value_create(&self, tag: &str, value: &str) -> Result<(), Error>

Add tag to database.

source

pub fn tag_list( &self, name: Option<&str>, value: Option<&str> ) -> Result<BTreeMap<Tag, TagValueInfo>, Error>

List tags in database.

source

pub fn tag_name_display(&self, name: &str, display: &str) -> Result<(), Error>

Set a tag name’s display value.

source

pub fn tag_value_display( &self, name: &str, value: &str, display: &str ) -> Result<(), Error>

Set a tag value’s display value. TODO: test and/or move this into tags view?

source

pub fn tag_name_create( &self, name: &str, display: Option<&str> ) -> Result<(), Error>

source

pub fn tag_names(&self) -> Result<BTreeMap<String, TagNameInfo>, Error>

List tag names

source

pub fn tag_name_rename(&self, old: &str, new: &str) -> Result<(), Error>

Rename tag name.

source

pub fn tag_value_rename( &self, name: &str, old: &str, new: &str ) -> Result<(), Error>

Rename tag value.

source

pub fn tag_delete( &self, name: Option<&str>, value: Option<&str> ) -> Result<(), Error>

Delete tags.

source

pub fn hash_tag_add( &self, file: &Hash, tag: &str, value: &str ) -> Result<(), Error>

Add tag to file

source

pub fn hash_tag_remove( &self, file: &Hash, tag: Option<&str>, value: Option<&str> ) -> Result<(), Error>

Remove tag from file

source

pub fn query_hashes( &self, query: &mut dyn Iterator<Item = &TagPredicate<'_>> ) -> Result<BTreeSet<BoxHash>, Error>

source

pub fn query_tag_union( &self, query: &mut dyn Iterator<Item = &TagPredicate<'_>>, name: Option<&str>, value: Option<&str> ) -> Result<BTreeSet<Tag>, Error>

For a given query, compute the union of all tags of all results.

source

pub fn query_tag_intersection( &self, query: &mut dyn Iterator<Item = &TagPredicate<'_>>, name: Option<&str>, value: Option<&str> ) -> Result<BTreeSet<Tag>, Error>

For a given query, compute the intersection of tags of the results.

source

pub fn query_tag_add( &self, query: &mut dyn Iterator<Item = &TagPredicate<'_>>, name: &str, value: &str ) -> Result<(), Error>

For a given query, add a tag to all results.

source

pub fn query_tag_remove( &self, query: &mut dyn Iterator<Item = &TagPredicate<'_>>, name: Option<&str>, value: Option<&str> ) -> Result<(), Error>

For a given query, remove tags from all results.

source

pub fn label_add( &self, file: &Hash, name: &str, value: &str, label: &Label ) -> Result<(), Error>

Add a label to a tagged file.

source

pub fn label_remove( &self, file: &Hash, name: &str, value: &str, label: &Label ) -> Result<(), Error>

Add a label to a tagged file.

source

pub fn label_get( &self, file: Option<&Hash>, name: Option<&str>, value: Option<&str>, kind: Option<LabelKind> ) -> Result<BTreeSet<(Tag, Label)>, Error>

source

pub fn migrate(&self) -> Result<(), Error>

Run migrations on database.

source§

impl Database<Connection>

source

pub fn transaction(&mut self) -> Result<Database<Transaction<'_>>, Error>

source§

impl Database<Transaction<'_>>

source

pub fn commit(self) -> Result<(), Error>

source

pub fn abort(self) -> Result<()>

Methods from Deref<Target = Connection>§

source

pub fn busy_timeout(&self, timeout: Duration) -> Result<(), Error>

Set a busy handler that sleeps for a specified amount of time when a table is locked. The handler will sleep multiple times until at least “ms” milliseconds of sleeping have accumulated.

Calling this routine with an argument equal to zero turns off all busy handlers.

There can only be a single busy handler for a particular database connection at any given moment. If another busy handler was defined (using busy_handler) prior to calling this routine, that other busy handler is cleared.

Newly created connections currently have a default busy timeout of 5000ms, but this may be subject to change.

source

pub fn busy_handler( &self, callback: Option<fn(_: i32) -> bool> ) -> Result<(), Error>

Register a callback to handle SQLITE_BUSY errors.

If the busy callback is None, then SQLITE_BUSY is returned immediately upon encountering the lock. The argument to the busy handler callback is the number of times that the busy handler has been invoked previously for the same locking event. If the busy callback returns false, then no additional attempts are made to access the database and SQLITE_BUSY is returned to the application. If the callback returns true, then another attempt is made to access the database and the cycle repeats.

There can only be a single busy handler defined for each database connection. Setting a new busy handler clears any previously set handler. Note that calling busy_timeout() or evaluating PRAGMA busy_timeout=N will change the busy handler and thus clear any previously set busy handler.

Newly created connections default to a busy_timeout() handler with a timeout of 5000ms, although this is subject to change.

source

pub fn prepare_cached(&self, sql: &str) -> Result<CachedStatement<'_>, Error>

Prepare a SQL statement for execution, returning a previously prepared (but not currently in-use) statement if one is available. The returned statement will be cached for reuse by future calls to prepare_cached once it is dropped.

fn insert_new_people(conn: &Connection) -> Result<()> {
    {
        let mut stmt = conn.prepare_cached("INSERT INTO People (name) VALUES (?1)")?;
        stmt.execute(["Joe Smith"])?;
    }
    {
        // This will return the same underlying SQLite statement handle without
        // having to prepare it again.
        let mut stmt = conn.prepare_cached("INSERT INTO People (name) VALUES (?1)")?;
        stmt.execute(["Bob Jones"])?;
    }
    Ok(())
}
Failure

Will return Err if sql cannot be converted to a C-compatible string or if the underlying SQLite call fails.

source

pub fn set_prepared_statement_cache_capacity(&self, capacity: usize)

Set the maximum number of cached prepared statements this connection will hold. By default, a connection will hold a relatively small number of cached statements. If you need more, or know that you will not use cached statements, you can set the capacity manually using this method.

source

pub fn flush_prepared_statement_cache(&self)

Remove/finalize all prepared statements currently in the cache.

source

pub fn db_config(&self, config: DbConfig) -> Result<bool, Error>

Returns the current value of a config.

  • SQLITE_DBCONFIG_ENABLE_FKEY: return false or true to indicate whether FK enforcement is off or on
  • SQLITE_DBCONFIG_ENABLE_TRIGGER: return false or true to indicate whether triggers are disabled or enabled
  • SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER: return false or true to indicate whether fts3_tokenizer are disabled or enabled
  • SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE: return false to indicate checkpoints-on-close are not disabled or true if they are
  • SQLITE_DBCONFIG_ENABLE_QPSG: return false or true to indicate whether the QPSG is disabled or enabled
  • SQLITE_DBCONFIG_TRIGGER_EQP: return false to indicate output-for-trigger are not disabled or true if it is
source

pub fn set_db_config( &self, config: DbConfig, new_val: bool ) -> Result<bool, Error>

Make configuration changes to a database connection

  • SQLITE_DBCONFIG_ENABLE_FKEY: false to disable FK enforcement, true to enable FK enforcement
  • SQLITE_DBCONFIG_ENABLE_TRIGGER: false to disable triggers, true to enable triggers
  • SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER: false to disable fts3_tokenizer(), true to enable fts3_tokenizer()
  • SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE: false (the default) to enable checkpoints-on-close, true to disable them
  • SQLITE_DBCONFIG_ENABLE_QPSG: false to disable the QPSG, true to enable QPSG
  • SQLITE_DBCONFIG_TRIGGER_EQP: false to disable output for trigger programs, true to enable it
source

pub fn pragma_query_value<T, F>( &self, schema_name: Option<DatabaseName<'_>>, pragma_name: &str, f: F ) -> Result<T, Error>where F: FnOnce(&Row<'_>) -> Result<T, Error>,

Query the current value of pragma_name.

Some pragmas will return multiple rows/values which cannot be retrieved with this method.

Prefer PRAGMA function introduced in SQLite 3.20: SELECT user_version FROM pragma_user_version;

source

pub fn pragma_query<F>( &self, schema_name: Option<DatabaseName<'_>>, pragma_name: &str, f: F ) -> Result<(), Error>where F: FnMut(&Row<'_>) -> Result<(), Error>,

Query the current rows/values of pragma_name.

Prefer PRAGMA function introduced in SQLite 3.20: SELECT * FROM pragma_collation_list;

source

pub fn pragma<F, V>( &self, schema_name: Option<DatabaseName<'_>>, pragma_name: &str, pragma_value: V, f: F ) -> Result<(), Error>where F: FnMut(&Row<'_>) -> Result<(), Error>, V: ToSql,

Query the current value(s) of pragma_name associated to pragma_value.

This method can be used with query-only pragmas which need an argument (e.g. table_info('one_tbl')) or pragmas which returns value(s) (e.g. integrity_check).

Prefer PRAGMA function introduced in SQLite 3.20: SELECT * FROM pragma_table_info(?1);

source

pub fn pragma_update<V>( &self, schema_name: Option<DatabaseName<'_>>, pragma_name: &str, pragma_value: V ) -> Result<(), Error>where V: ToSql,

Set a new value to pragma_name.

Some pragmas will return the updated value which cannot be retrieved with this method.

source

pub fn pragma_update_and_check<F, T, V>( &self, schema_name: Option<DatabaseName<'_>>, pragma_name: &str, pragma_value: V, f: F ) -> Result<T, Error>where F: FnOnce(&Row<'_>) -> Result<T, Error>, V: ToSql,

Set a new value to pragma_name and return the updated value.

Only few pragmas automatically return the updated value.

source

pub fn unchecked_transaction(&self) -> Result<Transaction<'_>, Error>

Begin a new transaction with the default behavior (DEFERRED).

Attempt to open a nested transaction will result in a SQLite error. Connection::transaction prevents this at compile time by taking &mut self, but Connection::unchecked_transaction() may be used to defer the checking until runtime.

See Connection::transaction and Transaction::new_unchecked (which can be used if the default transaction behavior is undesirable).

Example
fn perform_queries(conn: Rc<Connection>) -> Result<()> {
    let tx = conn.unchecked_transaction()?;

    do_queries_part_1(&tx)?; // tx causes rollback if this fails
    do_queries_part_2(&tx)?; // tx causes rollback if this fails

    tx.commit()
}
Failure

Will return Err if the underlying SQLite call fails. The specific error returned if transactions are nested is currently unspecified.

source

pub fn execute_batch(&self, sql: &str) -> Result<(), Error>

Convenience method to run multiple SQL statements (that cannot take any parameters).

Example
fn create_tables(conn: &Connection) -> Result<()> {
    conn.execute_batch(
        "BEGIN;
         CREATE TABLE foo(x INTEGER);
         CREATE TABLE bar(y TEXT);
         COMMIT;",
    )
}
Failure

Will return Err if sql cannot be converted to a C-compatible string or if the underlying SQLite call fails.

source

pub fn execute<P>(&self, sql: &str, params: P) -> Result<usize, Error>where P: Params,

Convenience method to prepare and execute a single SQL statement.

On success, returns the number of rows that were changed or inserted or deleted (via sqlite3_changes).

Example
With positional params
fn update_rows(conn: &Connection) {
    match conn.execute("UPDATE foo SET bar = 'baz' WHERE qux = ?1", [1i32]) {
        Ok(updated) => println!("{} rows were updated", updated),
        Err(err) => println!("update failed: {}", err),
    }
}
With positional params of varying types
fn update_rows(conn: &Connection) {
    match conn.execute(
        "UPDATE foo SET bar = 'baz' WHERE qux = ?1 AND quux = ?2",
        params![1i32, 1.5f64],
    ) {
        Ok(updated) => println!("{} rows were updated", updated),
        Err(err) => println!("update failed: {}", err),
    }
}
With named params
fn insert(conn: &Connection) -> Result<usize> {
    conn.execute(
        "INSERT INTO test (name) VALUES (:name)",
        &[(":name", "one")],
    )
}
Failure

Will return Err if sql cannot be converted to a C-compatible string or if the underlying SQLite call fails.

source

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

Returns the path to the database file, if one exists and is known.

Returns Some("") for a temporary or in-memory database.

Note that in some cases PRAGMA database_list is likely to be more robust.

source

pub fn last_insert_rowid(&self) -> i64

Get the SQLite rowid of the most recent successful INSERT.

Uses sqlite3_last_insert_rowid under the hood.

source

pub fn query_row<T, P, F>(&self, sql: &str, params: P, f: F) -> Result<T, Error>where P: Params, F: FnOnce(&Row<'_>) -> Result<T, Error>,

Convenience method to execute a query that is expected to return a single row.

Example
fn preferred_locale(conn: &Connection) -> Result<String> {
    conn.query_row(
        "SELECT value FROM preferences WHERE name='locale'",
        [],
        |row| row.get(0),
    )
}

If the query returns more than one row, all rows except the first are ignored.

Returns Err(QueryReturnedNoRows) if no results are returned. If the query truly is optional, you can call .optional() on the result of this to get a Result<Option<T>>.

Failure

Will return Err if sql cannot be converted to a C-compatible string or if the underlying SQLite call fails.

source

pub fn query_row_and_then<T, E, P, F>( &self, sql: &str, params: P, f: F ) -> Result<T, E>where P: Params, F: FnOnce(&Row<'_>) -> Result<T, E>, E: From<Error>,

Convenience method to execute a query that is expected to return a single row, and execute a mapping via f on that returned row with the possibility of failure. The Result type of f must implement std::convert::From<Error>.

Example
fn preferred_locale(conn: &Connection) -> Result<String> {
    conn.query_row_and_then(
        "SELECT value FROM preferences WHERE name='locale'",
        [],
        |row| row.get(0),
    )
}

If the query returns more than one row, all rows except the first are ignored.

Failure

Will return Err if sql cannot be converted to a C-compatible string or if the underlying SQLite call fails.

source

pub fn prepare(&self, sql: &str) -> Result<Statement<'_>, Error>

Prepare a SQL statement for execution.

Example
fn insert_new_people(conn: &Connection) -> Result<()> {
    let mut stmt = conn.prepare("INSERT INTO People (name) VALUES (?1)")?;
    stmt.execute(["Joe Smith"])?;
    stmt.execute(["Bob Jones"])?;
    Ok(())
}
Failure

Will return Err if sql cannot be converted to a C-compatible string or if the underlying SQLite call fails.

source

pub unsafe fn handle(&self) -> *mut sqlite3

Get access to the underlying SQLite database connection handle.

Warning

You should not need to use this function. If you do need to, please open an issue on the rusqlite repository and describe your use case.

Safety

This function is unsafe because it gives you raw access to the SQLite connection, and what you do with it could impact the safety of this Connection.

source

pub fn get_interrupt_handle(&self) -> InterruptHandle

Get access to a handle that can be used to interrupt long running queries from another thread.

source

pub fn changes(&self) -> u64

Return the number of rows modified, inserted or deleted by the most recently completed INSERT, UPDATE or DELETE statement on the database connection.

See https://www.sqlite.org/c3ref/changes.html

source

pub fn is_autocommit(&self) -> bool

Test for auto-commit mode. Autocommit mode is on by default.

source

pub fn is_busy(&self) -> bool

Determine if all associated prepared statements have been reset.

source

pub fn cache_flush(&self) -> Result<(), Error>

Flush caches to disk mid-transaction

source

pub fn is_readonly(&self, db_name: DatabaseName<'_>) -> Result<bool, Error>

Determine if a database is read-only

Trait Implementations§

source§

impl<T: Debug> Debug for Database<T>

source§

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

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

impl<T: Handle> Deref for Database<T>

§

type Target = Connection

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl<T: Handle> From<T> for Database<T>

source§

fn from(backend: T) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Database<T>where T: RefUnwindSafe,

§

impl<T> Send for Database<T>where T: Send,

§

impl<T> Sync for Database<T>where T: Sync,

§

impl<T> Unpin for Database<T>where T: Unpin,

§

impl<T> UnwindSafe for Database<T>where T: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for Twhere 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> Invalidatable<()> for T

source§

fn invalidated_by(&self, _mutation: &M) -> bool

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

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

§

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 Twhere U: TryFrom<T>,

§

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

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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