copy file-offset comment from arrow-rs

mapleFU · Aug 3, 2024 · 57f674d · 57f674d
1 parent 37d1af3
commit 57f674d
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/cpp/src/parquet/metadata.h b/cpp/src/parquet/metadata.h
@@ -146,7 +146,12 @@ class PARQUET_EXPORT ColumnChunkMetaData {
 
   bool Equals(const ColumnChunkMetaData& other) const;
 
-  // column chunk
+  // Byte offset of `ColumnMetaData` in `file_path()`.
+  //
+  // Note that the meaning of this field has been inconsistent between implementations
+  // so its use has since been deprecated in the Parquet specification. Moder
+  // implementations will set this to `0` to indicate that the `ColumnMetaData` is solely
+  // contained in the `ColumnChunk` struct.
   int64_t file_offset() const;
 
   // parameter is only used when a dataset is spread across multiple files