Skip to Content

Kysely Documentation

CTRL K

CTRL K

CODE OF CONDUCT
CONTRIBUTING
FUNDING
README
SECURITY
- README
Index
- Gap Analysis

CODE OF CONDUCT
CONTRIBUTING
FUNDING
README
SECURITY
- README
Index
- Gap Analysis

On This Page

Classes
Interfaces
Type Aliases
Variables
Functions
Settings
On This Page

Api ReferenceModules

Last Updated: 3/9/2026

kysely

Classes

AggregateFunctionBuilder

AliasedAggregateFunctionBuilder

AliasedDynamicTableBuilder

AliasedExpressionWrapper

AliasedJSONPathBuilder

AlterColumnBuilder

AlteredColumnBuilder

AlterTableBuilder

AlterTableColumnAlteringBuilder

CamelCasePlugin

CaseThenBuilder

CaseWhenBuilder

ColumnDefinitionBuilder

ConnectionBuilder

ControlledTransaction

ControlledTransactionBuilder

CreateIndexBuilder

CreateSchemaBuilder

CreateTableBuilder

CreateTypeBuilder

CreateViewBuilder

DeduplicateJoinsPlugin

DefaultConnectionProvider

DefaultQueryCompiler

DefaultQueryExecutor

DeleteQueryBuilder

DialectAdapterBase

DropIndexBuilder

DropSchemaBuilder

DropTableBuilder

DropTypeBuilder

DropViewBuilder

DynamicReferenceBuilder

DynamicTableBuilder

ExpressionWrapper

FileMigrationProvider

ForeignKeyConstraintBuilder

HandleEmptyInListsPlugin

InsertQueryBuilder

JSONPathBuilder

MatchedThenableMergeQueryBuilder

MergeQueryBuilder

MssqlIntrospector

MssqlQueryCompiler

MysqlIntrospector

MysqlQueryCompiler

NoopQueryExecutor

NotMatchedThenableMergeQueryBuilder

OnConflictBuilder

OnConflictDoNothingBuilder

OnConflictUpdateBuilder

OperationNodeTransformer

OperationNodeVisitor

OrderByItemBuilder

ParseJSONResultsPlugin

PostgresAdapter

PostgresDialect

PostgresIntrospector

PostgresQueryCompiler

RefreshMaterializedViewBuilder

SingleConnectionProvider

SqliteIntrospector

SqliteQueryCompiler

TransactionBuilder

TraversedJSONPathBuilder

UpdateQueryBuilder

WheneableMergeQueryBuilder

WithSchemaPlugin

Interfaces

AddConstraintNode

AggregateFunctionBuilderProps

AggregateFunctionNode

AliasableExpression

AliasedExpression

AliasedRawBuilder

AliasedSelectQueryBuilder

AlterColumnNode

AlterTableBuilderProps

AlterTableColumnAlteringBuilderProps

BinaryOperationNode

CamelCasePluginOptions

CheckConstraintNode

ColumnAlteringInterface

ColumnDefinitionNode

ColumnUpdateNode

CommonTableExpressionNameNode

CommonTableExpressionNode

ConnectionProvider

CreateIndexBuilderProps

CreateIndexNode

CreateSchemaBuilderProps

CreateSchemaNode

CreateTableBuilderProps

CreateTableNode

CreateTypeBuilderProps

CreateViewBuilderProps

DatabaseConnection

DatabaseIntrospector

DatabaseMetadata

DatabaseMetadataOptions

DefaultInsertValueNode

DefaultValueNode

DeleteQueryBuilderProps

DeleteQueryNode

DropConstraintNode

DropIndexBuilderProps

DropSchemaBuilderProps

DropTableBuilderProps

DropTypeBuilderProps

DropViewBuilderProps

ExpressionBuilder

FileMigrationProviderFS

FileMigrationProviderPath

FileMigrationProviderProps

ForeignKeyConstraintBuilderInterface

ForeignKeyConstraintNode

GroupByItemNode

HandleEmptyInListsOptions

HavingInterface

InsertQueryBuilderProps

InsertQueryNode

JoinBuilderProps

JSONOperatorChainNode

JSONPathLegNode

JSONReferenceNode

MergeQueryBuilderProps

MigrationLockOptions

MigrationProvider

MigrationResult

MigrationResultSet

