Docs: Update information about metrics mode#16391
Open
psvri wants to merge 1 commit into
Open
Conversation
pvary
reviewed
May 19, 2026
Comment on lines
+96
to
+103
| Notes: | ||
|
|
||
| 1. Metrics modes are explained below: | ||
| - `none`: In this mode, `value_counts`, `null_value_counts`, `nan_value_counts`, `lower_bounds`, and `upper_bounds` are not persisted. | ||
| - `counts`: In this mode, `value_counts`, `null_value_counts`, and `nan_value_counts` are persisted. | ||
| - `truncate(length)`: In this mode, `value_counts`, `null_value_counts`, `nan_value_counts`, truncated `lower_bounds`, and truncated `upper_bounds` are persisted. Only string and binary values are truncated to the specified length. For other types, values are written as is. | ||
| - `full`: In this mode, `value_counts`, `null_value_counts`, `nan_value_counts`, full `lower_bounds`, and full `upper_bounds` are persisted. | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| Notes: | |
| 1. Metrics modes are explained below: | |
| - `none`: In this mode, `value_counts`, `null_value_counts`, `nan_value_counts`, `lower_bounds`, and `upper_bounds` are not persisted. | |
| - `counts`: In this mode, `value_counts`, `null_value_counts`, and `nan_value_counts` are persisted. | |
| - `truncate(length)`: In this mode, `value_counts`, `null_value_counts`, `nan_value_counts`, truncated `lower_bounds`, and truncated `upper_bounds` are persisted. Only string and binary values are truncated to the specified length. For other types, values are written as is. | |
| - `full`: In this mode, `value_counts`, `null_value_counts`, `nan_value_counts`, full `lower_bounds`, and full `upper_bounds` are persisted. | |
| Notes: | |
| 1. Available metrics modes: | |
| - none: No metrics are persisted | |
| - counts: Only count metrics are persisted (value_counts, null_value_counts, nan_value_counts). | |
| - truncate(length): Persists counts plus truncated bounds (lower_bounds, upper_bounds). Truncation applies only to string and binary types; all other types are stored as-is. | |
| - full: Persists all metrics, including full lower_bounds and upper_bounds. | |
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.
I noticed that there is currently no documentation describing the various metrics modes that can be configured for a table via the table properties
write.metadata.metrics.defaultandwrite.metadata.metrics.column.col1. With the introduction of file format api , it would be helpful to document this to provide clearer guidance for integrators using this API.