Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@xsedla1o
Copy link
Collaborator

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 parameter generic_filter. The model returned by /entities has been changed to include the type of entity ID under the id_data_type key.

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.

@xsedla1o xsedla1o requested a review from dbnk0 November 18, 2024 13:24
Copy link
Collaborator

@dbnk0 dbnk0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@xsedla1o xsedla1o merged commit 82db363 into master Nov 19, 2024
4 checks passed
@xsedla1o xsedla1o deleted the custom_db_types branch November 21, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants