Struct IndexingDatabase 

pub struct IndexingDatabase { /* private fields */ }

Thread-safe SQLite database used by the indexing service.

Implementations

impl IndexingDatabase

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open or create an indexing database.

Errors

Returns an error if the database cannot be opened or initialized.

pub fn in_memory() -> Result<Self>

Create an isolated in-memory indexing database.

Errors

Returns an error if SQLite cannot initialize the schema.

pub fn path(&self) -> &Path

pub fn schema_version(&self) -> Result<String>

Return the persisted indexing schema version.

Errors

Returns an error if the schema metadata cannot be read.

pub fn has_fts5(&self) -> Result<bool>

Return whether the SQLite FTS5 virtual table is available.

Errors

Returns an error if the schema cannot be queried.

pub fn schema_objects(&self) -> Result<Vec<String>>

Return the names of schema objects owned by the index.

Errors

Returns an error if SQLite cannot query its schema.

pub fn has_table(&self, name: &str) -> Result<bool>

Return whether a schema table or view exists.

Errors

Returns an error if SQLite cannot query its schema.

pub fn folder_count(&self) -> Result<usize>

Return the number of opted-in folders.

Errors

Returns an error if SQLite cannot query the database.

pub fn entry_count(&self) -> Result<usize>

Return the number of indexed entries.

Errors

Returns an error if SQLite cannot query the database.

pub fn is_folder_enabled(&self, namespace_id: NamespaceId) -> Result<bool>

Return whether a namespace is currently opted into indexing.

Errors

Returns an error if SQLite cannot query the database.

pub fn upsert_entry( &self, namespace_id: NamespaceId, key: impl AsRef<[u8]>, hash: Hash, size: u64, ) -> Result<IndexedEntry>

Insert or update an entry in the index.

Errors

Returns an error if the database cannot persist the entry.

pub fn remove_entry( &self, namespace_id: NamespaceId, key: impl AsRef<[u8]>, ) -> Result<bool>

Remove an indexed entry if it exists.

Errors

Returns an error if the database cannot remove the entry.

pub fn search(&self, query: &str, limit: usize) -> Result<Vec<IndexedEntry>>

Search indexed paths and metadata using SQLite FTS5.

An empty query returns the most recently updated entries. FTS5 query syntax is passed through for non-empty queries.

Errors

Returns an error if the query is invalid or SQLite cannot read results.

pub fn enable_catalog( &self, namespace_id: NamespaceId, label: &str, ) -> Result<()>

Register a catalog that is published or subscribed to locally.

Errors

Returns an error if the catalog metadata cannot be stored.

pub fn catalog_count(&self) -> Result<usize>

Return the number of known catalogs.

Errors

Returns an error if SQLite cannot query the database.

pub fn catalog_entry_count(&self) -> Result<usize>

Return the number of records imported from catalogs.

Errors

Returns an error if SQLite cannot query the database.

pub fn upsert_catalog_record( &self, record: &CatalogRecord, ) -> Result<CatalogRecord>

Insert or update a record received from a catalog.

Errors

Returns an error if the catalog is not registered or the record cannot be persisted.

pub fn search_catalogs( &self, query: &str, limit: usize, ) -> Result<Vec<CatalogRecord>>

Search all subscribed catalogs with SQLite FTS5.

An empty query returns the most recently updated catalog records.

Errors

Returns an error if the query is invalid or SQLite cannot read results.

pub fn global_search( &self, query: &str, limit: usize, ) -> Result<Vec<CatalogRecord>>

Search all known catalogs. This is an alias for Self::search_catalogs.

Errors

Returns an error if the query is invalid or SQLite cannot read results.

pub fn catalog_search( &self, query: &str, limit: usize, ) -> Result<Vec<CatalogRecord>>

Search all known catalogs. Alias for Self::search_catalogs.

Errors

Returns an error if the query is invalid or SQLite cannot read results.

pub fn append_wot_metadata(&self, entry: &MetadataEntry) -> Result<bool>

Append a signed Web-of-Trust metadata entry to the local index.

Errors

Returns an error if the entry is invalid or SQLite cannot persist it.

pub fn search_wot_metadata( &self, query: &str, limit: usize, ) -> Result<Vec<MetadataEntry>>

Search accepted Web-of-Trust metadata using SQLite FTS5.

Errors

Returns an error if the query is invalid or metadata cannot be read.

pub fn disable_catalog(&self, namespace_id: NamespaceId) -> Result<()>

Remove a catalog and all records imported from it.

Errors

Returns an error if the catalog cannot be removed.

pub fn enable_folder( &self, namespace_id: NamespaceId, label: &str, ) -> Result<()>

Register a namespace for local indexing.

Errors

Returns an error if the folder metadata cannot be stored.

pub fn disable_folder(&self, namespace_id: NamespaceId) -> Result<()>

Remove a namespace and its indexed entries.

Errors

Returns an error if the folder metadata or entries cannot be removed.

Trait Implementations

impl Clone for IndexingDatabase

fn clone(&self) -> IndexingDatabase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexingDatabase

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

Formats the value using the given formatter.