Skip to content

Docs: Update information about metrics mode#16391

Open
psvri wants to merge 1 commit into
apache:mainfrom
psvri:doc_updates_1
Open

Docs: Update information about metrics mode#16391
psvri wants to merge 1 commit into
apache:mainfrom
psvri:doc_updates_1

Conversation

@psvri
Copy link
Copy Markdown
Contributor

@psvri psvri commented May 18, 2026

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.default and write.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.

@github-actions github-actions Bot added the docs label May 18, 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants