From d14790824d3ca88799c513b257eb99bb7e9f0e1d Mon Sep 17 00:00:00 2001 From: Tamo Date: Wed, 19 Feb 2025 16:40:31 +0100 Subject: [PATCH] itnroduce dumpless upgrade sprint issue note --- .github/ISSUE_TEMPLATE/sprint_issue.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/sprint_issue.md b/.github/ISSUE_TEMPLATE/sprint_issue.md index 84b8f1066..e5fc8a698 100644 --- a/.github/ISSUE_TEMPLATE/sprint_issue.md +++ b/.github/ISSUE_TEMPLATE/sprint_issue.md @@ -32,6 +32,18 @@ Related product discussion: - [ ] Once everything is done, start Meilisearch with the swagger flag: `cargo run --features swagger`, open `http://localhost:7700/scalar` on your browser, and ensure everything works as expected. - For more info, refer to [this presentation](https://pitch.com/v/generating-the-openapi-file-jrn3nh). +### Reminders when modifying a database + +- [ ] If modifying the API keys => Reach out to the team we've not planned anything for that yet +- [ ] If modifying a milli index => + - [ ] You can add the upgrade code to go from the previous to the latest version [here](https://github.com/meilisearch/meilisearch/blob/main/crates/milli/src/update/upgrade/mod.rs) + - [ ] Don't forget to return `true` to update the stats if needed + - [ ] Did the read read part requires a change? (gettings documents, search, facet search etc) + The index must **always** be able to read the old version of the database. Make everything with that in mind + and if the old and new database are not compatible you may need to match on the version of the database and keep both the old and new code. (The version of the index is stored in the main database under the `VERSION_KEY` key) +- [ ] If modifying the task queue or the index-mapper => + - [ ] Update + ### Reminders when modifying the Setting API