db-messiah/com.urosjarc.dbmessiah

Package-level declarations

Types

ConnectionPool

open class ConnectionPool

This class represents a Service that creates query or transactional connections on which queries can be executed.

Driver

open class Driver(val conn: Connection)

A class representing a database driver.

Exporter

open class Exporter(val schemas: List<Schema>)

Represents an exporter used to generate various diagram formats representing database architecture.

Mapper

class Mapper(var schemas: List<Schema>, var globalSerializers: List<TypeSerializer<*>>, var globalInputs: List<KClass<*>>, var globalOutputs: List<KClass<*>>, var globalProcedures: List<KClass<*>>) : MapperCache

A class that maps Kotlin classes to their associated database tables, procedures, and serializers and vice versa. Mapper is responsible to use kotlin reflection to inspects all user data and create maps from provided information. Kotlin's reflection is CPU expensive so reflection is used only on initialization of building database configuration after that no reflection is used by the sistem.

MapperCache

open class MapperCache(var schemas: List<Schema>, var globalSerializers: List<TypeSerializer<*>>, var globalInputs: List<KClass<*>>, var globalOutputs: List<KClass<*>>, var globalProcedures: List<KClass<*>>)

Profiler

class Profiler

Measures and stores the execution time of a query.

Schema

open class Schema(val name: String, var tables: List<Table<*>>, val serializers: List<TypeSerializer<out Any>> = listOf(), val procedures: List<KClass<*>> = listOf())

Represents a user defined database schema.

Serializer

abstract class Serializer(val allowAutoUUID: Boolean, val schemas: List<Schema>, val globalSerializers: List<TypeSerializer<*>>, val globalInputs: List<KClass<*>> = listOf(), val globalOutputs: List<KClass<*>> = listOf(), val globalProcedures: List<KClass<*>> = listOf()) : Exporter

Serializer is an abstract class that provides functionality for serializing objects to various string like formats. This class should be implemented and overriden by specific database implementation. On class initialization all internal structure provided by the user will be heavily tested for any inconsistency or error provided by the user mistake. These tests are trying to provide security, reliability and ultimately trust to the end user.

SerializerTests

internal class SerializerTests

Responsible for testing the user defined Serializer configuration. Tests are responsible to provide strong type safety before database initialization. It contains various tests to ensure the correctness of the database configuration.

Service

abstract class Service<SER : Any>

This class represents a Service that provides query and transactional operations on a database.