documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Make users aware of data.ms

Open bidoubiwa opened this issue 4 years ago • 1 comments

There is too little mention of data.ms in the documentation. Meaning users are confused when updating MeiliSearch to a new version. We should find ways to integrate that knowledge into our documentation.

What is data.ms?

data.ms is the default folder name for the database in MeiliSearch. It is in this folder that the database is stored with all its indexes, documents, settings, and updates.

Data.ms name can change using --db-path CLI option.

Data.ms is bound to the version it was created on. Meaning that if you update MeiliSearch you need to delete and recreate the database. Using dumps you can keep your data between versions.

bidoubiwa avatar Nov 04 '20 14:11 bidoubiwa

@meilisearch/docs-team what would be the best place for this? I could only think of the Update to the latest Meilisearch version page or under "Data backup".

maryamsulemani97 avatar Apr 12 '22 12:04 maryamsulemani97

So, IMHO

Data.ms is bound to the version it was created on. Meaning that if you update MeiliSearch you need to delete and recreate the database

This should go under "Data backup", probably both in "Snapshots" and "Dumps". Just a brief mention, though.

Might make sense to mention it on "Updating Meilisearch", but not sure. The info there seems to be enough, but an extra sentence can't hurt.

data.ms is the default folder name for the database in MeiliSearch

I think this could go as a new first section under "Advanced topics" > "Inner Workings" > "Storage". I think it's good to anchor the content in that page to something very concrete like an actual folder.

guimachiavelli avatar Oct 17 '22 14:10 guimachiavelli