Feature: Binary storage of selected types. #27
Merged
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
Modified collection getters to include codec. The "JSON friendly" is passed to outside API.
Updated tests in the process.
xsedla1o
force-pushed
the
custom_db_types
branch
from
9a8387a to
8a82fbf
Compare
xsedla1o
force-pushed
the
custom_db_types
branch
from
8a82fbf to
6fdf16f
Compare
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.
Changes how types that are not JSON and BSON native are handled.
IP and MAC as packed binary: IP and MAC addresses are now parsed into python objects instead of only being validated, but remaining as strings. They are also stored using user-defined binary subtypes in MongoDB, which is more efficient on storage space.
Entity ID type: The type of entity ID can now be configured to a subset of primitive types, including IP and MAC addresses. This is desirable, as smaller identifiers lead to smaller indexes and overall more efficient DB resource usage. The identifiers of snapshot buckets have been converted to use a binary encoding as well with the same justification.
API changes: To query the non-JSON native types, a search and replace module (
dp3.database.magic) has been introduced to the API endpoint/entity/{etype}query parametergeneric_filter. The model returned by/entitieshas been changed to include the type of entity ID under theid_data_typekey.DB schema changes: The new type information of entity ID is stored in the DB schema, which requires a new schema version. This migration is minor, as only schema accounting changes the Entity ID to be the previously used string type. In case a system changes its Entity ID type configuration, the only supported migration for now is to drop all records of that entity.