Skip to content

Commit

Permalink
add field_id in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mapleFU committed Apr 13, 2024
1 parent 83359d6 commit b9428f6
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/source/cpp/parquet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,19 @@ More specifically, Parquet C++ supports:
* EncryptionWithFooterKey and EncryptionWithColumnKey modes.
* Encrypted Footer and Plaintext Footer modes.

Field Id
----------

The parquet format supports an optional integer field_id which can be assigned
to a field. This is used in the `iceberg specification <https://github.com/apache/iceberg/blob/main/format/spec.md#column-projection>` __

On writer side, If ``PARQUET:field_id`` is present as a metadata key on a field, and the corresponding
value is a nonnegative integer, then it will be used as the field_id in the parquet
file.

On reader side, Arrow will convert these field IDs to a metadata key named
``PARQUET:field_id`` on the appropriate field.

Miscellaneous
-------------

Expand Down

0 comments on commit b9428f6

Please sign in to comment.