Struct meilisearch_sdk::client::Client

pub struct Client { /* fields omitted */ }

The top-level struct of the SDK, representing a client containing indexes.

Implementations

impl Client

pub fn new(host: impl Into<String>, api_key: impl Into<String>) -> Client

Create a client using the specified server. Don’t put a ‘/’ at the end of the host. In production mode, see the documentation about authentication.

Example

// create the client
let client = Client::new("http://localhost:7700", "masterKey");

pub async fn list_all_indexes(&self) -> Result<Vec<Index>, Error>

List all [indexes] and returns values as instances of Index(../indexes/struct.Index.html).

Example

// create the client
let client = Client::new("http://localhost:7700", "masterKey");

let indexes: Vec<Index> = client.list_all_indexes().await.unwrap();
println!("{:?}", indexes);

pub async fn list_all_indexes_raw(&self) -> Result<Vec<JsonIndex>, Error>

List all [indexes] and returns as Json (../indexes/struct.Index.html).

Example

// create the client
let client = Client::new("http://localhost:7700", "masterKey");

let json_indexes: Vec<JsonIndex> = client.list_all_indexes_raw().await.unwrap();
println!("{:?}", json_indexes);

pub async fn get_index(&self, uid: impl AsRef<str>) -> Result<Index, Error>

Get an index, this index should already exist.

Example

// create the client
let client = Client::new("http://localhost:7700", "masterKey");

// get the index named "movies"
let movies = client.get_index("movies").await.unwrap();

pub async fn get_raw_index(
    &self,
    uid: impl AsRef<str>
) -> Result<JsonIndex, Error>

Get a raw JSON index, this index should already exist.

Example

// create the client
let client = Client::new("http://localhost:7700", "masterKey");

// get the index named "movies"
let movies = client.get_raw_index("movies").await.unwrap();

If you use it directly from an index, you can use the method fetch_info, which is the equivalent method from an index.

pub fn index(&self, uid: impl Into<String>) -> Index

Create a corresponding object of an index without any check or doing an HTTP call.

pub async fn create_index(
    &self,
    uid: impl AsRef<str>,
    primary_key: Option<&str>
) -> Result<Index, Error>

Create an index. The second parameter will be used as the primary key of the new index. If it is not specified, MeiliSearch will try to infer the primary key.

Example

// create the client
let client = Client::new("http://localhost:7700", "masterKey");

// create a new index called movies and access it
let movies = client.create_index("movies", None).await;

pub async fn delete_index_if_exists(&self, uid: &str) -> Result<bool, Error>

Delete an index from its UID if it exists. To delete an index if it exists from the Index object, use the Index::delete_if_exists method.

pub async fn delete_index(&self, uid: impl AsRef<str>) -> Result<(), Error>

Delete an index from its UID. To delete an index from the index object, use the delete method.

pub async fn get_or_create(&self, uid: impl AsRef<str>) -> Result<Index, Error>

This will try to get an index and create the index if it does not exist.

pub async fn get_indexes(&self) -> Result<Vec<Index>, Error>

Alias for list_all_indexes.

pub async fn get_indexes_raw(&self) -> Result<Vec<JsonIndex>, Error>

Alias for list_all_indexes_raw.

pub async fn get_stats(&self) -> Result<ClientStats, Error>

Get stats of all indexes.

Example

let client = Client::new("http://localhost:7700", "masterKey");
let stats = client.get_stats().await.unwrap();

pub async fn health(&self) -> Result<Health, Error>

Get health of MeiliSearch server.

Example

let client = Client::new("http://localhost:7700", "masterKey");
let health = client.health().await.unwrap();

pub async fn is_healthy(&self) -> bool

Get health of MeiliSearch server, return true or false.

Example

let client = Client::new("http://localhost:7700", "masterKey");
let health = client.is_healthy().await;
assert_eq!(health, true);

pub async fn get_keys(&self) -> Result<Keys, Error>

Get the private and public key.

Example

let client = Client::new("http://localhost:7700", "masterKey");
let keys = client.get_keys().await.unwrap();

pub async fn get_version(&self) -> Result<Version, Error>

Get version of the MeiliSearch server.

Example

let client = Client::new("http://localhost:7700", "masterKey");
let version = client.get_version().await.unwrap();

impl Client

Dump related methods.
See the dumps module.

pub async fn create_dump(&self) -> Result<DumpInfo, Error>

Triggers a dump creation process. Once the process is complete, a dump is created in the dumps directory. If the dumps directory does not exist yet, it will be created.

Example

let dump_info = client.create_dump().await.unwrap();
assert!(matches!(dump_info.status, DumpStatus::InProgress));

pub async fn get_dump_status(
    &self,
    dump_uid: impl AsRef<str>
) -> Result<DumpInfo, Error>

Get the status of a dump creation process using the uid returned after calling the dump creation method.

Example

let dump_info = client.get_dump_status(&dump_info.uid).await.unwrap();

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.