JarCastingSomeDB
An opinionated library that provides a simple way to run an embedded, file backed database.
It uses:
- Flyway for schema migrations,
- SQLite (via sqlite-jdbc) for the database, and
- JDBI for executing SQL.
Installing
SomeDB can be installed from maven central.
In the below examples replace LATEST_VERSION as appropriate. The latest version is:
To use with maven add the following to your pom.xml.
<dependency>
<groupId>com.github.princesslana</groupId>
<artifactId>somedb</artifactId>
<version>LATEST_VERSION</version>
</dependency>
For gradle:
compile group: 'com.github.princesslana', name: 'somedb', version: 'LATEST_VERSION'
To use the latest development version SomeDB is available via JitPack
Getting Started
The following steps outline the quickest way to get a database setup within your application.
First, ensure that SomeDB is Installed in your project.
Next, we need to define how our database schema. With Flyway we place our migrations on the classpath under the path db/migration. If you are using Gradle or Maven this means they should be in the src/main/resources/db/migration folder.
Flyway has a naming scheme that should be followed so that our migrations can be discovered. For the example here our file could be called V1__Create_favorite_color_table.sql. In this file we can place SQL that will be used to setup our database.
CREATE TABLE favorite_color (
username VARCHAR(64),
color VARCHAR(64)
);
Now we are ready to use our database in our code. As an optional (but recommended step) we can initialize our database. If we don't initialize our database explicitly, it will be initialized on first use using a default name. We can use TheDB.initialize to perform this step.
import com.github.princesslana.somedb.TheDB;
public class MyApp {
public static void main(String[] args) {
TheDB.initialize("my_cool_app");
// ... more code ...
}
}
We can insert data into our database by using the execute method. Parameterized queries are supported using ? as the placeholder.
String name = ...
String color = ...
TheDB.execute("insert into favorite_color(username, color) values (?, ?)", name, color);
Querys can by run with the select method. The select method must be provided with a way to convert a row from the ResultSet into an object of our choosing. Results are provided as Stream, meaning we are able to use the full range of Stream functionality to, for example, get the first item or collect the results into a List. As with execute, parameterized queries are supported using ? as the placeholder.
String name = ...
Stream<FavoriteColor> colors = TheDB.execute(
rs -> new FavoriteColor(rs.getString("username"), rs.getString("color")),
"select username, color from favorite_color where username = ?",
name);
About Singletons
To say that the Singleton design pattern is controversial would be an understatement. SomeDB lets you choose whether you want to Singleton or not. If you wish to Singleton you can use the TheDB class, which provides static methods to execute SQL and access the database. If you do not wish to Singleton you can create instances of the OneDB class. Both classes provide the same functionality and a pretty much identical interface.
Contact
For futher help, queries, or to contribute the best way to reach out is the Discord Projects Hub.
