# Class: ValuesQuery

Defined in: packages/core/src/models/ValuesQuery.ts:13

Represents a VALUES query in SQL.

Extends

• SqlComponent

Implements

• SelectQuery

Constructors

Constructor

new ValuesQuery(tuples, columnAliases): ValuesQuery

Defined in: packages/core/src/models/ValuesQuery.ts:25

Parameters

tuples

TupleExpression[]

columnAliases

null | string[]

Returns

ValuesQuery

Overrides

SqlComponent.constructor

Properties

comments

comments: null | string[] = null

Defined in: packages/core/src/models/SqlComponent.ts:27

Implementation of

SelectQuery.comments

Inherited from

SqlComponent.comments

---

positionedComments

positionedComments: null | PositionedComment[] = null

Defined in: packages/core/src/models/SqlComponent.ts:30

Implementation of

SelectQuery.positionedComments

Inherited from

SqlComponent.positionedComments

---

kind

static kind: symbol

Defined in: packages/core/src/models/ValuesQuery.ts:14

Overrides

SqlComponent.kind

---

__selectQueryType

readonly __selectQueryType: "SelectQuery" = 'SelectQuery'

Defined in: packages/core/src/models/ValuesQuery.ts:15

Implementation of

SelectQuery.__selectQueryType

---

headerComments

headerComments: null | string[] = null

Defined in: packages/core/src/models/ValuesQuery.ts:16

Implementation of

SelectQuery.headerComments

---

tuples

tuples: TupleExpression[]

Defined in: packages/core/src/models/ValuesQuery.ts:17

---

columnAliases

columnAliases: null | string[]

Defined in: packages/core/src/models/ValuesQuery.ts:23

Column aliases for the VALUES query. These represent the logical column names for each value tuple. Note: This property is optional and is not referenced during SQL output, but is used when converting to a SimpleSelectQuery.

Methods

getKind()

getKind(): symbol

Defined in: packages/core/src/models/SqlComponent.ts:13

Returns

symbol

Implementation of

SelectQuery.getKind

Inherited from

SqlComponent.getKind

---

accept()

accept<T&gt;(visitor): T

Defined in: packages/core/src/models/SqlComponent.ts:17

Type Parameters

T

T

Parameters

visitor

SqlComponentVisitor<T&gt;

Returns

T

Implementation of

SelectQuery.accept

Inherited from

SqlComponent.accept

---

toSqlString()

toSqlString(formatter): string

Defined in: packages/core/src/models/SqlComponent.ts:21

Parameters

formatter

SqlComponentVisitor<string&gt;

Returns

string

Implementation of

SelectQuery.toSqlString

Inherited from

SqlComponent.toSqlString

---

addPositionedComments()

addPositionedComments(position, comments): void

Defined in: packages/core/src/models/SqlComponent.ts:35

Add comments at a specific position

Parameters

position

"before" | "after"

comments

string[]

Returns

void

Implementation of

SelectQuery.addPositionedComments

Inherited from

SqlComponent.addPositionedComments

---

getPositionedComments()

getPositionedComments(position): string[]

Defined in: packages/core/src/models/SqlComponent.ts:54

Get comments for a specific position

Parameters

position

"before" | "after"

Returns

string[]

Implementation of

SelectQuery.getPositionedComments

Inherited from

SqlComponent.getPositionedComments

---

getAllPositionedComments()

getAllPositionedComments(): string[]

Defined in: packages/core/src/models/SqlComponent.ts:64

Get all positioned comments as a flat array in order (before, after)

Returns

string[]

Implementation of

SelectQuery.getAllPositionedComments

Inherited from

SqlComponent.getAllPositionedComments

---

toSimpleQuery()

toSimpleQuery(): SimpleSelectQuery

Defined in: packages/core/src/models/ValuesQuery.ts:31

Returns

SimpleSelectQuery

Implementation of

SelectQuery.toSimpleQuery

---

setParameter()

setParameter(name, value): this

Defined in: packages/core/src/models/ValuesQuery.ts:40

Sets the value of a parameter by name in this query.

Parameters

name

string

Parameter name

value

SqlParameterValue

Value to set

Returns

this

Implementation of

SelectQuery.setParameter