![](\"https:\/\/raw.githubusercontent.com\/MrNavaStar\/SQLib\/master\/src\/main\/resources\/assets\/sqlib\/icon.png\"){kind=icon}
<\/p>\n
\n<\/p>\n
<\/p>\n
<\/p>\n
# SQLib
\nSQLib is the easiest way to store data for all your minecraft needs! A simple sql wrapper made with a focus on minecraft use cases.<\/p>\n
# Important Note:
\nThis library is not a full-fledged sql wrapper, and does not provide full access to many sql features.
\nThe main focus of this library is to provide an easy and simple way to store data in your mods.
\nIf you are looking for a more advanced database I recommend taking a look at something like Nitrite.<\/p>\n
# Config
\nThe mod generates a config on first time start that allows you to configure the database used by all mods relying on sqlib.
\nThe default database is a sqlite database running in the sqlib directory.<\/p>\n
# Datatypes
\nThe 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!
\n| Standard | Minecraft | Adventure |
\n|———-|————-|———–|
\n| Byte | Vec3i | Key |
\n| Byte[] | BlockPos | Component |
\n| Bool | ChunkPos | |
\n| Short | Text | |
\n| Int | Identifier | |
\n| Float | Sound | |
\n| Double | Json | |
\n| Long | NbtElement | |
\n| String | | |
\n| Char | | |
\n| Date | | |
\n| Color | | |
\n| UUID | | |
\n| URI | | |
\n| URL | | |<\/p>\n
You can also add your own custom types as seen here:<\/p>\n
# Setup
\nIn your build.gradle include:
\n“` gradle
\nrepositories {
\n maven { url “https:\/\/api.modrinth.com\/maven” }
\n}<\/p>\n
dependencies {
\n modImplementation(“maven.modrinth:sqlib:3.2.2”)
\n}
\n“`<\/p>\n
# Developer Usage
\nThis example uses the built-in database managed by sqlib. for 99% of mods, using the built-in database is good, however
\nfurther down are examples for custom database management.
\n“`java
\n\/\/ Do not call SQLib.getDatabase() in a early mod initializer. Doing so will likely crash your mod.
\n\/\/ Calling in or after the regular mod initializer is ok.
\nDatabase db = SQLib.getDatabase();<\/p>\n
DataStore store = db.dataStore(“myModId”, “userdata”);<\/p>\n
DataContainer playerData = store.createDataContainer();
\nplayerData.put(JavaTypes.STRING, “username”, “CoolGuy123”);
\nplayerData.put(MinecraftTypes.BLOCKPOS, “home”, new BlockPos(304, 62, 37));
\nplayerData.put(MinecraftTypes.NBT, “nbt”, new NbtCompound());<\/p>\n
System.out.println(playerdata.get(JavaTypes.STRING, “username”));
\nSystem.out.println(playerdata.get(MinecraftTypes.BLOCKPOS, “home”));
\nSystem.out.println(playerdata.get(MinecraftTypes.NBT, “nbt”));
\n“`<\/p>\n
# Custom Database Management
\n“`java
\nPostgres db = new Postgres(“name”, “192.168.1.69”, “3306”, “cooluser”, “radman”);
\n\/\/ OR
\nMySQL db = new MySQL(“name”, “192.168.1.69”, “3306”, “cooluser”, “radman”);
\n\/\/ OR
\nSQLite db = new SQLite(“name”, “some\/dir”);
\n“`<\/p>\n
# Transaction Support
\nThis approach will bach sql commands into one command for faster read\/writes of large amounts of data.
\n“`java
\nDataStore store = db.dataStore(“modId”, “userdata”);<\/p>\n
DataContainer playerData = table.createDataContainer();
\nplayerData.transaction().put(“username”, “CoolGuy123”).put(“home”, new BlockPos(304, 62, 37).commit();
\n“`<\/p>\n
# Custom Types \/\/ You can also extend a type like this: The easiest way to store data for all your minecraft needs!<\/p>\n","protected":false},"featured_media":147481,"template":"","meta":{"_minecraft_slug":"sqlib","_minecraft_project_id":"IM84wwxs","_minecraft_author":"mrnavastar","_minecraft_license":"CC0-1.0","_minecraft_downloads":10599,"_minecraft_follows":32,"_minecraft_client_side":"optional","_minecraft_server_side":"optional","_minecraft_storage_type":"zip","_minecraft_archive_name":"sqlib.zip","_minecraft_size_bytes":441209071,"_minecraft_version_count":67,"_minecraft_updated_at":"2026-05-16T01:53:44.715670Z","_minecraft_date_created":"2023-05-02T22:22:35.229563Z","_minecraft_date_modified":"2025-03-21T15:20:51.459119Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/sqlib","_minecraft_icon_attachment_id":147481,"_minecraft_imported_at":"2026-06-08T20:22:50+00:00","_minecraft_import_hash":"684d3ed7b876591ce6fe678430e9dbaa","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,873,126,98,123,985],"mod_loader":[99,100,986],"minecraft_version":[48,49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-147480","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-library","mod_category-management","mod_category-quilt","mod_category-technology","mod_category-velocity","mod_loader-fabric","mod_loader-quilt","mod_loader-velocity","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n
\nYou 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.
\n“`java
\n\/\/ The SQLPrimitive is the base type to serialize to, and the two function lambdas are to serialize and deserialize from it
\npublic static final SQLibType
\npublic static final SQLibType
\npublic static final SQLibType
\n“`<\/p>\n","protected":false},"excerpt":{"rendered":"