
Modrinth · Minecraft mod
SQLib
The easiest way to store data for all your minecraft needs!
Quick answer
Which SQLib release matches 1.19?
SQLib 3.2.9 targets 1.16.5, 1.17, 1.17.1 with Fabric, Quilt, velocity. Installation on the client is optional. Installation on the dedicated server is optional. No extra mods listed for this file.
Where it goes
Is SQLib required on the client, server, or both?
Installation on the client is optional. Installation on the dedicated server is optional.
The source marks this as usable on both the client and server.
What else does SQLib 3.2.9 need?
3.2.9 on 1.19. Every mod below is checked against that same setup.
This file does not list any required mods. Do not add a library just because a different file uses it.
This file does not list any required or optional mods.
Before you install it
Add SQLib without breaking your instance.
Built for SQLib 3.2.9 on 1.19. Pick another file and the loader, install side or required mods may change.
- 01
Stick to this file
Use 3.2.9. It targets 1.16.5, 1.17, 1.17.1 with Fabric, Quilt, velocity; another release may have different loader, side or dependency requirements.
- 02
Bring the mods it needs
This file does not list any required mods. Do not add a library just because a different file uses it.
- 03
Put it on the correct side
Installation on the client is optional. Installation on the dedicated server is optional.
- 04
Pick the file you checked
Use the “Get this file” button beside 3.2.9. It opens that exact file at the source.
About this project
What does SQLib add?
SQLib
SQLib is the easiest way to store data for all your minecraft needs! A simple sql wrapper made with a focus on minecraft use cases.
Important Note:
This library is not a full-fledged sql wrapper, and does not provide full access to many sql features.
The main focus of this library is to provide an easy and simple way to store data in your mods.
If you are looking for a more advanced database I recommend taking a look at something like Nitrite.
Config
The mod generates a config on first time start that allows you to configure the database used by all mods relying on sqlib.
The default database is a sqlite database running in the sqlib directory.
Datatypes
The datatypes can be accessed via JavaTpes, MinecraftTypes or the AdventureTypes classes. I tend to add support for new types as I run into them in my projects. If you would like one added, pleade make an issue!
| Standard | Minecraft | Adventure |
|---|---|---|
| Byte | Vec3i | Key |
| Byte[] | BlockPos | Component |
| Bool | ChunkPos | |
| Short | Text | |
| Int | Identifier | |
| Float | Sound | |
| Double | Json | |
| Long | NbtElement | |
| String | ||
| Char | ||
| Date | ||
| Color | ||
| UUID | ||
| URI | ||
| URL |
You can also add your own custom types as seen here:
Setup
In your build.gradle include:
repositories {
maven { url "https://api.modrinth.com/maven" }
}
dependencies {
modImplementation("maven.modrinth:sqlib:3.2.2")
}
Developer Usage
This example uses the built-in database managed by sqlib. for 99% of mods, using the built-in database is good, however
further down are examples for custom database management.
// Do not call SQLib.getDatabase() in a early mod initializer. Doing so will likely crash your mod.
// Calling in or after the regular mod initializer is ok.
Database db = SQLib.getDatabase();
DataStore store = db.dataStore("myModId", "userdata");
DataContainer playerData = store.createDataContainer();
playerData.put(JavaTypes.STRING, "username", "CoolGuy123");
playerData.put(MinecraftTypes.BLOCKPOS, "home", new BlockPos(304, 62, 37));
playerData.put(MinecraftTypes.NBT, "nbt", new NbtCompound());
System.out.println(playerdata.get(JavaTypes.STRING, "username"));
System.out.println(playerdata.get(MinecraftTypes.BLOCKPOS, "home"));
System.out.println(playerdata.get(MinecraftTypes.NBT, "nbt"));
Custom Database Management
Postgres db = new Postgres("name", "192.168.1.69", "3306", "cooluser", "radman");
// OR
MySQL db = new MySQL("name", "192.168.1.69", "3306", "cooluser", "radman");
// OR
SQLite db = new SQLite("name", "some/dir");
Transaction Support
This approach will bach sql commands into one command for faster read/writes of large amounts of data.
DataStore store = db.dataStore("modId", "userdata");
DataContainer playerData = table.createDataContainer();
playerData.transaction().put("username", "CoolGuy123").put("home", new BlockPos(304, 62, 37).commit();
Custom Types
You can add a custom type by following the implentations in JavaTypes, MinecraftTypes and AdventureTypes. Then you can use it like any other native SQLib type.
// The SQLPrimitive is the base type to serialize to, and the two function lambdas are to serialize and deserialize from it
public static final SQLibType<JsonElement> JSON = new SQLibType<>(SQLPrimitive.STRING, JsonElement::toString, JsonParser::parseString);
// You can also extend a type like this:
public static final SQLibType<Identifier> IDENTIFIER = new SQLibType<>(SQLPrimitive.STRING, Identifier::toString, Identifier::tryParse);
public static final SQLibType<SoundEvent> SOUND = new SQLibType<>(IDENTIFIER, SoundEvent::getId, SoundEvent::of);
Project description from Modrinth.
Pick your setup
SQLib by Minecraft version and loader
Choose the version and loader you play, then open the matching release.
1.21.10
2 loader builds1.21.9
2 loader builds1.21.8
2 loader builds1.21.7
2 loader builds1.21.6
2 loader builds1.21.5
2 loader builds1.21.4
2 loader builds1.21.3
2 loader builds1.21.2
2 loader builds1.21.1
2 loader builds1.21
2 loader buildsShowing the newest 12 of 30 game versions. Older files are in the list below.
Check the dependencies, then try the file in a copied instance before changing a world you care about.
Recent files
SQLib versions and loaders
3.2.9
sqlib-3.2.9.jar
21 Mar 2025
3.2.8
sqlib-3.2.8.jar
5 Feb 2025
3.2.7
sqlib-3.2.7.jar
5 Feb 2025
3.2.6
sqlib-3.2.6.jar
5 Feb 2025
3.2.5
sqlib-3.2.5.jar
21 Dec 2024
3.2.4
sqlib-3.2.4.jar
26 Nov 2024
3.2.3
sqlib-3.2.3.jar
23 Oct 2024
3.2.2
sqlib-3.2.2.jar
20 Sept 2024
3.2.1
sqlib-3.2.1.jar
11 Aug 2024
3.2.0
sqlib-3.2.0.jar
27 Jul 2024
3.1.4
sqlib-3.1.4.jar
22 Jul 2024
3.1.3
sqlib-3.1.3.jar
21 Jul 2024
Looking for an older file? The official Modrinth project page is in Resources.