Add relations() virtual table tests and documentation#9240
Draft
khanaffan wants to merge 1 commit into
Draft
Conversation
- Add comprehensive test suite (RelationsVTab.test.ts) with 16 tests covering link-table traversal, JOINs, recursive CTE, chained cross-join, BFS, graph set operations, edge cases, and real iModel traversal - All queries use ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES (feature is experimental) - Add ECSQL reference doc (RelationsVTab.md) with syntax, examples, and notes - Add practical patterns guide (RelationshipTraversal.md) with 6 patterns - Update NextVersion.md changelog with experimental note and CTE examples - Add navigation links in index.md and leftNav.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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.
Summary
Add comprehensive tests and documentation for the new experimental
relations()virtual table (ECVLib.Relations), which provides fast one-hop relationship traversal.Changes
Tests (
core/backend/src/test/ecdb/RelationsVTab.test.ts)ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURESDocumentation
docs/learning/ECSqlReference/RelationsVTab.md— ECSQL reference: syntax, columns, examples (basic, directional, JOIN, cross-join, chained, recursive CTE, subquery), TypeScript usage, comparison tabledocs/learning/backend/RelationshipTraversal.md— Practical patterns: 6 patterns (neighbors, directional, JOINs, multi-hop CTE/cross-join/BFS, graph set ops, impact analysis)docs/changehistory/NextVersion.md— Changelog entry with experimental note and examplesindex.mdandleftNav.mdAll docs include prominent experimental feature callouts noting the
ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURESrequirement.Validation
npx mocha --grep "relations" lib/cjs/test/ecdb/RelationsVTab.test.js— 16 passing, 3 pending