Struct pallet::Store

pub struct Store<T: DocumentLike> { /* fields omitted */ }

The document store, contains the sled::Tree and tantivy::Index.

Methods

impl<T: DocumentLike> Store<T>

pub fn builder() -> StoreBuilder<T>

Builder for a new Store

pub fn default_search_fields(&self) -> Vec<Field>

The fields that should be used as default search fields in a search.

pub fn index_writer(&self) -> Result<IndexWriter>

Get a tantivy::IndexWriter from the stored tantivy::Index.

pub fn create(&self, inner: &T) -> Result<u64>

Create a new Document, returns the persisted document's id.

pub fn create_multi(&self, inners: &[T]) -> Result<Vec<u64>>

Create new Documents, returns the persisted documents' ids.

pub fn update(&self, doc: &Document<T>) -> Result<()>

Update a given Document.

pub fn update_multi(&self, docs: &[Document<T>]) -> Result<()>

Update given Documents.

pub fn delete(&self, id: u64) -> Result<()>

Delete a Document by id.

pub fn delete_multi(&self, ids: &[u64]) -> Result<()>

Delete Documents by ids.

pub fn search(&self, query_str: &str) -> Result<Results<T>>

Search the datastore, using the query language provided by tantivy.

pub fn all(&self) -> Result<Vec<Document<T>>>

Get all Documents from the datastore. Does not use the search index.

pub fn index_all(&self) -> Result<()>

Index (or re-index) all Documents in the datastore.

pub fn find(&self, id: u64) -> Result<Option<Document<T>>>

Find a single Document by its id. Does not use the search index.