Defined in: packages/core/src/models/SqlComponent.ts:11
Extended by ​
BinarySelectQuerySelectQueryInlineQueryValueListColumnReferenceFunctionCallWindowFrameBoundStaticWindowFrameBoundaryValueWindowFrameSpecWindowFrameExpressionUnaryExpressionBinaryExpressionLiteralValueParameterExpressionSwitchCaseArgumentCaseKeyValuePairRawStringIdentifierStringParenExpressionCastExpressionCaseExpressionArrayExpressionArrayQueryExpressionBetweenExpressionStringSpecifierExpressionTypeValueTupleExpressionArraySliceExpressionArrayIndexExpressionQualifiedNameSelectItemSelectClauseDistinctDistinctOnWhereClausePartitionByClauseWindowFrameClauseWindowsClauseOrderByClauseOrderByItemGroupByClauseHavingClauseTableSourceFunctionSourceParenSourceSubQuerySourceSourceExpressionJoinOnClauseJoinUsingClauseJoinClauseFromClauseUsingClauseCommonTableWithClauseLimitClauseOffsetClauseFetchClauseFetchExpressionForClauseSourceAliasExpressionReturningClauseSetClauseSetClauseItemUpdateClauseDeleteClauseInsertClauseReferenceDefinitionColumnConstraintDefinitionTableConstraintDefinitionTableColumnDefinitionCreateTableQueryMergeActionMergeWhenClauseDropTableStatementDropIndexStatementCreateSchemaStatementDropSchemaStatementCommentOnStatementIndexColumnDefinitionCreateIndexStatementAlterTableAddConstraintAlterTableDropConstraintAlterTableDropColumnAlterTableAddColumnAlterTableAlterColumnDefaultAlterTableStatementDropConstraintStatementExplainOptionExplainStatementAnalyzeStatementCreateSequenceStatementAlterSequenceStatementVacuumStatementReindexStatementClusterStatementCheckpointStatementSimpleSelectQueryValuesQueryInsertQueryUpdateQueryDeleteQueryMergeQuery
Constructors ​
Constructor ​
new SqlComponent():
SqlComponent
Returns ​
SqlComponent
Properties ​
kind ​
statickind:symbol
Defined in: packages/core/src/models/SqlComponent.ts:13
comments ​
comments:
string[] |null=null
Defined in: packages/core/src/models/SqlComponent.ts:29
positionedComments ​
positionedComments:
PositionedComment[] |null=null
Defined in: packages/core/src/models/SqlComponent.ts:32
Methods ​
getKind() ​
getKind():
symbol
Defined in: packages/core/src/models/SqlComponent.ts:15
Returns ​
symbol
accept() ​
accept<
T>(visitor):T
Defined in: packages/core/src/models/SqlComponent.ts:19
Type Parameters ​
T ​
T
Parameters ​
visitor ​
SqlComponentVisitor<T>
Returns ​
T
toSqlString() ​
toSqlString(
formatter):string
Defined in: packages/core/src/models/SqlComponent.ts:23
Parameters ​
formatter ​
SqlComponentVisitor<string>
Returns ​
string
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
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[]
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[]