Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/meilisearch/meilisearch-rust

Rust wrapper for the Meilisearch API.
https://github.com/meilisearch/meilisearch-rust

crate meilisearch rust sdk search-engine wasm

Last synced: about 2 months ago
JSON representation

Rust wrapper for the Meilisearch API.

Lists

README 

        





  Meilisearch-Rust




Meilisearch Rust SDK





  Meilisearch |

  Meilisearch Cloud |

  Documentation |

  Discord |

  Roadmap |

  Website |

  FAQ






  crates.io

  Tests

  License

  

  Bors enabled




⚡ The Meilisearch API client written for Rust 🦀



**Meilisearch Rust** is the Meilisearch API client for Rust developers.



**Meilisearch** is an open-source search engine. [Learn more about Meilisearch.](https://github.com/meilisearch/meilisearch)



## Table of Contents 



- [📖 Documentation](#-documentation)

- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)

- [🔧 Installation](#-installation)

- [🚀 Getting started](#-getting-started)

- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)

- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)

- [⚙️ Contributing](#️-contributing)



## 📖 Documentation



This readme contains all the documentation you need to start using this Meilisearch SDK.



For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs).



## ⚡ Supercharge your Meilisearch experience



Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-rust). Get started with a 14-day free trial! No credit card required.



## 🔧 Installation



To use `meilisearch-sdk`, add this to your `Cargo.toml`:



```toml

[dependencies]

meilisearch-sdk = "0.24.3"

```



The following optional dependencies may also be useful:



```toml

futures = "0.3" # To be able to block on async functions if you are not using an async runtime

serde = { version = "1.0", features = ["derive"] }

```



This crate is `async` but you can choose to use an async runtime like [tokio](https://crates.io/crates/tokio) or just [block on futures](https://docs.rs/futures/latest/futures/executor/fn.block_on.html).

You can enable the `sync` feature to make most structs `Sync`. It may be a bit slower.



Using this crate is possible without [serde](https://crates.io/crates/serde), but a lot of features require serde.



### Run a Meilisearch Instance 



This crate requires a Meilisearch server to run.



There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation).



For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):



```bash

# Install Meilisearch

curl -L https://install.meilisearch.com | sh



# Launch Meilisearch

./meilisearch --master-key=masterKey

```



NB: you can also download Meilisearch from **Homebrew** or **APT**.



## 🚀 Getting started



#### Add Documents 



```rust

use meilisearch_sdk::client::*;

use serde::{Serialize, Deserialize};

use futures::executor::block_on;



#[derive(Serialize, Deserialize, Debug)]

struct Movie {

    id: usize,

    title: String,

    genres: Vec,

}



fn main() { block_on(async move {

    // Create a client (without sending any request so that can't fail)

    let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));



    // An index is where the documents are stored.

    let movies = client.index("movies");



    // Add some movies in the index. If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.

    movies.add_documents(&[

        Movie { id: 1, title: String::from("Carol"), genres: vec!["Romance".to_string(), "Drama".to_string()] },

        Movie { id: 2, title: String::from("Wonder Woman"), genres: vec!["Action".to_string(), "Adventure".to_string()] },

        Movie { id: 3, title: String::from("Life of Pi"), genres: vec!["Adventure".to_string(), "Drama".to_string()] },

        Movie { id: 4, title: String::from("Mad Max"), genres: vec!["Adventure".to_string(), "Science Fiction".to_string()] },

        Movie { id: 5, title: String::from("Moana"), genres: vec!["Fantasy".to_string(), "Action".to_string()] },

        Movie { id: 6, title: String::from("Philadelphia"), genres: vec!["Drama".to_string()] },

    ], Some("id")).await.unwrap();

})}

```



With the `uid`, you can check the status (`enqueued`, `canceled`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/tasks#get-task).



#### Basic Search 



```rust

// Meilisearch is typo-tolerant:

println!("{:?}", client.index("movies_2").search().with_query("caorl").execute::().await.unwrap().hits);

```



Output:

```

[Movie { id: 1, title: String::from("Carol"), genres: vec!["Romance", "Drama"] }]

```



Json output:

```json

{

  "hits": [{

    "id": 1,

    "title": "Carol",

    "genres": ["Romance", "Drama"]

  }],

  "offset": 0,

  "limit": 10,

  "processingTimeMs": 1,

  "query": "caorl"

}

```



#### Custom Search 



```rust

let search_result = client.index("movies_3")

  .search()

  .with_query("phil")

  .with_attributes_to_highlight(Selectors::Some(&["*"]))

  .execute::()

  .await

  .unwrap();

println!("{:?}", search_result.hits);

```



Json output:

```json

{

    "hits": [

        {

            "id": 6,

            "title": "Philadelphia",

            "_formatted": {

                "id": 6,

                "title": "Philadelphia",

                "genre": ["Drama"]

            }

        }

    ],

    "offset": 0,

    "limit": 20,

    "processingTimeMs": 0,

    "query": "phil"

}

```



#### Custom Search With Filters 



If you want to enable filtering, you must add your attributes to the `filterableAttributes`

index setting.



```rust

let filterable_attributes = [

    "id",

    "genres",

];

client.index("movies_4").set_filterable_attributes(&filterable_attributes).await.unwrap();

```



You only need to perform this operation once.



Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://www.meilisearch.com/docs/reference/api/tasks#get-task).



Then, you can perform the search:



```rust

let search_result = client.index("movies_5")

  .search()

  .with_query("wonder")

  .with_filter("id > 1 AND genres = Action")

  .execute::()

  .await

  .unwrap();

println!("{:?}", search_result.hits);

```



Json output:

```json

{

  "hits": [

    {

      "id": 2,

      "title": "Wonder Woman",

      "genres": ["Action", "Adventure"]

    }

  ],

  "offset": 0,

  "limit": 20,

  "estimatedTotalHits": 1,

  "processingTimeMs": 0,

  "query": "wonder"

}

```



## 🌐 Running in the Browser with WASM 



This crate fully supports WASM.



The only difference between the WASM and the native version is that the native version has one more variant (`Error::Http`) in the Error enum. That should not matter so much but we could add this variant in WASM too.



However, making a program intended to run in a web browser requires a **very** different design than a CLI program. To see an example of a simple Rust web app using Meilisearch, see the [our demo](./examples/web_app).



WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extension).



## 🤖 Compatibility with Meilisearch



This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-rust/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.



## ⚙️ Contributing



Any new contribution is more than welcome in this project!



If you want to know more about the development workflow or want to contribute, please visit our [contributing guidelines](/CONTRIBUTING.md) for detailed instructions!






**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.