From b9bc48d825af254533f598288cf3a152f7ec65fa Mon Sep 17 00:00:00 2001 From: dajiaohuang Date: Thu, 15 Oct 2026 16:15:45 +0800 Subject: [PATCH 1/2] Correct API names and generated-key types in guide examples --- README.md | 2 +- README_CN.md | 2 +- sqllin-dsl/doc/getting-start-cn.md | 2 +- sqllin-dsl/doc/getting-start.md | 4 ++-- sqllin-dsl/doc/modify-database-and-transaction-cn.md | 2 +- sqllin-dsl/doc/modify-database-and-transaction.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 781532fb..090a21f4 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ fun sample() { 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 -> + selectStatement.getResults().forEach { person -> println(person.name) } } diff --git a/README_CN.md b/README_CN.md index f2adc20e..6612439c 100644 --- a/README_CN.md +++ b/README_CN.md @@ -18,7 +18,7 @@ fun sample() { 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 -> + selectStatement.getResults().forEach { person -> println(person.name) } } diff --git a/sqllin-dsl/doc/getting-start-cn.md b/sqllin-dsl/doc/getting-start-cn.md index 22c3b643..97079415 100644 --- a/sqllin-dsl/doc/getting-start-cn.md +++ b/sqllin-dsl/doc/getting-start-cn.md @@ -141,7 +141,7 @@ val database = Database( 除此之外，你还可以使用 `DSLDBConfiguration`，它允许你在 `create` 和 `upgrade` 回调中使用类型安全的 SQL DSL，而不是原始的 SQL 字符串： ```kotlin -import com.ctrip.sqllin.driver.DSLDBConfiguration +import com.ctrip.sqllin.dsl.DSLDBConfiguration import com.ctrip.sqllin.dsl.Database val database = Database( diff --git a/sqllin-dsl/doc/getting-start.md b/sqllin-dsl/doc/getting-start.md index a81105bf..84e38965 100644 --- a/sqllin-dsl/doc/getting-start.md +++ b/sqllin-dsl/doc/getting-start.md @@ -150,7 +150,7 @@ only work on Android 9 and higher. And, because [sqlite-jdbc](https://github.com Alternatively, you can use `DSLDBConfiguration` which allows you to use the type-safe SQL DSL in the `create` and `upgrade` callbacks instead of raw SQL strings: ```kotlin -import com.ctrip.sqllin.driver.DSLDBConfiguration +import com.ctrip.sqllin.dsl.DSLDBConfiguration import com.ctrip.sqllin.dsl.Database val database = Database( @@ -396,7 +396,7 @@ Use `@CollateNoCase` to make string comparisons case-insensitive: ```kotlin import com.ctrip.sqllin.dsl.annotation.DBRow import com.ctrip.sqllin.dsl.annotation.PrimaryKey -import com.ctrip.sqllin.dsl.annotation.NoCase +import com.ctrip.sqllin.dsl.annotation.CollateNoCase import com.ctrip.sqllin.dsl.annotation.Unique import kotlinx.serialization.Serializable diff --git a/sqllin-dsl/doc/modify-database-and-transaction-cn.md b/sqllin-dsl/doc/modify-database-and-transaction-cn.md index c94807cd..f017d336 100644 --- a/sqllin-dsl/doc/modify-database-and-transaction-cn.md +++ b/sqllin-dsl/doc/modify-database-and-transaction-cn.md @@ -19,7 +19,7 @@ import kotlinx.serialization.Serializable @Serializable data class Person( @PrimaryKey(autoIncrement = true) - val id: Long = 0, + val id: Long? = null, val name: String, val age: Int, ) diff --git a/sqllin-dsl/doc/modify-database-and-transaction.md b/sqllin-dsl/doc/modify-database-and-transaction.md index 318ec34b..7277772d 100644 --- a/sqllin-dsl/doc/modify-database-and-transaction.md +++ b/sqllin-dsl/doc/modify-database-and-transaction.md @@ -22,7 +22,7 @@ import kotlinx.serialization.Serializable @Serializable data class Person( @PrimaryKey(autoIncrement = true) - val id: Long = 0, + val id: Long? = null, val name: String, val age: Int, ) From 41979f3b8cfb499a06fbba8ee84a46194db5f544 Mon Sep 17 00:00:00 2001 From: dajiaohuang Date: Fri, 16 Oct 2026 03:10:49 +0800 Subject: [PATCH 2/2] Correct query guide result method examples --- CHANGELOG.md | 1 + sqllin-dsl/doc/query-cn.md | 4 ++-- sqllin-dsl/doc/query.md | 4 ++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 325669b3..65792a53 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ * Fix: the default `lookasideSlotSize` and `lookasideSlotCount` of `DSLDBConfiguration` disabled SQLite's lookaside memory allocator on Kotlin/Native and on Android 9 and higher, as those of `DatabaseConfiguration` did; they are now -1, see sqllin-driver * Fix: on the JVM and Kotlin/Native, a blocking `database { }` scope on another thread could take the TEMP table and triggers that count the changes of observed queries with it, as its transaction can be open while they are created, the connection being locked for each statement rather than for a transaction: its rollback removed them, so the next write failed with "no such table", and once another table was observed, the changes of the table they belonged to were no longer counted. The tracker now creates them again where they are gone, and counts a change of their tables. A failure to tell the observed queries of a change no longer takes the place of the failure of the statement that made it. The guide to observed queries and the documentation of `Database#invoke` and `Database#observe` now say to write through `suspendedScope` while queries are observed, as they run on another thread, and that a blocking scope isn't serialized with them * Fix documentation: the example of the guide to concurrency safety called `database suspendScope { }`, which doesn't exist, in a function that wasn't a `suspend` one; it is `database suspendedScope { }`, in a `suspend` function +* Fix documentation: the query guide called `SelectStatement.getResult()`, which doesn't exist; the method is `getResults()` ### sqllin-driver diff --git a/sqllin-dsl/doc/query-cn.md b/sqllin-dsl/doc/query-cn.md index 2eec4a11..ab890ef5 100644 --- a/sqllin-dsl/doc/query-cn.md +++ b/sqllin-dsl/doc/query-cn.md @@ -14,7 +14,7 @@ fun sample() { selectStatement = table SELECT X } } - selectStatement.getResult().forEach { person -> + selectStatement.getResults().forEach { person -> println(person) } } @@ -76,7 +76,7 @@ fun sample() { selectStatement = 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 -> + selectStatement.getResults().forEach { person -> println(person) } } diff --git a/sqllin-dsl/doc/query.md b/sqllin-dsl/doc/query.md index 1c71bb44..edd50372 100644 --- a/sqllin-dsl/doc/query.md +++ b/sqllin-dsl/doc/query.md @@ -16,7 +16,7 @@ fun sample() { selectStatement = table SELECT X } } - selectStatement.getResult().forEach { person -> + selectStatement.getResults().forEach { person -> println(person) } } @@ -78,7 +78,7 @@ fun sample() { selectStatement = 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 -> + selectStatement.getResults().forEach { person -> println(person) } }