docs: clarify getDerivedClasses behavior regarding unloaded referencing schemas (#8047) #8795
+109
−14
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.
Fixes #8047.
Analysis:
getDerivedClassesrelies on the currentSchemaContextto identify subclasses. SinceSchemaContextdoes not maintain a reverse-index of all possible external schemas that might reference a base class, it is architecturally impossible for this method to return classes from unloaded schemas without a global pre-scan.Changes:
core/backenddemonstrating thatgetDerivedClassesreturns empty until the referencing schema is explicitly loaded.getDerivedClassesincore/ecschema-metadatato explicitly warn users that referencing schemas must be loaded into the context to be discovered.This resolves the ambiguity noted by the reporter.