JayDeBeApi

Warnings

• breaking The `connect` method signature changed significantly in JayDeBeApi 1.0.0. Older code using positional arguments for connection properties may break.
  Fix: Update your `jaydebeapi.connect()` calls to use the `driver_args` parameter (as a dictionary or sequence of username/password) and `jars` parameter for driver JAR paths, as documented in versions 1.0.0 and above.
• gotcha Incompatibility issues with certain JPype1 versions, particularly older JayDeBeApi versions with JPype1 0.7.2+. This can lead to connection errors or crashes.
  Fix: Upgrade JayDeBeApi to version 1.2.1 or newer (`pip install --upgrade JayDeBeApi`) to ensure compatibility with JPype1 0.7.2+. Ensure your JPype1 version is also compatible with your Python version.
• gotcha JVM shared library not found errors (e.g., `No JVM shared library file (libjvm.so) found`) are common. This typically means the Java Virtual Machine cannot be located.
  Fix: Ensure a Java Runtime Environment (JRE) or Java Development Kit (JDK) is installed and the `JAVA_HOME` environment variable is correctly set, pointing to your Java installation directory. Also, ensure the Java architecture (32-bit vs. 64-bit) matches your Python installation.
• gotcha Errors like `java.lang.RuntimeException: Class <driver_class_name> not found` indicate that the JDBC driver JAR file is not correctly located or loaded by the JVM.
  Fix: Verify the `jars` parameter in `jaydebeapi.connect()` points to the correct, absolute path of your JDBC driver JAR file. Alternatively, ensure the `CLASSPATH` environment variable includes the path to your JDBC driver JARs before starting your Python script.
• gotcha Mixing 32-bit Python with 64-bit Java (or vice versa) can cause `jpype` to crash, leading to unexpected program termination without clear Python exceptions.
  Fix: Ensure that the architecture (32-bit or 64-bit) of your Python installation matches that of your Java Runtime Environment (JRE) or Java Development Kit (JDK) installation.

Install

• pip install JayDeBeApi Install with pip

Imports

• jaydebeapi

  import jaydebeapi

Quickstart

This quickstart demonstrates how to establish a connection to a database using `jaydebeapi`. You need to provide the path to your JDBC driver JAR file, the fully qualified Java class name of the driver, the JDBC connection URL, and your database credentials. Remember to set the `JDBC_DRIVER_PATH`, `JDBC_DRIVER_CLASS`, `JDBC_URL`, `DB_USER`, and `DB_PASSWORD` environment variables or replace the placeholders.

import jaydebeapi
import os

# NOTE: Replace with your actual JDBC driver path, class name, and connection details
# For example, using a placeholder for a generic JDBC driver (e.g., PostgreSQL)
JDBC_DRIVER_PATH = os.environ.get('JDBC_DRIVER_PATH', '/path/to/your/jdbc_driver.jar')
JDBC_DRIVER_CLASS = os.environ.get('JDBC_DRIVER_CLASS', 'org.postgresql.Driver')
JDBC_URL = os.environ.get('JDBC_URL', 'jdbc:postgresql://localhost:5432/mydatabase')
DB_USER = os.environ.get('DB_USER', 'user')
DB_PASSWORD = os.environ.get('DB_PASSWORD', 'password')

try:
    conn = jaydebeapi.connect(
        JDBC_DRIVER_CLASS,
        JDBC_URL,
        [DB_USER, DB_PASSWORD],
        JDBC_DRIVER_PATH
    )
    cursor = conn.cursor()
    cursor.execute("SELECT 'Hello, JayDeBeApi!' AS message")
    result = cursor.fetchone()
    print(f"Connection successful: {result[0]}")
    cursor.close()
    conn.close()
except Exception as e:
    print(f"Error connecting to database: {e}")
    print("Please ensure your JDBC driver path, class name, URL, and credentials are correct, and that a compatible JRE is installed and JAVA_HOME is set if necessary.")