Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Row

A single row of the [execution result rowset] RowSet.

Hierarchy

Index

Properties

Methods

Properties

Static Readonly JSON_NULL

JSON_NULL: any

The JSON null literal value.
It is used to distinguish a JSON null literal value from the Java null value. This is only used when the database supports JSON types.

Methods

addArrayOfBigDecimal

  • addArrayOfBigDecimal(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addArrayOfBoolean

  • addArrayOfBoolean(value: boolean[]): Tuple

  • Add an array of Boolean value at the end of the tuple.

    Parameters

    • value: boolean[]

    Returns Tuple

addArrayOfDouble

  • addArrayOfDouble(value: number[]): Tuple

  • Add an array of Double value at the end of the tuple.

    Parameters

    • value: number[]

    Returns Tuple

addArrayOfFloat

  • addArrayOfFloat(value: number[]): Tuple

  • Add an array of Float value at the end of the tuple.

    Parameters

    • value: number[]

    Returns Tuple

addArrayOfInteger

  • addArrayOfInteger(value: number[]): Tuple

  • Add an array of Integer value at the end of the tuple.

    Target element instance of Number[] will be coerced to Integer[].

    Parameters

    • value: number[]

    Returns Tuple

addArrayOfJsonArray

  • addArrayOfJsonArray(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addArrayOfJsonObject

  • addArrayOfJsonObject(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addArrayOfLocalDate

  • addArrayOfLocalDate(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addArrayOfLocalDateTime

  • addArrayOfLocalDateTime(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addArrayOfLocalTime

  • addArrayOfLocalTime(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addArrayOfLong

  • addArrayOfLong(value: number[]): Tuple

  • Add an array of Long value at the end of the tuple.

    Parameters

    • value: number[]

    Returns Tuple

addArrayOfOffsetDateTime

  • addArrayOfOffsetDateTime(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addArrayOfOffsetTime

  • addArrayOfOffsetTime(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addArrayOfShort

  • addArrayOfShort(value: number[]): Tuple

  • Add an array of Short value at the end of the tuple.

    Parameters

    • value: number[]

    Returns Tuple

addArrayOfString

  • addArrayOfString(value: string[]): Tuple

  • Add an array of String value at the end of the tuple.

    Parameters

    • value: string[]

    Returns Tuple

addArrayOfTemporal

  • addArrayOfTemporal(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addArrayOfUUID

  • addArrayOfUUID(value: any): Tuple

  • Add an array of value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addBigDecimal

  • addBigDecimal(value: any): Tuple

  • Add a value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addBoolean

  • addBoolean(value: boolean): Tuple

  • Add a boolean value at the end of the tuple.

    Parameters

    • value: boolean

    Returns Tuple

addBuffer

  • addBuffer(value: Buffer): Tuple

  • Add a buffer value at the end of the tuple.

    Parameters

    • value: Buffer

    Returns Tuple

addDouble

  • addDouble(value: number): Tuple

  • Add a double value at the end of the tuple.

    Parameters

    • value: number

    Returns Tuple

addFloat

  • addFloat(value: number): Tuple

  • Add a float value at the end of the tuple.

    Parameters

    • value: number

    Returns Tuple

addInteger

  • addInteger(value: number): Tuple

  • Add an integer value at the end of the tuple.

    Parameters

    • value: number

    Returns Tuple

addJsonArray

  • addJsonArray(value: any[]): Tuple

  • Add a value at the end of the tuple.

    Parameters

    • value: any[]

    Returns Tuple

addJsonObject

  • addJsonObject(value: {}): Tuple

  • Add a value at the end of the tuple.

    Parameters

    • value: {}
      • [key: string]: any

    Returns Tuple

addLocalDate

  • addLocalDate(value: Date): Tuple

  • Add a LocalDate value at the end of the tuple.

    Parameters

    • value: Date

    Returns Tuple

addLocalDateTime

  • addLocalDateTime(value: Date): Tuple

  • Add a LocalDateTime value at the end of the tuple.

    Parameters

    • value: Date

    Returns Tuple

addLocalTime

  • addLocalTime(value: any): Tuple

  • Add a LocalTime value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addLong

  • addLong(value: number): Tuple

  • Add a long value at the end of the tuple.

    Parameters

    • value: number

    Returns Tuple

addOffsetDateTime

  • addOffsetDateTime(value: any): Tuple

  • Add a OffsetDateTime value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addOffsetTime

  • addOffsetTime(value: any): Tuple

  • Add a OffsetTime value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addShort

  • addShort(value: number): Tuple

  • Add a short value at the end of the tuple.

    Parameters

    • value: number

    Returns Tuple

addString

  • addString(value: string): Tuple

  • Add a string value at the end of the tuple.

    Parameters

    • value: string

    Returns Tuple

addTemporal

  • addTemporal(value: any): Tuple

  • Add a Temporal value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addUUID

  • addUUID(value: any): Tuple

  • Add a UUID value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

addValue

  • addValue(value: any): Tuple

  • Add an object value at the end of the tuple.

    Parameters

    • value: any

    Returns Tuple

clear

  • clear(): void

  • Returns void

deepToString

  • deepToString(): string

  • Returns string

get

  • get<T>(type: any, position: string | number): T

  • Like {@link Tuple#get} but specifying the column instead of the position.

    Type parameters

    • T

    Parameters

    • type: any
    • position: string | number

    Returns T

getArrayOfBigDecimals

  • getArrayOfBigDecimals(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfBooleans

  • getArrayOfBooleans(name: string | number): boolean[]

  • Get an array of Boolean value for the given column.

    Parameters

    • name: string | number

    Returns boolean[]

getArrayOfDoubles

  • getArrayOfDoubles(name: string | number): number[]

  • Get an array of Double value for the given column.

    Parameters

    • name: string | number

    Returns number[]

getArrayOfFloats

  • getArrayOfFloats(name: string | number): number[]

  • Get an array of Float value for the given column.

    Parameters

    • name: string | number

    Returns number[]

getArrayOfIntegers

  • getArrayOfIntegers(name: string | number): number[]

  • Get an array of Integer value for the given column.

    Parameters

    • name: string | number

    Returns number[]

getArrayOfJsonArrays

  • getArrayOfJsonArrays(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfJsonObjects

  • getArrayOfJsonObjects(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfJsons

  • getArrayOfJsons(name: string | number): any[]

  • Get an array of JSON elements for the given column, the element might be [#JSON_NULL null] Tuple or one of the following types:

    • String
    • Number
    • JsonObject
    • JsonArray
    • Boolean

    Parameters

    • name: string | number

    Returns any[]

getArrayOfLocalDateTimes

  • getArrayOfLocalDateTimes(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfLocalDates

  • getArrayOfLocalDates(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfLocalTimes

  • getArrayOfLocalTimes(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfLongs

  • getArrayOfLongs(name: string | number): number[]

  • Get an array of Long value for the given column.

    Parameters

    • name: string | number

    Returns number[]

getArrayOfNumerics

  • getArrayOfNumerics(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfOffsetDateTimes

  • getArrayOfOffsetDateTimes(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfOffsetTimes

  • getArrayOfOffsetTimes(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfShorts

  • getArrayOfShorts(name: string | number): number[]

  • Get an array of Short value for the given column.

    Parameters

    • name: string | number

    Returns number[]

getArrayOfStrings

  • getArrayOfStrings(name: string | number): string[]

  • Get an array of String value for the given column.

    Parameters

    • name: string | number

    Returns string[]

getArrayOfTemporals

  • getArrayOfTemporals(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getArrayOfUUIDs

  • getArrayOfUUIDs(name: string | number): any

  • Get an array of value for the given column.

    Parameters

    • name: string | number

    Returns any

getBigDecimal

  • getBigDecimal(name: string | number): any

  • Get value for the given column.

    Parameters

    • name: string | number

    Returns any

getBoolean

  • getBoolean(name: string | number): boolean

  • Get a boolean value for the given column.

    Parameters

    • name: string | number

    Returns boolean

getBuffer

  • getBuffer(name: string | number): Buffer

  • Get a buffer value for the given column.

    Parameters

    • name: string | number

    Returns Buffer

getColumnIndex

  • getColumnIndex(column: string): number

  • Get a column position for the given @code column}.

    Parameters

    • column: string

    Returns number

getColumnName

  • getColumnName(pos: number): string

  • Get a column name at pos.

    Parameters

    • pos: number

    Returns string

getDouble

  • getDouble(name: string | number): number

  • Get a double value for the given column.

    Parameters

    • name: string | number

    Returns number

getFloat

  • getFloat(name: string | number): number

  • Get a float value for the given column.

    Parameters

    • name: string | number

    Returns number

getInteger

  • getInteger(name: string | number): number

  • Get an integer value for the given column.

    Parameters

    • name: string | number

    Returns number

getJson

  • getJson(name: string | number): any

  • Get a JSON element for the given column, the element might be [#JSON_NULL null] Tuple or one of the following types:

    • String
    • Number
    • JsonObject
    • JsonArray
    • Boolean

    Parameters

    • name: string | number

    Returns any

getJsonArray

  • getJsonArray(name: string | number): any[]

  • Get a value for the given column.

    Parameters

    • name: string | number

    Returns any[]

getJsonObject

  • getJsonObject(name: string | number): {}

  • Get a value for the given column.

    Parameters

    • name: string | number

    Returns {}

    • [key: string]: any

getLocalDate

  • getLocalDate(name: string | number): Date

  • Get LocalDate value for the given column.

    Parameters

    • name: string | number

    Returns Date

getLocalDateTime

  • getLocalDateTime(name: string | number): Date

  • Get LocalDateTime value for the given column.

    Parameters

    • name: string | number

    Returns Date

getLocalTime

  • getLocalTime(name: string | number): any

  • Get LocalTime value for the given column.

    Parameters

    • name: string | number

    Returns any

getLong

  • getLong(name: string | number): number

  • Get a long value for the given column.

    Parameters

    • name: string | number

    Returns number

getNumeric

  • getNumeric(name: string | number): any

  • Get value for the given column.

    Parameters

    • name: string | number

    Returns any

getOffsetDateTime

  • getOffsetDateTime(name: string | number): any

  • Get OffsetDateTime value for the given column.

    Parameters

    • name: string | number

    Returns any

getOffsetTime

  • getOffsetTime(name: string | number): any

  • Get OffsetTime value for the given column.

    Parameters

    • name: string | number

    Returns any

getShort

  • getShort(name: string | number): number

  • Get a short value for the given column.

    Parameters

    • name: string | number

    Returns number

getString

  • getString(name: string | number): string

  • Get a string value for the given column.

    Parameters

    • name: string | number

    Returns string

getTemporal

  • getTemporal(name: string | number): any

  • Get a temporal value for the given column.

    Parameters

    • name: string | number

    Returns any

getUUID

  • getUUID(name: string | number): any

  • Get UUID value for the given column.

    Parameters

    • name: string | number

    Returns any

getValue

  • getValue(name: string | number): any

  • Get a value for the given column.

    Parameters

    • name: string | number

    Returns any

size

  • size(): number

  • Returns number

toJson

  • toJson(): {}

  • Return a JSON object representation of the row.

    Column names are mapped to JSON keys.

    The following rules are applied for the column values:

    • number, boolean and string are preserved
    • the null value is preserved
    • JSON elements are preserved
    • Buffer are converted to base64 encoded strings
    • array is mapped JsonArray
    • otherwise the type converted to a string

    Returns {}

    • [key: string]: any

Static from

  • from<T>(list: T): Tuple
  • from(array: any[]): Tuple

  • Wrap the provided list with a tuple.
    The list is not copied and is used as store for tuple elements.

    Type parameters

    • T

    Parameters

    • list: T

    Returns Tuple

  • Wrap the provided array with a tuple.
    The array is not copied and is used as store for tuple elements.

    Parameters

    • array: any[]

    Returns Tuple

Static of

  • of(elt1: any): Tuple
  • of(elt1: any, elt2: any): Tuple
  • of(elt1: any, elt2: any, elt3: any): Tuple
  • of(elt1: any, elt2: any, elt3: any, elt4: any): Tuple
  • of(elt1: any, elt2: any, elt3: any, elt4: any, elt5: any): Tuple
  • of(elt1: any, elt2: any, elt3: any, elt4: any, elt5: any, elt6: any): Tuple

  • Create a tuple of one element.

    Parameters

    • elt1: any

    Returns Tuple

  • Create a tuple of two elements.

    Parameters

    • elt1: any
    • elt2: any

    Returns Tuple

  • Create a tuple of three elements.

    Parameters

    • elt1: any
    • elt2: any
    • elt3: any

    Returns Tuple

  • Create a tuple of four elements.

    Parameters

    • elt1: any
    • elt2: any
    • elt3: any
    • elt4: any

    Returns Tuple

  • Create a tuple of five elements.

    Parameters

    • elt1: any
    • elt2: any
    • elt3: any
    • elt4: any
    • elt5: any

    Returns Tuple

  • Create a tuple of six elements.

    Parameters

    • elt1: any
    • elt2: any
    • elt3: any
    • elt4: any
    • elt5: any
    • elt6: any

    Returns Tuple

Static tuple

  • Returns Tuple

  • Create a tuple with the provided elements list.

    The elements list is not modified.

    Parameters

    • elements: any

    Returns Tuple

Static wrap

  • wrap<T>(list: T): Tuple
  • wrap(array: any[]): Tuple

  • Wrap the provided list with a tuple.
    The list is not copied and is used as store for tuple elements.
    Note: The list might be modified and users should use {@link Tuple#tuple} if the list is unmodifiable

    Type parameters

    • T

    Parameters

    • list: T

    Returns Tuple

  • Wrap the provided array with a tuple.
    The array is not copied and is used as store for tuple elements.

    Parameters

    • array: any[]

    Returns Tuple

Generated using TypeDoc