BoxLang 🚀 A New JVM Dynamic Language Learn More...

BoxLang Apache Derby

v1.0.0+2 BoxLang Modules

⚡︎ BoxLang Module: Apache Derby JDBC Driver

|:------------------------------------------------------:  |
| ⚡︎ B o x L a n g ⚡︎
| Dynamic : Modular : Productive
|:------------------------------------------------------:  |
Copyright Since 2023 by Ortus Solutions, Corp |


This module provides a BoxLang JDBC driver for Apache Derby. This module is part of the BoxLang project.


See BoxLang's Defining Datasources documentation for full examples on where and how to construct a datasource connection pool.

Here's a few examples of some Apache Derby datasources:

Connecting to an In-Memory Database

You can specify an in-memory database using this connection string: jdbc:derby: memory:{MyDBName};create=true where {MyDBName} is replaced with your database name of choice:

this.datasources[ "testDB" ] = {
	"driver"  : "derby",
	"protocol": "memory",
	"database": "testDB"

Connecting to a Database Directory On Disk

You can also work with an on-disk database:

this.datasources[ "AutoDB" ] = {
	"driver"  : "derby",
	"protocol": "directory",
	"database": "/home/michael/myApp/resources/AutoDB"

Connecting to a .Zip or .Jar File As a Read-Only Database

Apache Derby also supports compressing databases into a .zip file or .jar file, then accessing those as a readonly database:

Doing this as a BoxLang datasource would look like:

this.datasources[ "myJarDB" ] = {
	"driver"  : "derby",
	"protocol": "jar",
	"database": expandPath( "./libs/myDB.jar" ) & "products/boiledfood"

Note that even though protocol is set to "jar", a .zip file is fully supported. 😁

Note it is important to specify an absolute path to the jar or zip file, and the database file path within the jar must be specified correctly. You may need to use a leading slash. For more notes, see the Apache Derby documentatiion on Transferring read-only databases to archive (jar or zip) files and Accessing a read-only database in a zip/jar file.

Ortus Sponsors

BoxLang is a professional open-source project and it is completely funded by the community and Ortus Solutions, Corp. Ortus Patreons get many benefits like a cfcasts account, a FORGEBOX Pro account and so much more. If you are interested in becoming a sponsor, please visit our patronage page:


"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12


All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.


1.0.0 - 2024-06-13

1.0.0 => 2024-APR-05

  • First iteration of this module

$ box install bx-derby

No collaborators yet.
  • {{ getFullDate("2024-05-14T22:37:19Z") }}
  • {{ getFullDate("2024-06-13T13:11:54Z") }}
  • 213
  • 107