driver/io.github.octaviusframework.driver.registry/TypeDictionary

TypeDictionary

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

It provides specialized methods to fetch specific type categories such as arrays, ranges, and multiranges. Instances of this class are immutable and intended to be replaced entirely when types are reloaded.

Types

Companion

object Companion

Properties

size

val size: Int

How many types this dictionary holds.

Functions

findCompositeByRelation

fun findCompositeByRelation(relationOid: Int): PgType.Composite?

Returns the row type of the relation with the given relationOid, or null when this dictionary holds none for it.

forEachType

fun forEachType(action: (Int, PgType) -> Unit)

Executes the given action on each registered type.

getArrayType

fun getArrayType(elementOid: Int): PgType.Array

Retrieves an array type by the OID of its elements.

getMultirangeType

fun getMultirangeType(rangeOid: Int): PgType.Multirange

Retrieves a multirange type by the OID of its base range type.

getPgType

fun getPgType(oid: Int): PgType

Retrieves a PostgreSQL type by its OID.

getRangeType

fun getRangeType(elementOid: Int): PgType.Range

Retrieves a range type by the OID of its elements.

resolveOid

internal fun resolveOid(typeName: String, requestedSchema: String, isArray: Boolean = false, searchPath: List<String>): Int

Resolves the OID of a type given its name and an optional schema.