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 @@ -18,6 +18,7 @@ This section provides comprehensive API documentation for all PyAthena classes a
api/sqlalchemy
api/pandas
api/arrow
api/polars
api/s3fs
api/spark

Expand All @@ -44,5 +45,6 @@ Specialized integrations
- :ref:`api_sqlalchemy` - SQLAlchemy dialect implementations
- :ref:`api_pandas` - pandas DataFrame integration
- :ref:`api_arrow` - Apache Arrow columnar data integration
- :ref:`api_polars` - Polars DataFrame integration (no pyarrow required)
- :ref:`api_s3fs` - Lightweight S3FS-based cursor (no pandas/pyarrow required)
- :ref:`api_spark` - Apache Spark integration for big data processing
40 changes: 40 additions & 0 deletions docs/api/polars.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
.. _api_polars:

Polars Integration
==================

This section covers Polars-specific cursors, result sets, and data converters.

Polars Cursors
--------------

.. autoclass:: pyathena.polars.cursor.PolarsCursor
:members:
:inherited-members:

.. autoclass:: pyathena.polars.async_cursor.AsyncPolarsCursor
:members:
:inherited-members:

Polars Result Set
-----------------

.. autoclass:: pyathena.polars.result_set.AthenaPolarsResultSet
:members:
:inherited-members:

Polars Data Converters
----------------------

.. autoclass:: pyathena.polars.converter.DefaultPolarsTypeConverter
:members:

.. autoclass:: pyathena.polars.converter.DefaultPolarsUnloadTypeConverter
:members:

Polars Utilities
----------------

.. autofunction:: pyathena.polars.util.to_column_info

.. autofunction:: pyathena.polars.util.get_athena_type
10 changes: 10 additions & 0 deletions docs/cursor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,16 @@ AsyncArrowCursor

See :ref:`async-arrow-cursor`.

PolarsCursor
------------

See :ref:`polars-cursor`.

AsyncPolarsCursor
-----------------

See :ref:`async-polars-cursor`.

S3FSCursor
----------

Expand Down
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
sqlalchemy
pandas
arrow
polars
s3fs
spark
testing
Expand Down
4 changes: 3 additions & 1 deletion docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Extra packages:
+---------------+---------------------------------------+------------------+
| Arrow | ``pip install PyAthena[Arrow]`` | >=7.0.0 |
+---------------+---------------------------------------+------------------+
| Polars | ``pip install PyAthena[Polars]`` | >=1.0.0 |
+---------------+---------------------------------------+------------------+

.. _features:

Expand All @@ -43,7 +45,7 @@ PyAthena provides comprehensive support for Amazon Athena's data types and featu
**Core Features:**
- **DB API 2.0 Compliance**: Full PEP 249 compatibility for database operations
- **SQLAlchemy Integration**: Native dialect support with table reflection and ORM capabilities
- **Multiple Cursor Types**: Standard, Pandas, Arrow, S3FS, and Spark cursor implementations
- **Multiple Cursor Types**: Standard, Pandas, Arrow, Polars, S3FS and Spark cursor implementations
- **Async Support**: Asynchronous query execution for non-blocking operations

**Data Type Support:**
Expand Down
Loading