# Interface: SelectQuery

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

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:89

---

headerComments

headerComments: null | string[]

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

---

comments

comments: null | string[] = null

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

Inherited from

MergeQuery.comments

---

positionedComments

positionedComments: null | PositionedComment[] = null

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

Inherited from

MergeQuery.positionedComments

Methods

setParameter()

setParameter(name, value): this

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

Parameters

name

string

value

SqlParameterValue

Returns

this

---

toSimpleQuery()

toSimpleQuery(): SimpleSelectQuery

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

Returns

SimpleSelectQuery

---

toInsertQuery()

toInsertQuery(options): InsertQuery

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

Parameters

options

InsertQueryConversionOptions

Returns

InsertQuery

---

toUpdateQuery()

toUpdateQuery(options): UpdateQuery

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

Parameters

options

UpdateQueryConversionOptions

Returns

UpdateQuery

---

toDeleteQuery()

toDeleteQuery(options): DeleteQuery

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

Parameters

options

DeleteQueryConversionOptions

Returns

DeleteQuery

---

toMergeQuery()

toMergeQuery(options): MergeQuery

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

Parameters

options

MergeQueryConversionOptions

Returns

MergeQuery

---

getKind()

getKind(): symbol

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

Returns

symbol

Inherited from

SqlComponent.getKind

---

accept()

accept<T&gt;(visitor): T

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

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:23

Parameters

formatter

SqlComponentVisitor<string&gt;

Returns

string

Inherited from

SqlComponent.toSqlString

---

addPositionedComments()

addPositionedComments(position, comments): void

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

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:56

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:66

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

Returns

string[]

Inherited from

SqlComponent.getAllPositionedComments