https://github.com/ctripcorp/SQLlin

A DSL ORM library for Kotlin Multiplatform.
https://github.com/ctripcorp/SQLlin

android ios kotlin kotlin-jvm kotlin-multiplaform kotlin-multiplatform-library kotlin-native-library macos sqlite

Last synced: 3 months ago
JSON representation

A DSL ORM library for Kotlin Multiplatform.

• Host: GitHub
• URL: https://github.com/ctripcorp/SQLlin
• Owner: ctripcorp
• License: apache-2.0
• Created: 2022-11-24T06:24:01.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T02:03:24.000Z (5 months ago)
• Last Synced: 2024-07-12T20:08:10.816Z (4 months ago)
• Topics: android, ios, kotlin, kotlin-jvm, kotlin-multiplaform, kotlin-multiplatform-library, kotlin-native-library, macos, sqlite
• Language: C
• Homepage:
• Size: 5.95 MB
• Stars: 219
• Watchers: 3
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

• kmp-awesome - SQLlin - Low-level API for SQLite in Kotlin Multiplatform (Libraries / 📦 Storage)

README

        
# SQLlin

中文版请见[这里](README_CN.md)

SQLlin is an ORM library for Kotlin Multiplatform that is based on DSL and KSP. It uses SQLite under the hood. You can write SQL

statements with your Kotlin code and these can be verified by Kotlin compiler. Sample just like be this:

```kotlin

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 = 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 from database directly. The serialization

and deserialization ability is based on [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization).

SQLlin supports these platforms:

- Multiplatform Common

- Android (6.0+)

- JVM (Java 11+, since `1.2.0`)

- iOS (x64, arm64, simulatorArm64)

- macOS (x64, arm64)

- watchOS (x64, arm32, arm64, simulatorArm64, deviceArm64)

- tvOS (x64, arm64, simulatorArm64)

- Linux (x64, arm64)

- Windows (mingwX64)

The architecture design of SQLlin is shown in the figure:

![sqllin-architecture](sqllin-architecture.png)

SQLlin has 3 major parts: _sqllin-dsl_, _sqllin-driver_ and _sqllin-processor_. The _sqllin-driver_ is a set of common multiplatform SQLite low-level

APIs, most of the time it is not recommended to use it directly. The _sqllin-dsl_ is DSL implementations for SQL statements, it is based on

_sqllin-driver_. The _sqllin-processor_ uses KSP to process annotations and generate code for using with _sqllin-dsl_.

You can learn how to use _sqllin-dsl_ in these documentations:

- [Getting Start](./sqllin-dsl/doc/getting-start.md)

- [Modify Database and Transaction](./sqllin-dsl/doc/modify-database-and-transaction.md)

- [Query](./sqllin-dsl/doc/query.md)

- [Concurrency Safety](./sqllin-dsl/doc/concurrency-safety.md)

- [SQL Functions](./sqllin-dsl/doc/sql-functions.md)

- [Advanced Query](./sqllin-dsl/doc/advanced-query.md)

I don't recommend using _sqllin-driver_ directly, but if you want to learn more about it, you can read:

- [The sqllin-driver Basic Design and Usage](./sqllin-driver/README.md)

## R8/ProGuard

Due to _sqllin-dsl_'s serialization and deserialization are based on [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization), the R8/ProGuard configuration please refer to

[kotlinx.serialization#Android](https://github.com/Kotlin/kotlinx.serialization#Android).

## License

Distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

See [LICENSE](LICENSE.txt) for more information.