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.

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

DATABASE_METADATA.json enhancement #6408

Closed
fab-10 opened this issue Jan 15, 2024 · 1 comment · Fixed by #6555
Closed

DATABASE_METADATA.json enhancement #6408

fab-10 opened this issue Jan 15, 2024 · 1 comment · Fixed by #6555
Labels
enhancement New feature or request

Comments

@fab-10
Copy link
Contributor

fab-10 commented Jan 15, 2024

What do you think about migrating our DATABASE_METADATA.json content to something more talkative?

I mean now we have:
{"version":2}
wouldn't it clearer to have something like:
{"format": "BONSAI", "version": 1}?
Where format field is BONSAI or FOREST and version is the actual iteration of the format.

I am suggesting that, since I need to introduce a new version of the db, to identify the variables storage upgrade, and since it applies to both formats, with the current metadata, I should introduce 3 and 4 respectively from Forest and Bonsai, but I will prefer to have:

  • {"format": "FOREST", "version": 2}
  • {"format": "BONSAI", "version": 2}

Changing the DATABASE_METADATA.json format is a breaking change so we also need to define a migration strategy, and how to version the DATABASE_METADATA itself.

We can consider the current DATABASE_METADATA format, the v1, and it has 2 fields:

  • version
  • privacyVersion

we could introduce v2, changing the format of DATABASE_METADATA.json, adding the version of the metadata itself :

{
  "v2": {
    "format": "BONSAI",
    "version": 2
  }
}
@garyschulte garyschulte added the enhancement New feature or request label Jan 16, 2024
@garyschulte
Copy link
Contributor

relates to #6307

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants