SQLAlchemy JDBC/ODBC API Documentation

Modern, type-safe SQLAlchemy dialect for JDBC and ODBC connections with native Python implementation.

Version 2.0 - Major Modernization

Version 2.0 is a complete modernization of the library with:

• Automatic JDBC driver download from Maven Central (zero configuration!)

• ODBC support for native database connectivity

• Full SQLAlchemy native dialect integration (ORM, reflection, Alembic, Inspector API)

• DataFrame integration (pandas, polars, pyarrow)

• ️ 12 database dialects (8 JDBC + 4 ODBC)

• Modern Python 3.10+ with full type hints

• SQLAlchemy 2.0+ compatible

• 🏗 SOLID architecture with clean code principles

User Guide

• Quick Start Guide
  • Installation
  • JDBC with Auto-Download (Recommended!)
  • Supported Databases
  • Basic Usage
  • Next Steps
• Usage Guide
  • Table of Contents
  • Installation
  • JDBC Support
  • ODBC Support
  • Database-Specific Examples
  • Driver Management
  • ORM Usage
  • Asyncio Support
  • HikariCP Connection Pooling
  • Database X-Ray Monitoring
  • Advanced Features
  • Performance Optimization
  • Troubleshooting
  • Additional Resources
  • Support
  • Contributing
  • License
• Supported Drivers
  • Table of Contents
  • JDBC Drivers
  • ODBC Drivers
  • Driver Compatibility Matrix
  • Installation Instructions
  • Troubleshooting
  • Additional Resources
  • Support
• SQLAlchemy Integration Guide
  • Features
  • ORM Support
  • Table Reflection & Auto-load
  • Database Inspector
  • ORM Automapping
  • Alembic Migrations
  • Cross-Database Schema Migration
  • Reflection Implementation
  • Connection Pooling
  • Transaction Management
  • Batch Operations
  • Type Hints Support
  • See Also
• Examples
  • Basic Examples
  • Database-Specific Examples
  • DataFrame Integration
  • Advanced Patterns
  • Configuration Examples
  • Testing Examples
  • See Also
• Troubleshooting Guide
  • Table of Contents
  • JPype Issues
  • JDBC Connection Issues
  • Driver Issues
  • Database-Specific Issues
  • Performance Issues
  • Testing Issues
  • Getting Help

API Reference

• API Reference
  • JDBC Module
  • ODBC Module
  • Dialects Module
  • Overview
  • Package Structure
  • Main Entry Point
• JDBC Module
  • Connection
  • Cursor
  • Driver Manager
  • JVM Management
  • Type Converter
  • DataFrame Integration
  • Exceptions
  • DB-API Type Objects
• ODBC Module
  • Connection
  • Exceptions
• Dialects Module
  • Base Dialect
  • PostgreSQL Dialect
  • Oracle Dialect
  • MySQL Dialect
  • SQL Server Dialect
  • DB2 Dialect
  • OceanBase Dialect
  • SQLite Dialect
  • ODBC Dialects

Resources

Development

• Contributing Guide

• Changelog

• Code of Conduct

• Security Policy

Community

• GitHub Repository

• Issue Tracker

• Discussions

• PyPI Package

Indices and tables

• Index

• Module Index

• Search Page