driver/io.github.octaviusframework.driver.registry/TypeManager

TypeManager

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

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

This class provides a high-level API over CatalogHolder, making it easier to register custom mappings between Kotlin types and PostgreSQL database types.

The reading half of it is TypeLookup, which this delegates to and which is what a conversion is handed: registration is reached from a session, not from inside a converter.

Constructors

TypeManager

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

Properties

catalog

val catalog: TypeCatalog

Everything the driver knows about this database: dictionaries, converters and registrations, as one value.

codecs

val codecs: CodecDictionary

The dictionary maintaining TypeCodec implementations.

containers

val containers: ContainerFactory

Factory for creating container types (like composites).

dictionary

val dictionary: TypeDictionary

The dictionary mapping PostgreSQL type names to their OIDs and vice versa.

lookup

internal val lookup: TypeLookup

The reading half, following the store rather than any one catalog.

Functions

attach

fun <T : Any> attach(type: KClass<T>, transform: (T?) -> T)

Keeps a value for this database under type, for a layer built on the driver whose registrations belong to the database rather than to any one session.

detached

fun detached(): TypeLookup

A lookup on the same database with no session behind it.

pinnedTo

internal fun pinnedTo(catalog: TypeCatalog): TypeLookup

A lookup reading catalog and nothing else, for as long as it is held.

registerAutoComposite

inline fun <T : Any> registerAutoComposite(typeName: String = "", schema: String = "")

Registers a composite type mapped reflectively onto the data class T.

fun registerAutoComposite(kClass: KClass<*>, typeName: String = "", schema: String = "")

Registers a composite type mapped reflectively onto the data class kClass.

registerCodec

fun registerCodec(codec: TypeCodec<*>)

Registers a custom TypeCodec for encoding and decoding database types at the lowest level.

registerEnum

inline fun <T : Enum<T>> registerEnum(typeName: String = "", schema: String = "", pgConvention: CaseConvention = CaseConvention.SNAKE_CASE_UPPER, kotlinConvention: CaseConvention = CaseConvention.PASCAL_CASE)

fun registerEnum(enumClass: KClass<*>, typeName: String = "", schema: String = "", pgConvention: CaseConvention = CaseConvention.SNAKE_CASE_UPPER, kotlinConvention: CaseConvention = CaseConvention.PASCAL_CASE)

Registers an enum type, creating both parameter and result converters.

registerParameterConverter

fun registerParameterConverter(converter: ParameterConverter<*>)

Registers a custom ParameterConverter for mapping Kotlin types to PostgreSQL database types.

registerResultConverter

fun registerResultConverter(converter: ResultConverter<*, *>)

Registers a custom ResultConverter for mapping PostgreSQL database types to Kotlin types.

resolveOid

fun resolveOid(typeName: String, schema: String = "", isArray: Boolean = false): Int

Resolves an OID for a given type name, considering the current search path.