Class OperationNodeTransformer

Transforms an operation node tree into another one.

Kysely queries are expressed internally as a tree of objects (operation nodes). OperationNodeTransformer takes such a tree as its input and returns a transformed deep copy of it. By default the OperationNodeTransformer does nothing. You need to override one or more methods to make it do something.

There's a method for each node type. For example if you'd like to convert each identifier (table name, column name, alias etc.) from camelCase to snake_case, you'd do something like this:

class CamelCaseTransformer extends OperationNodeTransformer {
  transformIdentifier(node: IdentifierNode): IdentifierNode {
    node = super.transformIdentifier(node),

    return {
      ...node,
      name: snakeCase(node.name),
    }
  }
}

const transformer = new CamelCaseTransformer()
const tree = transformer.transformNode(tree)

Constructors

constructor

Properties

#private nodeStack

Methods

transformAddColumn transformAddConstraint transformAddIndex transformAggregateFunction transformAlias transformAlterColumn transformAlterTable transformAnd transformBinaryOperation transformCase transformCast transformCheckConstraint transformColumn transformColumnDefinition transformColumnUpdate transformCommonTableExpression transformCommonTableExpressionName transformCreateIndex transformCreateSchema transformCreateTable transformCreateType transformCreateView transformDataType transformDefaultInsertValue transformDefaultValue transformDeleteQuery transformDropColumn transformDropConstraint transformDropIndex transformDropSchema transformDropTable transformDropType transformDropView transformExplain transformFetch transformForeignKeyConstraint transformFrom transformFunction transformGenerated transformGroupBy transformGroupByItem transformHaving transformIdentifier transformInsertQuery transformJSONOperatorChain transformJSONPath transformJSONPathLeg transformJSONReference transformJoin transformLimit transformList transformMatched transformMergeQuery transformModifyColumn transformNode transformNodeImpl transformNodeList transformOffset transformOn transformOnConflict transformOnDuplicateKey transformOperator transformOr transformOrderBy transformOrderByItem transformOver transformParens transformPartitionBy transformPartitionByItem transformPrimaryKeyConstraint transformPrimitiveValueList transformRaw transformReference transformReferences transformRenameColumn transformReturning transformSchemableIdentifier transformSelectAll transformSelectModifier transformSelectQuery transformSelection transformSetOperation transformTable transformTop transformTuple transformUnaryOperation transformUniqueConstraint transformUpdateQuery transformUsing transformValue transformValueList transformValues transformWhen transformWhere transformWith

Constructors

constructor

Properties

Private #private

#private: any

Protected Readonly nodeStack

nodeStack: OperationNode[]

Methods

Protected transformAddColumn

Protected transformAddConstraint

Protected transformAddIndex

  • transformAddIndex(node): AddIndexNode

  • Parameters

    • node: AddIndexNode

    Returns AddIndexNode

Protected transformAggregateFunction

Protected transformAlias

  • transformAlias(node): kysely.AliasNode

  • Parameters

    Returns kysely.AliasNode

Protected transformAlterColumn

Protected transformAlterTable

Protected transformAnd

  • transformAnd(node): kysely.AndNode

  • Parameters

    Returns kysely.AndNode

Protected transformBinaryOperation

Protected transformCase

  • transformCase(node): kysely.CaseNode

  • Parameters

    Returns kysely.CaseNode

Protected transformCast

  • transformCast(node): CastNode

  • Parameters

    • node: CastNode

    Returns CastNode

Protected transformCheckConstraint

Protected transformColumn

Protected transformColumnDefinition

Protected transformColumnUpdate

Protected transformCommonTableExpression

Protected transformCommonTableExpressionName

Protected transformCreateIndex

Protected transformCreateSchema

Protected transformCreateTable

Protected transformCreateType

Protected transformCreateView

Protected transformDataType

Protected transformDefaultInsertValue

Protected transformDefaultValue

Protected transformDeleteQuery

Protected transformDropColumn

Protected transformDropConstraint

Protected transformDropIndex

Protected transformDropSchema

Protected transformDropTable

Protected transformDropType

Protected transformDropView

Protected transformExplain

Protected transformFetch

  • transformFetch(node): kysely.FetchNode

  • Parameters

    Returns kysely.FetchNode

Protected transformForeignKeyConstraint

Protected transformFrom

  • transformFrom(node): kysely.FromNode

  • Parameters

    Returns kysely.FromNode

Protected transformFunction

  • transformFunction(node): FunctionNode

  • Parameters

    • node: FunctionNode

    Returns FunctionNode

Protected transformGenerated

Protected transformGroupBy

Protected transformGroupByItem

Protected transformHaving

Protected transformIdentifier

Protected transformInsertQuery

Protected transformJSONOperatorChain

Protected transformJSONPath

Protected transformJSONPathLeg

Protected transformJSONReference

Protected transformJoin

  • transformJoin(node): kysely.JoinNode

  • Parameters

    Returns kysely.JoinNode

Protected transformLimit

  • transformLimit(node): kysely.LimitNode

  • Parameters

    Returns kysely.LimitNode

