Skip to content

Code samples changes related to Meilisearch release (v0.28.0) #298

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
Parent: Changes related to the next Meilisearch release (v0.28.0)
merged 9 commits into from
Aug 30, 2022
Merged

Code samples changes related to Meilisearch release (v0.28.0) #298

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
250fb34
Update README.md
meili-bot Jun 9, 2022
704f22e
Update README.tpl
meili-bot Jun 9, 2022
7d754d2
Update .code-samples.meilisearch.yaml
meili-bot Jul 4, 2022
5d8549f
Merge branch 'bump-meilisearch-v0.28.0' into meili-bot/code-samples-v…
bidoubiwa Aug 25, 2022
8ebd753
First batch of code-samples
bidoubiwa Aug 25, 2022
4d0ec1e
Add sample for get one document
bidoubiwa Aug 29, 2022
724f0fb
Update .code-samples.meilisearch.yaml
bidoubiwa Aug 30, 2022
bff4340
Merge branch 'bump-meilisearch-v0.28.0' of https://github.com/meilise…
bidoubiwa Aug 30, 2022
868ba03
Fix get_one_document
bidoubiwa Aug 30, 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
74 changes: 49 additions & 25 deletions .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,17 @@
get_one_index_1: |-
let movies: Index = client.get_index("movies").await.unwrap();
list_all_indexes_1: |-
let indexes: IndexesResults = client.list_all_indexes().await.unwrap();
let mut indexes = IndexesQuery::new(&client)
.with_limit(3)
.execute().await.unwrap();
create_an_index_1: |-
client.create_index("movies", Some("id")).await.unwrap();
update_an_index_1: |-
client.index("movies").update("movie_review_id").await.unwrap();
delete_an_index_1: |-
client.index("movies").delete().await.unwrap();
get_one_document_1: |-
let movie: Movie = client.index("movies").get_document(String::from("25684")).await.unwrap();
let movie: Movie = client.index("movies").get_document(String::from("25684"), ["id", "title", "poster", "release_date"].to_vec()).await.unwrap();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why .to_vec() is required here? But not in .with_status(["succeeded", "failed"]) ?

get_documents_1: |-
let documents: Vec<Movie> = client.index("movies").get_documents(None, Some(2), None).await.unwrap();
add_or_replace_documents_1: |-
Expand Down Expand Up @@ -54,16 +56,40 @@ search_post_1: |-
.execute()
.await
.unwrap();
get_task_by_index_1: |-
let task: Task = client.index("movies").get_task(1).await.unwrap();
get_all_tasks_by_index_1: |-
let tasks: TasksResults = client.index("movies").get_tasks().await.unwrap();
get_all_tasks_1: |-
let tasks: TasksResults = client.get_tasks().await.unwrap();
get_all_tasks_filtering_1: |-
let mut query = TasksQuery::new(&client)
.with_index_uid(["movies"])
.execute()
.await
.unwrap();
get_all_tasks_filtering_2: |-
let mut query = TasksQuery::new(&client)
.with_status(["succeeded", "failed"])
.with_type(["documentAdditionOrUpdate"])
.execute()
.await
.unwrap();
get_all_tasks_paginating_1: |-
let mut query = TasksQuery::new(&client)
.with_limit(2)
.from(10)
.execute()
.await
.unwrap();
get_all_tasks_paginating_2: |-
let mut query = TasksQuery::new(&client)
.with_limit(2)
.from(8)
.execute()
.await
.unwrap();
get_task_1: |-
let task: Task = client.get_task(1).await.unwrap();
get_settings_1: |-
let settings: Settings = client.index("movies").get_settings().await.unwrap();
# Cannot be updated until API faceting and pagination are added
update_settings_1: |-
let mut synonyms = std::collections::HashMap::new();
synonyms.insert(String::from("wolverine"), vec!["xmen", "logan"]);
Expand Down Expand Up @@ -303,7 +329,7 @@ search_parameter_guide_highlight_tag_1: |-

// Get the formatted results
let formatted_results: Vec<&Movie> = results.hits.iter().map(|r| r.formatted_result.as_ref().unwrap()).collect();
search_parameter_guide_matches_1: |-
search_parameter_guide_show_matches_position_1: |-
let results: SearchResults<Movie> = client.index("movies").search()
.with_query("winter feast")
.with_show_matches_position(true)
Expand All @@ -312,7 +338,7 @@ search_parameter_guide_matches_1: |-
.unwrap();

