driver/io.github.octaviusframework.driver.container/PgComposite

PgComposite

class PgComposite(val type: PgType.Composite, val fields: Array<Any?>) : PgContainer

Represents a composite structure (e.g., row of a specific type) loaded from the database.

Constructors

internal constructor(type: PgType.Composite, fields: Array<Any?>)

Properties

val attributeNames: List<String>

The names of this composite's attributes, in declaration order.

open override val containerOid: Int

OID of the container's own type — the array type rather than its element type, the range type rather than its subtype.

val fields: Array<Any?>

Array containing the values of the fields in this composite structure.

val type: PgType.Composite

The composite type definition.

Functions

attributesAsMap

internal fun PgComposite.attributesAsMap(valueType: KType, context: DeserializationContext): Map<String, Any?>

Every attribute of this composite, keyed by name, each one converted to valueType.

inline operator fun <T> get(index: Int): T

Returns the attribute at index, cast to T.

inline operator fun <T> get(name: String): T

Returns the attribute named name, cast to T.

getAttributeOid

fun getAttributeOid(index: Int): Int

Returns the PostgreSQL OID of the attribute at index.

fun getAttributeOid(name: String): Int

Returns the PostgreSQL OID of the attribute named name.

fun getColumnIndex(columnName: String): Int

Resolves an attribute name to its zero-based index.

operator fun set(index: Int, newValue: Any?)

Sets the attribute at index. The value is converted when the composite is sent, not here, so nothing is checked against the attribute's type at this point.

operator fun set(columnName: String, newValue: Any?)

Sets the attribute named columnName.