Crate pallet[−][src]
A searchable document datastore built on sled
and tantivy
.
Provides a typed-tree interface to a sled
database, with standard datastore ops (find
, create
, update
, delete
),
but also Lucene/Elasticsearch style searching.
The included pallet_macros
crate provides an easy way to derive pallet::DocumentLike
for data structs.
Usage
#[macro_use] extern crate serde; #[derive(Serialize, Deserialize, Debug, pallet::DocumentLike)] #[pallet(tree_name = "books")] pub struct Book { #[pallet(default_search_field)] title: String, #[pallet(default_search_field)] description: Option<String>, #[pallet(index_field_type = "u64")] rating: u8, } fn main() -> Result<(), Box<dyn std::error::Error>> { let temp_dir = tempfile::TempDir::new_in(".")?; let db = sled::open(temp_dir.path().join("db"))?; let store = pallet::Store::builder().with_db(db).with_index_dir(temp_dir.path()).finish()?; let books = vec![ Book { title: "The Old Man and the Sea".into(), description: Some( "He was an old man who fished alone in a skiff in \ the Gulf Stream and he had gone eighty-four days \ now without taking a fish." .into(), ), rating: 10, }, Book { title: "The Great Gatsby".into(), description: Some("About a man and some other stuff".into()), rating: 8, }, ]; let _ = store.create_multi(&books)?; let books = store.search("man AND rating:>8")?; println!("{:?}", books); Ok(()) }
pallet_macros
See the example for usage. The following attributes can be used to customize the implementation:
tree_name
: A container level attribute to specify thesled::Tree
name.index_field_name
: Rename the field in the search schema.index_field_type
: Set the index field type, must implementInto<tantivy::schema::Value>
.index_field_options
: Set the index field options. By default, the options forString
istantivy::schema::TEXT
, and the options for numeric types istantivy::schema::INDEXED
.default_search_field
: Include this field in the list of default search fields.skip_indexing
: Do not index this field.
Changelog
0.7.0
- Update sled/tantivy deps (thanks @lberezy)
0.6.0
- Add
serde-cbor
serialization support (thanks @minioin)
0.5.0
- Add
Deref
to inner type onDocument
- Make index writer persistent
0.4.0
- Add various builders.
- Split out
index
andtree
functionality. - Set up
search::Searcher
trait and other search helpers.
0.3.2
- Add some docs
0.3.0
- Add
pallet_macros
to derivepallet::DocumentLike
Modules
db | Items related to |
err | Error management |
ext | Re-exports |
search | Items relating to |
Structs
Document | Persisted wrapper of the internal document, includes |
Store | The document store, contains the |
StoreBuilder | Builder for |
Traits
DocumentLike | Defines methods for building the index schema and creating a |
Derive Macros
DocumentLike | Re-export the |