ktorm-core/org.ktorm.expression/SqlFormatter

SqlFormatter

abstract class SqlFormatter(val database: Database, val beautifySql: Boolean, val indentSize: Int) : SqlExpressionVisitor(source)

Implementation of SqlExpressionVisitor, visiting SQL expression trees using visitor pattern. After a visit completes, the executable SQL string will be generated in the sql property with its execution parameters in parameters.

Constructors

SqlFormatter

constructor(database: Database, beautifySql: Boolean, indentSize: Int)

Properties

beautifySql

val beautifySql: Boolean

mark if we should output beautiful SQL strings with line-wrapping and indentation.

database

val database: Database

the current database object used to obtain metadata such as identifier quote string.

indentSize

val indentSize: Int

the indent size.

parameters

val parameters: List<ArgumentExpression<*>>

return the SQL execution parameters after the visit completes.

sql

val sql: String

return the executable SQL string after the visit completes.

Functions

visit

open override fun visit(expr: SqlExpression): SqlExpression

Dispatch different type of expression nodes to their specific visit* functions. Custom expression types that are unknown to Ktorm will be dispatched to visitUnknown.

visitAggregate

open override fun <T : Any> visitAggregate(expr: AggregateExpression<T>): AggregateExpression<T>

Function that visits an AggregateExpression.

visitArgument

open override fun <T : Any> visitArgument(expr: ArgumentExpression<T>): ArgumentExpression<T>

Function that visits an ArgumentExpression.

visitBetween

open override fun visitBetween(expr: BetweenExpression): BetweenExpression

Function that visits a BetweenExpression.

visitBinary

open override fun <T : Any> visitBinary(expr: BinaryExpression<T>): BinaryExpression<T>

Function that visits a BinaryExpression.

visitCaseWhen

open override fun <T : Any> visitCaseWhen(expr: CaseWhenExpression<T>): CaseWhenExpression<T>

Function that visits a CaseWhenExpression.

visitCasting

open override fun <T : Any> visitCasting(expr: CastingExpression<T>): CastingExpression<T>

Function that visits a CastingExpression.

visitColumn

open override fun <T : Any> visitColumn(expr: ColumnExpression<T>): ColumnExpression<T>

Function that visits a ColumnExpression.

visitColumnAssignment

open fun <T : Any> visitColumnAssignment(expr: ColumnAssignmentExpression<T>): ColumnAssignmentExpression<T>

Function that visits a ColumnAssignmentExpression.

visitColumnDeclaring

open override fun <T : Any> visitColumnDeclaring(expr: ColumnDeclaringExpression<T>): ColumnDeclaringExpression<T>

Function that visits a ColumnDeclaringExpression.

visitDelete

open override fun visitDelete(expr: DeleteExpression): DeleteExpression

Function that visits a DeleteExpression.

visitExists

open override fun visitExists(expr: ExistsExpression): ExistsExpression

Function that visits an ExistsExpression.

visitExpressionList

open override fun <T : SqlExpression> visitExpressionList(original: List<T>, subVisitor: (T) -> T): List<T>

Helper function for visiting a list of expressions.

visitFunction

open override fun <T : Any> visitFunction(expr: FunctionExpression<T>): FunctionExpression<T>

Function that visits a FunctionExpression.

visitInList

open override fun visitInList(expr: InListExpression): InListExpression

Function that visits an InListExpression.

visitInsert

open override fun visitInsert(expr: InsertExpression): InsertExpression

Function that visits an InsertExpression.

visitInsertFromQuery

open override fun visitInsertFromQuery(expr: InsertFromQueryExpression): InsertFromQueryExpression

Function that visits an InsertFromQueryExpression.

visitJoin

open override fun visitJoin(expr: JoinExpression): JoinExpression

Function that visits a JoinExpression.

visitOrderBy

open override fun visitOrderBy(expr: OrderByExpression): OrderByExpression

Function that visits an OrderByExpression.

visitQuery

open fun visitQuery(expr: QueryExpression): QueryExpression

Function that visits a QueryExpression.

visitQuerySource

open override fun visitQuerySource(expr: QuerySourceExpression): QuerySourceExpression

Function that visits a QuerySourceExpression.

visitScalar

open fun <T : Any> visitScalar(expr: ScalarExpression<T>): ScalarExpression<T>

Function that visits a general ScalarExpression, this function dispatches different type of scalar expressions to their specific visit* functions. Custom expression types that are unknown to Ktorm will be dispatched to visitUnknown

visitSelect