11 releases (5 breaking)

✓ Uses Rust 2018 edition

0.6.1 May 21, 2020
0.6.0 May 21, 2020
0.5.1 Mar 18, 2020
0.4.1 Feb 28, 2020
0.1.0 Dec 12, 2019

#14 in Database implementations

Download history 1/week @ 2020-02-07 27/week @ 2020-02-14 53/week @ 2020-02-21 53/week @ 2020-02-28 15/week @ 2020-03-06 113/week @ 2020-03-13 96/week @ 2020-03-20 18/week @ 2020-03-27 3/week @ 2020-04-03 54/week @ 2020-04-10 10/week @ 2020-04-17 9/week @ 2020-04-24 5/week @ 2020-05-01 9/week @ 2020-05-08 21/week @ 2020-05-15 30/week @ 2020-05-22

142 downloads per month

MIT license

44KB
902 lines

pallet

Docs Crates.io

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 the sled::Tree name.
  • index_field_name: Rename the field in the search schema.
  • index_field_type: Set the index field type, must implement Into<tantivy::schema::Value>.
  • index_field_options: Set the index field options. By default, the options for String is tantivy::schema::TEXT, and the options for numeric types is tantivy::schema::INDEXED.
  • default_search_field: Include this field in the list of default search fields.
  • skip_indexing: Do not index this field.

Changelog

0.6.0

  • Add serde-cbor serialization support (thanks @minioin)

0.5.0

  • Add Deref to inner type on Document
  • Make index writer persistent

0.4.0

  • Add various builders.
  • Split out index and tree functionality.
  • Set up search::Searcher trait and other search helpers.

0.3.2

  • Add some docs

0.3.0

  • Add pallet_macros to derive pallet::DocumentLike

Current version: 0.6.0

License: MIT

Dependencies

~18MB
~246K SLoC