driver/io.github.octaviusframework.driver.registry

Package-level declarations

Types

CatalogHolder

internal class CatalogHolder

The one mutable thing in the type system: which TypeCatalog is the current one for a database.

CatalogLoader

internal object CatalogLoader

Utility object responsible for loading PostgreSQL type definitions from the database and populating a CatalogHolder.

CodecDictionary

class CodecDictionary

A dictionary that maps PostgreSQL OIDs and Kotlin classes to their corresponding TypeCodecs.

CodecScope

internal class CodecScope(val types: TypeDictionary)

The dictionaries a container or domain codec resolves through as it walks a value.

ContainerFactory

class ContainerFactory(types: TypeLookup)

A factory for creating PostgreSQL container types such as composites, ranges, and multiranges.

DatabaseKey

internal data class DatabaseKey(val servers: Set<ServerAddress>, val database: String)

Identifies the database a CatalogHolder belongs to: the servers it is reached on, and its name.

GlobalCatalogStore

object GlobalCatalogStore

Where the type catalogs live: one per database - the servers it is reached on and its name - for the whole JVM.

IntObjectMap

internal class IntObjectMap<V>

A highly optimized, primitive-key map implementation that maps primitive Int keys to object values.

PgEnumRegistration

data class PgEnumRegistration(val qualifiedName: QualifiedName, val pgConvention: CaseConvention, val kotlinConvention: CaseConvention)

What an enum was registered as: the type it stands for, and the two conventions that map one side's names onto the other's.

TypeCatalog

class TypeCatalog(val dictionary: TypeDictionary, val codecs: CodecDictionary, val resultConverters: Map<KClass<*>, List<ResultConverter<*, *>>>, val anyResultConverters: List<ResultConverter<*, *>>, val parameterConverters: List<ParameterConverter<*>>, val registeredComposites: Map<KClass<*>, QualifiedName>, val compositeClassByName: Map<QualifiedName, KClass<*>>, val registeredEnums: Map<KClass<*>, PgEnumRegistration>, val enumClassByName: Map<QualifiedName, KClass<*>>, val attachments: Map<KClass<*>, Any>)

Everything the driver knows about a database's types, as one immutable value.

TypeDictionary

class TypeDictionary

A dictionary that holds PostgreSQL types definitions and allows querying them by OID or name.

TypeLookup

class TypeLookup(catalogSource: () -> TypeCatalog, searchPathProvider: () -> List<String>)

The type system as something to read: dictionaries, containers and OID resolution, and nothing that writes.

TypeManager

class TypeManager(holder: CatalogHolder, searchPathProvider: () -> List<String> = { emptyList() })

Registers PostgreSQL types, codecs and converters, and reads back what is registered.

Functions

builtinCatalog

internal fun builtinCatalog(): TypeCatalog

The catalog the driver starts out with, before a database has said anything: the codecs it ships, the types those codecs name, and the converters that map them.