Extend update docs to mention possible data fragmentation #2164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vasil-pashov
requested review from
alexowens90,
willdealtry and
poodlewars
as code owners
vasil-pashov
commented
Feb 3, 2025
| @@ -966,9 +966,9 @@ def append( | |||
| metadata | |||
| Optional metadata to persist along with the new symbol version. Note that the metadata is | |||
| not combined in any way with the metadata stored in the previous version. | |||
| prune_previous_versions, default=False | |||
There was a problem hiding this comment.
This and validate_index were causing mkdocs serve -s -a 0.0.0.0:8000 to fail in strict mode with
WARNING - griffe: /home/vasil/Documents/source/ArcticDB/python/arcticdb/version_store/library.py:973: Parameter 'default' does not appear in the function signature
mkdocs parses the function signature and can show the default without mentioning it in the docstring.
vasil-pashov
force-pushed
the
vasil.pashov/extend-update-docs
branch
from
581a1ab to
72fd0f1
Compare
poodlewars
reviewed
Feb 3, 2025
| @@ -1099,6 +1099,9 @@ def update( | |||
| If dynamic schema is used then data will override everything in storage for the entire index of ``data``. Update | |||
| will not keep columns from storage which are not in ``data``. | |||
| The update will split the first and last segments in the storage that intersect with 'data'. Therefore, frequent | |||
There was a problem hiding this comment.
calls to the update should be calls to update
poodlewars
reviewed
Feb 3, 2025
| @@ -1151,6 +1154,25 @@ def update( | |||
| 2018-01-01 400 | |||
| 2018-01-03 40 | |||
| 2018-01-04 4 | |||
| Update will split the first and the last segment intersecting with ``data`` | |||
There was a problem hiding this comment.
Perhaps better to put this as a guide in our docs with more context rather than in the docstring? I don't think most users will have the context about what a segment is, what read_index does etc etc and it will all get too long to explain in the docstring
poodlewars
approved these changes
Feb 3, 2025
IvoDD
approved these changes
Feb 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
What does this implement or fix?
Any other comments?
Checklist
Checklist for code changes...