SQL-ORM/net.redstonecraft.sqlorm/Database

Database

class Database(connection: Connection, dbType: SQLTypeTranslator) : Closeable

This is the entrypoint of the library.

Parameters

connection

Connection of the existing database.

dbType

Translator to create the SQL statements. Currently, either net.redstonecraft.sqlorm.translator.MySQLTranslator or net.redstonecraft.sqlorm.translator.SQLiteTranslator.

Constructors

Database

fun Database(connection: Connection, dbType: SQLTypeTranslator)

Creates an instance of an existing database connection.

Types

Companion

object Companion

Query

class Query(clazz: KClass<*>)

Functions

add

fun add(value: Any): Boolean

Adds a new entry.

avg

inline fun <T> avg(prop: KProperty<*>, noinline block: Database.Query.() -> List<Database.Query.Clause> = { emptyList() }): Double

fun avg(clazz: KClass<*>, prop: KProperty<*>, block: Database.Query.() -> List<Database.Query.Clause> = { emptyList() }): Double

Returns the average value of the fields matching the specified criteria.

open override fun close()

contains

inline operator fun <T> contains(value: T): Boolean

fun contains(clazz: KClass<*>, value: Any?): Boolean

count

inline fun <T> count(noinline block: Database.Query.() -> List<Database.Query.Clause> = { emptyList() }): Int

fun count(clazz: KClass<*>, block: Database.Query.() -> List<Database.Query.Clause> = { emptyList() }): Int

Counts the entries matching the specified criteria.

createTable

inline fun <T> createTable()

Create a new table from the definition of the data class.s

fun createTable(clazz: KClass<*>)

Create a new table from the definition of the data class.

get

inline operator fun <T> get(id: Any): T

operator fun get(clazz: KClass<*>, id: Any): Any

Get an entry by the data class and id.

makeCurrent

fun makeCurrent(): Database

Make this database current on the companion object.

minusAssign

operator fun minusAssign(value: Any)

plusAssign

operator fun plusAssign(value: Any)

query

inline fun <T> query(noinline block: Database.Query.() -> List<Database.Query.Clause> = { emptyList() }): List<T>

fun query(clazz: KClass<*>, block: Database.Query.() -> List<Database.Query.Clause> = { emptyList() }): List<Any>

Query for entries matching the specified criteria.

remove

fun remove(value: Any): Boolean

Delete an entry.

set

fun set(value: Any): Boolean

Adds the entry if it does not already exist or modifies it. Try to use add and update directly to reduce overhead.

sum

inline fun <T> sum(prop: KProperty<*>, noinline block: Database.Query.() -> List<Database.Query.Clause> = { emptyList() }): Double

fun sum(clazz: KClass<*>, prop: KProperty<*>, block: Database.Query.() -> List<Database.Query.Clause> = { emptyList() }): Double

Sums up the fields matching the specified criteria.

update

fun update(value: Any): Boolean

Updates an existing entry.

Properties

connection

val connection: Connection

dbType

val dbType: SQLTypeTranslator