diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
| commit | e6918187568dbd01842d8d1d2c808ce16a894239 (patch) | |
| tree | 64f88b554b444a49f656b6c656111a145cbbaa28 /src/arrow/docs/source/python/api/ipc.rst | |
| parent | Initial commit. (diff) | |
| download | ceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip | |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/arrow/docs/source/python/api/ipc.rst')
| -rw-r--r-- | src/arrow/docs/source/python/api/ipc.rst | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/src/arrow/docs/source/python/api/ipc.rst b/src/arrow/docs/source/python/api/ipc.rst new file mode 100644 index 000000000..83ff53de7 --- /dev/null +++ b/src/arrow/docs/source/python/api/ipc.rst @@ -0,0 +1,69 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + +.. currentmodule:: pyarrow + +.. _api.ipc: + +Serialization and IPC +===================== + +Inter-Process Communication +--------------------------- + +.. autosummary:: + :toctree: ../generated/ + + ipc.new_file + ipc.open_file + ipc.new_stream + ipc.open_stream + ipc.read_message + ipc.read_record_batch + ipc.get_record_batch_size + ipc.read_tensor + ipc.write_tensor + ipc.get_tensor_size + ipc.IpcWriteOptions + ipc.Message + ipc.MessageReader + ipc.RecordBatchFileReader + ipc.RecordBatchFileWriter + ipc.RecordBatchStreamReader + ipc.RecordBatchStreamWriter + +Serialization +------------- + +.. warning:: + + The serialization functionality is deprecated in pyarrow 2.0, and will + be removed in a future version. Use the standard library ``pickle`` or + the IPC functionality of pyarrow (see :ref:`ipc`). + + +.. autosummary:: + :toctree: ../generated/ + + serialize + serialize_to + deserialize + deserialize_components + deserialize_from + read_serialized + SerializedPyObject + SerializationContext |