Fix many issues about removing the DBEntity

CHANGELOG.md

@@ -4,6 +4,11 @@
 
 ## v1.1.1 / 2023-xx-xx
 
+### sqllin-dsl
+
+* *Breaking Change*: Remove the public API `DBEntity`([#36](https://github.com/ctripcorp/SQLlin/pull/36)), any data classes used in _sqllin-dsl_ don't need to extend `DBEntity` anymore.
+
+
 ### sqllin-driver
 
 * Fix a bug about empty `ByteArray` on native platforms([#30](https://github.com/ctripcorp/SQLlin/pull/30))

sqllin-dsl/doc/advanced-query-cn.md

@@ -62,7 +62,7 @@ SQLlin 还不支持子查询，我们将会尽快开发该功能。
 
 SQLlin 目前支持 join 表。
 
-我们需要另外两个 `DBEntity`：
+我们需要另外两个数据库实体：
 
 ```kotlin
 @DBRow("transcript")
@@ -71,28 +71,22 @@ data class Transcript(
     val name: String?,
     val math: Int,
     val english: Int,
-): DBEntity<Transcript> {
-    override fun kSerializer(): KSerializer<Transcript> = serializer()
-}
+)
 
 @Serializable
 data class Student(
     val name: String?,
     val age: Int?,
     val math: Int,
     val english: Int,
-): DBEntity<Student> {
-    override fun kSerializer(): KSerializer<Student> = serializer()
-}
+)
 
 @Serializable
 data class CrossJoinStudent(
     val age: Int?,
     val math: Int,
     val english: Int,
-): DBEntity<CrossJoinStudent> {
-    override fun kSerializer(): KSerializer<Student> = CrossJoinStudent()
-}
+)
 ```
 
 `Transcript` 代表另一张表，`Student` 表示 join 的查询结果的类型（所以 `Student` 不需要被添加 `@DBRow` 注解），它拥有所有 `Person` 和 `Transcript`

sqllin-dsl/doc/advanced-query.md

@@ -65,7 +65,7 @@ SQLlin doesn't yet support subqueries, we will develop as soon as possible.
 
 SQLlin supports joining tables now.
 
-We need other two `DBEntity`s:
+We need other two database entities:
 
 ```kotlin
 @DBRow("transcript")
@@ -74,28 +74,22 @@ data class Transcript(
     val name: String?,
     val math: Int,
     val english: Int,
-): DBEntity<Transcript> {
-    override fun kSerializer(): KSerializer<Transcript> = serializer()
-}
+)
 
 @Serializable
 data class Student(
     val name: String?,
     val age: Int?,
     val math: Int,
     val english: Int,
-): DBEntity<Student> {
-    override fun kSerializer(): KSerializer<Student> = serializer()
-}
+)
 
 @Serializable
 data class CrossJoinStudent(
     val age: Int?,
     val math: Int,
     val english: Int,
-): DBEntity<CrossJoinStudent> {
-    override fun kSerializer(): KSerializer<Student> = CrossJoinStudent()
-}
+)
 ```
 
 The `Transcript` represents a other table. And the `Student` represents the join query results' type(so `Student`

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

@@ -126,9 +126,9 @@ override fun onDestroy() {
 }
 ```
 
-## 定义你的 DBEntity
+## 定义你的数据库实体
 
-在 _sqllin-dsl_ 中，你可以直接插入或查找对象。所以，你需要使用正确的方式定义你的 data class，比如：
+在 _sqllin-dsl_ 中，你可以直接插入或查找对象。所以，你需要使用正确的方式定义你的数据库实体，比如：
 
 ```kotlin
 import com.ctrip.sqllin.dsl.annotation.DBRow
@@ -141,8 +141,8 @@ data class Person(
     val age: Int,
 )
 ```
-你定义的 DBEntity 的属性名应与数据库表的列名相对应。DBEntity 不应该拥有名字与表中的所有列名均不相同的属性，但是
-DBEntity 的属性数量可以比表中列的数量少。
+你定义的数据库实体的属性名应与数据库表的列名相对应。数据库实体不应该拥有名字与表中的所有列名均不相同的属性，但是
+数据库实体的属性数量可以比表中列的数量少。
 
 `@DBRow` 的参数 `tableName` 表示数据库中的表名，请确保传入正确的值。如果不手动传入，_sqllin-processor_
 将会使用类名作为表名，比如 `Person` 类的默认表名是"Person"。

sqllin-dsl/doc/getting-start.md

@@ -134,7 +134,7 @@ override fun onDestroy() {
 }
 ```
 
-## Defining Your DBEntity
+## Defining Your database entity
 
 In _sqllin-dsl_, you can insert and query objects directly. So, you need to use the correct way to define your data class. For example:
 
@@ -150,8 +150,8 @@ data class Person(
 )
 ```
 
-Your DBEntity's property names should same with the database table's column names. The DBEntity cannot have properties with names different from all
-column names in the table. But the count of your DBEntity's properties can less than the count of columns.
+Your database entity's property names should same with the database table's column names. The database entity cannot have properties with names different from all
+column names in the table. But the count of your database entity's properties can less than the count of columns.
 
 The `@DBRow`'s param `tableName` represents the table name in Database, please ensure pass
 the correct value. If you don't pass the parameter manually, _sqllin-processor_ will use the class

sqllin-dsl/doc/modify-database-and-transaction-cn.md

@@ -1,6 +1,6 @@
 # 修改数据库与事务
 
-在[《开始使用》](getting-start-cn.md)中，我们学习了如何创建 `Database` 实例以及定义你自己的 `DBEntity`。现在我们将开始学习如何在 SQLlin 中编写 SQL 语句。
+在[《开始使用》](getting-start-cn.md)中，我们学习了如何创建 `Database` 实例以及定义你自己的数据库实体。现在我们将开始学习如何在 SQLlin 中编写 SQL 语句。
 
 ## 插入
 
@@ -20,8 +20,8 @@ fun sample() {
     }
 }
 ```
-`PersonTable` 由 _sqllin-processor_ 生成，这是因为 `Person` 类被添加了 `@DBRow` 注解。任何继承自 `DBEntity`
-且被添加了 `@DBRow` 注解的类都会生成一个 `Table` object，它的名字为 `类名 + 'Table'`。
+`PersonTable` 由 _sqllin-processor_ 生成，这是因为 `Person` 类被添加了 `@DBRow` 注解。任何添加了 `@DBRow`
+注解的类都会生成一个 `Table` object，它的名字为 `类名 + 'Table'`。
 
 现在让我们来进行真正的 _INSERT_ 操作：
 

sqllin-dsl/doc/modify-database-and-transaction.md

@@ -2,7 +2,7 @@
 
 中文版请见[这里](modify-database-and-transaction-cn.md)
 
-In [Getting Start](getting-start.md), we have learned how to create the `Database` instance and define your `DBEntity`. Now,
+In [Getting Start](getting-start.md), we have learned how to create the `Database` instance and define your database entity. Now,
 we start learn how to write SQL statements with SQLlin.
 
 ## Insert
@@ -27,7 +27,7 @@ fun sample() {
 ```
 
 The `PersonTable` is generated by _sqllin-processor_, because `Person` is annotated the `@DBRow`
-annotation. Any class that extended from `DBEntity` and be annotated the `@DBRow` will be generated a `Table` object, its name is
+annotation. Any class that be annotated the `@DBRow` will be generated a `Table` object, its name is
 `class name + 'Table'`.
 
 Now, let's do the real _INSERT_:

sqllin-dsl/doc/query-cn.md

@@ -23,7 +23,7 @@ fun sample() {
 `X` 表示没有任何子句，我们已经在 _DELETE_ 语句中见过它了。
 
 _SELECT_ 语句与其他语句的另一个不同点在于它拥有查询结果。所以你需要声明一个类型为 `SelectStatement<T>`
-的变量，泛型参数 `T` 是你希望反序列化的 `DBEntity`。你应该将你构建的 _SELECT_ 语句赋值给此变量。
+的变量，泛型参数 `T` 是你希望反序列化的数据库实体的类型。你应该将你构建的 _SELECT_ 语句赋值给此变量。
 
 注意，所有的语句只会在 _DatabaseScope_ 结束后执行，我们曾在[《修改数据库与事务》](modify-database-and-transaction-cn.md)中提到过这一点。
 所以你必须在 `database { ... }` 外部调用 `getResults` 函数，SQLlin 将会帮助你将查询结果反序列化为你期待的对象。

sqllin-dsl/doc/query.md

@@ -24,7 +24,7 @@ fun sample() {
 The `X` represents without any clause, we’ve seen it in _DELETE_ statements.
 
 The _SELECT_ statement has query results, this is another difference from other statements. So, you need to declare a variable that
-type is `SelectStatement<T>`. The generic parameter `T` is your `DBEntity` that you expect to deserialize. You should assign _SELECT_ statement you built to this variable.
+type is `SelectStatement<T>`. The generic parameter `T` is your database entity's type that you expect to deserialize. You should assign _SELECT_ statement you built to this variable.
 
 Note, all statements will only be executed when the _DatabaseScope_ ends, we mentioned this in the [Modify Database and Transaction](modify-database-and-transaction.md).
 So, you must invoke the `getResults` function outside the `database { ... }` block, SQLlin will help you deserialize query results to objects that you expected.

sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/DBEntity.kt

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2022 Ctrip.com.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.ctrip.sqllin.dsl
+
+import kotlinx.serialization.KSerializer
+
+/**
+ * Base where clause property in SQL
+ * @author yaqiao
+ */
+
+@Deprecated(message = "The DBEntity hae benn deprecated, you don't need to implement this interface anymore")
+public fun interface DBEntity<T> {
+
+    public fun kSerializer(): KSerializer<T>
+}

sqllin-dsl/src/commonMain/kotlin/com/ctrip/sqllin/dsl/Database.kt

@@ -171,10 +171,10 @@ public class Database(
      * Select with no any clause.
      */
     public inline infix fun <reified T> Table<T>.SELECT(x: X): FinalSelectStatement<T> =
-        select(getKSerializer(), false)
+        select(kSerializer(), false)
 
     public inline infix fun <reified T> Table<T>.SELECT_DISTINCT(x: X): FinalSelectStatement<T> =
-        select(getKSerializer(), true)
+        select(kSerializer(), true)
 
     public fun <T> Table<T>.select(serializer: KSerializer<T>, isDistinct: Boolean): FinalSelectStatement<T> {
         val container = getSelectStatementGroup()
@@ -187,10 +187,10 @@ public class Database(
      * Receive the 'WHERE' clause.
      */
     public inline infix fun <reified T> Table<T>.SELECT(clause: WhereClause<T>): WhereSelectStatement<T> =
-        select(getKSerializer(), clause, false)
+        select(kSerializer(), clause, false)
 
     public inline infix fun <reified T> Table<T>.SELECT_DISTINCT(clause: WhereClause<T>): WhereSelectStatement<T> =
-        select(getKSerializer(), clause, true)
+        select(kSerializer(), clause, true)
 
     public fun <T> Table<T>.select(serializer: KSerializer<T>, clause: WhereClause<T>, isDistinct: Boolean): WhereSelectStatement<T> {
         val container = getSelectStatementGroup()
@@ -203,10 +203,10 @@ public class Database(
      * Receive the 'ORDER BY' clause.
      */
     public inline infix fun <reified T> Table<T>.SELECT(clause: OrderByClause<T>): OrderBySelectStatement<T> =
-        select(getKSerializer(), clause, false)
+        select(kSerializer(), clause, false)
 
     public inline infix fun <reified T> Table<T>.SELECT_DISTINCT(clause: OrderByClause<T>): OrderBySelectStatement<T> =
-        select(getKSerializer(), clause, true)
+        select(kSerializer(), clause, true)
 
     public fun <T> Table<T>.select(serializer: KSerializer<T>, clause: OrderByClause<T>, isDistinct: Boolean): OrderBySelectStatement<T> {
         val container = getSelectStatementGroup()
@@ -219,10 +219,10 @@ public class Database(
      * Receive the 'LIMIT' clause.
      */
     public inline infix fun <reified T> Table<T>.SELECT(clause: LimitClause<T>): LimitSelectStatement<T> =
-        select(getKSerializer(), clause, false)
+        select(kSerializer(), clause, false)
 
     public inline infix fun <reified T> Table<T>.SELECT_DISTINCT(clause: LimitClause<T>): LimitSelectStatement<T> =
-        select(getKSerializer(), clause, true)
+        select(kSerializer(), clause, true)
 
     public fun <T> Table<T>.select(serializer: KSerializer<T>, clause: LimitClause<T>, isDistinct: Boolean): LimitSelectStatement<T> {
         val container = getSelectStatementGroup()
@@ -235,10 +235,10 @@ public class Database(
      * Receive the 'GROUP BY' clause.
      */
     public inline infix fun <reified T> Table<T>.SELECT(clause: GroupByClause<T>): GroupBySelectStatement<T> =
-        select(getKSerializer(), clause, false)
+        select(kSerializer(), clause, false)
 
     public inline infix fun <reified T> Table<T>.SELECT_DISTINCT(clause: GroupByClause<T>): GroupBySelectStatement<T> =
-        select(getKSerializer(), clause, true)
+        select(kSerializer(), clause, true)
 
     public fun <T> Table<T>.select(serializer: KSerializer<T>, clause: GroupByClause<T>, isDistinct: Boolean): GroupBySelectStatement<T> {
         val container = getSelectStatementGroup()

sqllin-processor/src/main/kotlin/com/ctrip/sqllin/processor/ClauseProcessor.kt

@@ -50,7 +50,7 @@ class ClauseProcessor(
         for (classDeclaration in allClassAnnotatedWhereProperties) {
 
             if (classDeclaration.annotations.all { !it.annotationType.resolve().isAssignableFrom(serializableType) })
-                continue // Don't handle the class that don't implement 'DBEntity' or not annotated 'Serializable'
+                continue // Don't handle the class that don't annotated 'Serializable'
 
             val className = classDeclaration.simpleName.asString()
             val packageName = classDeclaration.packageName.asString()