docs: Add data definition document #2544
Conversation
AndrewSisley
added
documentation
This can be expanded over time.
AndrewSisley
force-pushed
the
2538-data-def-docs
branch
from
9d74f9f
to
705a58a
Compare
client/data_definition.md
Outdated
|
|
||
| ## Global definitions | ||
|
|
||
| Global definitions are consistent across all nodes in the decentralized network of nodes in the database. This is enforced by the use of things like CIDs for schema versions. If a global definition was to differ across nodes, the different variations will be treated as a completely different definitions. |
There was a problem hiding this comment.
suggestion: Global definitions are consistent across all nodes in the decentralized network of nodes in the database
There was a problem hiding this comment.
Will do :) I wasn't terribly confident writing that last bit out, so I'm very glad you spoke up :)
- Drop extra words
client/data_definition.md
Outdated
|
|
||
| `CollectionDescription` instances may be active or inactive. Inactive `CollectionDescription`s will not have a name, and cannot be queried. | ||
|
|
||
| When a new [schema](#schemas) version is created for a schema that has a collection defined for it, a new `CollectionDescription` instance will be created and linked to the new schema version. The new `CollectionDescription` instance will share the same root ID as the previous, and may be active or inactive depending on what arguments the user defining the new schema specified. |
There was a problem hiding this comment.
suggestion: When a new schema version is created for a schema that and has a collection defined for it, a new CollectionDescription instance will be created and linked to the new schema version.
There was a problem hiding this comment.
Yeah, I think I agree - will do, thanks Keenan :)
- Remove extra words
There was a problem hiding this comment.
praise: The italics on and in your suggestion saved me a bit of hassle, thanks for bothering to add that :)
Relevant issue(s)
Resolves #2538
Description
Adds data definition document, documenting how data is defined.
It is targeted at us, and anyone looking to embed defradb in their application.