Skip to content

Commit c538744

Browse files
curquizacurquiza
committed
Update code samples
1 parent e5aa844 commit c538744

File tree

1 file changed

+68
-69
lines changed

1 file changed

+68
-69
lines changed

‎.code-samples.meilisearch.yaml

Lines changed: 68 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,53 @@
44
# You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples
55
---
66
get_one_index_1: |-
7-
client.get_index('movies').info()
7+
index = client.get_index('movies')
8+
index.uid
9+
index.primary_key
810
list_all_indexes_1: |-
911
client.get_indexes()
1012
create_an_index_1: |-
1113
client.create_index('movies', {'primaryKey': 'movie_id'})
1214
update_an_index_1: |-
13-
client.get_index('movies').update(primaryKey='movie_review_id')
15+
client.index('movies').update(primaryKey='movie_review_id')
1416
delete_an_index_1: |-
15-
client.get_index('movies').delete()
17+
client.index('movies').delete()
1618
get_one_document_1: |-
17-
client.get_index('movies').get_document(25684)
19+
client.index('movies').get_document(25684)
1820
get_documents_1: |-
19-
client.get_index('movies').get_documents({'limit':2})
21+
client.index('movies').get_documents({'limit':2})
2022
add_or_replace_documents_1: |-
21-
client.get_index('movies').add_documents([{
23+
client.index('movies').add_documents([{
2224
'id': 287947,
2325
'title': 'Shazam',
2426
'poster': 'https://image.tmdb.org/t/p/w1280/xnopI5Xtky18MPhK40cZAGAOVeV.jpg',
2527
'overview': 'A boy is given the ability to become an adult superhero in times of need with a single magic word.',
2628
'release_date': '2019-03-23'
2729
}])
2830
add_or_update_documents_1: |-
29-
client.get_index('movies').update_documents([{
31+
client.index('movies').update_documents([{
3032
'id': 287947,
3133
'title': 'Shazam ⚡️',
3234
'genres': 'comedy'
3335
}])
3436
delete_all_documents_1: |-
35-
client.get_index('movies').delete_all_documents()
37+
client.index('movies').delete_all_documents()
3638
delete_one_document_1: |-
37-
client.get_index('movies').delete_document(25684)
39+
client.index('movies').delete_document(25684)
3840
delete_documents_1: |-
39-
client.get_index('movies').delete_documents([23488, 153738, 437035, 363869])
41+
client.index('movies').delete_documents([23488, 153738, 437035, 363869])
4042
search_1: |-
41-
client.get_index('movies').search('American ninja')
43+
client.index('movies').search('American ninja')
4244
get_update_1: |-
43-
client.get_index('movies').get_update_status(1)
45+
client.index('movies').get_update_status(1)
4446
get_all_updates_1: |-
45-
client.get_index('movies').get_all_update_status()
47+
client.index('movies').get_all_update_status()
4648
get_keys_1: |-
4749
client.get_keys()
4850
get_settings_1: |-
49-
client.get_index('movies').get_settings()
51+
client.index('movies').get_settings()
5052
update_settings_1: |-
51-
client.get_index('movies').update_settings({
53+
client.index('movies').update_settings({
5254
'rankingRules': [
5355
'typo',
5456
'words',
@@ -88,27 +90,27 @@ update_settings_1: |-
8890
'acceptNewFields': False
8991
})
9092
reset_settings_1: |-
91-
client.get_index('movies').reset_settings()
93+
client.index('movies').reset_settings()
9294
get_synonyms_1: |-
93-
client.get_index('movies').get_synonyms()
95+
client.index('movies').get_synonyms()
9496
update_synonyms_1: |-
95-
client.get_index('movies').update_synonyms({
97+
client.index('movies').update_synonyms({
9698
'wolverine': ['xmen', 'logan'],
9799
'logan': ['wolverine', 'xmen'],
98100
'wow': ['world of warcraft']
99101
})
100102
reset_synonyms_1: |-
101-
client.get_index('movies').reset_synonyms()
103+
client.index('movies').reset_synonyms()
102104
get_stop_words_1: |-
103-
client.get_index('movies').get_stop_words()
105+
client.index('movies').get_stop_words()
104106
update_stop_words_1: |-
105-
client.get_index('movies').update_stop_words(['of', 'the', 'to'])
107+
client.index('movies').update_stop_words(['of', 'the', 'to'])
106108
reset_stop_words_1: |-
107-
client.get_index('movies').reset_stop_words()
109+
client.index('movies').reset_stop_words()
108110
get_ranking_rules_1: |-
109-
client.get_index('movies').get_ranking_rules()
111+
client.index('movies').get_ranking_rules()
110112
update_ranking_rules_1: |-
111-
client.get_index('movies').update_ranking_rules([
113+
client.index('movies').update_ranking_rules([
112114
'typo',
113115
'words',
114116
'proximity',
@@ -119,50 +121,47 @@ update_ranking_rules_1: |-
119121
'desc(rank)'
120122
])
121123
reset_ranking_rules_1: |-
122-
client.get_index('movies').reset_ranking_rules()
124+
client.index('movies').reset_ranking_rules()
123125
get_distinct_attribute_1: |-
124-
client.get_index('movies').get_distinct_attribute()
126+
client.index('movies').get_distinct_attribute()
125127
update_distinct_attribute_1: |-
126-
client.get_index('movies').update_distinct_attribute('movie_id')
128+
client.index('movies').update_distinct_attribute('movie_id')
127129
reset_distinct_attribute_1: |-
128-
client.get_index('movies').reset_distinct_attribute()
130+
client.index('movies').reset_distinct_attribute()
129131
get_searchable_attributes_1: |-
130-
client.get_index('movies').get_searchable_attributes()
132+
client.index('movies').get_searchable_attributes()
131133
update_searchable_attributes_1: |-
132-
client.get_index('movies').update_searchable_attributes([
134+
client.index('movies').update_searchable_attributes([
133135
'title',
134136
'description',
135137
'uid'
136138
])
137139
reset_searchable_attributes_1: |-
138-
client.get_index('movies').reset_searchable_attributes()
140+
client.index('movies').reset_searchable_attributes()
139141
get_displayed_attributes_1: |-
140-
client.get_index('movies').get_displayed_attributes()
142+
client.index('movies').get_displayed_attributes()
141143
update_displayed_attributes_1: |-
142-
client.get_index('movies').update_displayed_attributes([
144+
client.index('movies').update_displayed_attributes([
143145
"title",
144146
'description',
145147
'release_date',
146148
'rank',
147149
'poster'
148150
])
149151
reset_displayed_attributes_1: |-
150-
client.get_index('movies').reset_displayed_attributes()
152+
client.index('movies').reset_displayed_attributes()
151153
get_index_stats_1: |-
152-
client.get_index('movies').get_stats()
154+
client.index('movies').get_stats()
153155
get_indexes_stats_1: |-
154156
client.get_all_stats()
155157
get_health_1: |-
156158
client.health()
157159
get_version_1: |-
158160
clien.get_version()
159-
get_pretty_sys_info_1: |-
160-
get_sys_info_1: |-
161-
client.get_sys_info()
162161
distinct_attribute_guide_1: |-
163-
client.get_index('jackets').update_settings({'distinctAttribute': 'product_id'})
162+
client.index('jackets').update_settings({'distinctAttribute': 'product_id'})
164163
field_properties_guide_searchable_1: |-
165-
client.get_index('movies').update_settings({
164+
client.index('movies').update_settings({
166165
'searchableAttributes': [
167166
'uid',
168167
'movie_id',
@@ -173,7 +172,7 @@ field_properties_guide_searchable_1: |-
173172
'rank'
174173
]})
175174
field_properties_guide_displayed_1: |-
176-
client.get_index('movies').update_settings({
175+
client.index('movies').update_settings({
177176
'displayedAttributes': [
178177
'title',
179178
'description',
@@ -182,75 +181,75 @@ field_properties_guide_displayed_1: |-
182181
'rank'
183182
]})
184183
filtering_guide_1: |-
185-
client.get_index('movies').search('Avengers', {
184+
client.index('movies').search('Avengers', {
186185
'filters': 'release_date > 795484800'
187186
})
188187
filtering_guide_2: |-
189-
client.get_index('movies').search('Batman', {
188+
client.index('movies').search('Batman', {
190189
'filters': 'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan")'
191190
})
192191
filtering_guide_3: |-
193-
client.get_index('movies').search('horror', {
192+
client.index('movies').search('horror', {
194193
'filters': 'director = "Jordan Peele"'
195194
})
196195
filtering_guide_4: |-
197-
client.get_index('movies').search('Planet of the Apes', {
196+
client.index('movies').search('Planet of the Apes', {
198197
'filters': 'rating >= 3 AND (NOT director = "Tim Burton")'
199198
})
200199
search_parameter_guide_query_1: |-
201-
client.get_index('movies').search('shifu')
200+
client.index('movies').search('shifu')
202201
search_parameter_guide_offset_1: |-
203-
client.get_index('movies').search('shifu', {
202+
client.index('movies').search('shifu', {
204203
'offset': 1
205204
})
206205
search_parameter_guide_limit_1: |-
207-
client.get_index('movies').search('shifu', {
206+
client.index('movies').search('shifu', {
208207
'limit': 2
209208
})
210209
search_parameter_guide_retrieve_1: |-
211-
client.get_index('movies').search('shifu', {
210+
client.index('movies').search('shifu', {
212211
'attributesToRetrieve': ['overview', 'title']
213212
})
214213
search_parameter_guide_crop_1: |-
215-
client.get_index('movies').search('shifu', {
214+
client.index('movies').search('shifu', {
216215
'attributesToCrop': ['overview'],
217216
'cropLength': 10
218217
})
219218
search_parameter_guide_highlight_1: |-
220-
client.get_index('movies').search('shifu', {
219+
client.index('movies').search('shifu', {
221220
'attributesToHighlight': ['overview']
222221
})
223222
search_parameter_guide_filter_1: |-
224-
client.get_index('movies').search('n', {
223+
client.index('movies').search('n', {
225224
'filters': 'title = Nightshift'
226225
})
227226
search_parameter_guide_filter_2: |-
228-
client.get_index('movies').search('n', {
227+
client.index('movies').search('n', {
229228
'filters': 'title = "Kung Fu Panda"'
230229
})
231230
search_parameter_guide_matches_1: |-
232-
client.get_index('movies').search('n', {
231+
client.index('movies').search('n', {
233232
'filters': 'title = "Kung Fu Panda"',
234233
'attributesToHighlight': ['overview'],
235234
'matches': 'true'
236235
})
237236
settings_guide_synonyms_1: |-
238-
client.get_index('movies').update_settings({
237+
client.index('movies').update_settings({
239238
'synonyms': {
240239
sweater: ['jumper'],
241240
jumper: ['sweater']
242241
},
243242
})
244243
settings_guide_stop_words_1: |-
245-
client.get_index('movies').update_settings({
244+
client.index('movies').update_settings({
246245
'stopWords': [
247246
'the',
248247
'a',
249248
'an'
250249
],
251250
})
252251
settings_guide_ranking_rules_1: |-
253-
client.get_index('movies').update_settings({
252+
client.index('movies').update_settings({
254253
'rankingRules': [
255254
'typo',
256255
'words',
@@ -263,11 +262,11 @@ settings_guide_ranking_rules_1: |-
263262
]
264263
})
265264
settings_guide_distinct_1: |-
266-
client.get_index('movies').update_settings({
265+
client.index('movies').update_settings({
267266
'distinctAttribute': 'product_id'
268267
})
269268
settings_guide_searchable_1: |-
270-
client.get_index('movies').update_settings({
269+
client.index('movies').update_settings({
271270
'searchableAttributes': [
272271
'uid',
273272
'movie_id',
@@ -279,7 +278,7 @@ settings_guide_searchable_1: |-
279278
]
280279
})
281280
settings_guide_displayed_1: |-
282-
client.get_index('movies').update_settings({
281+
client.index('movies').update_settings({
283282
'displayedAttributes': [
284283
'title',
285284
'description',
@@ -289,17 +288,17 @@ settings_guide_displayed_1: |-
289288
]
290289
})
291290
documents_guide_add_movie_1: |-
292-
client.get_index('movies').add_documents([{
291+
client.index('movies').add_documents([{
293292
'movie_id': '123sq178',
294293
'title': 'Amélie Poulain'
295294
}])
296295
search_guide_1: |-
297-
client.get_index('movies').search('shifu', {
296+
client.index('movies').search('shifu', {
298297
'limit': 5,
299298
'offset': 10
300299
})
301300
search_guide_2: |-
302-
client.get_index('movies').search('Avengers', {
301+
client.index('movies').search('Avengers', {
303302
'filters': 'release_date > 795484800'
304303
})
305304
getting_started_create_index_md: |-
@@ -332,31 +331,31 @@ getting_started_search_md: |-
332331
333332
[About this package](https://github.com/meilisearch/meilisearch-python/)
334333
faceted_search_update_settings_1: |-
335-
client.get_index('movies').update_attributes_for_faceting([
334+
client.index('movies').update_attributes_for_faceting([
336335
'director',
337336
'genres',
338337
])
339338
faceted_search_facet_filters_1: |-
340-
client.get_index('movies').search('thriller', {
339+
client.index('movies').search('thriller', {
341340
'facetFilters': [['genres:Horror', 'genres:Mystery'], 'director:Jordan Peele']
342341
})
343342
faceted_search_facets_distribution_1: |-
344-
client.get_index('movies').search('Batman', {
343+
client.index('movies').search('Batman', {
345344
'facetsDistribution': ['genres']
346345
})
347346
faceted_search_walkthrough_attributes_for_faceting_1: |-
348-
client.get_index('movies').update_attributes_for_faceting([
347+
client.index('movies').update_attributes_for_faceting([
349348
'director',
350349
'producer',
351350
'genres',
352351
'production_companies'
353352
])
354353
faceted_search_walkthrough_facet_filters_1: |-
355-
client.get_index('movies').search('thriller', {
354+
client.index('movies').search('thriller', {
356355
'facetFilters': [['genres:Horror', 'genres:Mystery'], 'director:Jordan Peele']
357356
})
358357
faceted_search_walkthrough_facets_distribution_1: |-
359-
client.get_index('movies').search('Batman', {
358+
client.index('movies').search('Batman', {
360359
'facetsDistribution': ['genres']
361360
})
362361
post_dump_1: |-

0 commit comments

Comments
 (0)