Skip to content

Commit a9fedb8

Browse files
authored
Document status of file_path
1 parent 5d56a53 commit a9fedb8

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/main/thrift/parquet.thrift

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -958,6 +958,22 @@ union ColumnCryptoMetaData {
958958
struct ColumnChunk {
959959
/** File where column data is stored. If not set, assumed to be same file as
960960
* metadata. This path is relative to the current file.
961+
*
962+
* As of December 2025, there are no known released Parquet implementations
963+
* that make use of this field when reading columns. Readers should check
964+
* that the field is empty before retrieving a column from within the file,
965+
* and error if it isn't.
966+
*
967+
* Writers should not populate this field.
968+
*
969+
* Any new use of this field must go through the normal Parquet feature
970+
* addition process. CONTRIBUTING.md in the parquet-format repository
971+
* provides details on the process.
972+
*
973+
* One known use-case for this field is to batch parquet footers together
974+
* in a single file that serves as an index. As such, Parquet implementations
975+
* expose an accessor to this field, but orchestrating column reads is left to
976+
* data processing engines and generally not done in Parquet implementations.
961977
**/
962978
1: optional string file_path
963979

0 commit comments

Comments
 (0)