ModifyColumnNode

MssqlDialectConfig

MultiTableReturningInterface

MysqlDialectConfig

MysqlPoolConnection

MysqlStreamOptions

OnConflictBuilderProps

OnDuplicateKeyNode

OperationNodeSource

OrderByInterface

OrderByItemBuilderProps

OrderByItemNode

OutputInterface

ParseJSONResultsPluginOptions

PartitionByItemNode

PartitionByNode

PluginTransformQueryArgs

PluginTransformResultArgs

PostgresDialectConfig

PostgresPoolClient

PostgresQueryResult

PrimaryKeyConstraintNode

PrimitiveValueListNode

QueryCreatorProps

RawBuilderProps

RefreshMaterializedViewBuilderProps

RefreshMaterializedViewNode

RenameColumnNode

RenameConstraintNode

ReturningInterface

SchemableIdentifierNode

SelectModifierNode

SelectQueryBuilder

SelectQueryBuilderProps

SelectQueryNode

SetOperationNode

SqliteDialectConfig

SqliteStatement

TarnPendingRequest

TarnPoolOptions

TediousColumnValue

TediousConnection

TediousDataType

TediousRequestClass

TransactionSettings

UnaryOperationNode

UniqueConstraintNode

UpdateQueryBuilderProps

UpdateQueryNode

Type Aliases

AddIndexNodeProps

AlterColumnBuilderCallback

AlterColumnNodeProps

AlterTableColumnAlterationNode

AlterTableNodeTableProps

AnyAliasedColumn

AnyAliasedColumnWithTable

AnyColumnWithTable

ArithmeticOperator

CallbackSelection

ColumnBuilderCallback

ColumnDefinitionBuilderCallback

ColumnDefinitionNodeProps

ComparisonOperator

ComparisonOperatorExpression

CreateIndexNodeProps

CreateSchemaNodeParams

CreateTableNodeParams

CreateTypeNodeParams

CreateViewNodeParams

DeleteQueryBuilderWithFullJoin

DeleteQueryBuilderWithInnerJoin

DeleteQueryBuilderWithLeftJoin

DeleteQueryBuilderWithRightJoin

DropConstraintNodeProps

DropIndexNodeProps

DropSchemaNodeParams

DropTablexNodeParams

DropTypeNodeParams

DropViewNodeParams

EmptyInListNode

EmptyInListsStrategy

ExistsExpression

ExpressionOrFactory

ExtractTypeFromReferenceExpression

ExtractTypeFromStringReference

ExtractWheneableMergeQueryBuilder

ForeignKeyConstraintBuilderCallback

ForeignKeyConstraintNodeProps

GeneratedAlways

GeneratedNodeParams

InsertQueryNodeProps

JoinCallbackExpression

JoinReferenceExpression

JSONOperatorWith$

JSONPathLegType

MysqlQueryResult

NonNullableInsertKeys

NoResultErrorConstructor

NullableInsertKeys

NumbersWhenDataTypeNotAvailable

OnConflictDatabase

OnConflictNodeProps

OnConflictTables

OnDuplicateKeyNodeProps

OnModifyForeignAction

OperandExpression

OperandValueExpression

OperandValueExpressionOrList

OperationNodeKind

OrderByDirection

OrderByDirectionExpression

OrderByExpression

OrderByItemNodeProps

OrderByModifiers

OrderByModifiersCallbackExpression

OutputExpression

OverBuilderCallback

PostgresCursorConstructor

PrimaryKeyConstraintNodeProps

ReferenceExpression

ReferenceExpressionOrList

RefreshMaterializedViewNodeParams

RootOperationNode

SelectExpression

SelectExpressionFromOutputCallback

SelectExpressionFromOutputExpression

SelectQueryBuilderWithFullJoin

SelectQueryBuilderWithInnerJoin

SelectQueryBuilderWithLeftJoin

SelectQueryBuilderWithRightJoin

ShallowDehydrateObject

ShallowDehydrateValue

SimpleReferenceExpression

SimpleReferenceExpressionNode

SimpleTableReference

StringReference

StringsWhenDataTypeNotAvailable

TableExpression

TableExpressionOrList

TediousIsolationLevel

UnaryFilterOperator

UniqueConstraintNodeProps

UpdateQueryBuilderWithFullJoin

