Skip to content

Docs: Document compute_partition_stats procedure #13532

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.

Sign up for GitHub

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
szehon-ho merged 4 commits into from
Jul 17, 2025
Merged

Docs: Document compute_partition_stats procedure #13532

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
809e8a5
Docs: Document compute_partition_stats procedure
ajantha-bhat Jul 11, 2025
55baa4c
Address comments
ajantha-bhat Jul 12, 2025
80cc56e
Address new comment
ajantha-bhat Jul 15, 2025
9ab182f
remove space
ajantha-bhat Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/docs/spark-procedures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -974,6 +974,38 @@ Collect statistics of the snapshot with id `snap1` of table `my_table` for colum
CALL catalog_name.system.compute_table_stats(table => 'my_table', snapshot_id => 'snap1', columns => array('col1', 'col2'));
```

## Partition Statistics

### `compute_partition_stats`

This procedure computes the [partition stats](../../spec.md#partition-statistics) incrementally from the last snapshot that has a `PartitionStatisticsFile`
until the given snapshot (uses current snapshot if not specified) and writes the combined result into a `PartitionStatisticsFile`.
It performs a full compute if the previous partition statistics file does not exist. It also registers the
`PartitionStatisticsFile` to the table metadata.

| Argument Name | Required? | Type | Description |
|---------------|-----------|---------------|--------------------------------------------------------------------------------|
| `table` | ✔️ | string | Name of the table |
| `snapshot_id` | | string | Id of the snapshot to compute partition stats. Defaults to current snapshot id |

#### Output

| Output Name | Type | Description |
|-------------------|--------|----------------------------------------------------------|
| `partition_statistics_file` | string | Path to the partition stats file created from by command |

#### Examples

Collect partition statistics of the latest snapshot of table `my_table`
```sql
CALL catalog_name.system.compute_partition_stats('my_table');
```

Collect partition statistics of the snapshot with id `snap1` of table `my_table`
```sql
CALL catalog_name.system.compute_partition_stats(table => 'my_table', snapshot_id => 'snap1');
```

## Table Replication

The `rewrite_table_path` procedure prepares an Iceberg table for copying to another location.
Expand Down