# Interface: SelectQuery

Defined in: packages/core/src/models/SelectQuery.ts:51

Shared interface implemented by all select query variants.

Example

const query = SelectQueryParser.parse('WITH active_users AS (SELECT * FROM users)');
query.setParameter('tenantId', 42);
const simple = query.toSimpleQuery();

Related tests: packages/core/tests/models/SelectQuery.toSimpleQuery.test.ts

Extends

• SqlComponent

Properties

__selectQueryType

readonly __selectQueryType: "SelectQuery"

Defined in: packages/core/src/models/SelectQuery.ts:52

---

headerComments

headerComments: null | string[]

Defined in: packages/core/src/models/SelectQuery.ts:53

---

comments

comments: null | string[] = null

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

Inherited from

InsertQuery.comments

---

positionedComments

positionedComments: null | PositionedComment[] = null

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

Inherited from

InsertQuery.positionedComments

Methods

setParameter()

setParameter(name, value): this

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

Parameters

name

string

value

SqlParameterValue

Returns

this

---

toSimpleQuery()

toSimpleQuery(): SimpleSelectQuery

Defined in: packages/core/src/models/SelectQuery.ts:55

Returns

SimpleSelectQuery

---

getKind()

getKind(): symbol

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

Returns

symbol

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

Inherited from

SqlComponent.accept

---

toSqlString()

toSqlString(formatter): string

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

Parameters

formatter

SqlComponentVisitor<string&gt;

Returns

string

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

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[]

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[]

Inherited from

SqlComponent.getAllPositionedComments