This is an automated email from the ASF dual-hosted git repository.
kevinjqliu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git
The following commit(s) were added to refs/heads/main by this push:
new b84d446897 Spec: Update formatting in tables to use material content
tabs (#14656)
b84d446897 is described below
commit b84d4468979bb29350cd0ab4246a2c56787f8998
Author: Amogh Jahagirdar <[email protected]>
AuthorDate: Fri May 8 11:32:37 2026 -0600
Spec: Update formatting in tables to use material content tabs (#14656)
* Spec: Udpate formatting to use material content tabs
* Collapse v1-v3 into a single tab
* Spec: Restore content dropped during tab formatting refactor
Restore four pieces of content that were accidentally removed in the
formatting-only tab refactor, as flagged by Steven's review:
- column_sizes: restore "Does not include bytes necessary to read other
columns, like footers." sentence
- partitions: restore "(see below)" cross-reference to field_summary table
- partition-spec: restore note that writers use this field but readers use
specs from manifest files
- properties: restore commit.retry.num-retries example
Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
* add back (see below)
---------
Co-authored-by: Claude Sonnet 4.6 <[email protected]>
Co-authored-by: Kevin Liu <[email protected]>
---
format/spec.md | 322 +++++++++++++++++++++++++++++----------------------------
1 file changed, 166 insertions(+), 156 deletions(-)
diff --git a/format/spec.md b/format/spec.md
index 0d3c79762c..94651da0fa 100644
--- a/format/spec.md
+++ b/format/spec.md
@@ -600,14 +600,15 @@ A manifest stores files for a single partition spec. When
a table’s partition
A manifest file must store the partition spec and other metadata as properties
in the Avro file's key-value metadata:
-| v1 | v2 | Key | Value
|
-|------------|------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
-| _required_ | _required_ | `schema` | JSON representation of the
table schema at the time the manifest was written
|
-| _optional_ | _required_ | `schema-id` | ID of the schema used to
write the manifest as a string
|
-| _required_ | _required_ | `partition-spec` | JSON representation of only
the partition fields array of the partition spec used to write the manifest.
See [Appendix C](#partition-specs) |
-| _optional_ | _required_ | `partition-spec-id` | ID of the partition spec
used to write the manifest as a string
|
-| _optional_ | _required_ | `format-version` | Table format version number
of the manifest as a string
|
-| | _required_ | `content` | Type of content files
tracked by the manifest: "data" or "deletes"
|
+=== "v1 - v3"
+ | v1 | v2 and v3 | Key | Value
|
+
|------------|------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
+ | _required_ | _required_ | `schema` | JSON representation of
the table schema at the time the manifest was written
|
+ | _optional_ | _required_ | `schema-id` | ID of the schema used to
write the manifest as a string
|
+ | _required_ | _required_ | `partition-spec` | JSON representation of
only the partition fields array of the partition spec used to write the
manifest. See [Appendix C](#partition-specs) |
+ | _optional_ | _required_ | `partition-spec-id` | ID of the partition spec
used to write the manifest as a string
|
+ | _optional_ | _required_ | `format-version` | Table format version
number of the manifest as a string
|
+ | | _required_ | `content` | Type of content files
tracked by the manifest: "data" or "deletes"
|
The schema of a manifest file is defined by the `manifest_entry` struct,
described in the following section.
@@ -615,13 +616,14 @@ The schema of a manifest file is defined by the
`manifest_entry` struct, describ
The `manifest_entry` struct consists of the following fields:
-| v1 | v2 | Field id, name | Type
| Description |
-| ---------- | ----------
|-------------------------------|-----------------------------------------------------------|-------------|
-| _required_ | _required_ | **`0 status`** | `int` with
meaning: `0: EXISTING` `1: ADDED` `2: DELETED` | Used to track additions and
deletions. Deletes are informational only and not used in scans. |
-| _required_ | _optional_ | **`1 snapshot_id`** | `long`
| Snapshot id where the file was added,
or deleted if status is 2. Inherited when null. |
-| | _optional_ | **`3 sequence_number`** | `long`
| Data sequence number of the file.
Inherited when null and status is 1 (added). |
-| | _optional_ | **`4 file_sequence_number`** | `long`
| File sequence number indicating when
the file was added. Inherited when null and status is 1 (added). |
-| _required_ | _required_ | **`2 data_file`** | `data_file`
`struct` (see below) | File path, partition tuple,
metrics, ... |
+=== "v1 - v3"
+ | v1 | v2 and v3 | Field id, name | Type
| Description |
+ | ---------- | ----------
|-------------------------------|-----------------------------------------------------------|-------------|
+ | _required_ | _required_ | **`0 status`** | `int` with
meaning: `0: EXISTING` `1: ADDED` `2: DELETED` | Used to track additions and
deletions. Deletes are informational only and not used in scans. |
+ | _required_ | _optional_ | **`1 snapshot_id`** | `long`
| Snapshot id where the file was
added, or deleted if status is 2. Inherited when null. |
+ | | _optional_ | **`3 sequence_number`** | `long`
| Data sequence number of the file.
Inherited when null and status is 1 (added). |
+ | | _optional_ | **`4 file_sequence_number`** | `long`
| File sequence number indicating
when the file was added. Inherited when null and status is 1 (added). |
+ | _required_ | _required_ | **`2 data_file`** | `data_file`
`struct` (see below) | File path, partition tuple,
metrics, ... |
The manifest entry fields are used to keep track of the snapshot in which
files were added or logically deleted. The `data_file` struct, defined below,
is nested inside the manifest entry so that it can be easily passed to job
planning without the manifest entry fields.
@@ -643,32 +645,33 @@ Notes:
The `data_file` struct consists of the following fields:
-| v1 | v2 | v3 | Field id, name |
Type |
Description
|
-| ----------
|------------|------------|-----------------------------------|-----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| | _required_ | _required_ | **`134 content`** |
`int` with meaning: `0: DATA`, `1: POSITION DELETES`, `2: EQUALITY DELETES` |
Type of content stored by the data file: data, equality deletes, or position
deletes (all v1 files are data files)
|
-| _required_ | _required_ | _required_ | **`100 file_path`** |
`string` |
Full URI for the file with FS scheme
|
-| _required_ | _required_ | _required_ | **`101 file_format`** |
`string` |
String file format name, `avro`, `orc`, `parquet`, or `puffin`
|
-| _required_ | _required_ | _required_ | **`102 partition`** |
`struct<...>` |
Partition data tuple, schema based on the partition spec output using partition
field ids for the struct field ids
|
-| _required_ | _required_ | _required_ | **`103 record_count`** |
`long` |
Number of records in this file, or the cardinality of a deletion vector
|
-| _required_ | _required_ | _required_ | **`104 file_size_in_bytes`** |
`long` |
Total file size in bytes
|
-| _required_ | | | ~~**`105 block_size_in_bytes`**~~ |
`long` |
**Deprecated. Always write a default in v1. Do not write in v2 or v3.**
|
-| _optional_ | | | ~~**`106 file_ordinal`**~~ |
`int` |
**Deprecated. Do not write.**
|
-| _optional_ | | | ~~**`107 sort_columns`**~~ |
`list<112: int>` |
**Deprecated. Do not write.**
|
-| _optional_ | _optional_ | _optional_ | **`108 column_sizes`** |
`map<117: int, 118: long>` |
Map from column id to the total size on disk of all regions that store the
column. Does not include bytes necessary to read other columns, like footers.
Leave null for row-oriented formats (Avro) |
-| _optional_ | _optional_ | _optional_ | **`109 value_counts`** |
`map<119: int, 120: long>` |
Map from column id to number of values in the column (including null and NaN
values)
|
-| _optional_ | _optional_ | _optional_ | **`110 null_value_counts`** |
`map<121: int, 122: long>` |
Map from column id to number of null values in the column
|
-| _optional_ | _optional_ | _optional_ | **`137 nan_value_counts`** |
`map<138: int, 139: long>` |
Map from column id to number of NaN values in the column
|
-| _optional_ | _optional_ | | ~~**`111 distinct_counts`**~~ |
`map<123: int, 124: long>` |
**Deprecated. Do not write.**
|
-| _optional_ | _optional_ | _optional_ | **`125 lower_bounds`** |
`map<126: int, 127: binary>` |
Map from column id to lower bound in the column serialized as binary [1]. Each
value must be less than or equal to all non-null, non-NaN values in the column
for the file [2] |
-| _optional_ | _optional_ | _optional_ | **`128 upper_bounds`** |
`map<129: int, 130: binary>` |
Map from column id to upper bound in the column serialized as binary [1]. Each
value must be greater than or equal to all non-null, non-Nan values in the
column for the file [2] |
-| _optional_ | _optional_ | _optional_ | **`131 key_metadata`** |
`binary` |
Implementation-specific key metadata for encryption
|
-| _optional_ | _optional_ | _optional_ | **`132 split_offsets`** |
`list<133: long>` |
Split offsets for the data file. For example, all row group offsets in a
Parquet file. Must be sorted ascending
|
-| | _optional_ | _optional_ | **`135 equality_ids`** |
`list<136: int>` |
Field ids used to determine row equality in equality delete files. Required
when `content=2` and should be null otherwise. Fields with ids listed in this
column must be present in the delete file |
-| _optional_ | _optional_ | _optional_ | **`140 sort_order_id`** |
`int` |
ID representing sort order for this file [3].
|
-| | | _optional_ | **`142 first_row_id`** |
`long` |
The `_row_id` for the first row in the data file. See [First Row ID
Inheritance](#first-row-id-inheritance)
|
-| | _optional_ | _optional_ | **`143 referenced_data_file`** |
`string` |
Fully qualified location (URI with FS scheme) of a data file that all deletes
reference [4]
|
-| | | _optional_ | **`144 content_offset`** |
`long` |
The offset in the file where the content starts [5]
|
-| | | _optional_ | **`145 content_size_in_bytes`** |
`long` |
The length of a referenced content stored in the file; required if
`content_offset` is present [5]
|
+=== "v1 - v3"
+ | v1 | v2 | v3 | Field id, name
| Type |
Description |
+ | ----------
|------------|------------|-----------------------------------|-----------------------------------------------------------------------------|-------------|
+ | | _required_ | _required_ | **`134 content`**
| `int` with meaning: `0: DATA`, `1: POSITION DELETES`, `2: EQUALITY DELETES` |
Type of content stored by the data file: data, equality deletes, or position
deletes (all v1 files are data files) |
+ | _required_ | _required_ | _required_ | **`100 file_path`**
| `string` |
Full URI for the file with FS scheme |
+ | _required_ | _required_ | _required_ | **`101 file_format`**
| `string` |
String file format name, `avro`, `orc`, `parquet`, or `puffin` |
+ | _required_ | _required_ | _required_ | **`102 partition`**
| `struct<...>` |
Partition data tuple, schema based on the partition spec output using partition
field ids for the struct field ids |
+ | _required_ | _required_ | _required_ | **`103 record_count`**
| `long` |
Number of records in this file, or the cardinality of a deletion vector |
+ | _required_ | _required_ | _required_ | **`104 file_size_in_bytes`**
| `long` |
Total file size in bytes |
+ | _required_ | | | ~~**`105 block_size_in_bytes`**~~
| `long` |
**Deprecated. Always write a default in v1. Do not write in v2 or v3.** |
+ | _optional_ | | | ~~**`106 file_ordinal`**~~
| `int` |
**Deprecated. Do not write.** |
+ | _optional_ | | | ~~**`107 sort_columns`**~~
| `list<112: int>` |
**Deprecated. Do not write.** |
+ | _optional_ | _optional_ | _optional_ | **`108 column_sizes`**
| `map<117: int, 118: long>` |
Map from column id to the total size on disk of all regions that store the
column. **Does not include bytes necessary to read other columns, like
footers.** Leave null for row-oriented formats (Avro) |
+ | _optional_ | _optional_ | _optional_ | **`109 value_counts`**
| `map<119: int, 120: long>` |
Map from column id to number of values in the column (including null and NaN
values) |
+ | _optional_ | _optional_ | _optional_ | **`110 null_value_counts`**
| `map<121: int, 122: long>` |
Map from column id to number of null values in the column |
+ | _optional_ | _optional_ | _optional_ | **`137 nan_value_counts`**
| `map<138: int, 139: long>` |
Map from column id to number of NaN values in the column |
+ | _optional_ | _optional_ | | ~~**`111 distinct_counts`**~~
| `map<123: int, 124: long>` |
**Deprecated. Do not write.** |
+ | _optional_ | _optional_ | _optional_ | **`125 lower_bounds`**
| `map<126: int, 127: binary>` |
Map from column id to lower bound in the column serialized as binary [1]. Each
value must be less than or equal to all non-null, non-NaN values in the column
for the file [2] |
+ | _optional_ | _optional_ | _optional_ | **`128 upper_bounds`**
| `map<129: int, 130: binary>` |
Map from column id to upper bound in the column serialized as binary [1]. Each
value must be greater than or equal to all non-null, non-Nan values in the
column for the file [2] |
+ | _optional_ | _optional_ | _optional_ | **`131 key_metadata`**
| `binary` |
Implementation-specific key metadata for encryption |
+ | _optional_ | _optional_ | _optional_ | **`132 split_offsets`**
| `list<133: long>` |
Split offsets for the data file. For example, all row group offsets in a
Parquet file. Must be sorted ascending |
+ | | _optional_ | _optional_ | **`135 equality_ids`**
| `list<136: int>` |
Field ids used to determine row equality in equality delete files. Required
when `content=2` and should be null otherwise. Fields with ids listed in this
column must be present in the delete file |
+ | _optional_ | _optional_ | _optional_ | **`140 sort_order_id`**
| `int` |
ID representing sort order for this file [3]. |
+ | | | _optional_ | **`142 first_row_id`**
| `long` |
The `_row_id` for the first row in the data file. See [First Row ID
Inheritance](#first-row-id-inheritance) |
+ | | _optional_ | _optional_ | **`143 referenced_data_file`**
| `string` |
Fully qualified location (URI with FS scheme) of a data file that all deletes
reference [4] |
+ | | | _optional_ | **`144 content_offset`**
| `long` |
The offset in the file where the content starts [5] |
+ | | | _optional_ | **`145 content_size_in_bytes`**
| `long` |
The length of a referenced content stored in the file; required if
`content_offset` is present [5] |
The `partition` struct stores the tuple of partition values for each file. Its
type is derived from the partition fields of the partition spec used to write
the manifest file. In v2, the partition struct's field ids must match the ids
from the partition spec.
@@ -733,20 +736,20 @@ Any null (unassigned) `first_row_id` must be assigned via
inheritance, even if t
### Snapshots
A snapshot consists of the following fields:
-
-| v1 | v2 | v3 | Field |
Description
|
-| ---------- | ----------
|------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
-| _required_ | _required_ | _required_ | **`snapshot-id`** | A
unique long ID
|
-| _optional_ | _optional_ | _optional_ | **`parent-snapshot-id`** | The
snapshot ID of the snapshot's parent. Omitted for any snapshot with no parent
|
-| | _required_ | _required_ | **`sequence-number`** | A
monotonically increasing long that tracks the order of changes to a table
|
-| _required_ | _required_ | _required_ | **`timestamp-ms`** | A
timestamp when the snapshot was created, used for garbage collection and table
inspection |
-| _optional_ | _required_ | _required_ | **`manifest-list`** | The
location of a manifest list for this snapshot that tracks manifest files with
additional metadata |
-| _optional_ | | | **`manifests`** | A list
of manifest file locations. Must be omitted if `manifest-list` is present
|
-| _optional_ | _required_ | _required_ | **`summary`** | A
string map that summarizes the snapshot changes, including `operation` as a
_required_ field (see below) |
-| _optional_ | _optional_ | _optional_ | **`schema-id`** | ID of
the table's current schema when the snapshot was created
|
-| | | _required_ | **`first-row-id`** | The
first `_row_id` assigned to the first row in the first data file in the first
manifest, see [Row Lineage](#row-lineage) |
-| | | _required_ | **`added-rows`** | The
upper bound of the number of rows with assigned row IDs, see [Row
Lineage](#row-lineage) |
-| | | _optional_ | **`key-id`** | ID of
the encryption key that encrypts the manifest list key metadata |
+=== "v1 - v3"
+ | v1 | v2 | v3 | Field |
Description |
+ | ---------- | ----------
|------------|------------------------------|-------------|
+ | _required_ | _required_ | _required_ | **`snapshot-id`** | A
unique long ID |
+ | _optional_ | _optional_ | _optional_ | **`parent-snapshot-id`** |
The snapshot ID of the snapshot's parent. Omitted for any snapshot with no
parent |
+ | | _required_ | _required_ | **`sequence-number`** | A
monotonically increasing long that tracks the order of changes to a table |
+ | _required_ | _required_ | _required_ | **`timestamp-ms`** | A
timestamp when the snapshot was created, used for garbage collection and table
inspection |
+ | _optional_ | _required_ | _required_ | **`manifest-list`** |
The location of a manifest list for this snapshot that tracks manifest files
with additional metadata |
+ | _optional_ | | | **`manifests`** | A
list of manifest file locations. Must be omitted if `manifest-list` is present |
+ | _optional_ | _required_ | _required_ | **`summary`** | A
string map that summarizes the snapshot changes, including `operation` as a
_required_ field (see below) |
+ | _optional_ | _optional_ | _optional_ | **`schema-id`** | ID
of the table's current schema when the snapshot was created |
+ | | | _required_ | **`first-row-id`** |
The first `_row_id` assigned to the first row in the first data file in the
first manifest, see [Row Lineage](#row-lineage) |
+ | | | _required_ | **`added-rows`** |
The upper bound of the number of rows with assigned row IDs, see [Row
Lineage](#row-lineage) |
+ | | | _optional_ | **`key-id`** | ID
of the encryption key that encrypts the manifest list key metadata |
The snapshot summary's `operation` field is used by some operations, like
snapshot expiration, to skip processing certain snapshots. Possible `operation`
values are:
@@ -790,33 +793,34 @@ A manifest list is a valid Iceberg data file: files must
use valid Iceberg forma
Manifest list files store `manifest_file`, a struct with the following fields:
-| v1 | v2 | v3 | Field id, name |
Type | Description
|
-| ---------- | ----------
|------------|----------------------------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
-| _required_ | _required_ | _required_ | **`500 manifest_path`** |
`string` | Location of the manifest file
|
-| _required_ | _required_ | _required_ | **`501 manifest_length`** |
`long` | Length of the manifest file in
bytes
|
-| _required_ | _required_ | _required_ | **`502 partition_spec_id`** |
`int` | ID of a partition spec used to
write the manifest; must be listed in table metadata `partition-specs`
|
-| | _required_ | _required_ | **`517 content`** |
`int` with meaning: `0: data`, `1: deletes` | The type of files tracked by the
manifest, either data or delete files; 0 for all v1 manifests
|
-| | _required_ | _required_ | **`515 sequence_number`** |
`long` | The sequence number when the
manifest was added to the table; use 0 when reading v1 manifest lists
|
-| | _required_ | _required_ | **`516 min_sequence_number`** |
`long` | The minimum data sequence number
of all live data or delete files in the manifest; use 0 when reading v1
manifest lists |
-| _required_ | _required_ | _required_ | **`503 added_snapshot_id`** |
`long` | ID of the snapshot where the
manifest file was added
|
-| _optional_ | _required_ | _required_ | **`504 added_files_count`** |
`int` | Number of entries in the manifest
that have status `ADDED` (1), when `null` this is assumed to be non-zero
|
-| _optional_ | _required_ | _required_ | **`505 existing_files_count`** |
`int` | Number of entries in the manifest
that have status `EXISTING` (0), when `null` this is assumed to be non-zero
|
-| _optional_ | _required_ | _required_ | **`506 deleted_files_count`** |
`int` | Number of entries in the manifest
that have status `DELETED` (2), when `null` this is assumed to be non-zero
|
-| _optional_ | _required_ | _required_ | **`512 added_rows_count`** |
`long` | Number of rows in all of files in
the manifest that have status `ADDED`, when `null` this is assumed to be
non-zero |
-| _optional_ | _required_ | _required_ | **`513 existing_rows_count`** |
`long` | Number of rows in all of files in
the manifest that have status `EXISTING`, when `null` this is assumed to be
non-zero |
-| _optional_ | _required_ | _required_ | **`514 deleted_rows_count`** |
`long` | Number of rows in all of files in
the manifest that have status `DELETED`, when `null` this is assumed to be
non-zero |
-| _optional_ | _optional_ | _optional_ | **`507 partitions`** |
`list<508: field_summary>` (see below) | A list of field summaries for
each partition field in the spec. Each field in the list corresponds to a field
in the manifest file’s partition spec. |
-| _optional_ | _optional_ | _optional_ | **`519 key_metadata`** |
`binary` | Implementation-specific key
metadata for encryption
|
-| | | _optional_ | **`520 first_row_id`** |
`long` | The starting `_row_id` to assign
to rows added by `ADDED` data files [First Row ID
Assignment](#first-row-id-assignment) |
+=== "v1 - v3"
+ | v1 | v2 | v3 | Field id, name
| Type | Description |
+ | ---------- | ----------
|------------|-------------------------------------|---------------------------------------------|-------------|
+ | _required_ | _required_ | _required_ | **`500 manifest_path`**
| `string` | Location of the manifest file
|
+ | _required_ | _required_ | _required_ | **`501 manifest_length`**
| `long` | Length of the manifest file
in bytes |
+ | _required_ | _required_ | _required_ | **`502 partition_spec_id`**
| `int` | ID of a partition spec used
to write the manifest; must be listed in table metadata `partition-specs` |
+ | | _required_ | _required_ | **`517 content`**
| `int` with meaning: `0: data`, `1: deletes` | The type of files tracked by
the manifest, either data or delete files; 0 for all v1 manifests |
+ | | _required_ | _required_ | **`515 sequence_number`**
| `long` | The sequence number when the
manifest was added to the table; use 0 when reading v1 manifest lists |
+ | | _required_ | _required_ | **`516 min_sequence_number`**
| `long` | The minimum data sequence
number of all live data or delete files in the manifest; use 0 when reading v1
manifest lists |
+ | _required_ | _required_ | _required_ | **`503 added_snapshot_id`**
| `long` | ID of the snapshot where the
manifest file was added |
+ | _optional_ | _required_ | _required_ | **`504 added_files_count`**
| `int` | Number of entries in the
manifest that have status `ADDED` (1), when `null` this is assumed to be
non-zero |
+ | _optional_ | _required_ | _required_ | **`505 existing_files_count`**
| `int` | Number of entries in the
manifest that have status `EXISTING` (0), when `null` this is assumed to be
non-zero |
+ | _optional_ | _required_ | _required_ | **`506 deleted_files_count`**
| `int` | Number of entries in the
manifest that have status `DELETED` (2), when `null` this is assumed to be
non-zero |
+ | _optional_ | _required_ | _required_ | **`512 added_rows_count`**
| `long` | Number of rows in all of
files in the manifest that have status `ADDED`, when `null` this is assumed to
be non-zero |
+ | _optional_ | _required_ | _required_ | **`513 existing_rows_count`**
| `long` | Number of rows in all of
files in the manifest that have status `EXISTING`, when `null` this is assumed
to be non-zero |
+ | _optional_ | _required_ | _required_ | **`514 deleted_rows_count`**
| `long` | Number of rows in all of
files in the manifest that have status `DELETED`, when `null` this is assumed
to be non-zero |
+ | _optional_ | _optional_ | _optional_ | **`507 partitions`**
| `list<508: field_summary>` **(see below)** | A list of field summaries for
each partition field in the spec. Each field in the list corresponds to a field
in the manifest file’s partition spec. |
+ | _optional_ | _optional_ | _optional_ | **`519 key_metadata`**
| `binary` | Implementation-specific key
metadata for encryption |
+ | | | _optional_ | **`520 first_row_id`**
| `long` | The starting `_row_id` to
assign to rows added by `ADDED` data files [First Row ID
Assignment](#first-row-id-assignment) |
`field_summary` is a struct with the following fields:
-
-| v1 | v2 | Field id, name | Type |
Description |
-| ---------- | ----------
|-------------------------|---------------|-------------|
-| _required_ | _required_ | **`509 contains_null`** | `boolean` | Whether
the manifest contains at least one partition with a null value for the field |
-| _optional_ | _optional_ | **`518 contains_nan`** | `boolean` | Whether
the manifest contains at least one partition with a NaN value for the field |
-| _optional_ | _optional_ | **`510 lower_bound`** | `bytes` [1] | Lower
bound for the non-null, non-NaN values in the partition field, or null if all
values are null or NaN [2] |
-| _optional_ | _optional_ | **`511 upper_bound`** | `bytes` [1] | Upper
bound for the non-null, non-NaN values in the partition field, or null if all
values are null or NaN [2] |
+=== "v1 - v3"
+ | v1 | v2 and v3 | Field id, name | Type |
Description |
+ | ---------- | ----------
|-------------------------|---------------|-------------|
+ | _required_ | _required_ | **`509 contains_null`** | `boolean` |
Whether the manifest contains at least one partition with a null value for the
field |
+ | _optional_ | _optional_ | **`518 contains_nan`** | `boolean` |
Whether the manifest contains at least one partition with a NaN value for the
field |
+ | _optional_ | _optional_ | **`510 lower_bound`** | `bytes` [1] |
Lower bound for the non-null, non-NaN values in the partition field, or null if
all values are null or NaN [2] |
+ | _optional_ | _optional_ | **`511 upper_bound`** | `bytes` [1] |
Upper bound for the non-null, non-NaN values in the partition field, or null if
all values are null or NaN [2] |
Notes:
@@ -885,13 +889,14 @@ Tags are labels for individual snapshots. Branches are
mutable named references
The snapshot reference object records all the information of a reference
including snapshot ID, reference type and [Snapshot Retention
Policy](#snapshot-retention-policy).
-| v1 | v2 | Field name | Type |
Description |
-| ---------- | ---------- | ---------------------------- | --------- |
----------- |
-| _required_ | _required_ | **`snapshot-id`** | `long` | A
reference's snapshot ID. The tagged snapshot or latest snapshot of a branch. |
-| _required_ | _required_ | **`type`** | `string` | Type of
the reference, `tag` or `branch` |
-| _optional_ | _optional_ | **`min-snapshots-to-keep`** | `int` | For
`branch` type only, a positive number for the minimum number of snapshots to
keep in a branch while expiring snapshots. Defaults to table property
`history.expire.min-snapshots-to-keep`. |
-| _optional_ | _optional_ | **`max-snapshot-age-ms`** | `long` | For
`branch` type only, a positive number for the max age of snapshots to keep when
expiring, including the latest snapshot. Defaults to table property
`history.expire.max-snapshot-age-ms`. |
-| _optional_ | _optional_ | **`max-ref-age-ms`** | `long` | For
snapshot references except the `main` branch, a positive number for the max age
of the snapshot reference to keep while expiring snapshots. Defaults to table
property `history.expire.max-ref-age-ms`. The `main` branch never expires. |
+=== "v1 - v3"
+ | v1 | v2 and v3 | Field name | Type |
Description |
+ | ---------- | ---------- | ---------------------------- | --------- |
----------- |
+ | _required_ | _required_ | **`snapshot-id`** | `long` | A
reference's snapshot ID. The tagged snapshot or latest snapshot of a branch. |
+ | _required_ | _required_ | **`type`** | `string` |
Type of the reference, `tag` or `branch` |
+ | _optional_ | _optional_ | **`min-snapshots-to-keep`** | `int` | For
`branch` type only, a positive number for the minimum number of snapshots to
keep in a branch while expiring snapshots. Defaults to table property
`history.expire.min-snapshots-to-keep`. |
+ | _optional_ | _optional_ | **`max-snapshot-age-ms`** | `long` | For
`branch` type only, a positive number for the max age of snapshots to keep when
expiring, including the latest snapshot. Defaults to table property
`history.expire.max-snapshot-age-ms`. |
+ | _optional_ | _optional_ | **`max-ref-age-ms`** | `long` | For
snapshot references except the `main` branch, a positive number for the max age
of the snapshot reference to keep while expiring snapshots. Defaults to table
property `history.expire.max-ref-age-ms`. The `main` branch never expires. |
Valid snapshot references are stored as the values of the `refs` map in table
metadata. For serialization, see Appendix C.
@@ -921,33 +926,34 @@ The atomic operation used to commit metadata depends on
how tables are tracked a
Table metadata consists of the following fields:
-| v1 | v2 | v3 | Field |
Description
|
-| ---------- | ----------
|------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| _required_ | _required_ | _required_ | **`format-version`** | An
integer version number for the format. Implementations must throw an exception
if a table's version is higher than the supported version.
|
-| _optional_ | _required_ | _required_ | **`table-uuid`** | A UUID
that identifies the table, generated when the table is created. Implementations
must throw an exception if a table's UUID does not match the expected UUID
after refreshing metadata.
|
-| _required_ | _required_ | _required_ | **`location`** | The
table's base location. This is used by writers to determine where to store data
files, manifest files, and table metadata files.
|
-| | _required_ | _required_ | **`last-sequence-number`** | The
table's highest assigned sequence number, a monotonically increasing long that
tracks the order of snapshots in a table.
|
-| _required_ | _required_ | _required_ | **`last-updated-ms`** |
Timestamp in milliseconds from the unix epoch when the table was last updated.
Each table metadata file should update this field just before writing.
|
-| _required_ | _required_ | _required_ | **`last-column-id`** | An
integer; the highest assigned column ID for the table. This is used to ensure
columns are always assigned an unused ID when evolving schemas.
|
-| _required_ | | | **`schema`** | The
table’s current schema. (**Deprecated**: use `schemas` and `current-schema-id`
instead)
|
-| _optional_ | _required_ | _required_ | **`schemas`** | A list
of schemas, stored as objects with `schema-id`.
|
-| _optional_ | _required_ | _required_ | **`current-schema-id`** | ID of
the table's current schema.
|
-| _required_ | | | **`partition-spec`** | The
table’s current partition spec, stored as only fields. Note that this is used
by writers to partition data, but is not used when reading because reads use
the specs stored in manifest files. (**Deprecated**: use `partition-specs` and
`default-spec-id` instead)
|
-| _optional_ | _required_ | _required_ | **`partition-specs`** | A list
of partition specs, stored as full partition spec objects.
|
-| _optional_ | _required_ | _required_ | **`default-spec-id`** | ID of
the "current" spec that writers should use by default.
|
-| _optional_ | _required_ | _required_ | **`last-partition-id`** | An
integer; the highest assigned partition field ID across all partition specs for
the table. This is used to ensure partition fields are always assigned an
unused ID when evolving specs.
|
-| _optional_ | _optional_ | _optional_ | **`properties`** | A
string to string map of table properties. This is used to control settings that
affect reading and writing and is not intended to be used for arbitrary
metadata. For example, `commit.retry.num-retries` is used to control the number
of commit retries.
|
-| _optional_ | _optional_ | _optional_ | **`current-snapshot-id`** | `long`
ID of the current table snapshot; must be the same as the current ID of the
`main` branch in `refs`.
|
-| _optional_ | _optional_ | _optional_ | **`snapshots`** | A list
of valid snapshots. Valid snapshots are snapshots for which all data files
exist in the file system. A data file must not be deleted from the file system
until the last snapshot in which it was listed is garbage collected.
|
-| _optional_ | _optional_ | _optional_ | **`snapshot-log`** | A list
(optional) of timestamp and snapshot ID pairs that encodes changes to the
current snapshot for the table. Each time the current-snapshot-id is changed, a
new entry should be added with the last-updated-ms and the new
current-snapshot-id. When snapshots are expired from the list of valid
snapshots, all entries before a snapshot that has expired should be removed.
|
-| _optional_ | _optional_ | _optional_ | **`metadata-log`** | A list
(optional) of timestamp and metadata file location pairs that encodes changes
to the previous metadata files for the table. Each time a new metadata file is
created, a new entry of the previous metadata file location should be added to
the list. Tables can be configured to remove oldest metadata log entries and
keep a fixed-size log of the most recent entries after a commit. |
-| _optional_ | _required_ | _required_ | **`sort-orders`** | A list
of sort orders, stored as full sort order objects.
|
-| _optional_ | _required_ | _required_ | **`default-sort-order-id`** | Default
sort order id of the table. Note that this could be used by writers, but is not
used when reading because reads use the specs stored in manifest files.
|
-| | _optional_ | _optional_ | **`refs`** | A map
of snapshot references. The map keys are the unique snapshot reference names in
the table, and the map values are snapshot reference objects. There is always a
`main` branch reference pointing to the `current-snapshot-id` even if the
`refs` map is null.
|
-| _optional_ | _optional_ | _optional_ | **`statistics`** | A list
(optional) of [table statistics](#table-statistics).
|
-| _optional_ | _optional_ | _optional_ | **`partition-statistics`** | A list
(optional) of [partition statistics](#partition-statistics).
|
-| | | _required_ | **`next-row-id`** | A
`long` higher than all assigned row IDs; the next snapshot's `first-row-id`.
See [Row Lineage](#row-lineage).
|
-| | | _optional_ | **`encryption-keys`** | A list
(optional) of [encryption keys](#encryption-keys) used for table encryption. |
+=== "v1 - v3"
+ | v1 | v2 | v3 | Field |
Description |
+ | ---------- | ---------- |------------|-----------------------------|
------------|
+ | _required_ | _required_ | _required_ | **`format-version`** | An
integer version number for the format. Implementations must throw an exception
if a table’s version is higher than the supported version. |
+ | _optional_ | _required_ | _required_ | **`table-uuid`** | A
UUID that identifies the table, generated when the table is created.
Implementations must throw an exception if a table’s UUID does not match the
expected UUID after refreshing metadata. |
+ | _required_ | _required_ | _required_ | **`location`** | The
table’s base location. This is used by writers to determine where to store data
files, manifest files, and table metadata files. |
+ | | _required_ | _required_ | **`last-sequence-number`** | The
table’s highest assigned sequence number, a monotonically increasing long that
tracks the order of snapshots in a table. |
+ | _required_ | _required_ | _required_ | **`last-updated-ms`** |
Timestamp in milliseconds from the unix epoch when the table was last updated.
Each table metadata file should update this field just before writing. |
+ | _required_ | _required_ | _required_ | **`last-column-id`** | An
integer; the highest assigned column ID for the table. This is used to ensure
columns are always assigned an unused ID when evolving schemas. |
+ | _required_ | | | **`schema`** | The
table’s current schema. (**Deprecated**: use `schemas` and `current-schema-id`
instead) |
+ | _optional_ | _required_ | _required_ | **`schemas`** | A
list of schemas, stored as objects with `schema-id`. |
+ | _optional_ | _required_ | _required_ | **`current-schema-id`** | ID
of the table’s current schema. |
+ | _required_ | | | **`partition-spec`** | The
table’s current partition spec, stored as only fields. (**Deprecated**: use
`partition-specs` and `default-spec-id` instead) Note that this is used by
writers to partition data, but is not used when reading because reads use the
specs stored in manifest files. |
+ | _optional_ | _required_ | _required_ | **`partition-specs`** | A
list of partition specs, stored as full partition spec objects. |
+ | _optional_ | _required_ | _required_ | **`default-spec-id`** | ID
of the "current" spec that writers should use by default. |
+ | _optional_ | _required_ | _required_ | **`last-partition-id`** | An
integer; the highest assigned partition field ID across all partition specs for
the table. This is used to ensure partition fields are always assigned an
unused ID when evolving specs. |
+ | _optional_ | _optional_ | _optional_ | **`properties`** | A
string to string map of table properties. This is used to control settings that
affect reading and writing and is not intended to be used for arbitrary
metadata. For example, `commit.retry.num-retries` is used to control the number
of commit retries. |
+ | _optional_ | _optional_ | _optional_ | **`current-snapshot-id`** |
`long` ID of the current table snapshot; must be the same as the current ID of
the `main` branch in `refs`. |
+ | _optional_ | _optional_ | _optional_ | **`snapshots`** | A
list of valid snapshots. Valid snapshots are snapshots for which all data files
exist in the file system. A data file must not be deleted from the file system
until the last snapshot in which it was listed is garbage collected. |
+ | _optional_ | _optional_ | _optional_ | **`snapshot-log`** | A
list (optional) of timestamp and snapshot ID pairs that encodes changes to the
current snapshot for the table. Each time the current-snapshot-id is changed, a
new entry should be added with the last-updated-ms and the new
current-snapshot-id. When snapshots are expired from the list of valid
snapshots, all entries before a snapshot that has expired should be removed. |
+ | _optional_ | _optional_ | _optional_ | **`metadata-log`** | A
list (optional) of timestamp and metadata file location pairs that encodes
changes to the previous metadata files for the table. Each time a new metadata
file is created, a new entry of the previous metadata file location should be
added to the list. Tables can be configured to remove oldest metadata log
entries and keep a fixed-size log of the most recent entries after a commit. |
+ | _optional_ | _required_ | _required_ | **`sort-orders`** | A
list of sort orders, stored as full sort order objects. |
+ | _optional_ | _required_ | _required_ | **`default-sort-order-id`** |
Default sort order id of the table. Note that this could be used by writers,
but is not used when reading because reads use the specs stored in manifest
files. |
+ | | _optional_ | _optional_ | **`refs`** | A
map of snapshot references. The map keys are the unique snapshot reference
names in the table, and the map values are snapshot reference objects. There is
always a `main` branch reference pointing to the `current-snapshot-id` even if
the `refs` map is null. |
+ | _optional_ | _optional_ | _optional_ | **`statistics`** | A
list (optional) of [table statistics](#table-statistics). |
+ | _optional_ | _optional_ | _optional_ | **`partition-statistics`** | A
list (optional) of [partition statistics](#partition-statistics). |
+ | | | _required_ | **`next-row-id`** | A
`long` higher than all assigned row IDs; the next snapshot’s `first-row-id`.
See [Row Lineage](#row-lineage). |
+ | | | _optional_ | **`encryption-keys`** | A
list (optional) of [encryption keys](#encryption-keys) used for table
encryption. |
For serialization details, see Appendix C.
@@ -963,24 +969,26 @@ many statistics files associated with different table
snapshots.
Statistics files metadata within `statistics` table metadata field is a struct
with the following fields:
-| v1 | v2 | Field name | Type | Description |
-|----|----|------------|------|-------------|
-| _required_ | _required_ | **`snapshot-id`** | `long` | ID of the Iceberg
table's snapshot the statistics file is associated with. |
-| _required_ | _required_ | **`statistics-path`** | `string` | Path of the
statistics file. See [Puffin file format](puffin-spec.md). |
-| _required_ | _required_ | **`file-size-in-bytes`** | `long` | Size of the
statistics file. |
-| _required_ | _required_ | **`file-footer-size-in-bytes`** | `long` | Total
size of the statistics file's footer (not the footer payload size). See [Puffin
file format](puffin-spec.md) for footer definition. |
-| _optional_ | _optional_ | **`key-metadata`** | Base64-encoded
implementation-specific key metadata for encryption. |
-| _required_ | _required_ | **`blob-metadata`** | `list<blob metadata>` (see
below) | A list of the blob metadata for statistics contained in the file with
structure described below. |
+=== "v1 - v3"
+ | v1 | v2 and v3 | Field name | Type
| Description |
+ | ---------- | ----------
|---------------------------------|-----------------------|-------------|
+ | _required_ | _required_ | **`snapshot-id`** | `long`
| ID of the Iceberg table's snapshot the statistics file is associated
with. |
+ | _required_ | _required_ | **`statistics-path`** | `string`
| Path of the statistics file. See [Puffin file
format](puffin-spec.md). |
+ | _required_ | _required_ | **`file-size-in-bytes`** | `long`
| Size of the statistics file. |
+ | _required_ | _required_ | **`file-footer-size-in-bytes`** | `long`
| Total size of the statistics file's footer (not the footer payload
size). See [Puffin file format](puffin-spec.md) for footer definition. |
+ | _optional_ | _optional_ | **`key-metadata`** |
| Base64-encoded implementation-specific key metadata for encryption. |
+ | _required_ | _required_ | **`blob-metadata`** | `list<blob
metadata>` (see below) | A list of the blob metadata for statistics contained
in the file with structure described below. |
Blob metadata is a struct with the following fields:
-| v1 | v2 | Field name | Type | Description |
-|----|----|------------|------|-------------|
-| _required_ | _required_ | **`type`** | `string` | Type of the blob. Matches
Blob type in the Puffin file. |
-| _required_ | _required_ | **`snapshot-id`** | `long` | ID of the Iceberg
table's snapshot the blob was computed from. |
-| _required_ | _required_ | **`sequence-number`** | `long` | Sequence number
of the Iceberg table's snapshot the blob was computed from. |
-| _required_ | _required_ | **`fields`** | `list<integer>` | Ordered list of
fields, given by field ID, on which the statistic was calculated. |
-| _optional_ | _optional_ | **`properties`** | `map<string, string>` |
Additional properties associated with the statistic. Subset of Blob properties
in the Puffin file. |
+=== "v1 - v3"
+ | v1 | v2 and v3 | Field name | Type
| Description |
+ | ---------- | ----------
|-----------------------|-----------------------|-------------|
+ | _required_ | _required_ | **`type`** | `string`
| Type of the blob. Matches Blob type in the Puffin file. |
+ | _required_ | _required_ | **`snapshot-id`** | `long`
| ID of the Iceberg table's snapshot the blob was computed from. |
+ | _required_ | _required_ | **`sequence-number`** | `long`
| Sequence number of the Iceberg table's snapshot the blob was computed from. |
+ | _required_ | _required_ | **`fields`** | `list<integer>`
| Ordered list of fields, given by field ID, on which the statistic was
calculated. |
+ | _optional_ | _optional_ | **`properties`** | `map<string, string>`
| Additional properties associated with the statistic. Subset of Blob
properties in the Puffin file. |
#### Partition Statistics
@@ -992,11 +1000,12 @@ Partition statistics file must be registered in the
table metadata file to be co
`partition-statistics` field of table metadata is an optional list of structs
with the following fields:
-| v1 | v2 | v3 | Field name | Type | Description |
-|----|----|----|------------|------|-------------|
-| _required_ | _required_ | _required_ | **`snapshot-id`** | `long` | ID of
the Iceberg table's snapshot the partition statistics file is associated with. |
-| _required_ | _required_ | _required_ | **`statistics-path`** | `string` |
Path of the partition statistics file. See [Partition statistics
file](#partition-statistics-file). |
-| _required_ | _required_ | _required_ | **`file-size-in-bytes`** | `long` |
Size of the partition statistics file. |
+=== "v1 - v3"
+ | v1 | v2 | v3 | Field name | Type
| Description |
+ | ---------- | ----------
|------------|--------------------------|----------|-------------|
+ | _required_ | _required_ | _required_ | **`snapshot-id`** | `long`
| ID of the Iceberg table's snapshot the partition statistics file is
associated with. |
+ | _required_ | _required_ | _required_ | **`statistics-path`** |
`string` | Path of the partition statistics file. See [Partition statistics
file](#partition-statistics-file). |
+ | _required_ | _required_ | _required_ | **`file-size-in-bytes`** | `long`
| Size of the partition statistics file. |
##### Partition Statistics File
@@ -1005,21 +1014,22 @@ These rows must be sorted (in ascending manner with
NULL FIRST) by `partition` f
The schema of the partition statistics file is as follows:
-| v1 | v2 | v3 | Field id, name | Type | Description |
-|----|----|----|----------------|------|-------------|
-| _required_ | _required_ | _required_ | **`1 partition`** | `struct<..>` |
Partition data tuple, schema based on the unified partition type considering
all specs in a table |
-| _required_ | _required_ | _required_ | **`2 spec_id`** | `int` | Partition
spec id |
-| _required_ | _required_ | _required_ | **`3 data_record_count`** | `long` |
Count of records in data files |
-| _required_ | _required_ | _required_ | **`4 data_file_count`** | `int` |
Count of data files |
-| _required_ | _required_ | _required_ | **`5 total_data_file_size_in_bytes`**
| `long` | Total size of data files in bytes |
-| _optional_ | _optional_ | _required_ | **`6 position_delete_record_count`**
| `long` | Count of position deletes across position delete files and deletion
vectors |
-| _optional_ | _optional_ | _required_ | **`7 position_delete_file_count`** |
`int` | Count of position delete files ignoring deletion vectors |
-| | | _required_ | **`13 dv_count`** | `int` | Count of
deletion vectors |
-| _optional_ | _optional_ | _required_ | **`8 equality_delete_record_count`**
| `long` | Count of records in equality delete files |
-| _optional_ | _optional_ | _required_ | **`9 equality_delete_file_count`** |
`int` | Count of equality delete files |
-| _optional_ | _optional_ | _optional_ | **`10 total_record_count`** | `long`
| Accurate count of records in a partition after applying deletes if any |
-| _optional_ | _optional_ | _optional_ | **`11 last_updated_at`** | `long` |
Timestamp in milliseconds from the unix epoch when the partition was last
updated |
-| _optional_ | _optional_ | _optional_ | **`12 last_updated_snapshot_id`** |
`long` | ID of snapshot that last updated this partition |
+=== "v1 - v3"
+ | v1 | v2 | v3 | Field id, name
| Type | Description |
+ | ---------- | ----------
|------------|------------------------------------------|--------------|-------------|
+ | _required_ | _required_ | _required_ | **`1 partition`**
| `struct<..>` | Partition data tuple, schema based on the unified
partition type considering all specs in a table |
+ | _required_ | _required_ | _required_ | **`2 spec_id`**
| `int` | Partition spec id |
+ | _required_ | _required_ | _required_ | **`3 data_record_count`**
| `long` | Count of records in data files |
+ | _required_ | _required_ | _required_ | **`4 data_file_count`**
| `int` | Count of data files |
+ | _required_ | _required_ | _required_ | **`5
total_data_file_size_in_bytes`** | `long` | Total size of data files
in bytes |
+ | _optional_ | _optional_ | _required_ | **`6
position_delete_record_count`** | `long` | Count of position deletes
across position delete files and deletion vectors |
+ | _optional_ | _optional_ | _required_ | **`7
position_delete_file_count`** | `int` | Count of position delete
files ignoring deletion vectors |
+ | | | _required_ | **`13 dv_count`**
| `int` | Count of deletion vectors |
+ | _optional_ | _optional_ | _required_ | **`8
equality_delete_record_count`** | `long` | Count of records in
equality delete files |
+ | _optional_ | _optional_ | _required_ | **`9
equality_delete_file_count`** | `int` | Count of equality delete
files |
+ | _optional_ | _optional_ | _optional_ | **`10 total_record_count`**
| `long` | Accurate count of records in a partition after applying
deletes if any |
+ | _optional_ | _optional_ | _optional_ | **`11 last_updated_at`**
| `long` | Timestamp in milliseconds from the unix epoch when the
partition was last updated |
+ | _optional_ | _optional_ | _optional_ | **`12 last_updated_snapshot_id`**
| `long` | ID of snapshot that last updated this partition |
Note that partition data tuple's schema is based on the partition spec output
using partition field ids for the struct field ids.
The unified partition type is a struct containing all fields that have ever
been a part of any spec in the table
@@ -1044,13 +1054,13 @@ If a table has no deletes or only deletion vectors,
implementations are encourag
#### Encryption Keys
Keys used for table encryption can be tracked in table metadata as a list
named `encryption-keys`. The schema of each key is a struct with the following
fields:
-
-| v1 | v2 | v3 | Field name | Type.
| Description |
-|----|----|------------|------------------------------|-----------------------|-------------|
-| | | _required_ | **`key-id`** | `string`
| ID of the encryption key |
-| | | _required_ | **`encrypted-key-metadata`** | `string`
| Encrypted key and metadata, base64 encoded [1] |
-| | | _optional_ | **`encrypted-by-id`** | `string`
| Optional ID of the key used to encrypt or wrap `key-metadata` |
-| | | _optional_ | **`properties`** | `map<string, string>`
| A string to string map of additional metadata used by the table's encryption
scheme |
+=== "v1 - v3"
+ | v1 | v2 | v3 | Field name | Type
| Description |
+
|----|----|------------|-------------------------------|-----------------------|-------------|
+ | | | _required_ | **`key-id`** | `string`
| ID of the encryption key |
+ | | | _required_ | **`encrypted-key-metadata`** | `string`
| Encrypted key and metadata, base64 encoded [1] |
+ | | | _optional_ | **`encrypted-by-id`** | `string`
| Optional ID of the key used to encrypt or wrap `key-metadata` |
+ | | | _optional_ | **`properties`** | `map<string,
string>` | A string to string map of additional metadata used by the table's
encryption scheme |
Notes:
