-
Notifications
You must be signed in to change notification settings - Fork 559
(tree) Tag incremental summary APIs as @alpha #25918
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
agarwal-navin
merged 7 commits into
microsoft:main
from
agarwal-navin:incrSummaryAlphaAPIs
Nov 26, 2025
Merged
(tree) Tag incremental summary APIs as @alpha #25918
agarwal-navin
merged 7 commits into
microsoft:main
from
agarwal-navin:incrSummaryAlphaAPIs
Nov 26, 2025
Conversation
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
noencke
reviewed
Nov 25, 2025
noencke
reviewed
Nov 25, 2025
| } | ||
|
|
||
| export interface SharedTreeOptionsInternal | ||
| extends Partial<SharedTreeOptions>, |
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this should be a Partial. If SharedTreeOptionsPublic or Beta or Alpha has a required parameter, then SharedTreeOptionsInternal needs to supply that as well to be compatible.
noencke
approved these changes
Nov 25, 2025
Contributor
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
noencke
approved these changes
Nov 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area: dds: tree
area: dds
Issues related to distributed data structures
area: framework
Framework is a tag for issues involving the developer framework. Eg Aqueduct
base: main
PRs targeted against main branch
public api change
Changes to a public API
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.
The APIs neede to enable incremental summary have been tagged as @ alpha so that they can be used by applications.
The list of APIs that are marked @ alpha:
configuredSharedTreeAlpha- This is a new API which is similar toconfiguredSharedTreeBetabut has a couple more options exposed for configuring incremental summaries.SharedTreeOptionsAlpha- Extension ofSharedTreeOptionsBetathat includes options to enable incremental summarization.IncrementalEncodingPolicy- Policy type to determine whether a node / field should be incrementally encoded.incrementalEncodingPolicyForAllowedTypes- This function returns anIncrementalEncodingPolicywhich will determine ifAllowedTypesare opted into incremental summarization.incrementalSummaryHint- This is a symbol that should be put in the metadata property ofAllowedTypesto opt-in these types to be incrementally summarized.AB#54252
AB#46028