JDBC Drivers

JDBC drivers require Java. There is no BoxLang-only mechanism for registering database drivers.

JDBC driver modules provide database connectivity for BoxLang's datasource system. Common examples include bx-mysql, bx-postgresql, and bx-sqlite.

Registration Methods

There are two approaches to register JDBC drivers:

Implement java.sql.Driver and register via DriverManager:

File: src/main/java/ortus/boxlang/modules/mymodule/jdbc/MyJDBCDriver.java

import java.sql.*;

public class MyJDBCDriver implements Driver {

    static {
        try {
            DriverManager.registerDriver( new MyJDBCDriver() );
        } catch ( SQLException e ) {
            throw new RuntimeException( "Failed to register driver", e );
        }
    }

    @Override
    public Connection connect( String url, Properties info ) {
        // Return connection if URL matches
    }

    @Override
    public boolean acceptsURL( String url ) {
        return url.startsWith( "jdbc:mydb:" );
    }

    // ... other Driver methods
}

ServiceLoader Config: META-INF/services/java.sql.Driver

ortus.boxlang.modules.mymodule.jdbc.MyJDBCDriver

Implement IJDBCDriver for BoxLang-specific features:

import ortus.boxlang.runtime.jdbc.IJDBCDriver;

public class MyBoxLangJDBCDriver implements IJDBCDriver {

    @Override
    public String getPrefix() {
        return "jdbc:mydb:";
    }

    @Override
    public Connection connect( String url, Properties info ) {
        // Return connection
    }

    @Override
    public boolean acceptsURL( String url ) {
        return url.startsWith( getPrefix() );
    }
}

Module Structure

JDBC driver modules are typically simple — just the driver JAR and registration:

bx-mydb/
├── box.json
├── ModuleConfig.bx
├── libs/
│   └── mydb-jdbc.jar
└── src/main/java/
    └── ortus/boxlang/modules/mydb/
        └── MyDBDriver.java