
Typed schema definitions, parameterized SQL, and typed row access with dialect-aware SQL rendering, multiple database drivers, and a BOM for consistent dependency alignment.
Kagiroi (pronounced "kah-gee-roh-ee") is a database toolkit for Kotlin/JS and Kotlin/Wasm. It provides typed schema definitions, parameterized SQL, typed row access, and dialect-specific SQL rendering.
Kagiroi is experimental. Check the target dialect's type mappings and supported operations before using it in an application.
| Database | Connection options |
|---|---|
|
|
In memory, file-backed |
|
|
|
|
|
Direct, |
|
|
PGlite driver |
|
|
Direct, |
|
|
Direct, |
|
|
Direct |
|
|
Direct |
kagiroi-schema.Use kagiroi-bom as a Gradle platform to align every Kagiroi artifact, and
choose the dependencies for your connection target. The BOM contributes version
constraints only; it does not add a runtime library to the application classpath.
dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-sqlite-inmemory-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-sqlite-file-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-d1-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-postgres-node-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-postgres-hyperdrive-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-pglite-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-mysql-node-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-mysql-hyperdrive-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-mariadb")
implementation("dev.quwac.kagiroi:kagiroi-mysql-node-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-mariadb")
implementation("dev.quwac.kagiroi:kagiroi-mysql-hyperdrive-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-sqlserver-node-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlserver-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlserver-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-node-oracle-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-oracle-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-oracle-quwac-bignumber")
}Each driver exposes its dialect and the core SQL and schema modules transitively. MariaDB also requires its own dialect module alongside the MySQL driver. Optional dialect extensions expose their shared type modules transitively; see Kagiroi type mappings for the supported types.
They do not provide Kotlin/Native, standalone Wasm, or WASI database clients.
| Need | Modules |
|---|---|
| Core database contracts | kagiroi-core |
| Table definitions and explicit application schema | kagiroi-schema |
| Typed queries, writes, and DDL | kagiroi-sql |
Optional kotlinx-datetime columns |
Dialect-specific kotlinx-datetime extension |
| Optional BigNumber columns | Dialect-specific BigNumber extension |
| Version alignment | kagiroi-bom |
kagiroi-schema contains tables, columns, expressions, and schema(...).
kagiroi-sql contains statements, parameter rendering, and driver-facing execution
contracts. Dialects contain SQL syntax and physical types; drivers contain host and
connection integration.
Values are bound as parameters; schema identifiers are application declarations.
Dialect-specific operations such as conflict handling, RETURNING/OUTPUT, and
advanced DDL stay visible in the API. Unsupported typed operations fail rather
than being rewritten.
Typed DDL runs only when explicitly executed. Kagiroi does not introspect or synchronize databases, or apply migration history. Use parameterized raw SQL for a complete vendor-specific statement outside the typed API.
Native row-level security is available for PostgreSQL/PGlite, SQL Server, and
Oracle. Register policies in Table.init, export canonical security objects,
plan security changes, and set transaction-scoped runtime context. See
native RLS for native DDL, prerequisites, and context
cleanup semantics.
Typed notNullBackfill declarations describe one-time INSERT/UPDATE operations for
Kagiroi Migration while keeping application columns non-null. See the
backfill API.
Typed typeUsing declarations describe PostgreSQL conversions when an existing non-null
column changes type. See column type conversions.
Column .order(Int) controls CREATE TABLE and schema export order, including columns
inherited from base tables. Unspecified keys follow declaration positions; ties retain
declaration order. See tables and columns.
Kagiroi (pronounced "kah-gee-roh-ee") is a database toolkit for Kotlin/JS and Kotlin/Wasm. It provides typed schema definitions, parameterized SQL, typed row access, and dialect-specific SQL rendering.
Kagiroi is experimental. Check the target dialect's type mappings and supported operations before using it in an application.
| Database | Connection options |
|---|---|
|
|
In memory, file-backed |
|
|
|
|
|
Direct, |
|
|
PGlite driver |
|
|
Direct, |
|
|
Direct, |
|
|
Direct |
|
|
Direct |
kagiroi-schema.Use kagiroi-bom as a Gradle platform to align every Kagiroi artifact, and
choose the dependencies for your connection target. The BOM contributes version
constraints only; it does not add a runtime library to the application classpath.
dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-sqlite-inmemory-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-sqlite-file-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-d1-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlite-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-postgres-node-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-postgres-hyperdrive-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-pglite-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-postgres-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-mysql-node-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-mysql-hyperdrive-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-mariadb")
implementation("dev.quwac.kagiroi:kagiroi-mysql-node-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-mariadb")
implementation("dev.quwac.kagiroi:kagiroi-mysql-hyperdrive-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-mysql-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-sqlserver-node-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlserver-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-sqlserver-quwac-bignumber")
}dependencies {
implementation(platform("dev.quwac.kagiroi:kagiroi-bom:<version>"))
implementation("dev.quwac.kagiroi:kagiroi-node-oracle-driver")
// Optional: kotlinx-datetime columns
// implementation("dev.quwac.kagiroi:kagiroi-oracle-kotlinx-datetime")
// Optional: BigNumber columns
// implementation("dev.quwac.kagiroi:kagiroi-oracle-quwac-bignumber")
}Each driver exposes its dialect and the core SQL and schema modules transitively. MariaDB also requires its own dialect module alongside the MySQL driver. Optional dialect extensions expose their shared type modules transitively; see Kagiroi type mappings for the supported types.
They do not provide Kotlin/Native, standalone Wasm, or WASI database clients.
| Need | Modules |
|---|---|
| Core database contracts | kagiroi-core |
| Table definitions and explicit application schema | kagiroi-schema |
| Typed queries, writes, and DDL | kagiroi-sql |
Optional kotlinx-datetime columns |
Dialect-specific kotlinx-datetime extension |
| Optional BigNumber columns | Dialect-specific BigNumber extension |
| Version alignment | kagiroi-bom |
kagiroi-schema contains tables, columns, expressions, and schema(...).
kagiroi-sql contains statements, parameter rendering, and driver-facing execution
contracts. Dialects contain SQL syntax and physical types; drivers contain host and
connection integration.
Values are bound as parameters; schema identifiers are application declarations.
Dialect-specific operations such as conflict handling, RETURNING/OUTPUT, and
advanced DDL stay visible in the API. Unsupported typed operations fail rather
than being rewritten.
Typed DDL runs only when explicitly executed. Kagiroi does not introspect or synchronize databases, or apply migration history. Use parameterized raw SQL for a complete vendor-specific statement outside the typed API.
Native row-level security is available for PostgreSQL/PGlite, SQL Server, and
Oracle. Register policies in Table.init, export canonical security objects,
plan security changes, and set transaction-scoped runtime context. See
native RLS for native DDL, prerequisites, and context
cleanup semantics.
Typed notNullBackfill declarations describe one-time INSERT/UPDATE operations for
Kagiroi Migration while keeping application columns non-null. See the
backfill API.
Typed typeUsing declarations describe PostgreSQL conversions when an existing non-null
column changes type. See column type conversions.
Column .order(Int) controls CREATE TABLE and schema export order, including columns
inherited from base tables. Unspecified keys follow declaration positions; ties retain
declaration order. See tables and columns.