UpdateQueryBuilderWithInnerJoin

UpdateQueryBuilderWithLeftJoin

UpdateQueryBuilderWithRightJoin

ValueExpression

ValueExpressionOrList

Variables

ARITHMETIC_OPERATORS

BINARY_OPERATORS

COMPARISON_OPERATORS

DEFAULT_ALLOW_UNORDERED_MIGRATIONS

DEFAULT_MIGRATION_LOCK_TABLE

DEFAULT_MIGRATION_TABLE

MIGRATION_LOCK_ID

NOOP_QUERY_EXECUTOR

ON_COMMIT_ACTIONS

ON_MODIFY_FOREIGN_ACTIONS

PrimaryConstraintNode

TRANSACTION_ACCESS_MODES

TRANSACTION_ISOLATION_LEVELS

UNARY_FILTER_OPERATORS

UNARY_OPERATORS

Functions

createFunctionModule

createRawBuilder

createSelectQueryBuilder

expressionBuilder

isAliasedDynamicTableBuilder

isAliasedExpression

isArithmeticOperator

isBinaryOperator

isColumnDataType

isComparisonOperator

isDynamicReferenceBuilder

isNoResultErrorConstructor

isOperationNodeSource

pushValueIntoList

replaceWithNoncontingentExpression

validateTransactionSettings

Settings

Member Visibility

On This Page

Classes

AggregateFunctionBuilder AliasedAggregateFunctionBuilder AliasedDynamicTableBuilder AliasedExpressionWrapper AliasedJSONPathBuilder AlterColumnBuilder AlteredColumnBuilder AlterTableBuilder AlterTableColumnAlteringBuilder AndWrapper CamelCasePlugin CaseBuilder CaseEndBuilder CaseThenBuilder CaseWhenBuilder ColumnDefinitionBuilder Command ConnectionBuilder ControlledTransaction ControlledTransactionBuilder CreateIndexBuilder CreateSchemaBuilder CreateTableBuilder CreateTypeBuilder CreateViewBuilder DeduplicateJoinsPlugin DefaultConnectionProvider DefaultQueryCompiler DefaultQueryExecutor DeleteQueryBuilder DeleteResult DialectAdapterBase DropIndexBuilder DropSchemaBuilder DropTableBuilder DropTypeBuilder DropViewBuilder DummyDriver DynamicModule DynamicReferenceBuilder DynamicTableBuilder ExpressionWrapper FileMigrationProvider ForeignKeyConstraintBuilder HandleEmptyInListsPlugin InsertQueryBuilder InsertResult JoinBuilder JSONPathBuilder Kysely Log MatchedThenableMergeQueryBuilder MergeQueryBuilder MergeResult Migrator MssqlAdapter MssqlDialect MssqlDriver MssqlIntrospector MssqlQueryCompiler MysqlAdapter MysqlDialect MysqlDriver MysqlIntrospector MysqlQueryCompiler NoopQueryExecutor NoResultError NotMatchedThenableMergeQueryBuilder OnConflictBuilder OnConflictDoNothingBuilder OnConflictUpdateBuilder OperationNodeTransformer OperationNodeVisitor OrderByItemBuilder OrWrapper ParseJSONResultsPlugin PostgresAdapter PostgresDialect PostgresDriver PostgresIntrospector PostgresQueryCompiler QueryCreator RefreshMaterializedViewBuilder SchemaModule SingleConnectionProvider SqliteAdapter SqliteDialect SqliteDriver SqliteIntrospector SqliteQueryCompiler TarnPool TediousRequest Transaction TransactionBuilder TraversedJSONPathBuilder UpdateQueryBuilder UpdateResult WheneableMergeQueryBuilder WithSchemaPlugin

Interfaces

