Skip to content

Commit

Permalink
misc minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-beedie committed Mar 6, 2024
1 parent e6d02d7 commit a5332bc
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 55 deletions.
2 changes: 1 addition & 1 deletion py-polars/docs/source/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Python API reference
====================

This page gives a high-level overview of all public Polars objects, functions and
methods. All classes and functions exposed in ``polars.*`` namespace are public.
methods. All classes and functions exposed in the ``polars.*`` namespace are public.


.. grid::
Expand Down
105 changes: 51 additions & 54 deletions py-polars/docs/source/reference/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ Input/output
============
.. currentmodule:: polars

Avro
~~~~
.. autosummary::
:toctree: api/

read_avro
DataFrame.write_avro

CSV
~~~
.. autosummary::
Expand All @@ -14,29 +22,14 @@ CSV
DataFrame.write_csv
LazyFrame.sink_csv

Feather/ IPC
~~~~~~~~~~~~
.. autosummary::
:toctree: api/

read_ipc
read_ipc_stream
scan_ipc
read_ipc_schema
DataFrame.write_ipc
DataFrame.write_ipc_stream
LazyFrame.sink_ipc
.. currentmodule:: polars.io.csv.batched_reader

Parquet
~~~~~~~
.. autosummary::
:toctree: api/

read_parquet
scan_parquet
read_parquet_schema
DataFrame.write_parquet
LazyFrame.sink_parquet
BatchedCsvReader.next_batches

.. currentmodule:: polars

Database
~~~~~~~~
Expand All @@ -47,27 +40,16 @@ Database
read_database_uri
DataFrame.write_database

JSON
~~~~
.. autosummary::
:toctree: api/

read_json
read_ndjson
scan_ndjson
DataFrame.write_json
DataFrame.write_ndjson
LazyFrame.sink_ndjson

AVRO
~~~~
Delta Lake
~~~~~~~~~~
.. autosummary::
:toctree: api/

read_avro
DataFrame.write_avro
scan_delta
read_delta
DataFrame.write_delta

Spreadsheet
Excel / ODS
~~~~~~~~~~~
.. autosummary::
:toctree: api/
Expand All @@ -76,39 +58,54 @@ Spreadsheet
read_ods
DataFrame.write_excel

Apache Iceberg
~~~~~~~~~~~~~~
Feather / IPC
~~~~~~~~~~~~~
.. autosummary::
:toctree: api/

scan_iceberg
read_ipc
read_ipc_stream
scan_ipc
read_ipc_schema
DataFrame.write_ipc
DataFrame.write_ipc_stream
LazyFrame.sink_ipc

Delta Lake
~~~~~~~~~~
Iceberg
~~~~~~~
.. autosummary::
:toctree: api/

scan_delta
read_delta
DataFrame.write_delta

Datasets
~~~~~~~~
Connect to pyarrow datasets.
scan_iceberg

JSON
~~~~
.. autosummary::
:toctree: api/

scan_pyarrow_dataset
read_json
read_ndjson
scan_ndjson
DataFrame.write_json
DataFrame.write_ndjson
LazyFrame.sink_ndjson

Parquet
~~~~~~~
.. autosummary::
:toctree: api/

read_parquet
scan_parquet
read_parquet_schema
DataFrame.write_parquet
LazyFrame.sink_parquet

BatchedCsvReader
PyArrow Datasets
~~~~~~~~~~~~~~~~
This reader comes available by calling `pl.read_csv_batched`.

.. currentmodule:: polars.io.csv.batched_reader
Connect to pyarrow datasets.

.. autosummary::
:toctree: api/

BatchedCsvReader.next_batches
scan_pyarrow_dataset

0 comments on commit a5332bc

Please sign in to comment.