Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This section provides comprehensive API documentation for all PyAthena classes a
api/connection
api/pandas
api/arrow
api/s3fs
api/spark
api/converters
api/filesystem
Expand All @@ -35,6 +36,7 @@ Specialized Integrations

- :ref:`api_pandas` - pandas DataFrame integration
- :ref:`api_arrow` - Apache Arrow columnar data integration
- :ref:`api_s3fs` - Lightweight S3FS-based cursor (no pandas/pyarrow required)
- :ref:`api_spark` - Apache Spark integration for big data processing

Infrastructure
Expand Down
42 changes: 42 additions & 0 deletions docs/api/s3fs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.. _api_s3fs:

S3FS Integration
================

This section covers lightweight S3FS-based cursors, CSV readers, and data converters.

S3FS Cursors
------------

.. autoclass:: pyathena.s3fs.cursor.S3FSCursor
:members:
:inherited-members:

.. autoclass:: pyathena.s3fs.async_cursor.AsyncS3FSCursor
:members:
:inherited-members:

S3FS CSV Readers
----------------

S3FSCursor supports pluggable CSV reader implementations to control how NULL values
and empty strings are handled when parsing Athena's CSV output.

.. autoclass:: pyathena.s3fs.reader.AthenaCSVReader
:members:

.. autoclass:: pyathena.s3fs.reader.DefaultCSVReader
:members:

S3FS Data Converters
--------------------

.. autoclass:: pyathena.s3fs.converter.DefaultS3FSTypeConverter
:members:

S3FS Result Set
---------------

.. autoclass:: pyathena.s3fs.result_set.AthenaS3FSResultSet
:members:
:inherited-members:
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Documentation
cursor
pandas
arrow
s3fs
spark
testing
api
Expand Down
Loading