AddColumnNode AddConstraintNode AddIndexNode AggregateFunctionBuilderProps AggregateFunctionNode AliasableExpression AliasedExpression AliasedRawBuilder AliasedSelectQueryBuilder AliasNode AlterColumnNode AlterTableBuilderProps AlterTableColumnAlteringBuilderProps AlterTableNode AndNode BinaryOperationNode CamelCasePluginOptions CaseNode CastNode CheckConstraintNode CollateNode ColumnAlteringInterface ColumnDefinitionNode ColumnMetadata ColumnNode ColumnUpdateNode CommonTableExpressionNameNode CommonTableExpressionNode Compilable CompiledQuery ConnectionProvider CreateIndexBuilderProps CreateIndexNode CreateSchemaBuilderProps CreateSchemaNode CreateTableBuilderProps CreateTableNode CreateTypeBuilderProps CreateTypeNode CreateViewBuilderProps CreateViewNode DatabaseConnection DatabaseIntrospector DatabaseMetadata DatabaseMetadataOptions DataTypeNode DefaultInsertValueNode DefaultValueNode DeleteQueryBuilderProps DeleteQueryNode Dialect DialectAdapter Driver DropColumnNode DropConstraintNode DropIndexBuilderProps DropIndexNode DropSchemaBuilderProps DropSchemaNode DropTableBuilderProps DropTableNode DropTypeBuilderProps DropTypeNode DropViewBuilderProps DropViewNode ErrorLogEvent Explainable ExplainNode Expression ExpressionBuilder FetchNode FileMigrationProviderFS FileMigrationProviderPath FileMigrationProviderProps ForeignKeyConstraintBuilderInterface ForeignKeyConstraintNode FromNode FunctionModule FunctionNode GeneratedNode GroupByItemNode GroupByNode HandleEmptyInListsOptions HavingInterface HavingNode IdentifierNode InsertQueryBuilderProps InsertQueryNode JoinBuilderProps JoinNode JSONOperatorChainNode JSONPathLegNode JSONPathNode JSONReferenceNode KyselyConfig KyselyPlugin KyselyProps LimitNode ListNode MatchedNode MergeQueryBuilderProps MergeQueryNode Migration MigrationInfo MigrationLockOptions MigrationProvider MigrationResult MigrationResultSet MigratorProps ModifyColumnNode MssqlDialectConfig MultiTableReturningInterface MysqlDialectConfig MysqlOkPacket MysqlPool MysqlPoolConnection MysqlStream MysqlStreamOptions NoMigrations OffsetNode OnConflictBuilderProps OnConflictNode OnDuplicateKeyNode OnNode OperationNode OperationNodeSource OperatorNode OrActionNode OrderByInterface OrderByItemBuilderProps OrderByItemNode OrderByNode OrNode OutputInterface OutputNode OverNode ParensNode ParseJSONResultsPluginOptions PartitionByItemNode PartitionByNode PluginTransformQueryArgs PluginTransformResultArgs PostgresCursor PostgresDialectConfig PostgresPool PostgresPoolClient PostgresQueryResult PostgresStream PrimaryKeyConstraintNode PrimitiveValueListNode QueryCompiler QueryCreatorProps QueryExecutor QueryId QueryLogEvent QueryResult RawBuilder RawBuilderProps RawNode ReferenceNode ReferencesNode RefreshMaterializedViewBuilderProps RefreshMaterializedViewNode RenameColumnNode RenameConstraintNode ReturningInterface ReturningNode SchemableIdentifierNode SchemaMetadata SelectAllNode SelectionNode SelectModifierNode SelectQueryBuilder SelectQueryBuilderProps SelectQueryNode SetOperationNode Sql SqliteDatabase SqliteDialectConfig SqliteStatement Streamable TableMetadata TableNode Tarn TarnPendingRequest TarnPoolOptions Tedious TediousColumnValue TediousConnection TediousDataType TediousRequestClass TediousTypes TopNode TransactionSettings TupleNode UnaryOperationNode UniqueConstraintNode UpdateQueryBuilderProps UpdateQueryNode UsingNode ValueListNode ValueNode ValuesNode WhenNode WhereInterface WhereNode WithNode

Type Aliases

