API reference

This section provides comprehensive API documentation for all PyAthena classes and functions, organized by functionality.

API Documentation:

• Connection and Cursors
  • Connection
  • Standard Cursors
  • Asynchronous Cursors
  • Result Sets
• Data Conversion
  • Type Converters
  • Parameter Formatters
• Utilities and Configuration
  • Retry Configuration
  • Utility Functions
  • Common Base Classes
• Exception Handling
  • Exception Hierarchy
  • Base Exceptions
  • Interface Errors
  • Data Errors
  • Operational Errors
• File System Integration
  • S3 FileSystem
  • Async S3 FileSystem
  • S3 Executor
  • S3 Objects
  • S3 Upload Operations
• Data Models
  • Query Execution
  • Session Management
  • Database and Table Metadata
  • File Formats and Compression
• SQLAlchemy Integration
  • Dialects
  • Type System
  • Compilers
  • Identifier Preparers
• Pandas Integration
  • Pandas Cursors
  • Pandas Result Set
  • Pandas Data Converters
  • Pandas Utilities
• Apache Arrow Integration
  • Arrow Cursors
  • Arrow Result Set
  • Arrow Data Converters
  • Arrow Utilities
• Polars Integration
  • Polars Cursors
  • Polars Result Set
  • Polars Data Converters
  • Polars Utilities
• S3FS Integration
  • S3FS Cursors
  • S3FS CSV Readers
  • S3FS Data Converters
  • S3FS Result Set
• Spark Integration
  • Spark Cursors
  • Spark Base Classes
• Native Asyncio
  • Connection
  • Aio Cursors
  • Aio Result Set
  • Aio Base Classes
  • Aio Pandas Cursor
  • Aio Arrow Cursor
  • Aio Polars Cursor
  • Aio S3FS Cursor
  • Aio Spark Cursor

Quick reference

Core functionality

• Connection and Cursors - Connection management and basic cursors

• Data Conversion - Data type conversion and parameter formatting

• Utilities and Configuration - Utility functions and base classes

• Exception Handling - Exception handling and error classes

Infrastructure

• File System Integration - S3 filesystem integration and object management

• Data Models - Athena query execution and metadata models

Specialized integrations

• SQLAlchemy Integration - SQLAlchemy dialect implementations

• Pandas Integration - pandas DataFrame integration

• Apache Arrow Integration - Apache Arrow columnar data integration

• Polars Integration - Polars DataFrame integration (no pyarrow required)

• S3FS Integration - Lightweight S3FS-based cursor (no pandas/pyarrow required)

• Spark Integration - Apache Spark integration for big data processing

• Native Asyncio - Native asyncio cursor implementations