summaryrefslogtreecommitdiffstats
path: root/src/arrow/docs/source/python/api/files.rst
blob: 106dfde8abffb5329c557eb86aea037b383abc22 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
.. 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

Streams and File Access
=======================

.. _api.io:

Factory Functions
-----------------

These factory functions are the recommended way to create a Arrow stream.
They accept various kinds of sources, such as in-memory buffers or on-disk files.

.. autosummary::
   :toctree: ../generated/

   input_stream
   output_stream
   memory_map
   create_memory_map

Stream Classes
--------------

.. autosummary::
   :toctree: ../generated/

   NativeFile
   OSFile
   PythonFile
   BufferReader
   BufferOutputStream
   FixedSizeBufferWriter
   MemoryMappedFile
   CompressedInputStream
   CompressedOutputStream

File Systems
------------

.. autosummary::
   :toctree: ../generated/

   hdfs.connect
   LocalFileSystem

.. class:: HadoopFileSystem
   :noindex: