Skip to content

Commit 4cbb386

Browse files
qiaoyuangqiaoyuang
committed
Add default value support
1 parent 354942f commit 4cbb386

11 files changed

Lines changed: 637 additions & 33 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* New experimental DSL API: `DatabaseScope#CREATE_UNIQUE_INDEX` for creating unique indexes
1111
* New experimental DSL API: `DatabaseScope#PRAGMA_FOREIGN_KEYS` for enabling foreign keys
1212
* New experimental annotation APIs: `ForeignKeyGroup`, `References`, `ForeignKey` for supporting foreign keys for table and column levels
13+
* New experimental annotation API: `@Default` for specifying default values for columns in CREATE TABLE statements
1314
* New SQL aggregate function: `group_concat` for concatenating values with a separator
1415
* New SQL scalar functions: `round`, `random`, `sign`
1516
* New SQL string functions: `substr`, `trim`, `ltrim`, `rtrim`, `replace`, `instr`, `printf`

‎sqllin-dsl-test/build.gradle.kts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,21 @@ kotlin {
8383
}
8484
}
8585

86+
gradle.taskGraph.whenReady {
87+
if (!project.hasProperty("onCICD"))
88+
return@whenReady
89+
tasks.forEach {
90+
when {
91+
it.name.contains("linux", true) -> it.enabled = HostManager.hostIsLinux
92+
it.name.contains("mingw", true) -> it.enabled = HostManager.hostIsMingw
93+
it.name.contains("ios", true)
94+
|| it.name.contains("macos", true)
95+
|| it.name.contains("watchos", true)
96+
|| it.name.contains("tvos", true) -> it.enabled = HostManager.hostIsMac
97+
}
98+
}
99+
}
100+
86101
android {
87102
namespace = "com.ctrip.sqllin.dsl.test"
88103
compileSdk = libs.versions.android.sdk.compile.get().toInt()

‎sqllin-dsl-test/src/androidInstrumentedTest/kotlin/com/ctrip/sqllin/dsl/test/AndroidTest.kt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,15 @@ class AndroidTest {
142142
@Test
143143
fun testForeignKeyWithoutPragma() = commonTest.testForeignKeyWithoutPragma()
144144

145+
@Test
146+
fun testDefaultValuesCreateSQL() = commonTest.testDefaultValuesCreateSQL()
147+
148+
@Test
149+
fun testDefaultValuesInsert() = commonTest.testDefaultValuesInsert()
150+
151+
@Test
152+
fun testDefaultValuesWithForeignKey() = commonTest.testDefaultValuesWithForeignKey()
153+
145154
@Before
146155
fun setUp() {
147156
val context = InstrumentationRegistry.getInstrumentation().targetContext

‎sqllin-dsl-test/src/commonMain/kotlin/com/ctrip/sqllin/dsl/test/Entities.kt‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,4 +381,66 @@ data class FKComment(
381381
val postId: Long,
382382
val content: String,
383383
val createdAt: String,
384+
)
385+
386+
/**
387+
* Default Values Test Entities
388+
*/
389+
390+
/**
391+
* Test entity for @Default annotation with basic types
392+
* Tests default values for String, Int, Boolean, and SQLite functions
393+
*/
394+
@DBRow("default_values_test")
395+
@Serializable
396+
data class DefaultValuesTest(
397+
@PrimaryKey(isAutoincrement = true) val id: Long?,
398+
val name: String,
399+
@com.ctrip.sqllin.dsl.annotation.Default("'active'") val status: String,
400+
@com.ctrip.sqllin.dsl.annotation.Default("0") val loginCount: Int,
401+
@com.ctrip.sqllin.dsl.annotation.Default("1") val isEnabled: Boolean,
402+
@com.ctrip.sqllin.dsl.annotation.Default("CURRENT_TIMESTAMP") val createdAt: String,
403+
)
404+
405+
/**
406+
* Test entity for @Default annotation with nullable types
407+
* Tests default values on nullable columns
408+
*/
409+
@DBRow("default_nullable_test")
410+
@Serializable
411+
data class DefaultNullableTest(
412+
@PrimaryKey(isAutoincrement = true) val id: Long?,
413+
val name: String,
414+
@com.ctrip.sqllin.dsl.annotation.Default("'In Stock'") val availability: String?,
415+
@com.ctrip.sqllin.dsl.annotation.Default("100") val quantity: Int?,
416+
@com.ctrip.sqllin.dsl.annotation.Default("0.0") val discount: Double?,
417+
)
418+
419+
/**
420+
* Parent table for testing @Default with foreign key SET_DEFAULT trigger
421+
*/
422+
@DBRow("default_fk_parent")
423+
@Serializable
424+
data class DefaultFKParent(
425+
@PrimaryKey(isAutoincrement = true) val id: Long?,
426+
val name: String,
427+
)
428+
429+
/**
430+
* Child table with @Default and foreign key SET_DEFAULT trigger
431+
* Tests that default values work with ON_DELETE_SET_DEFAULT
432+
*/
433+
@DBRow("default_fk_child")
434+
@Serializable
435+
@com.ctrip.sqllin.dsl.annotation.ForeignKeyGroup(
436+
group = 0,
437+
tableName = "default_fk_parent",
438+
trigger = com.ctrip.sqllin.dsl.annotation.Trigger.ON_DELETE_SET_DEFAULT
439+
)
440+
data class DefaultFKChild(
441+
@PrimaryKey(isAutoincrement = true) val id: Long?,
442+
@com.ctrip.sqllin.dsl.annotation.ForeignKey(group = 0, reference = "id")
443+
@com.ctrip.sqllin.dsl.annotation.Default("0")
444+
val parentId: Long,
445+
val description: String,
384446
)

‎sqllin-dsl-test/src/commonTest/kotlin/com/ctrip/sqllin/dsl/test/CommonBasicTest.kt‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2611,6 +2611,167 @@ class CommonBasicTest(private val path: DatabasePath) {
26112611
}
26122612
}
26132613

2614+
/**
2615+
* Test for @Default annotation - CREATE SQL generation
2616+
* Verifies that createSQL property contains the DEFAULT clause
2617+
*/
2618+
fun testDefaultValuesCreateSQL() {
2619+
// Test 1: Basic default values
2620+
val defaultValuesSQL = DefaultValuesTestTable.createSQL
2621+
assertEquals(true, defaultValuesSQL.contains("CREATE TABLE default_values_test"))
2622+
assertEquals(true, defaultValuesSQL.contains("status TEXT NOT NULL DEFAULT 'active'"))
2623+
assertEquals(true, defaultValuesSQL.contains("loginCount INT NOT NULL DEFAULT 0"))
2624+
assertEquals(true, defaultValuesSQL.contains("isEnabled BOOLEAN NOT NULL DEFAULT 1"))
2625+
assertEquals(true, defaultValuesSQL.contains("createdAt TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP"))
2626+
2627+
// Test 2: Nullable columns with default values
2628+
val defaultNullableSQL = DefaultNullableTestTable.createSQL
2629+
assertEquals(true, defaultNullableSQL.contains("CREATE TABLE default_nullable_test"))
2630+
assertEquals(true, defaultNullableSQL.contains("availability TEXT DEFAULT 'In Stock'"))
2631+
assertEquals(true, defaultNullableSQL.contains("quantity INT DEFAULT 100"))
2632+
assertEquals(true, defaultNullableSQL.contains("discount DOUBLE DEFAULT 0.0"))
2633+
2634+
// Test 3: Default values with foreign key SET_DEFAULT trigger
2635+
val defaultFKChildSQL = DefaultFKChildTable.createSQL
2636+
assertEquals(true, defaultFKChildSQL.contains("CREATE TABLE default_fk_child"))
2637+
assertEquals(true, defaultFKChildSQL.contains("parentId BIGINT NOT NULL DEFAULT 0"))
2638+
assertEquals(true, defaultFKChildSQL.contains("FOREIGN KEY (parentId) REFERENCES default_fk_parent(id) ON DELETE SET DEFAULT"))
2639+
}
2640+
2641+
/**
2642+
* Test for @Default annotation - INSERT behavior
2643+
* Verifies that default values are used when columns are omitted in INSERT
2644+
* Note: SQLlin's INSERT operation always provides all column values from data classes,
2645+
* so this test verifies the schema is correctly generated with DEFAULT clauses
2646+
*/
2647+
fun testDefaultValuesInsert() {
2648+
val config = DSLDBConfiguration(
2649+
name = DATABASE_NAME,
2650+
path = path,
2651+
version = 1,
2652+
create = {
2653+
CREATE(DefaultValuesTestTable)
2654+
CREATE(DefaultNullableTestTable)
2655+
}
2656+
)
2657+
Database(config, true).databaseAutoClose { database ->
2658+
// Test 1: Verify CREATE SQL contains DEFAULT clauses
2659+
val createSQL = DefaultValuesTestTable.createSQL
2660+
assertEquals(true, createSQL.contains("DEFAULT 'active'"))
2661+
assertEquals(true, createSQL.contains("DEFAULT 0"))
2662+
assertEquals(true, createSQL.contains("DEFAULT 1"))
2663+
2664+
// Test 2: Insert record with all fields specified
2665+
val record1 = DefaultValuesTest(
2666+
id = null,
2667+
name = "Test User",
2668+
status = "active",
2669+
loginCount = 0,
2670+
isEnabled = true,
2671+
createdAt = "2025-12-14 00:00:00"
2672+
)
2673+
database {
2674+
DefaultValuesTestTable { table ->
2675+
table INSERT record1
2676+
}
2677+
}
2678+
2679+
// Verify insertion
2680+
lateinit var selectStatement: SelectStatement<DefaultValuesTest>
2681+
database {
2682+
selectStatement = DefaultValuesTestTable SELECT X
2683+
}
2684+
assertEquals(1, selectStatement.getResults().size)
2685+
val result = selectStatement.getResults()[0]
2686+
assertEquals("Test User", result.name)
2687+
assertEquals("active", result.status)
2688+
assertEquals(0, result.loginCount)
2689+
2690+
// Test 3: Nullable columns with default values
2691+
val nullableRecord = DefaultNullableTest(
2692+
id = null,
2693+
name = "Product A",
2694+
availability = "In Stock",
2695+
quantity = 100,
2696+
discount = 0.0
2697+
)
2698+
database {
2699+
DefaultNullableTestTable { table ->
2700+
table INSERT nullableRecord
2701+
}
2702+
}
2703+
2704+
lateinit var selectNullable: SelectStatement<DefaultNullableTest>
2705+
database {
2706+
selectNullable = DefaultNullableTestTable SELECT X
2707+
}
2708+
assertEquals(1, selectNullable.getResults().size)
2709+
assertEquals("Product A", selectNullable.getResults()[0].name)
2710+
assertEquals("In Stock", selectNullable.getResults()[0].availability)
2711+
assertEquals(100, selectNullable.getResults()[0].quantity)
2712+
}
2713+
}
2714+
2715+
/**
2716+
* Test for @Default annotation with foreign key ON_DELETE_SET_DEFAULT trigger
2717+
* Verifies that default values are correctly included in CREATE TABLE statements with foreign keys
2718+
*/
2719+
@OptIn(ExperimentalDSLDatabaseAPI::class)
2720+
fun testDefaultValuesWithForeignKey() {
2721+
val config = DSLDBConfiguration(
2722+
name = DATABASE_NAME,
2723+
path = path,
2724+
version = 1,
2725+
create = {
2726+
PRAGMA_FOREIGN_KEYS(true)
2727+
CREATE(DefaultFKParentTable)
2728+
CREATE(DefaultFKChildTable)
2729+
}
2730+
)
2731+
Database(config, true).databaseAutoClose { database ->
2732+
// Test 1: Verify CREATE SQL contains DEFAULT with foreign key
2733+
val childSQL = DefaultFKChildTable.createSQL
2734+
assertEquals(true, childSQL.contains("parentId BIGINT NOT NULL DEFAULT 0"))
2735+
assertEquals(true, childSQL.contains("FOREIGN KEY"))
2736+
assertEquals(true, childSQL.contains("REFERENCES default_fk_parent(id)"))
2737+
assertEquals(true, childSQL.contains("ON DELETE SET DEFAULT"))
2738+
2739+
// Test 2: Verify we can insert parent and child records
2740+
val parent = DefaultFKParent(id = null, name = "Test Parent")
2741+
database {
2742+
DefaultFKParentTable { table ->
2743+
table INSERT parent
2744+
}
2745+
}
2746+
2747+
// Get parent ID
2748+
lateinit var parentSelect: SelectStatement<DefaultFKParent>
2749+
database {
2750+
parentSelect = DefaultFKParentTable SELECT X
2751+
}
2752+
val parents = parentSelect.getResults()
2753+
assertEquals(1, parents.size)
2754+
val parentId = parents[0].id!!
2755+
2756+
// Test 3: Insert child record referencing parent
2757+
val child = DefaultFKChild(id = null, parentId = parentId, description = "Test Child")
2758+
database {
2759+
DefaultFKChildTable { table ->
2760+
table INSERT child
2761+
}
2762+
}
2763+
2764+
// Verify child was inserted with correct parentId
2765+
lateinit var childSelect: SelectStatement<DefaultFKChild>
2766+
database {
2767+
childSelect = DefaultFKChildTable SELECT X
2768+
}
2769+
assertEquals(1, childSelect.getResults().size)
2770+
assertEquals(parentId, childSelect.getResults()[0].parentId)
2771+
assertEquals("Test Child", childSelect.getResults()[0].description)
2772+
}
2773+
}
2774+
26142775
private fun getDefaultDBConfig(): DatabaseConfiguration =
26152776
DatabaseConfiguration(
26162777
name = DATABASE_NAME,

‎sqllin-dsl-test/src/jvmTest/kotlin/com/ctrip/sqllin/dsl/test/JvmTest.kt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,15 @@ class JvmTest {
136136
@Test
137137
fun testForeignKeyWithoutPragma() = commonTest.testForeignKeyWithoutPragma()
138138

139+
@Test
140+
fun testDefaultValuesCreateSQL() = commonTest.testDefaultValuesCreateSQL()
141+
142+
@Test
143+
fun testDefaultValuesInsert() = commonTest.testDefaultValuesInsert()
144+
145+
@Test
146+
fun testDefaultValuesWithForeignKey() = commonTest.testDefaultValuesWithForeignKey()
147+
139148
@BeforeTest
140149
fun setUp() {
141150
deleteDatabase(path, CommonBasicTest.DATABASE_NAME)

‎sqllin-dsl-test/src/nativeTest/kotlin/com/ctrip/sqllin/dsl/test/NativeTest.kt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,15 @@ class NativeTest {
152152
@Test
153153
fun testForeignKeyWithoutPragma() = commonTest.testForeignKeyWithoutPragma()
154154

155+
@Test
156+
fun testDefaultValuesCreateSQL() = commonTest.testDefaultValuesCreateSQL()
157+
158+
@Test
159+
fun testDefaultValuesInsert() = commonTest.testDefaultValuesInsert()
160+
161+
@Test
162+
fun testDefaultValuesWithForeignKey() = commonTest.testDefaultValuesWithForeignKey()
163+
155164
@BeforeTest
156165
fun setUp() {
157166
deleteDatabase(path, CommonBasicTest.DATABASE_NAME)

‎sqllin-dsl/doc/getting-start-cn.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,82 @@ data class Product(
400400
)
401401
```
402402

403+
#### @Default - 列默认值
404+
405+
使用 `@Default` 为 CREATE TABLE 语句中的列指定默认值。当插入行时未显式提供这些列的值时，SQLite 会自动使用这些默认值：
406+
407+
```kotlin
408+
import com.ctrip.sqllin.dsl.annotation.DBRow
409+
import com.ctrip.sqllin.dsl.annotation.PrimaryKey
410+
import com.ctrip.sqllin.dsl.annotation.Default
411+
import kotlinx.serialization.Serializable
412+
413+
@DBRow
414+
@Serializable
415+
data class User(
416+
@PrimaryKey(isAutoincrement = true) val id: Long?,
417+
val name: String,
418+
@Default("'active'") val status: String, // String default
419+
@Default("0") val loginCount: Int, // Numeric default
420+
@Default("1") val isEnabled: Boolean, // Boolean default (1 = true)
421+
@Default("CURRENT_TIMESTAMP") val createdAt: String, // SQLite function
422+
)
423+
// Generated SQL: CREATE TABLE User(
424+
// id INTEGER PRIMARY KEY AUTOINCREMENT,
425+
// name TEXT NOT NULL,
426+
// status TEXT NOT NULL DEFAULT 'active',
427+
// loginCount INT NOT NULL DEFAULT 0,
428+
// isEnabled INT NOT NULL DEFAULT 1,
429+
// createdAt TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
430+
// )
431+
```
432+
433+
**值格式：**
434+
- **字符串**：必须用单引号括起来：`'默认文本'`
435+
- **数字**：纯数字字面量：`0`、`42`、`3.14`
436+
- **布尔值**：用 `0` 表示 false，用 `1` 表示 true
437+
- **NULL**：使用字面量 `NULL`
438+
- **表达式**：SQLite 函数，如 `CURRENT_TIMESTAMP`、`datetime('now')`、`(random())` 等
439+
440+
**与外键触发器的集成：**
441+
442+
当使用 `ON_DELETE_SET_DEFAULT` 或 `ON_UPDATE_SET_DEFAULT` 触发器时，**必须**设置默认值：
443+
444+
```kotlin
445+
@DBRow
446+
@Serializable
447+
data class Order(
448+
@PrimaryKey(isAutoincrement = true) val id: Long?,
449+
@References(
450+
tableName = "User",
451+
foreignKeys = ["id"],
452+
trigger = Trigger.ON_DELETE_SET_DEFAULT
453+
)
454+
@Default("0") // REQUIRED when using ON_DELETE_SET_DEFAULT
455+
val userId: Long,
456+
val amount: Double,
457+
)
458+
// When a User is deleted, their Orders' userId becomes 0
459+
```
460+
461+
**重要注意事项：**
462+
- **字符串值必须使用单引号**：`'text'`，而不是 `"text"`
463+
- 默认值不会覆盖 INSERT 语句中显式提供的值
464+
- 像 `CURRENT_TIMESTAMP` 这样的函数在插入时求值，而不是在创建表时
465+
- 注解处理器不会验证默认值是否与列类型匹配
466+
467+
**常见陷阱：**
468+
469+
```kotlin
470+
// ❌ Wrong - using double quotes for strings
471+
@Default("\"active\"")
472+
val status: String
473+
474+
// ✅ Correct - using single quotes for strings
475+
@Default("'active'")
476+
val status: String
477+
```
478+
403479
### 支持的类型
404480

405481
SQLlin 支持以下 Kotlin 类型用于 `@DBRow` 数据类的属性：

0 commit comments

Comments
 (0)