Skip to content

Add support to the pagination setting customization at the index level #342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Oct 10, 2022
Merged

Add support to the pagination setting customization at the index level #342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0429b85
Add support to the pagination setting customization at the index level
vishalsodani Oct 1, 2022
f960455
create PaginationSetting struct
vishalsodani Oct 3, 2022
012ad81
update the code to reflect usage of PaginationSetting structure
vishalsodani Oct 3, 2022
82b22f7
add pagination struct to settings structas member
vishalsodani Oct 4, 2022
dbba176
fix styling issues
vishalsodani Oct 4, 2022
262443a
add 3 tests for pagination settings
vishalsodani Oct 4, 2022
666e573
fix clippy warning for Eq
vishalsodani Oct 4, 2022
e05e76f
Make property as usize
vishalsodani Oct 5, 2022
dccbfc8
fix code samples
vishalsodani Oct 5, 2022
58ea450
fix styling issues
vishalsodani Oct 5, 2022
ba507cb
Merge branch 'main' into pagination_setting_index
vishalsodani Oct 6, 2022
53c5da8
add comment for pagination property
vishalsodani Oct 6, 2022
82d9fec
removed duplicate declaration of test
vishalsodani Oct 6, 2022
98e9cee
fix code styling issues
vishalsodani Oct 6, 2022
2c267ac
add Box as per clippys suggestion
vishalsodani Oct 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,26 @@ reset_synonyms_1: |-
.reset_synonyms()
.await
.unwrap();
get_pagination_settings_1: |-
let pagination: PaginationSetting = client
.index("books")
.get_pagination()
.await
.unwrap();
update_pagination_settings_1: |-
let pagination = PaginationSetting {max_total_hits:100};

let task: TaskInfo = client
.index("books")
.set_pagination(pagination)
.await
.unwrap();
reset_pagination_settings_1: |-
let task: TaskInfo = client
.index("books")
.reset_pagination()
.await
.unwrap();
get_stop_words_1: |-
let stop_words: Vec<String> = client
.index("movies")
Expand Down Expand Up @@ -657,6 +677,14 @@ settings_guide_searchable_1: |-
.set_settings(&settings)
.await
.unwrap();
settings_guide_pagination_1: |-
let pagination = PaginationSetting {max_total_hits:100};

let task: TaskInfo = client
.index("movies")
.set_pagination(pagination)
.await
.unwrap();
settings_guide_displayed_1: |-
let settings = Settings::new()
.with_displayed_attributes([
Expand Down
157 changes: 155 additions & 2 deletions src/settings.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ use crate::{
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Serialize, Deserialize, Default, Debug, Clone, PartialEq, Eq, Copy)]
#[serde(rename_all = "camelCase")]
pub struct PaginationSetting {
pub max_total_hits: usize
}

#[derive(Serialize, Deserialize, Default, Debug, Clone, Eq, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct FacetingSettings {
Expand Down Expand Up @@ -65,6 +71,9 @@ pub struct Settings {
/// Fields displayed in the returned documents
#[serde(skip_serializing_if = "Option::is_none")]
pub displayed_attributes: Option<Vec<String>>,
/// Pagination settings
#[serde(skip_serializing_if = "Option::is_none")]
pub pagination: Option<PaginationSetting>,
/// Faceting settings
#[serde(skip_serializing_if = "Option::is_none")]
pub faceting: Option<FacetingSettings>,
Expand All @@ -83,6 +92,7 @@ impl Settings {
distinct_attribute: None,
searchable_attributes: None,
displayed_attributes: None,
pagination: None,
faceting: None,
}
}
Expand Down Expand Up @@ -123,6 +133,13 @@ impl Settings {
}
}

pub fn with_pagination(self, pagination_settings: PaginationSetting) -> Settings {
Settings {
pagination: Some(pagination_settings),
..self
}
}

pub fn with_ranking_rules(
self,
ranking_rules: impl IntoIterator<Item = impl AsRef<str>>,
Expand Down Expand Up @@ -272,6 +289,35 @@ impl Index {
.await
}

/// Get [pagination](https://docs.meilisearch.com/learn/configuration/settings.html#pagination) of the [Index].
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*};
/// #
/// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
/// # client.create_index("get_pagination", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// let index = client.index("get_pagination");
/// let pagination = index.get_pagination().await.unwrap();
/// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub async fn get_pagination(&self) -> Result<PaginationSetting, Error> {
request::<(), PaginationSetting>(
&format!(
"{}/indexes/{}/settings/pagination",
self.client.host, self.uid
),
&self.client.api_key,
Method::Get(()),
200,
)
.await
}

