Skip to content
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

Jump to bottom

Changes related to the new task API #276

Merged
merged 5 commits into from Dec 14, 2021
Merged

Changes related to the new task API #276

merged 5 commits into from Dec 14, 2021

Conversation

curquiza
Copy link
Member

@curquiza curquiza commented Dec 13, 2021 •
edited

Breaking changes

  • create_index, update_index and delete_index are now asynchrone regarding MeiliSearch and do not return a Index instance anymore, but a task object. Please use index() method instead.
  • Rename index.get_all_update_status into index.tasks
  • Rename index.get_update_status into index.task
  • wait_for_pending_update is renamed into wait_for_task and is accessible from index and from client

Improvements

  • Add new method create_index! that creates an index synchronously regarding MeiliSearch. Be careful using it, this can block your code in production.
  • Add new methods client.tasks and client.task

Misc

  • delete_if_exists and get_or_create_index are commented since we don't know yet if we will remove them or not.

Why the tests are still failing?

@curquiza curquiza changed the title First verison of the new task API Changes related to the new task API Dec 13, 2021
@curquiza curquiza added the breaking-change The related changes are breaking for the users label Dec 13, 2021
@curquiza curquiza force-pushed the task-api branch 4 times, most recently from a445d7c to 7ea63fd Compare December 13, 2021 19:33
@curquiza curquiza marked this pull request as ready for review December 14, 2021 14:38
alallema
alallema approved these changes Dec 14, 2021
View reviewed changes
Copy link
Contributor

@alallema alallema left a comment

Choose a reason for hiding this comment

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

Well done 💪 !
LGTM! 🎉

@curquiza curquiza merged commit 8893955 into bump-meilisearch-v0.25.0 Dec 14, 2021
@curquiza curquiza deleted the task-api branch December 14, 2021 17:41
@curquiza curquiza mentioned this pull request Jan 12, 2022
Merged
meili-bors bot added a commit that referenced this pull request Jan 12, 2022
@meili-bors @curquiza
Merge #289
5f282ef 
289: Update version for the next release (v0.18.0) r=brunoocasali a=curquiza

Why is it breaking?
- #276
- #277
- #278
- #273

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alallema alallema alallema approved these changes

Assignees
No one assigned
Labels
breaking-change The related changes are breaking for the users
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@curquiza @alallema