Protected transformList

  • transformList(node): kysely.ListNode

  • Parameters

    Returns kysely.ListNode

Protected transformMatched

Protected transformMergeQuery

Protected transformModifyColumn

transformNode

  • transformNode<T>(node): T

  • Type Parameters

    Parameters

    • node: T

    Returns T

Protected transformNodeImpl

  • transformNodeImpl<T>(node): T

  • Type Parameters

    Parameters

    • node: T

    Returns T

Protected transformNodeList

  • transformNodeList<T>(list): T

  • Type Parameters

    Parameters

    • list: T

    Returns T

Protected transformOffset

Protected transformOn

  • transformOn(node): kysely.OnNode

  • Parameters

    Returns kysely.OnNode

Protected transformOnConflict

Protected transformOnDuplicateKey

Protected transformOperator

Protected transformOr

  • transformOr(node): kysely.OrNode

  • Parameters

    Returns kysely.OrNode

Protected transformOrderBy

Protected transformOrderByItem

Protected transformOver

  • transformOver(node): kysely.OverNode

  • Parameters

    Returns kysely.OverNode

Protected transformParens

Protected transformPartitionBy

Protected transformPartitionByItem

Protected transformPrimaryKeyConstraint

Protected transformPrimitiveValueList

Protected transformRaw

  • transformRaw(node): kysely.RawNode

  • Parameters

    Returns kysely.RawNode

Protected transformReference

Protected transformReferences

Protected transformRenameColumn

Protected transformReturning

Protected transformSchemableIdentifier

  • transformSchemableIdentifier(node): SchemableIdentifierNode

  • Parameters

    • node: SchemableIdentifierNode

    Returns SchemableIdentifierNode

Protected transformSelectAll

Protected transformSelectModifier

  • transformSelectModifier(node): SelectModifierNode

  • Parameters

    • node: SelectModifierNode

    Returns SelectModifierNode

Protected transformSelectQuery

Protected transformSelection

Protected transformSetOperation

Protected transformTable

  • transformTable(node): kysely.TableNode

  • Parameters

    Returns kysely.TableNode

Protected transformTop

  • transformTop(node): kysely.TopNode

  • Parameters

    Returns kysely.TopNode

Protected transformTuple

  • transformTuple(node): kysely.TupleNode

  • Parameters

    Returns kysely.TupleNode

Protected transformUnaryOperation

Protected transformUniqueConstraint

Protected transformUpdateQuery

Protected transformUsing

  • transformUsing(node): kysely.UsingNode

  • Parameters

    Returns kysely.UsingNode

Protected transformValue

  • transformValue(node): kysely.ValueNode

  • Parameters

    Returns kysely.ValueNode

Protected transformValueList

Protected transformValues

Protected transformWhen

  • transformWhen(node): kysely.WhenNode

  • Parameters

    Returns kysely.WhenNode

Protected transformWhere

  • transformWhere(node): kysely.WhereNode

  • Parameters

    Returns kysely.WhereNode

Protected transformWith

  • transformWith(node): kysely.WithNode

  • Parameters

    Returns kysely.WithNode

Settings

Member Visibility

Theme

On This Page

constructor#privatenodeStacktransformAddColumntransformAddConstrainttransformAddIndextransformAggregateFunctiontransformAliastransformAlterColumntransformAlterTabletransformAndtransformBinaryOperationtransformCasetransformCasttransformCheckConstrainttransformColumntransformColumnDefinitiontransformColumnUpdatetransformCommonTableExpressiontransformCommonTableExpressionNametransformCreateIndextransformCreateSchematransformCreateTabletransformCreateTypetransformCreateViewtransformDataTypetransformDefaultInsertValuetransformDefaultValuetransformDeleteQuerytransformDropColumntransformDropConstrainttransformDropIndextransformDropSchematransformDropTabletransformDropTypetransformDropViewtransformExplaintransformFetchtransformForeignKeyConstrainttransformFromtransformFunctiontransformGeneratedtransformGroupBytransformGroupByItemtransformHavingtransformIdentifiertransformInsertQuerytransformJSONOperatorChaintransformJSONPathtransformJSONPathLegtransformJSONReferencetransformJointransformLimittransformListtransformMatchedtransformMergeQuerytransformModifyColumntransformNodetransformNodeImpltransformNodeListtransformOffsettransformOntransformOnConflicttransformOnDuplicateKeytransformOperatortransformOrtransformOrderBytransformOrderByItemtransformOvertransformParenstransformPartitionBytransformPartitionByItemtransformPrimaryKeyConstrainttransformPrimitiveValueListtransformRawtransformReferencetransformReferencestransformRenameColumntransformReturningtransformSchemableIdentifiertransformSelectAlltransformSelectModifiertransformSelectQuerytransformSelectiontransformSetOperationtransformTabletransformToptransformTupletransformUnaryOperationtransformUniqueConstrainttransformUpdateQuerytransformUsingtransformValuetransformValueListtransformValuestransformWhentransformWheretransformWith