import quincy 17.2.0

[ceph.git] / ceph / src / arrow / docs / source / python / api / dataset.rst

.. 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