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

Add Metadata Layer to Pickled Data #81

Open
florian-vuillemot opened this issue Dec 22, 2024 · 0 comments
Open

Add Metadata Layer to Pickled Data #81

florian-vuillemot opened this issue Dec 22, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@florian-vuillemot
Copy link
Contributor

Description

Currently, pickles are uploaded without an internal metadata layer, which may cause compatibility issues in the future.

To address this, a metadata layer should be added to each stored pickle, as in the encryption module.

By incorporating this metadata, cshelve will support:

  1. Backward Compatibility: The ability to parse existing storage to determine whether it adheres to the current cshelve format or an older one.
  2. Seamless Migrations: Allows future enhancements (e.g., applying encryption or compression) without requiring service interruptions.

Acceptance Criteria

  1. Legacy pickles without the metadata layer are detected and handled without breaking existing projects.
  2. Migration scripts can leverage the metadata layer for seamless upgrades.
  3. Ensure the metadata is designed to support incremental changes (e.g., versioning for future enhancements).
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

No branches or pull requests

1 participant