alamb commented on code in PR #51248: URL: https://github.com/apache/arrow/pull/51248#discussion_r4349990107
########## docs/source/format/CanonicalExtensions.rst: ########## @@ -546,6 +546,262 @@ Primitive Type Mappings | UUID extension type | UUID | +----------------------+------------------------+ +.. _parquet_file_extension: + +Parquet File +============ + +File represents a reference to a range of bytes stored inline or in an external +file. It is intended for use cases such as file inventories, manifests, and +references to unstructured data such as images or audio files in object +storage. This extension type preserves the semantics of the +`Parquet FILE logical type <https://github.com/apache/parquet-format/blob/master/LogicalTypes.md#file>`__ +in Arrow columns. + +* Extension name: ``arrow.parquet.file``. + +* The storage type of this extension is a ``Struct`` containing at least one of + the following nullable fields: + + .. list-table:: + :header-rows: 1 + + * - Field + - Type + * - ``uri`` + - ``String``, ``LargeString``, or ``StringView`` + * - ``offset`` + - ``Int64`` + * - ``size`` + - ``Int64`` + * - ``content_type`` + - ``String``, ``LargeString``, or ``StringView`` + * - ``checksum`` + - ``String``, ``LargeString``, or ``StringView`` + * - ``inline`` + - ``Binary``, ``LargeBinary``, or ``BinaryView`` + + The fields may be in any order and must be accessed by case-sensitive name, + not by position. Each field may occur at most once and may be omitted from + the ``Struct`` when it is not used. The ``Struct`` must not contain fields + other than those listed above. + +* Extension type parameters: + + This type does not have any parameters. + +* Description of the serialization: + + Extension metadata is an empty string. + +Field semantics Review Comment: unless there is a good reason to restate all the content, I think it should simply point at the Parquet spec -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
