Sqldelight

SQLDelight is a Kotlin database library that validates SQL schema, statements, and migrations at compile time, generating type-safe Kotlin query functions from labeled SQL files. It treats SQL as the source of truth for database definitions, catching schema errors during the build process before they reach production.

The library supports multiple database dialects including SQLite, MySQL, PostgreSQL, HSQL, and H2, and generates platform-specific code for Android, iOS, JVM, and JavaScript targets. It provides a platform-specific driver abstraction that handles database connectivity differences across environments, with connection pooling that reserves a dedicated connection for write operations while limiting concurrent readers.

SQLDelight assembles database schemas by applying numbered migration files in order, and generates typed Kotlin APIs that accept parameters and return structured results at runtime. For JavaScript targets, it offloads all database operations to a background web worker to prevent blocking the main thread. The library works with standard JDBC data sources, Android databases, and SQLite files or in-memory databases.

Features

Kotlin SQL Compilers - Compiles SQL queries into type-safe Kotlin code, catching schema errors at build time.

Database Driver Abstractions - Provides a common database access interface with platform-specific implementations for Android, native, JVM, and JavaScript.

Database Drivers - Creates platform-specific database driver instances for Android, native, JVM, and JavaScript targets.

Database Migration Management - Applies numbered SQL migration files in order to evolve the database schema.

Typesafe Query API Generators - Creates functions from labeled SQL statements that return typed objects and accept typed parameters.

SQL Schema Definitions - Defines database schemas using SQL statements that are verified at compile time and generate matching Kotlin types.

Compile-Time Verified Schemas - Writes table definitions, indexes, and seed data in schema files that are verified at compile time for correctness.

Typesafe Query Function Generators - Generates typed Kotlin query functions from labeled SQL statements at compile time.

Schema Migration Tools - Assembles database schemas by applying numbered migration files in order.

SQL Dialect Adapters - Provides dialect-specific SQL parsing to support multiple database engines at compile time.

SQL Query Execution - Runs generated typesafe query functions through a database driver, returning typed objects.

Typesafe Query Executions - Labels SQL statements to produce generated typed functions that run the statements and return typed objects.

Typesafe Query Generations - Generates functions for each labeled SQL statement, returning typed results and accepting typed parameters.

Typesafe Kotlin Code Generators - Compiles SQL schema and queries into type-safe Kotlin code at build time.

Multi-Database Support - Supports multiple interchangeable SQL database backends including SQLite, MySQL, PostgreSQL, and HSQL/H2.

Multi-Platform Database Frameworks - Supports Android, iOS, JVM, and JavaScript with multiple SQL dialects from a single codebase.

Schema Migrations - Assembles the database schema by applying numbered migration files in order.

SQL Schema Generators - Generates SQL schema definitions from SQL statements in schema files, producing a database class and schema object.

Compile-Time Schema Integrations - Treats SQL schema files as the source of truth, verified at compile time to generate matching Kotlin types.

Platform Support - Supports Android, native, JVM, and JavaScript environments across desktop and mobile.

SQL Query Extensions - Creates typed query functions from labeled SQL statements for runtime execution.

Typed Query Function Generators - Generates typed Kotlin functions from labeled SQL statements for runtime execution.

Multi-Platform Code Generators - Generates platform-specific Kotlin code from a single SQL source for multiple targets.

Database Access Code Generators - Generates platform-specific database access code from a single SQL source for Android, iOS, JVM, and JavaScript.

Database Schema Migrations - Assembles database schemas by applying numbered migration files in order.

Typesafe SQL Code Generators - Generates type-safe Kotlin APIs from SQL schema, queries, and migrations at compile time.

SQL Query Validators - Validates SQL syntax and type safety against a live database schema during the build process.

Database API Generation - Generates type-safe database access APIs from SQL schema and queries at compile time.

SQL Schema Validators - Validates SQL schema, statements, and migrations during compilation to ensure correctness before runtime.

Android Database Access Tools - Constructs an Android-specific database driver using the generated schema to create or migrate the database.

Read-Write Connection Limiters - Limits concurrent read connections while reserving a dedicated connection for writes and transactions.

Write-Reserved Connection Pools - Implements connection pooling with a dedicated write reservation and reader limits.

SQLite Database Management - Opens SQLite database files or in-memory databases using JDBC connection strings and generated schemas.

Web Worker Execution - Executes all database operations in a background web worker to prevent blocking the main thread.

Database Connectivity Drivers - Opens database connections from standard JDBC data sources for executing generated typesafe queries.

Main Thread Offloading - Offloads database operations to a background web worker to prevent blocking the main JavaScript thread.

sqldelightsqldelight

Features

Star history