// Get the matches info
let matched_info: Vec<&HashMap<String, Vec<MatchRange>>> = results.hits.iter().map(|r| r.matches_position.as_ref().unwrap()).collect();
let matches_position: Vec<&HashMap<String, Vec<MatchRange>>> = results.hits.iter().map(|r| r.matches_position.as_ref().unwrap()).collect();
settings_guide_synonyms_1: |-
let mut synonyms = HashMap::new();
synonyms.insert(String::from("sweater"), vec![String::from("jumper")]);
Expand Down Expand Up @@ -564,7 +590,7 @@ getting_started_update_stop_words: |-
let stop_words = ["the"];
client.index("movies").set_stop_words(&stop_words).await.unwrap();
getting_started_check_task_status: |-
client.index("movies").get_task(0).await.unwrap();
client.get_task(0).await.unwrap();
getting_started_synonyms: |-
let mut synonyms = std::collections::HashMap::new();
synonyms.insert(String::from("winnie"), vec![String::from("piglet")]);
Expand Down Expand Up @@ -651,7 +677,7 @@ faceted_search_filter_1: |-
.execute()
.await
.unwrap();
faceted_search_facets_distribution_1: |-
faceted_search_facets_1: |-
let results: SearchResults<Movie> = client.index("movies").search()
.with_query("Batman")
.with_facets(Selectors::Some(&["genres"]))
Expand All @@ -668,8 +694,6 @@ faceted_search_walkthrough_filter_1: |-
.unwrap();
post_dump_1: |-
client.create_dump().await.unwrap();
get_dump_status_1: |-
client.get_dump_status("20201101-110357260").await.unwrap();
phrase_search_1: |-
let results: SearchResults<Movie> = client.index("movies")
.search()
Expand Down Expand Up @@ -756,26 +780,26 @@ geosearch_guide_sort_usage_2: |-
.await
.unwrap();
get_one_key_1: |-
let key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
let key = client.get_key("6062abda-a5aa-4414-ac91-ecd7944c0f8d").await.unwrap();
get_all_keys_1: |-
let keys = client.get_keys().await.unwrap();
let mut query = KeysQuery::new().with_limit(3).execute(&client).await.unwrap();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the examples are multiline and some are not, I think it could be nice to follow a standard :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I bring consistency now I have to do it on every sample even the ones that are not linked to this PR.
Maybe an issue that request that change ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect for me! You can open the issue :)

create_a_key_1: |-
let mut key_options = KeyBuilder::new("Add documents: Products API key");
key_options.with_action(Action::DocumentsAdd)
.with_expires_at(time::macros::datetime!(2042 - 04 - 02 00:42:42 UTC))
.with_index("products");
let new_key = client.create_key(key_options).await.unwrap();
update_a_key_1: |-
let mut key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
let mut key = client.get_key("6062abda-a5aa-4414-ac91-ecd7944c0f8d").await.unwrap();
key
.with_description("Manage documents: Products/Reviews API key".to_string())
.with_actions(vec![Action::DocumentsAdd, Action::DocumentsDelete])
.with_indexes(vec!["products".to_string(), "reviews".to_string()])
.with_expires_at(time::macros::datetime!(2042 - 04 - 02 00:42:42 UTC))
.update(&client);
.with_name("Products/Reviews API key".to_string())
.update(&client)
.await
.unwrap();
delete_a_key_1: |-
let key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
client.delete_key(&key);
let key = client.get_key("6062abda-a5aa-4414-ac91-ecd7944c0f8d").await.unwrap();
client.delete_key(&key).await?;
authorization_header_1:
let client = Client::new("http://localhost:7700", "masterKey");
let keys = client.get_keys().await.unwrap();
Expand All @@ -784,8 +808,8 @@ security_guide_search_key_1: |-
let result = client.index("patient_medical_records").search().execute().await.unwrap();
security_guide_update_key_1: |-
let client = Client::new("http://localhost:7700", "masterKey");
let mut key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
key.with_indexes(vec!["doctors".to_string()]).update(&client);
let mut key = client.get_key("74c9c733-3368-4738-bbe5-1d18a5fecb37").await.unwrap();
key.with_description("Default Search API key".to_string()).update(&client);
security_guide_create_key_1: |-
let client = Client::new("http://localhost:7700", "masterKey");
let mut key_options = KeyBuilder::new("Search patient records key");
Expand All @@ -798,8 +822,8 @@ security_guide_list_keys_1: |-
let keys = client.get_keys().await.unwrap();
security_guide_delete_key_1: |-
let client = Client::new("http://localhost:7700", "masterKey");
let key = client.get_key("d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4").await.unwrap();
client.delete_key(&key);
let key = client.get_key("ac5cd97d-5a4b-4226-a868-2d0eb6d197ab").await.unwrap();
client.delete_key(&key).await?;
landing_getting_started_1: |-
let client = Client::new("http://localhost:7700", "masterKey");

Expand Down