You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/06/10 21:48:36 UTC
[GitHub] [arrow] westonpace opened a new pull request #10512: ARROW-13036: [Doc] Mention recommended file extension(s) for Arrow IPC
westonpace opened a new pull request #10512:
URL: https://github.com/apache/arrow/pull/10512
See JIRA
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] westonpace commented on a change in pull request #10512: ARROW-13036: [Doc] Mention recommended file extension(s) for Arrow IPC
Posted by GitBox <gi...@apache.org>.
westonpace commented on a change in pull request #10512:
URL: https://github.com/apache/arrow/pull/10512#discussion_r652093456
##########
File path: docs/source/format/Columnar.rst
##########
@@ -1006,19 +1006,21 @@ message flatbuffer is read, you can then read the message body.
The stream writer can signal end-of-stream (EOS) either by writing 8 bytes
containing the 4-byte continuation indicator (``0xFFFFFFFF``) followed by 0
-metadata length (``0x00000000``) or closing the stream interface.
+metadata length (``0x00000000``) or closing the stream interface. We
+recommend the ".arrows" file extension for the streaming format although
+in many cases these streams will not ever be stored as files.
IPC File Format
---------------
-We define a "file format" supporting random access that is build with
-the stream format. The file starts and ends with a magic string
-``ARROW1`` (plus padding). What follows in the file is identical to
-the stream format. At the end of the file, we write a *footer*
-containing a redundant copy of the schema (which is a part of the
-streaming format) plus memory offsets and sizes for each of the data
-blocks in the file. This enables random access any record batch in the
-file. See `File.fbs`_ for the precise details of the file footer.
+We define a "file format" supporting random access that is built with
Review comment:
I went with "is an extension of"
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou closed pull request #10512: ARROW-13036: [Doc] Mention recommended file extension(s) for Arrow IPC
Posted by GitBox <gi...@apache.org>.
pitrou closed pull request #10512:
URL: https://github.com/apache/arrow/pull/10512
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a change in pull request #10512: ARROW-13036: [Doc] Mention recommended file extension(s) for Arrow IPC
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #10512:
URL: https://github.com/apache/arrow/pull/10512#discussion_r651745191
##########
File path: docs/source/format/Columnar.rst
##########
@@ -1006,19 +1006,21 @@ message flatbuffer is read, you can then read the message body.
The stream writer can signal end-of-stream (EOS) either by writing 8 bytes
containing the 4-byte continuation indicator (``0xFFFFFFFF``) followed by 0
-metadata length (``0x00000000``) or closing the stream interface.
+metadata length (``0x00000000``) or closing the stream interface. We
+recommend the ".arrows" file extension for the streaming format although
+in many cases these streams will not ever be stored as files.
IPC File Format
---------------
-We define a "file format" supporting random access that is build with
-the stream format. The file starts and ends with a magic string
-``ARROW1`` (plus padding). What follows in the file is identical to
-the stream format. At the end of the file, we write a *footer*
-containing a redundant copy of the schema (which is a part of the
-streaming format) plus memory offsets and sizes for each of the data
-blocks in the file. This enables random access any record batch in the
-file. See `File.fbs`_ for the precise details of the file footer.
+We define a "file format" supporting random access that is built with
+the stream format. We recommend the ".arrow" extension for files. The
Review comment:
"for such files" or "for IPC files"?
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #10512: ARROW-13036: [Doc] Mention recommended file extension(s) for Arrow IPC
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #10512:
URL: https://github.com/apache/arrow/pull/10512#issuecomment-859099974
https://issues.apache.org/jira/browse/ARROW-13036
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a change in pull request #10512: ARROW-13036: [Doc] Mention recommended file extension(s) for Arrow IPC
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #10512:
URL: https://github.com/apache/arrow/pull/10512#discussion_r651744990
##########
File path: docs/source/format/Columnar.rst
##########
@@ -1006,19 +1006,21 @@ message flatbuffer is read, you can then read the message body.
The stream writer can signal end-of-stream (EOS) either by writing 8 bytes
containing the 4-byte continuation indicator (``0xFFFFFFFF``) followed by 0
-metadata length (``0x00000000``) or closing the stream interface.
+metadata length (``0x00000000``) or closing the stream interface. We
+recommend the ".arrows" file extension for the streaming format although
+in many cases these streams will not ever be stored as files.
IPC File Format
---------------
-We define a "file format" supporting random access that is build with
-the stream format. The file starts and ends with a magic string
-``ARROW1`` (plus padding). What follows in the file is identical to
-the stream format. At the end of the file, we write a *footer*
-containing a redundant copy of the schema (which is a part of the
-streaming format) plus memory offsets and sizes for each of the data
-blocks in the file. This enables random access any record batch in the
-file. See `File.fbs`_ for the precise details of the file footer.
+We define a "file format" supporting random access that is built with
Review comment:
Since we are at it, can we replace "built with" with something less weird / less confusing? Perhaps "built upon" or "built on top of" or "is an extension of" (or...)?
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] westonpace commented on a change in pull request #10512: ARROW-13036: [Doc] Mention recommended file extension(s) for Arrow IPC
Posted by GitBox <gi...@apache.org>.
westonpace commented on a change in pull request #10512:
URL: https://github.com/apache/arrow/pull/10512#discussion_r652094464
##########
File path: docs/source/format/Columnar.rst
##########
@@ -1006,19 +1006,21 @@ message flatbuffer is read, you can then read the message body.
The stream writer can signal end-of-stream (EOS) either by writing 8 bytes
containing the 4-byte continuation indicator (``0xFFFFFFFF``) followed by 0
-metadata length (``0x00000000``) or closing the stream interface.
+metadata length (``0x00000000``) or closing the stream interface. We
+recommend the ".arrows" file extension for the streaming format although
+in many cases these streams will not ever be stored as files.
IPC File Format
---------------
-We define a "file format" supporting random access that is build with
-the stream format. The file starts and ends with a magic string
-``ARROW1`` (plus padding). What follows in the file is identical to
-the stream format. At the end of the file, we write a *footer*
-containing a redundant copy of the schema (which is a part of the
-streaming format) plus memory offsets and sizes for each of the data
-blocks in the file. This enables random access any record batch in the
-file. See `File.fbs`_ for the precise details of the file footer.
+We define a "file format" supporting random access that is built with
+the stream format. We recommend the ".arrow" extension for files. The
Review comment:
I moved the sentence down to the end and changed it to `We recommend the ".arrow" extension for files
created with this format`.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org