summaryrefslogtreecommitdiffstats
path: root/src/arrow/docs/source/python/api/dataset.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
commite6918187568dbd01842d8d1d2c808ce16a894239 (patch)
tree64f88b554b444a49f656b6c656111a145cbbaa28 /src/arrow/docs/source/python/api/dataset.rst
parentInitial commit. (diff)
downloadceph-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/dataset.rst')
-rw-r--r--src/arrow/docs/source/python/api/dataset.rst64
1 files changed, 64 insertions, 0 deletions
diff --git a/src/arrow/docs/source/python/api/dataset.rst b/src/arrow/docs/source/python/api/dataset.rst
new file mode 100644
index 000000000..9718006ab
--- /dev/null
+++ b/src/arrow/docs/source/python/api/dataset.rst
@@ -0,0 +1,64 @@
+.. 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.dataset
+
+.. _api.dataset:
+
+Dataset
+=======
+
+.. warning::
+
+ The ``pyarrow.dataset`` module is experimental (specifically the classes),
+ and a stable API is not yet guaranteed.
+
+Factory functions
+-----------------
+
+.. autosummary::
+ :toctree: ../generated/
+
+ dataset
+ parquet_dataset
+ partitioning
+ field
+ scalar
+ write_dataset
+
+Classes
+-------
+
+.. autosummary::
+ :toctree: ../generated/
+
+ FileFormat
+ ParquetFileFormat
+ ORCFileFormat
+ IpcFileFormat
+ CsvFileFormat
+ Partitioning
+ PartitioningFactory
+ DirectoryPartitioning
+ HivePartitioning
+ Dataset
+ FileSystemDataset
+ FileSystemFactoryOptions
+ FileSystemDatasetFactory
+ UnionDataset
+ Scanner
+ Expression