equinox-backend/com.tecknobit.equinoxbackend.environment.services.builtin.service/EquinoxItemsHelper

EquinoxItemsHelper

abstract class EquinoxItemsHelper

The EquinoxItemsHelper class is useful to manage all the EquinoxItem database operations

Author

N7ghtm4r3 - Tecknobit

Inheritors

BatchSynchronizationProcedure

EquinoxUsersService

Constructors

EquinoxItemsHelper

constructor()

Types

BatchQuery

interface BatchQuery<V>

The BatchQuery interface is useful to manage the batch queries to insert or delete values in batch

ComplexBatchItem

interface ComplexBatchItem

The ComplexBatchItem interface is useful to execute the syncBatch method with complex custom object with different values to synchronize.

InsertCommand

enum InsertCommand

InsertCommand list of supported commands to insert records in the batch queries

SyncBatchModel

interface SyncBatchModel

The SyncBatchModel interface is useful to execute the syncBatch method to synchronize the data.

Properties

_IN_CLAUSE_

private val _IN_CLAUSE_: String = " IN "

IN_CLAUSE in clause query part

_VALUES_

val _VALUES_: String = " VALUES "

VALUES values query part

_WHERE_

val _WHERE_: String = " WHERE "

WHERE where query part

CLOSED_ROUND_BRACKET

val CLOSED_ROUND_BRACKET: String = ")"

CLOSED_ROUND_BRACKET closed round bracket character

COMMA

val COMMA: String = ","

COMMA comma character

DELETE_FROM_

val DELETE_FROM_: String = "DELETE FROM "

DELETE_FROM_ delete from query command

entityManager

protected open var entityManager: EntityManager

entityManager entity manager helper

OPENED_ROUND_BRACKET

val OPENED_ROUND_BRACKET: String = "("

OPENED_ROUND_BRACKET opened round bracket character

QUESTION_MARK

val QUESTION_MARK: String = "?"

QUESTION_MARK question mark character

SINGLE_QUOTE

val SINGLE_QUOTE: String = "'"

SINGLE_QUOTE single quote character

Functions

batchDelete

protected open fun batchDelete(table: String, values: Collection<out Any>, @NotNull columns: Array<@NotNull String>)

Method used to execute a batch delete of a single list of data simultaneously

batchInsert

protected open fun <V> batchInsert( command: EquinoxItemsHelper.InsertCommand, table: String, batchQuery: EquinoxItemsHelper.BatchQuery<V>)

Method used to execute a batch insert of a list of data simultaneously

formatColumns

private open fun formatColumns(columns: Array<String>): String

Method used to format the columns value for the query

formatComplexBatchItemInClause

private open fun formatComplexBatchItemInClause(columns: Int, inValues: Collection<out Any>): String

Method used to format the in clause for the query with ComplexBatchItem values

formatInClause

private open fun formatInClause(columns: Int, inValues: Collection<out Any>): String

Method used to format the in clause for the query

formatPlaceholder

private open fun formatPlaceholder(columns: Array<String>): String

Method used to format the placeholder value for the query

formatValuesForQuery

private open fun formatValuesForQuery(start: String, values: Collection<out Any>, formatter: String, isToClose: Boolean): String

Method used to format a list of values for the query

syncBatch

protected open fun <V> syncBatch(model: EquinoxItemsHelper.SyncBatchModel, table: String, batchQuery: EquinoxItemsHelper.BatchQuery<V>)

protected open fun <V> syncBatch( model: EquinoxItemsHelper.SyncBatchModel, command: EquinoxItemsHelper.InsertCommand, table: String, batchQuery: EquinoxItemsHelper.BatchQuery<V>)

Method used to execute a batch synchronization of a list of data simultaneously