deprecate ktorm-global

Author: vincentlauvlwj

ktorm-global/src/main/kotlin/org/ktorm/global/Aggregations.kt

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+@file:Suppress("DeprecatedCallableAddReplaceWith", "DEPRECATION")
+
 package org.ktorm.global
 
 import org.ktorm.database.Database
@@ -24,90 +26,103 @@ import org.ktorm.schema.ColumnDeclaring
 /**
  * Check if all the records in the table matches the given [predicate].
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>> T.all(predicate: (T) -> ColumnDeclaring<Boolean>): Boolean {
     return Database.global.sequenceOf(this).all(predicate)
 }
 
 /**
  * Check if there is any record in the table.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <E : Any, T : BaseTable<E>> T.any(): Boolean {
     return Database.global.sequenceOf(this).any()
 }
 
 /**
  * Check if there is any record in the table matches the given [predicate].
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>> T.any(predicate: (T) -> ColumnDeclaring<Boolean>): Boolean {
     return Database.global.sequenceOf(this).any(predicate)
 }
 
 /**
  * Return `true` if there is no records in the table.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <E : Any, T : BaseTable<E>> T.none(): Boolean {
     return Database.global.sequenceOf(this).none()
 }
 
 /**
  * Return `true` if there is no records in the table that matches the given [predicate].
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>> T.none(predicate: (T) -> ColumnDeclaring<Boolean>): Boolean {
     return Database.global.sequenceOf(this).none(predicate)
 }
 
 /**
  * Return `true` if the table has no records.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <E : Any, T : BaseTable<E>> T.isEmpty(): Boolean {
     return Database.global.sequenceOf(this).isEmpty()
 }
 
 /**
  * Return `true` if the table has at lease one record.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <E : Any, T : BaseTable<E>> T.isNotEmpty(): Boolean {
     return Database.global.sequenceOf(this).isNotEmpty()
 }
 
 /**
  * Return the records count in the table.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <E : Any, T : BaseTable<E>> T.count(): Int {
     return Database.global.sequenceOf(this).count()
 }
 
 /**
  * Return the records count in the table that matches the given [predicate].
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>> T.count(predicate: (T) -> ColumnDeclaring<Boolean>): Int {
     return Database.global.sequenceOf(this).count(predicate)
 }
 
 /**
  * Return the sum of the given column or expression of all the records, null if there are no records in the table.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>, C : Number> T.sumBy(selector: (T) -> ColumnDeclaring<C>): C? {
     return Database.global.sequenceOf(this).sumBy(selector)
 }
 
 /**
  * Return the max value of the given column or expression of all the records, null if there are no records in the table.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>, C : Comparable<C>> T.maxBy(selector: (T) -> ColumnDeclaring<C>): C? {
     return Database.global.sequenceOf(this).maxBy(selector)
 }
 
 /**
  * Return the min value of the given column or expression of all the records, null if there are no records in the table.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>, C : Comparable<C>> T.minBy(selector: (T) -> ColumnDeclaring<C>): C? {
     return Database.global.sequenceOf(this).minBy(selector)
 }
 
 /**
  * Return the average value of the given column or expression of all the records, null if there are no records.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>> T.averageBy(selector: (T) -> ColumnDeclaring<out Number>): Double? {
     return Database.global.sequenceOf(this).averageBy(selector)
 }

ktorm-global/src/main/kotlin/org/ktorm/global/Dml.kt

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+@file:Suppress("DeprecatedCallableAddReplaceWith", "DEPRECATION")
+
 package org.ktorm.global
 
 import org.ktorm.database.Database
@@ -41,6 +43,7 @@ import java.sql.Statement
  * @param block the DSL block, an extension function of [UpdateStatementBuilder], used to construct the expression.
  * @return the effected row count.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <T : BaseTable<*>> T.update(block: UpdateStatementBuilder.(T) -> Unit): Int {
     return Database.global.update(this, block)
 }
@@ -70,6 +73,7 @@ public fun <T : BaseTable<*>> T.update(block: UpdateStatementBuilder.(T) -> Unit
  * @param block the DSL block, extension function of [BatchUpdateStatementBuilder], used to construct the expressions.
  * @return the effected row counts for each sub-operation.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <T : BaseTable<*>> T.batchUpdate(block: BatchUpdateStatementBuilder<T>.() -> Unit): IntArray {
     return Database.global.batchUpdate(this, block)
 }
@@ -93,6 +97,7 @@ public fun <T : BaseTable<*>> T.batchUpdate(block: BatchUpdateStatementBuilder<T
  * @param block the DSL block, an extension function of [AssignmentsBuilder], used to construct the expression.
  * @return the effected row count.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <T : BaseTable<*>> T.insert(block: AssignmentsBuilder.(T) -> Unit): Int {
     return Database.global.insert(this, block)
 }
@@ -130,6 +135,7 @@ public fun <T : BaseTable<*>> T.insert(block: AssignmentsBuilder.(T) -> Unit): I
  * @param block the DSL block, extension function of [BatchInsertStatementBuilder], used to construct the expressions.
  * @return the effected row counts for each sub-operation.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <T : BaseTable<*>> T.batchInsert(block: BatchInsertStatementBuilder<T>.() -> Unit): IntArray {
     return Database.global.batchInsert(this, block)
 }
@@ -156,20 +162,23 @@ public fun <T : BaseTable<*>> T.batchInsert(block: BatchInsertStatementBuilder<T
  * @param block the DSL block, an extension function of [AssignmentsBuilder], used to construct the expression.
  * @return the first auto-generated key.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <T : BaseTable<*>> T.insertAndGenerateKey(block: AssignmentsBuilder.(T) -> Unit): Any {
     return Database.global.insertAndGenerateKey(this, block)
 }
 
 /**
  * Delete the records in the table that matches the given [predicate].
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <T : BaseTable<*>> T.delete(predicate: (T) -> ColumnDeclaring<Boolean>): Int {
     return Database.global.delete(this, predicate)
 }
 
 /**
  * Delete all the records in the table.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.deleteAll(): Int {
     return Database.global.deleteAll(this)
 }

ktorm-global/src/main/kotlin/org/ktorm/global/EntitySequence.kt

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+@file:Suppress("DeprecatedCallableAddReplaceWith", "DEPRECATION")
+
 package org.ktorm.global
 
 import org.ktorm.database.Database
@@ -25,6 +27,7 @@ import org.ktorm.schema.Table
 /**
  * Create an [EntitySequence] from this table.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <E : Any, T : BaseTable<E>> T.asSequence(withReferences: Boolean = true): EntitySequence<E, T> {
     return Database.global.sequenceOf(this, withReferences)
 }
@@ -43,6 +46,7 @@ public fun <E : Any, T : BaseTable<E>> T.asSequence(withReferences: Boolean = tr
  * @see Entity.flushChanges
  * @see Entity.delete
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <E : Entity<E>> Table<E>.addEntity(entity: E): Int {
     return Database.global.sequenceOf(this).add(entity)
 }
@@ -56,27 +60,31 @@ public fun <E : Entity<E>> Table<E>.addEntity(entity: E): Int {
  * @see Entity.delete
  * @since 3.1.0
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <E : Entity<E>> Table<E>.updateEntity(entity: E): Int {
     return Database.global.sequenceOf(this).update(entity)
 }
 
 /**
  * Obtain a entity object matching the given [predicate], auto left joining all the reference tables.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>> T.findOne(predicate: (T) -> ColumnDeclaring<Boolean>): E? {
     return Database.global.sequenceOf(this).find(predicate)
 }
 
 /**
  * Obtain all the entity objects from this table, auto left joining all the reference tables.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun <E : Any> BaseTable<E>.findAll(): List<E> {
     return Database.global.sequenceOf(this).toList()
 }
 
 /**
  * Obtain a list of entity objects matching the given [predicate], auto left joining all the reference tables.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <E : Any, T : BaseTable<E>> T.findList(predicate: (T) -> ColumnDeclaring<Boolean>): List<E> {
     return Database.global.sequenceOf(this).filter(predicate).toList()
 }

ktorm-global/src/main/kotlin/org/ktorm/global/Global.kt

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+@file:Suppress("DEPRECATION")
+
 package org.ktorm.global
 
 import org.ktorm.database.*
@@ -48,6 +50,7 @@ internal val threadLocal: ThreadLocal<Database> = ThreadLocal()
  *
  * @see Database.invoke
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public val Database.Companion.global: Database get() {
     val database = threadLocal.get() ?: lastConnected.get()
     return database ?: error("Not connected to any database yet, please connect to one via Database.connectGlobally")
@@ -64,6 +67,7 @@ public val Database.Companion.global: Database get() {
  * @param connector the connector function used to obtain SQL connections.
  * @return the new-created database object.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun Database.Companion.connectGlobally(
     dialect: SqlDialect = detectDialectImplementation(),
     logger: Logger = detectLoggerImplementation(),
@@ -93,6 +97,7 @@ public fun Database.Companion.connectGlobally(
  * @param generateSqlInUpperCase whether we need to output the generated SQLs in upper case.
  * @return the new-created database object.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun Database.Companion.connectGlobally(
     dataSource: DataSource,
     dialect: SqlDialect = detectDialectImplementation(),
@@ -126,6 +131,7 @@ public fun Database.Companion.connectGlobally(
  * @param generateSqlInUpperCase whether we need to output the generated SQLs in upper case.
  * @return the new-created database object.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun Database.Companion.connectGlobally(
     url: String,
     driver: String? = null,
@@ -170,6 +176,7 @@ public fun Database.Companion.connectGlobally(
  * @param generateSqlInUpperCase whether we need to output the generated SQLs in upper case.
  * @return the new-created database object.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun Database.Companion.connectWithSpringSupportGlobally(
     dataSource: DataSource,
     dialect: SqlDialect = detectDialectImplementation(),
@@ -202,6 +209,7 @@ public fun Database.Companion.connectWithSpringSupportGlobally(
  *
  * @see Database.Companion.global
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline operator fun <T> Database.invoke(func: Database.() -> T): T {
     // Contracts are not allowed for operator functions?
     // contract {
@@ -230,6 +238,7 @@ public inline operator fun <T> Database.invoke(func: Database.() -> T): T {
  * @see Database.useConnection
  */
 @OptIn(ExperimentalContracts::class)
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <T> useConnection(func: (Connection) -> T): T {
     contract {
         callsInPlace(func, InvocationKind.EXACTLY_ONCE)
@@ -256,6 +265,7 @@ public inline fun <T> useConnection(func: (Connection) -> T): T {
  * @see Database.useTransaction
  */
 @OptIn(ExperimentalContracts::class)
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public inline fun <T> useTransaction(isolation: TransactionIsolation? = null, func: (Transaction) -> T): T {
     contract {
         callsInPlace(func, InvocationKind.EXACTLY_ONCE)

ktorm-global/src/main/kotlin/org/ktorm/global/Query.kt

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+@file:Suppress("DEPRECATION", "DeprecatedCallableAddReplaceWith")
+
 package org.ktorm.global
 
 import org.ktorm.database.Database
@@ -24,34 +26,39 @@ import org.ktorm.schema.ColumnDeclaring
 /**
  * Join the right table and return a new [QuerySource], translated to `cross join` in SQL.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.crossJoin(right: BaseTable<*>, on: ColumnDeclaring<Boolean>? = null): QuerySource {
     return Database.global.from(this).crossJoin(right, on)
 }
 
 /**
  * Join the right table and return a new [QuerySource], translated to `inner join` in SQL.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.innerJoin(right: BaseTable<*>, on: ColumnDeclaring<Boolean>? = null): QuerySource {
     return Database.global.from(this).innerJoin(right, on)
 }
 
 /**
  * Join the right table and return a new [QuerySource], translated to `left join` in SQL.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.leftJoin(right: BaseTable<*>, on: ColumnDeclaring<Boolean>? = null): QuerySource {
     return Database.global.from(this).leftJoin(right, on)
 }
 
 /**
  * Join the right table and return a new [QuerySource], translated to `right join` in SQL.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.rightJoin(right: BaseTable<*>, on: ColumnDeclaring<Boolean>? = null): QuerySource {
     return Database.global.from(this).rightJoin(right, on)
 }
 
 /**
  * Return a new-created [Query] object, left joining all the reference tables, and selecting all columns of them.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.joinReferencesAndSelect(): Query {
     return Database.global.from(this).joinReferencesAndSelect()
 }
@@ -61,6 +68,7 @@ public fun BaseTable<*>.joinReferencesAndSelect(): Query {
  *
  * Note that the specific columns can be empty, that means `select *` in SQL.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.select(columns: Collection<ColumnDeclaring<*>>): Query {
     return Database.global.from(this).select(columns)
 }
@@ -70,6 +78,7 @@ public fun BaseTable<*>.select(columns: Collection<ColumnDeclaring<*>>): Query {
  *
  * Note that the specific columns can be empty, that means `select *` in SQL.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.select(vararg columns: ColumnDeclaring<*>): Query {
     return Database.global.from(this).select(*columns)
 }
@@ -79,6 +88,7 @@ public fun BaseTable<*>.select(vararg columns: ColumnDeclaring<*>): Query {
  *
  * Note that the specific columns can be empty, that means `select distinct *` in SQL.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.selectDistinct(columns: Collection<ColumnDeclaring<*>>): Query {
     return Database.global.from(this).selectDistinct(columns)
 }
@@ -88,6 +98,7 @@ public fun BaseTable<*>.selectDistinct(columns: Collection<ColumnDeclaring<*>>):
  *
  * Note that the specific columns can be empty, that means `select distinct *` in SQL.
  */
+@Deprecated("ktorm-global will be removed in the future, please migrate to the standard API.")
 public fun BaseTable<*>.selectDistinct(vararg columns: ColumnDeclaring<*>): Query {
     return Database.global.from(this).selectDistinct(*columns)
 }

ktorm-global/src/test/kotlin/org/ktorm/global/BaseGlobalTest.kt

@@ -6,6 +6,7 @@ import org.ktorm.database.Database
 /**
  * Created by vince at Apr 05, 2020.
  */
+@Suppress("DEPRECATION")
 open class BaseGlobalTest : BaseTest() {
 
     override fun init() {