Skip to content

Changes due to the implicit index creation #175

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 7 commits into from
Nov 17, 2020
Merged

Changes due to the implicit index creation #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
baca2de
Add code-samples
curquiza Nov 13, 2020
abf4928
Update Getting Started in README.md
curquiza Nov 13, 2020
652868f
Update code and tests with implicit index creation changes
curquiza Nov 13, 2020
6438fe6
Update comments
curquiza Nov 16, 2020
49cbeed
Update code-samples
curquiza Nov 17, 2020
ed86de1
Change get_or_create_index
curquiza Nov 17, 2020
ed5489c
Fix code-samples
curquiza Nov 17, 2020
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
135 changes: 66 additions & 69 deletions .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,51 @@
# You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples
---
get_one_index_1: |-
client.get_index('movies').info()
client.get_index('movies')
list_all_indexes_1: |-
client.get_indexes()
create_an_index_1: |-
client.create_index('movies', {'primaryKey': 'movie_id'})
update_an_index_1: |-
client.get_index('movies').update(primaryKey='movie_review_id')
client.index('movies').update(primaryKey='movie_review_id')
delete_an_index_1: |-
client.get_index('movies').delete()
client.index('movies').delete()
get_one_document_1: |-
client.get_index('movies').get_document(25684)
client.index('movies').get_document(25684)
get_documents_1: |-
client.get_index('movies').get_documents({'limit':2})
client.index('movies').get_documents({'limit':2})
add_or_replace_documents_1: |-
client.get_index('movies').add_documents([{
client.index('movies').add_documents([{
'id': 287947,
'title': 'Shazam',
'poster': 'https://image.tmdb.org/t/p/w1280/xnopI5Xtky18MPhK40cZAGAOVeV.jpg',
'overview': 'A boy is given the ability to become an adult superhero in times of need with a single magic word.',
'release_date': '2019-03-23'
}])
add_or_update_documents_1: |-
client.get_index('movies').update_documents([{
client.index('movies').update_documents([{
'id': 287947,
'title': 'Shazam ⚡️',
'genres': 'comedy'
}])
delete_all_documents_1: |-
client.get_index('movies').delete_all_documents()
client.index('movies').delete_all_documents()
delete_one_document_1: |-
client.get_index('movies').delete_document(25684)
client.index('movies').delete_document(25684)
delete_documents_1: |-
client.get_index('movies').delete_documents([23488, 153738, 437035, 363869])
client.index('movies').delete_documents([23488, 153738, 437035, 363869])
search_1: |-
client.get_index('movies').search('American ninja')
client.index('movies').search('American ninja')
get_update_1: |-
client.get_index('movies').get_update_status(1)
client.index('movies').get_update_status(1)
get_all_updates_1: |-
client.get_index('movies').get_all_update_status()
client.index('movies').get_all_update_status()
get_keys_1: |-
client.get_keys()
get_settings_1: |-
client.get_index('movies').get_settings()
client.index('movies').get_settings()
update_settings_1: |-
client.get_index('movies').update_settings({
client.index('movies').update_settings({
'rankingRules': [
'typo',
'words',
Expand Down Expand Up @@ -88,27 +88,27 @@ update_settings_1: |-
'acceptNewFields': False
})
reset_settings_1: |-
client.get_index('movies').reset_settings()
client.index('movies').reset_settings()
get_synonyms_1: |-
client.get_index('movies').get_synonyms()
client.index('movies').get_synonyms()
update_synonyms_1: |-
client.get_index('movies').update_synonyms({
client.index('movies').update_synonyms({
'wolverine': ['xmen', 'logan'],
'logan': ['wolverine', 'xmen'],
'wow': ['world of warcraft']
})
reset_synonyms_1: |-
client.get_index('movies').reset_synonyms()
client.index('movies').reset_synonyms()
get_stop_words_1: |-
client.get_index('movies').get_stop_words()
client.index('movies').get_stop_words()
update_stop_words_1: |-
client.get_index('movies').update_stop_words(['of', 'the', 'to'])
client.index('movies').update_stop_words(['of', 'the', 'to'])
reset_stop_words_1: |-
client.get_index('movies').reset_stop_words()
client.index('movies').reset_stop_words()
get_ranking_rules_1: |-
client.get_index('movies').get_ranking_rules()
client.index('movies').get_ranking_rules()
update_ranking_rules_1: |-
client.get_index('movies').update_ranking_rules([
client.index('movies').update_ranking_rules([
'typo',
'words',
'proximity',
Expand All @@ -119,50 +119,47 @@ update_ranking_rules_1: |-
'desc(rank)'
])
reset_ranking_rules_1: |-
client.get_index('movies').reset_ranking_rules()
client.index('movies').reset_ranking_rules()
get_distinct_attribute_1: |-
client.get_index('movies').get_distinct_attribute()
client.index('movies').get_distinct_attribute()
update_distinct_attribute_1: |-
client.get_index('movies').update_distinct_attribute('movie_id')
client.index('movies').update_distinct_attribute('movie_id')
reset_distinct_attribute_1: |-
client.get_index('movies').reset_distinct_attribute()
client.index('movies').reset_distinct_attribute()
get_searchable_attributes_1: |-
client.get_index('movies').get_searchable_attributes()
client.index('movies').get_searchable_attributes()
update_searchable_attributes_1: |-
client.get_index('movies').update_searchable_attributes([
client.index('movies').update_searchable_attributes([
'title',
'description',
'uid'
])
reset_searchable_attributes_1: |-
client.get_index('movies').reset_searchable_attributes()
client.index('movies').reset_searchable_attributes()
get_displayed_attributes_1: |-
client.get_index('movies').get_displayed_attributes()
client.index('movies').get_displayed_attributes()
update_displayed_attributes_1: |-
client.get_index('movies').update_displayed_attributes([
client.index('movies').update_displayed_attributes([
"title",
'description',
'release_date',
'rank',
'poster'
])
reset_displayed_attributes_1: |-
client.get_index('movies').reset_displayed_attributes()
client.index('movies').reset_displayed_attributes()
get_index_stats_1: |-
client.get_index('movies').get_stats()
client.index('movies').get_stats()
get_indexes_stats_1: |-
client.get_all_stats()
get_health_1: |-
client.health()
get_version_1: |-
clien.get_version()
get_pretty_sys_info_1: |-
get_sys_info_1: |-
client.get_sys_info()
distinct_attribute_guide_1: |-
client.get_index('jackets').update_settings({'distinctAttribute': 'product_id'})
client.index('jackets').update_settings({'distinctAttribute': 'product_id'})
field_properties_guide_searchable_1: |-
client.get_index('movies').update_settings({
client.index('movies').update_settings({
'searchableAttributes': [
'uid',
'movie_id',
Expand All @@ -173,7 +170,7 @@ field_properties_guide_searchable_1: |-
'rank'
]})
field_properties_guide_displayed_1: |-
client.get_index('movies').update_settings({
client.index('movies').update_settings({
'displayedAttributes': [
'title',
'description',
Expand All @@ -182,75 +179,75 @@ field_properties_guide_displayed_1: |-
'rank'
]})
filtering_guide_1: |-
client.get_index('movies').search('Avengers', {
client.index('movies').search('Avengers', {
'filters': 'release_date > 795484800'
})
filtering_guide_2: |-
client.get_index('movies').search('Batman', {
client.index('movies').search('Batman', {
'filters': 'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan")'
})
filtering_guide_3: |-
client.get_index('movies').search('horror', {
client.index('movies').search('horror', {
'filters': 'director = "Jordan Peele"'
})
filtering_guide_4: |-
client.get_index('movies').search('Planet of the Apes', {
client.index('movies').search('Planet of the Apes', {
'filters': 'rating >= 3 AND (NOT director = "Tim Burton")'
})
search_parameter_guide_query_1: |-
client.get_index('movies').search('shifu')
client.index('movies').search('shifu')
search_parameter_guide_offset_1: |-
client.get_index('movies').search('shifu', {
client.index('movies').search('shifu', {
'offset': 1
})
search_parameter_guide_limit_1: |-
client.get_index('movies').search('shifu', {
client.index('movies').search('shifu', {
'limit': 2
})
search_parameter_guide_retrieve_1: |-
client.get_index('movies').search('shifu', {
client.index('movies').search('shifu', {
'attributesToRetrieve': ['overview', 'title']
})
search_parameter_guide_crop_1: |-
client.get_index('movies').search('shifu', {
client.index('movies').search('shifu', {
'attributesToCrop': ['overview'],
'cropLength': 10
})
search_parameter_guide_highlight_1: |-
client.get_index('movies').search('shifu', {
client.index('movies').search('shifu', {
'attributesToHighlight': ['overview']
})
search_parameter_guide_filter_1: |-
client.get_index('movies').search('n', {
client.index('movies').search('n', {
'filters': 'title = Nightshift'
})
search_parameter_guide_filter_2: |-
client.get_index('movies').search('n', {
client.index('movies').search('n', {
'filters': 'title = "Kung Fu Panda"'
})
search_parameter_guide_matches_1: |-
client.get_index('movies').search('n', {
client.index('movies').search('n', {
'filters': 'title = "Kung Fu Panda"',
'attributesToHighlight': ['overview'],
'matches': 'true'
})
settings_guide_synonyms_1: |-
client.get_index('movies').update_settings({
client.index('movies').update_settings({
'synonyms': {
sweater: ['jumper'],
jumper: ['sweater']
},
})
settings_guide_stop_words_1: |-
client.get_index('movies').update_settings({
client.index('movies').update_settings({
'stopWords': [
'the',
'a',
'an'
],
})
settings_guide_ranking_rules_1: |-
client.get_index('movies').update_settings({
client.index('movies').update_settings({
'rankingRules': [
'typo',
'words',
Expand All @@ -263,11 +260,11 @@ settings_guide_ranking_rules_1: |-
]
})
settings_guide_distinct_1: |-
client.get_index('movies').update_settings({
client.index('movies').update_settings({
'distinctAttribute': 'product_id'
})
settings_guide_searchable_1: |-
client.get_index('movies').update_settings({
client.index('movies').update_settings({
'searchableAttributes': [
'uid',
'movie_id',
Expand All @@ -279,7 +276,7 @@ settings_guide_searchable_1: |-
]
})
settings_guide_displayed_1: |-
client.get_index('movies').update_settings({
client.index('movies').update_settings({
'displayedAttributes': [
'title',
'description',
Expand All @@ -289,17 +286,17 @@ settings_guide_displayed_1: |-
]
})
documents_guide_add_movie_1: |-
client.get_index('movies').add_documents([{
client.index('movies').add_documents([{
'movie_id': '123sq178',
'title': 'Amélie Poulain'
}])
search_guide_1: |-
client.get_index('movies').search('shifu', {
client.index('movies').search('shifu', {
'limit': 5,
'offset': 10
})
search_guide_2: |-
client.get_index('movies').search('Avengers', {
client.index('movies').search('Avengers', {
'filters': 'release_date > 795484800'
})
getting_started_create_index_md: |-
Expand Down Expand Up @@ -332,31 +329,31 @@ getting_started_search_md: |-

[About this package](https://github.com/meilisearch/meilisearch-python/)
faceted_search_update_settings_1: |-
client.get_index('movies').update_attributes_for_faceting([
client.index('movies').update_attributes_for_faceting([
'director',
'genres',
])
faceted_search_facet_filters_1: |-
client.get_index('movies').search('thriller', {
client.index('movies').search('thriller', {
'facetFilters': [['genres:Horror', 'genres:Mystery'], 'director:Jordan Peele']
})
faceted_search_facets_distribution_1: |-
client.get_index('movies').search('Batman', {
client.index('movies').search('Batman', {
'facetsDistribution': ['genres']
})
faceted_search_walkthrough_attributes_for_faceting_1: |-
client.get_index('movies').update_attributes_for_faceting([
client.index('movies').update_attributes_for_faceting([
'director',
'producer',
'genres',
'production_companies'
])
faceted_search_walkthrough_facet_filters_1: |-
client.get_index('movies').search('thriller', {
client.index('movies').search('thriller', {
'facetFilters': [['genres:Horror', 'genres:Mystery'], 'director:Jordan Peele']
})
faceted_search_walkthrough_facets_distribution_1: |-
client.get_index('movies').search('Batman', {
client.index('movies').search('Batman', {
'facetsDistribution': ['genres']
})
post_dump_1: |-
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ NB: you can also download MeiliSearch from **Homebrew** or **APT**.
import meilisearch

client = meilisearch.Client('http://127.0.0.1:7700', 'masterKey')
index = client.create_index('books') # If your index does not exist
index = client.get_index('books') # If you already created your index

# An index is where the documents are stored.
index = client.index('books')

documents = [
{ 'book_id': 123, 'title': 'Pride and Prejudice' },
Expand All @@ -79,6 +80,7 @@ documents = [
{ 'book_id': 42, 'title': 'The Hitchhiker\'s Guide to the Galaxy' }
]

# If the index 'books' does not exist, MeiliSearch creates it when you first add the documents.
index.add_documents(documents) # => { "updateId": 0 }
```

Expand Down
Loading