docs(orm): document ORM framework (entity.h, ENTITY_TABLE/ENTITY_FIELD macros)#358
Merged
Merged
Conversation
Document the ORM framework including entity definition macros (ENTITY_TABLE, ENTITY_FIELD, ENTITY_METADATA), supported types and SQL mapping, field constraints, CRUD operations, query builder API, schema management, metadata system, and limitations. Update API_REFERENCE.md with corrected ORM examples and cross-reference.
7 tasks
The ENTITY_METADATA lazy initialization uses a non-atomic static bool, which is not thread-safe. Update documentation to accurately describe the behavior and add it to the limitations table.
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
…D macros) (#358) * docs(orm): add comprehensive ORM framework guide (#354) Document the ORM framework including entity definition macros (ENTITY_TABLE, ENTITY_FIELD, ENTITY_METADATA), supported types and SQL mapping, field constraints, CRUD operations, query builder API, schema management, metadata system, and limitations. Update API_REFERENCE.md with corrected ORM examples and cross-reference. * docs(orm): fix inaccurate thread-safety claim in ENTITY_METADATA docs The ENTITY_METADATA lazy initialization uses a non-atomic static bool, which is not thread-safe. Update documentation to accurately describe the behavior and add it to the limitations table.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #354
Summary
docs/ORM_GUIDE.mdcovering entity definition, macro system, CRUD operations, query builder, schema management, and limitationsdocs/API_REFERENCE.mdwith corrected ORM examples and cross-reference to the new guideChanges
New Files
docs/ORM_GUIDE.md— Complete ORM documentation with:ENTITY_TABLE,ENTITY_FIELD,ENTITY_METADATAwith exact syntaxModified Files
docs/API_REFERENCE.md— Updated ORM section with correct entity_manager usage pattern and link to guideTest Plan
cmake --buildpasses)