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
34 changes: 17 additions & 17 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _api:

API Reference
API reference
=============

This section provides comprehensive API documentation for all PyAthena classes and functions, organized by functionality.
Expand All @@ -10,39 +10,39 @@ This section provides comprehensive API documentation for all PyAthena classes a
:caption: API Documentation:

api/connection
api/converters
api/utilities
api/errors
api/filesystem
api/models
api/sqlalchemy
api/pandas
api/arrow
api/s3fs
api/spark
api/converters
api/sqlalchemy
api/filesystem
api/models
api/utilities
api/errors

Quick Reference
Quick reference
---------------

Core Functionality
Core functionality
~~~~~~~~~~~~~~~~~~

- :ref:`api_connection` - Connection management and basic cursors
- :ref:`api_converters` - Data type conversion and parameter formatting
- :ref:`api_utilities` - Utility functions and base classes
- :ref:`api_errors` - Exception handling and error classes

Specialized Integrations
Infrastructure
~~~~~~~~~~~~~~~

- :ref:`api_filesystem` - S3 filesystem integration and object management
- :ref:`api_models` - Athena query execution and metadata models

Specialized integrations
~~~~~~~~~~~~~~~~~~~~~~~~

- :ref:`api_sqlalchemy` - SQLAlchemy dialect implementations
- :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
- :ref:`api_sqlalchemy` - SQLAlchemy dialect implementations

Infrastructure
~~~~~~~~~~~~~~~

- :ref:`api_filesystem` - S3 filesystem integration and object management
- :ref:`api_models` - Athena query execution and metadata models
3 changes: 0 additions & 3 deletions docs/cursor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -329,9 +329,6 @@ AsyncS3FSCursor

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

API Reference
-------------

SparkCursor
-----------

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Documentation

introduction
usage
sqlalchemy
cursor
sqlalchemy
pandas
arrow
s3fs
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,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, and Spark cursor implementations
- **Multiple Cursor Types**: Standard, Pandas, Arrow, S3FS, and Spark cursor implementations
- **Async Support**: Asynchronous query execution for non-blocking operations

**Data Type Support:**
Expand Down
4 changes: 2 additions & 2 deletions docs/s3fs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Execution information of the query can also be retrieved.
print(cursor.service_processing_time_in_millis)
print(cursor.output_location)

Type Conversion
Type conversion
~~~~~~~~~~~~~~~

S3FSCursor converts Athena data types to Python types using the built-in converter.
Expand Down Expand Up @@ -172,7 +172,7 @@ Then specify an instance of this class in the converter argument when creating a
cursor = connect(s3_staging_dir="s3://YOUR_S3_BUCKET/path/to/",
region_name="us-west-2").cursor(S3FSCursor, converter=CustomS3FSTypeConverter())

CSV Reader Options
CSV reader options
~~~~~~~~~~~~~~~~~~

S3FSCursor supports pluggable CSV reader implementations to control how NULL values and empty strings
Expand Down
Loading