AlenkaF commented on code in PR #43950:
URL: https://github.com/apache/arrow/pull/43950#discussion_r1753867604
##########
docs/source/format/Columnar.rst:
##########
@@ -1385,6 +1387,59 @@ have two entries in each RecordBatch. For a RecordBatch
of this schema with
buffer 13: col2 data
+Compression
+-----------
+
+There are three different options for compression of record batch
+body buffers: Buffers can be uncompressed, buffers can be
+compressed with the ``lz4`` compression codec, or buffers can
+be compressed with the ``zstd`` compression codec. Buffers in
+the flat sequence of a message body must be either all
+uncompressed or all compressed separately using the same codec.
+
+.. note::
+
+ ``lz4`` compression codec means the
+ `LZ4 frame format
<https://github.com/lz4/lz4/blob/dev/doc/lz4_Frame_format.md>`_
+ and should not to be confused with
+ `"raw" (also called "block") format
<https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md>`_.
+
+The difference between compressed and uncompressed buffers in the
+serialized form is as follows:
+
+* If the buffers in the :ref:`ipc-recordbatch-message` are **compressed**
+
+ - the ``data header`` includes the length and memory offset
+ of each **compressed buffer** in the record batch's body
+
+ - the ``body`` includes a flat sequence of **compressed buffers**
+ together with the **length of uncompressed buffer** as a 64-bit
+ little-endian signed integer stored in the first 8 bytes for each
+ buffer in the sequence
+
+* If the buffers in the :ref:`ipc-recordbatch-message` are **uncompressed**
+
+ - the ``data header`` includes the length and memory offset
+ of each **uncompressed buffer** in the record batch's body
+
+ - the ``body`` includes a flat sequence of **uncompressed buffers**
+ with the first 8 bytes empty or equal to ``-1`` to indicate that
+ the buffer is uncompressed
Review Comment:
Hm, reading Message.fbs I must admit I was sure `-1` signals the
uncompressed buffer in a sequence of compressed ones. Because all buffers need
to be compressed by the same codec I was sure it also means that they all
should be compressed or not. `-1` would be a bit redundant in case we know all
buffers are not compressed, but thought this is needed because in any case
(compressed or uncompressed) there are first 8 bytes present to store this
information.
So if I understand correctly there is no need for a separate
**uncompressed** bullet point (or I could remove the 8 byte info that is wrong
and keep the second bullet point) and `-1` or empty info needs to be added to
the **compressed** bullet point?
--
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]
