spark-instrumented-optimizer/python/docs/source/reference/ps_io.rst
Hyukjin Kwon 3d158f9c91 [SPARK-35587][PYTHON][DOCS] Initial porting of Koalas documentation
### What changes were proposed in this pull request?

This PR proposes to port Koalas documentation to PySpark documentation as its initial step.
It ports almost as is except these differences:

- Renamed import from `databricks.koalas` to `pyspark.pandas`.
- Renamed `to_koalas` -> `to_pandas_on_spark`
- Renamed `(Series|DataFrame).koalas` -> `(Series|DataFrame).pandas_on_spark`
- Added a `ps_` prefix in the RST file names of Koalas documentation

Other then that,

- Excluded `python/docs/build/html` in linter
- Fixed GA dependency installataion

### Why are the changes needed?

To document pandas APIs on Spark.

### Does this PR introduce _any_ user-facing change?

Yes, it adds new documentations.

### How was this patch tested?

Manually built the docs and checked the output.

Closes #32726 from HyukjinKwon/SPARK-35587.

Authored-by: Hyukjin Kwon <gurwls223@apache.org>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
2021-06-04 11:11:09 +09:00

104 lines
1.2 KiB
ReStructuredText

.. _api.io:
============
Input/Output
============
.. currentmodule:: pyspark.pandas
Data Generator
--------------
.. autosummary::
:toctree: api/
range
Spark Metastore Table
---------------------
.. autosummary::
:toctree: api/
read_table
DataFrame.to_table
Delta Lake
----------
.. autosummary::
:toctree: api/
read_delta
DataFrame.to_delta
Parquet
-------
.. autosummary::
:toctree: api/
read_parquet
DataFrame.to_parquet
ORC
-------
.. autosummary::
:toctree: api/
read_orc
DataFrame.to_orc
Generic Spark I/O
-----------------
.. autosummary::
:toctree: api/
read_spark_io
DataFrame.to_spark_io
Flat File / CSV
---------------
.. autosummary::
:toctree: api/
read_csv
DataFrame.to_csv
Clipboard
---------
.. autosummary::
:toctree: api/
read_clipboard
DataFrame.to_clipboard
Excel
-----
.. autosummary::
:toctree: api/
read_excel
DataFrame.to_excel
JSON
----
.. autosummary::
:toctree: api/
read_json
DataFrame.to_json
HTML
----
.. autosummary::
:toctree: api/
read_html
DataFrame.to_html
SQL
---
.. autosummary::
:toctree: api/
read_sql_table
read_sql_query
read_sql