search

daneshpatel / sqlalchemy-jdbcapi

SQLAlchemy dialect for JDBC supported database. (Using JDBCAPI)
Other
23 stars 25 forks source link

readme

JDBC Connection for SQLAlchemy.

.. image:: https://img.shields.io/pypi/dm/sqlalchemy-jdbcapi.svg :target: https://pypi.org/project/sqlalchemy-jdbcapi/

The primary purpose of this dialect is to provide JDBC connection using provided driver(JAR).

Installation

Installing the dialect is straightforward::

 python3 -m pip install sqlalchemy-jdbcapi

Usage

Set an environment variable export CLASSPATH=<path>/ojdbc8.jar:<path>/postgresql-42.2.9.jre7.jar

PostgressSQL::

from sqlalchemy import create_engine
create_engine('jdbcapi+pgjdbc://{}:{}@{}/{}'.format(username, password, <ip:host>', <database name>))

Oracle::

create_engine("jdbcapi+oraclejdbc://username:password@HOST:1521/Database")

OceanBase::

from urllib.parse import quote
user = quote('username@tenant#cluster')
create_engine("jdbcapi+oceanbasejdbc://user:password@HOST:2881/Database")

GenericJDBCConnection::

    Set an environment variable `JDBC_DRIVER_PATH`

Supported databases

In theory every database with a suitable JDBC driver should work.

Contributing

Please submit bugs and patches <https://github.com/daneshpatel/sqlalchemy-jdbcapi/issues>_. All contributors will be acknowledged. Thanks!

Changelog