/// Get [stop-words](https://docs.meilisearch.com/reference/features/stop_words.html) of the [Index].
///
/// ```
Expand Down Expand Up @@ -510,7 +556,7 @@ impl Index {
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings};
/// # use meilisearch_sdk::{client::*, indexes::*, settings::{Settings, PaginationSetting}};
/// #
/// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
Expand All @@ -522,7 +568,9 @@ impl Index {
///
/// let stop_words = vec![String::from("a"), String::from("the"), String::from("of")];
/// let settings = Settings::new()
/// .with_stop_words(stop_words.clone());
/// .with_stop_words(stop_words.clone())
/// .with_pagination(PaginationSetting {max_total_hits: 100}
/// );
///
/// let task = index.set_settings(&settings).await.unwrap();
/// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
Expand Down Expand Up @@ -578,6 +626,38 @@ impl Index {
.await
}

/// Update [pagination](https://docs.meilisearch.com/learn/configuration/settings.html#pagination) of the [Index].
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*, settings::{Settings, PaginationSetting}};
/// #
/// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
/// # client.create_index("set_pagination", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// let mut index = client.index("set_pagination");
/// let pagination = PaginationSetting {max_total_hits:100};
/// let task = index.set_pagination(pagination).await.unwrap();
/// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub async fn set_pagination(&self, pagination: PaginationSetting,) -> Result<TaskInfo, Error> {
request::<&PaginationSetting, TaskInfo>(
&format!(
"{}/indexes/{}/settings/pagination",
self.client.host, self.uid
),
&self.client.api_key,
Method::Patch(&pagination),
202,
)
.await
}

/// Update [stop-words](https://docs.meilisearch.com/reference/features/stop_words.html) of the [Index].
///
/// # Example
Expand Down Expand Up @@ -967,6 +1047,37 @@ impl Index {
.await
}

/// Reset [pagination](https://docs.meilisearch.com/learn/configuration/settings.html#pagination) of the [Index].
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings};
/// #
/// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// #
/// # futures::executor::block_on(async move {
/// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
/// # client.create_index("reset_pagination", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// let mut index = client.index("reset_pagination");
///
/// let task = index.reset_pagination().await.unwrap();
/// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
/// # });
/// ```
pub async fn reset_pagination(&self) -> Result<TaskInfo, Error> {
request::<(), TaskInfo>(
&format!(
"{}/indexes/{}/settings/pagination",
self.client.host, self.uid
),
&self.client.api_key,
Method::Delete,
202,
)
.await
}
/// Reset [stop-words](https://docs.meilisearch.com/reference/features/stop_words.html) of the [Index].
///
/// # Example
Expand Down Expand Up @@ -1285,4 +1396,46 @@ mod tests {

assert_eq!(faceting, res);
}

#[meilisearch_test]
async fn test_get_pagination(index: Index) {
let pagination = PaginationSetting {
max_total_hits: 1000,
};

let res = index.get_pagination().await.unwrap();

assert_eq!(pagination, res);
}

#[meilisearch_test]
async fn test_set_pagination(index: Index) {
let pagination = PaginationSetting {
max_total_hits: 11,
};
let task = index.set_pagination(pagination).await.unwrap();
index.wait_for_task(task, None, None).await.unwrap();

let res = index.get_pagination().await.unwrap();

assert_eq!(pagination, res);
}

#[meilisearch_test]
async fn test_reset_pagination(index: Index) {
let pagination = PaginationSetting {
max_total_hits: 10,
};
let default = PaginationSetting { max_total_hits: 1000};

let task = index.set_pagination(pagination).await.unwrap();
index.wait_for_task(task, None, None).await.unwrap();

let reset_task = index.reset_pagination().await.unwrap();
index.wait_for_task(reset_task, None, None).await.unwrap();

let res = index.get_pagination().await.unwrap();

assert_eq!(default, res);
}
}
2 changes: 1 addition & 1 deletion src/tasks.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pub enum TaskType {
details: Option<IndexDeletion>,
},
SettingsUpdate {
details: Option<Settings>,
details: Box<Option<Settings>>,
},
DumpCreation {
details: Option<DumpCreation>,
Expand Down