中文版请见这里

SQLlin is a Kotlin Multiplatform SQLite library that based on DSL and KSP. You can write SQL statements with your Kotlin code and these can be verified by Kotlin compiler. Sample just like be this:

private val db by lazy { Database(name = "person.db", path = path, version = 1) }

fun sample() {
    val tom = Person(age = 4, name = "Tom")
    val jerry = Person(age = 3, name = "Jerry")
    val jack = Person(age = 8, name = "Jack")
    val selectStatement: SelectStatement<Person> = db {
        PersonTable { table ->
            table INSERT listOf(tom, jerry, jack)
            table UPDATE SET { age = 5; name = "Tom" } WHERE ((age LTE 5) AND (name NEQ "Tom"))
            table DELETE WHERE ((age GTE 10) OR (name NEQ "Jerry"))
            table SELECT WHERE (age LTE 5) GROUP_BY age HAVING (upper(name) EQ "TOM") ORDER_BY (age to DESC) LIMIT 2 OFFSET 1
        }
    }
    selectStatement.getResult().forEach { person ->
        println(person.name)
    }
}

SQLlin is able to insert Kotlin objects into database directly, and could query Kotlin objects directly from database. The serialization and deserialization ability based on kotlinx.serialization.

SQLlin supports these platforms:

• Android (6.0+)
• iOS (x64, arm64, simulatorArm64)
• macOS (x64, arm64)
• watchOS (x64, arm32, arm64, simulatorArm64, deviceArm64)
• tvOS (x64, arm64, simulatorArm64)
• Linux (x64)
• Windows (mingwX64)

The structure design of SQLlin is shown in the figure:

SQLlin has two major parts: sqllin-dsl and sqllin-driver. The sqllin-driver is a common multiplatform SQLite low-level API, most of the time it is not recommended to use it directly. The sqllin-dsl is the SQL statements DSL implementation and depends on sqllin-driver.

The sqllin-processor uses KSP to process annotations and generate codes for use with sqllin-dsl.

You can learn how to use sqllin-dsl in these documentations:

• Getting Start
• Modify Database and Transaction
• Query
• SQL Functions
• Advanced Query

I don't recommend use sqllin-driver directly, but if you want to learn more about it, you can read:

• The sqllin-driver basic design and usage

Due to sqllin-dsl's deserialization based on kotlinx.serialization, R8/ProGuard configuration please refer to kotlinx.serialization#Android.

Distributed under the Apache License, Version 2.0.

See LICENSE for more information.