driver/io.github.octaviusframework.driver.message.backend/FieldDescription

FieldDescription

internal class FieldDescription(val name: String, val tableOid: Int, val columnAttrNumber: Short, val dataTypeOid: Int, val dataTypeSize: Short, val typeModifier: Int, val formatCode: Short)

The description of a single field (column) as it arrives inside a RowDescription message.

This is the wire form, where every reference is an OID and every modifier is raw. It is resolved into io.github.octaviusframework.driver.row.ColumnMetadata once per result, and never reaches a caller as it is.

Constructors

FieldDescription

constructor(name: String, tableOid: Int, columnAttrNumber: Short, dataTypeOid: Int, dataTypeSize: Short, typeModifier: Int, formatCode: Short)

Properties

columnAttrNumber

val columnAttrNumber: Short

The attribute number of the column within that relation, or 0 if it is not a plain column reference.

val dataTypeOid: Int

The object ID of the field's data type.

val dataTypeSize: Short

The data type size (in bytes). A negative value denotes a variable-width type.

val formatCode: Short

The format code indicating how the field is represented (0 for text, 1 for binary).

val name: String

The name of the field - the alias, where the query gave the column one.

val tableOid: Int

The OID of the relation the column was written against, or 0 if it is not a plain column reference.

val typeModifier: Int

The type modifier of the data type.