driver/io.github.octaviusframework.driver.container/PgArray

PgArray

class PgArray(val arrayOid: Int, val elementOid: Int, val dimensions: List<ArrayDimension>, val elements: List<Any?>) : PgContainer

Represents a PostgreSQL array type.

Constructors

PgArray

internal constructor(arrayOid: Int, elementOid: Int, dimensions: List<ArrayDimension>, elements: List<Any?>)

Properties

arrayOid

val arrayOid: Int

OID of the array type.

containerOid

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.

dimensions

val dimensions: List<ArrayDimension>

List of dimensions for the array. A one-dimensional array has one entry; PostgreSQL arrays are rectangular, so a multi-dimensional one describes each axis here.

elementOid

val elementOid: Int

OID of the elements within the array.

elements

val elements: List<Any?>

Flat list of elements contained in the array. Multi-dimensional arrays are stored flattened in row-major order, so dimensions is what gives the flat list its shape.

totalElements

val totalElements: Int

The number of elements across every dimension, i.e. the size of the flat elements list.

Functions

get

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

Returns the element at index in the flat element list, cast to T.