mirror of
https://github.com/apache/arrow.git
synced 2026-10-29 17:15:39 +08:00
Add docs to pq.read_pandas
This commit is contained in:
1 parent
c35970cabc
commit
21a88295f7
1 file changed
+23
@@ -639,6 +639,29 @@ def read_table(source, columns=None, nthreads=1, metadata=None):
|
||||
|
||||
|
||||
def read_pandas(source, columns=None, nthreads=1, metadata=None):
|
||||
"""
|
||||
Read a Table from Parquet format, reconstructing the index values if
|
||||
available.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
source: str or pyarrow.io.NativeFile
|
||||
Location of Parquet dataset. If a string passed, can be a single file
|
||||
name or directory name. For passing Python file objects or byte
|
||||
buffers, see pyarrow.io.PythonFileInterface or pyarrow.io.BufferReader.
|
||||
columns: list
|
||||
If not None, only these columns will be read from the file.
|
||||
nthreads : int, default 1
|
||||
Number of columns to read in parallel. Requires that the underlying
|
||||
file source is threadsafe
|
||||
metadata : FileMetaData
|
||||
If separately computed
|
||||
|
||||
Returns
|
||||
-------
|
||||
pyarrow.Table
|
||||
Content of the file as a table (of columns)
|
||||
"""
|
||||
if is_string(source):
|
||||
fs = LocalFilesystem.get_instance()
|
||||
if fs.isdir(source):
|
||||
|
||||
Reference in new issue
Block a user