AccessMode AddIndexNodeProps AlterColumnBuilderCallback AlterColumnNodeProps AlterTableColumnAlterationNode AlterTableNodeTableProps AnyAliasedColumn AnyAliasedColumnWithTable AnyColumn AnyColumnWithTable ArithmeticOperator BinaryOperator CallbackSelection Collation ColumnBuilderCallback ColumnDataType ColumnDefinitionBuilderCallback ColumnDefinitionNodeProps ColumnType ComparisonOperator ComparisonOperatorExpression ConstraintNode CreateIndexNodeProps CreateSchemaNodeParams CreateTableNodeParams CreateTypeNodeParams CreateViewNodeParams DataTypeParams DeleteQueryBuilderWithFullJoin DeleteQueryBuilderWithInnerJoin DeleteQueryBuilderWithLeftJoin DeleteQueryBuilderWithRightJoin DropConstraintNodeProps DropIndexNodeProps DropSchemaNodeParams DropTablexNodeParams DropTypeNodeParams DropViewNodeParams EmptyInListNode EmptyInListsStrategy Equals ExistsExpression ExplainFormat ExpressionOrFactory ExtractTypeFromReferenceExpression ExtractTypeFromStringReference ExtractWheneableMergeQueryBuilder FetchModifier FilterObject ForeignKeyConstraintBuilderCallback ForeignKeyConstraintNodeProps Generated GeneratedAlways GeneratedNodeParams IndexType InferResult Insertable InsertObject InsertQueryNodeProps InsertType IsolationLevel JoinCallbackExpression JoinReferenceExpression JoinType JSONColumnType JSONOperator JSONOperatorWith$JSONPathLegType LogConfig LogEvent Logger LogLevel MysqlQueryResult NonNullableInsertKeys NoResultErrorConstructor NotNull Nullable NullableInsertKeys NumbersWhenDataTypeNotAvailable NumericString OnCommitAction OnConflictDatabase OnConflictNodeProps OnConflictTables OnDuplicateKeyNodeProps OnModifyForeignAction OperandExpression OperandValueExpression OperandValueExpressionOrList OperationNodeKind Operator OrderByDirection OrderByDirectionExpression OrderByExpression OrderByItemNodeProps OrderByModifiers OrderByModifiersCallbackExpression OutputCallback OutputDatabase OutputExpression OutputPrefix OverBuilderCallback PostgresCursorConstructor PrimaryKeyConstraintNodeProps QueryNode ReferenceExpression ReferenceExpressionOrList RefreshMaterializedViewNodeParams RootOperationNode Selectable SelectArg SelectCallback SelectExpression SelectExpressionFromOutputCallback SelectExpressionFromOutputExpression Selection SelectModifier SelectQueryBuilderWithFullJoin SelectQueryBuilderWithInnerJoin SelectQueryBuilderWithLeftJoin SelectQueryBuilderWithRightJoin SelectType SetOperator ShallowDehydrateObject ShallowDehydrateValue SimpleReferenceExpression SimpleReferenceExpressionNode SimpleTableReference Simplify SqlBool StringReference StringsWhenDataTypeNotAvailable TableExpression TableExpressionOrList TediousIsolationLevel TopModifier UnaryFilterOperator UnaryOperator UniqueConstraintNodeProps UnknownRow Updateable UpdateKeys UpdateObject UpdateQueryBuilderWithFullJoin UpdateQueryBuilderWithInnerJoin UpdateQueryBuilderWithLeftJoin UpdateQueryBuilderWithRightJoin UpdateType ValueExpression ValueExpressionOrList ValuesItemNode WithNodeParams

Variables

ARITHMETIC_OPERATORS BINARY_OPERATORS COMPARISON_OPERATORS CompiledQuery DEFAULT_ALLOW_UNORDERED_MIGRATIONS DEFAULT_MIGRATION_LOCK_TABLE DEFAULT_MIGRATION_TABLE JSON_OPERATORS LOG_LEVELS MIGRATION_LOCK_ID NO_MIGRATIONS NOOP_QUERY_EXECUTOR ON_COMMIT_ACTIONS ON_MODIFY_FOREIGN_ACTIONS OPERATORS PrimaryConstraintNode sql TRANSACTION_ACCESS_MODES TRANSACTION_ISOLATION_LEVELS UNARY_FILTER_OPERATORS UNARY_OPERATORS

Functions

createFunctionModule createQueryId createRawBuilder createSelectQueryBuilder expressionBuilder isAliasedDynamicTableBuilder isAliasedExpression isArithmeticOperator isBinaryOperator isColumnDataType isComparisonOperator isCompilable isDynamicReferenceBuilder isExpression isJSONOperator isKyselyProps isNoResultErrorConstructor isOperationNodeSource isOperator logOnce pushValueIntoList replaceWithNoncontingentExpression validateTransactionSettings

Hierarchy CaseThenBuilder

Kysely Documentation · Powered by Jolli