Skip to main content
Version: Next

@mikro-orm/knex

Index

Classes

Enumerations

Functions

Interfaces

References

Type Aliases

Variables

References

AbstractNamingStrategy

Re-exports AbstractNamingStrategy

AbstractSchemaGenerator

Re-exports AbstractSchemaGenerator

AfterCreate

Re-exports AfterCreate

AfterDelete

Re-exports AfterDelete

AfterUpdate

Re-exports AfterUpdate

AfterUpsert

Re-exports AfterUpsert

AnyEntity

Re-exports AnyEntity

ARRAY_OPERATORS

Re-exports ARRAY_OPERATORS

ArrayCollection

Re-exports ArrayCollection

ArrayType

Re-exports ArrayType

assign

Re-exports assign

AssignOptions

Re-exports AssignOptions

AutoPath

Re-exports AutoPath

BaseEntity

Re-exports BaseEntity

BeforeCreate

Re-exports BeforeCreate

BeforeDelete

Re-exports BeforeDelete

BeforeUpdate

Re-exports BeforeUpdate

BeforeUpsert

Re-exports BeforeUpsert

BigIntType

Re-exports BigIntType

BlobType

Re-exports BlobType

BooleanType

Re-exports BooleanType

CacheAdapter

Re-exports CacheAdapter

Cascade

Re-exports Cascade

Cast

Re-exports Cast

ChangeSet

Re-exports ChangeSet

ChangeSetComputer

Re-exports ChangeSetComputer

ChangeSetPersister

Re-exports ChangeSetPersister

ChangeSetType

Re-exports ChangeSetType

CharacterType

Re-exports CharacterType

Check

Re-exports Check

CheckCallback

Re-exports CheckCallback

CheckConstraintViolationException

Re-exports CheckConstraintViolationException

CheckOptions

Re-exports CheckOptions

ClearDatabaseOptions

Re-exports ClearDatabaseOptions

Collection

Re-exports Collection

compareArrays

Re-exports compareArrays

compareBooleans

Re-exports compareBooleans

compareBuffers

Re-exports compareBuffers

compareObjects

Re-exports compareObjects

Config

Re-exports Config

Configuration

Re-exports Configuration

Connection

Re-exports Connection

ConnectionConfig

Re-exports ConnectionConfig

ConnectionException

Re-exports ConnectionException

ConnectionOptions

Re-exports ConnectionOptions

ConnectionType

Re-exports ConnectionType

ConstraintViolationException

Re-exports ConstraintViolationException

Constructor

Re-exports Constructor

CountOptions

Re-exports CountOptions

CreateContextOptions

Re-exports CreateContextOptions

CreateOptions

Re-exports CreateOptions

CreateRequestContext

Re-exports CreateRequestContext

CreateSchemaOptions

Re-exports CreateSchemaOptions

createSqlFunction

Re-exports createSqlFunction

Cursor

Re-exports Cursor

CursorError

Re-exports CursorError

DatabaseDriver

Re-exports DatabaseDriver

DatabaseObjectExistsException

Re-exports DatabaseObjectExistsException

DatabaseObjectNotFoundException

Re-exports DatabaseObjectNotFoundException

DataloaderType

Re-exports DataloaderType

DataloaderUtils

Re-exports DataloaderUtils

DateTimeType

Re-exports DateTimeType

DateType

Re-exports DateType

DeadlockException

Re-exports DeadlockException

DecimalType

Re-exports DecimalType

DeepPartial

Re-exports DeepPartial

DefaultLogger

Re-exports DefaultLogger

DeferMode

Re-exports DeferMode

defineConfig

Re-exports defineConfig

DefineConfig

Re-exports DefineConfig

DeleteOptions

Re-exports DeleteOptions

Dictionary

Re-exports Dictionary

DoubleType

Re-exports DoubleType

DriverException

Re-exports DriverException

DriverMethodOptions

Re-exports DriverMethodOptions

DropSchemaOptions

Re-exports DropSchemaOptions

DynamicPassword

Re-exports DynamicPassword

EagerProps

Re-exports EagerProps

Edge

Re-exports Edge

Embeddable

Re-exports Embeddable

EmbeddableOptions

Re-exports EmbeddableOptions

Embedded

Re-exports Embedded

EmbeddedOptions

Re-exports EmbeddedOptions

EmbeddedPrefixMode

Re-exports EmbeddedPrefixMode

EnsureDatabaseOptions

Re-exports EnsureDatabaseOptions

EnsureRequestContext

Re-exports EnsureRequestContext

Entity

Re-exports Entity

EntityAssigner

Re-exports EntityAssigner

EntityCaseNamingStrategy

Re-exports EntityCaseNamingStrategy

EntityClass

Re-exports EntityClass

EntityClassGroup

Re-exports EntityClassGroup

EntityComparator

Re-exports EntityComparator

EntityData

Re-exports EntityData

EntityDictionary

Re-exports EntityDictionary

EntityDTO

Re-exports EntityDTO

EntityFactory

Re-exports EntityFactory

EntityField

Re-exports EntityField

EntityKey

Re-exports EntityKey

EntityLoader

Re-exports EntityLoader

EntityLoaderOptions

Re-exports EntityLoaderOptions

EntityManagerType

Re-exports EntityManagerType

EntityMetadata

Re-exports EntityMetadata

EntityName

Re-exports EntityName

EntityOptions

Re-exports EntityOptions

EntityProperty

Re-exports EntityProperty

EntityProps

Re-exports EntityProps

EntityRef

Re-exports EntityRef

EntityRepositoryType

Re-exports EntityRepositoryType

EntitySchema

Re-exports EntitySchema

EntitySchemaMetadata

Re-exports EntitySchemaMetadata

EntitySchemaProperty

Re-exports EntitySchemaProperty

EntitySerializer

Re-exports EntitySerializer

EntityTransformer

Re-exports EntityTransformer

EntityType

Re-exports EntityType

EntityValidator

Re-exports EntityValidator

EntityValue

Re-exports EntityValue

Enum

Re-exports Enum

EnumArrayType

Re-exports EnumArrayType

EnumOptions

Re-exports EnumOptions

EnumType

Re-exports EnumType

equals

Re-exports equals

EventArgs

Re-exports EventArgs

EventManager

Re-exports EventManager

EventSubscriber

Re-exports EventSubscriber

EventType

Re-exports EventType

EventTypeMap

Re-exports EventTypeMap

ExceptionConverter

Re-exports ExceptionConverter

ExpandHint

Re-exports ExpandHint

ExpandProperty

Re-exports ExpandProperty

ExpandQuery

Re-exports ExpandQuery

ExpandScalar

Re-exports ExpandScalar

FactoryOptions

Re-exports FactoryOptions

FileCacheAdapter

Re-exports FileCacheAdapter

Filter

Re-exports Filter

FilterItemValue

Re-exports FilterItemValue

FilterKey

Re-exports FilterKey

FilterObject

Re-exports FilterObject

FilterOptions

Re-exports FilterOptions

FilterQuery

Re-exports FilterQuery

FilterValue

Re-exports FilterValue

FindAllOptions

Re-exports FindAllOptions

FindByCursorOptions

Re-exports FindByCursorOptions

FindOneOptions

Re-exports FindOneOptions

FindOneOrFailOptions

Re-exports FindOneOrFailOptions

FindOptions

Re-exports FindOptions

FlatQueryOrderMap

Re-exports FlatQueryOrderMap

FloatType

Re-exports FloatType

FlushEventArgs

Re-exports FlushEventArgs

FlushMode

Re-exports FlushMode

ForeignKeyConstraintViolationException

Re-exports ForeignKeyConstraintViolationException

ForkOptions

Re-exports ForkOptions

Formula

Re-exports Formula

FormulaOptions

Re-exports FormulaOptions

FromEntityType

Re-exports FromEntityType

GeneratedCacheAdapter

Re-exports GeneratedCacheAdapter

GenerateOptions

Re-exports GenerateOptions

GetReferenceOptions

Re-exports GetReferenceOptions

GetRepository

Re-exports GetRepository

GroupOperator

Re-exports GroupOperator

Hidden

Re-exports Hidden

HiddenProps

Re-exports HiddenProps

Highlighter

Re-exports Highlighter

Hydrator

Re-exports Hydrator

IConfiguration

Re-exports IConfiguration

IDatabaseDriver

Re-exports IDatabaseDriver

IdentityMap

Re-exports IdentityMap

IEntityGenerator

Re-exports IEntityGenerator

IMigrationGenerator

Re-exports IMigrationGenerator

IMigrator

Re-exports IMigrator

ImportsResolver

Re-exports ImportsResolver

Index

Re-exports Index

IndexOptions

Re-exports IndexOptions

InitCollectionOptions

Re-exports InitCollectionOptions

IntegerType

Re-exports IntegerType

IntervalType

Re-exports IntervalType

InvalidFieldNameException

Re-exports InvalidFieldNameException

IPrimaryKey

Re-exports IPrimaryKey

ISchemaGenerator

Re-exports ISchemaGenerator

ISeedManager

Re-exports ISeedManager

IsolationLevel

Re-exports IsolationLevel

IsSubset

Re-exports IsSubset

IsUnknown

Re-exports IsUnknown

IType

Re-exports IType

IWrappedEntity

Re-exports IWrappedEntity

JSON_KEY_OPERATORS

Re-exports JSON_KEY_OPERATORS

JsonProperty

Re-exports JsonProperty

JsonType

Re-exports JsonType

LoadCountOptions

Re-exports LoadCountOptions

Loaded

Re-exports Loaded

LoadedCollection

Re-exports LoadedCollection

LoadedReference

Re-exports LoadedReference

LoadHint

Re-exports LoadHint

LoadReferenceOptions

Re-exports LoadReferenceOptions

LoadReferenceOrFailOptions

Re-exports LoadReferenceOrFailOptions

LoadStrategy

Re-exports LoadStrategy

LockMode

Re-exports LockMode

LockOptions

Re-exports LockOptions

LockWaitTimeoutException

Re-exports LockWaitTimeoutException

LogContext

Re-exports LogContext

Logger

Re-exports Logger

LoggerNamespace

Re-exports LoggerNamespace

LoggerOptions

Re-exports LoggerOptions

LoggingOptions

Re-exports LoggingOptions

ManyToMany

Re-exports ManyToMany

ManyToManyOptions

Re-exports ManyToManyOptions

ManyToOne

Re-exports ManyToOne

ManyToOneOptions

Re-exports ManyToOneOptions

MatchingOptions

Re-exports MatchingOptions

MaybePromise

Re-exports MaybePromise

MediumIntType

Re-exports MediumIntType

MemoryCacheAdapter

Re-exports MemoryCacheAdapter

MergeLoaded

Re-exports MergeLoaded

MergeOptions

Re-exports MergeOptions

MergeSelected

Re-exports MergeSelected

MetadataDiscovery

Re-exports MetadataDiscovery

MetadataDiscoveryOptions

Re-exports MetadataDiscoveryOptions

MetadataError

Re-exports MetadataError

MetadataProcessor

Re-exports MetadataProcessor

MetadataProvider

Re-exports MetadataProvider

MetadataStorage

Re-exports MetadataStorage

MigrateOptions

Re-exports MigrateOptions

MigrationDiff

Re-exports MigrationDiff

MigrationObject

Re-exports MigrationObject

MigrationResult

Re-exports MigrationResult

MigrationRow

Re-exports MigrationRow

MigrationsOptions

Re-exports MigrationsOptions

MigratorEvent

Re-exports MigratorEvent

MikroORM

Re-exports MikroORM

MikroORMOptions

Re-exports MikroORMOptions

MongoNamingStrategy

Re-exports MongoNamingStrategy

NamingStrategy

Re-exports NamingStrategy

NativeDeleteOptions

Re-exports NativeDeleteOptions

NativeInsertUpdateManyOptions

Re-exports NativeInsertUpdateManyOptions

NativeInsertUpdateOptions

Re-exports NativeInsertUpdateOptions

New

Re-exports New

Node

Re-exports Node

NodeState

Re-exports NodeState

NoInfer

Re-exports NoInfer

NonUniqueFieldNameException

Re-exports NonUniqueFieldNameException

NotFoundError

Re-exports NotFoundError

NotNullConstraintViolationException

Re-exports NotNullConstraintViolationException

NullCacheAdapter

Re-exports NullCacheAdapter

NullHighlighter

Re-exports NullHighlighter

ObjectBindingPattern

Re-exports ObjectBindingPattern

ObjectHydrator

Re-exports ObjectHydrator

ObjectQuery

Re-exports ObjectQuery

OneToMany

Re-exports OneToMany

OneToManyOptions

Re-exports OneToManyOptions

OneToOne

Re-exports OneToOne

OneToOneOptions

Re-exports OneToOneOptions

OnInit

Re-exports OnInit

OnLoad

Re-exports OnLoad

Opt

Re-exports Opt

OptimisticLockError

Re-exports OptimisticLockError

OptionalProps

Re-exports OptionalProps

Options

Re-exports Options

OrderDefinition

Re-exports OrderDefinition

parseJsonSafe

Re-exports parseJsonSafe

PlainObject

Re-exports PlainObject

Platform

Re-exports Platform

PoolConfig

Re-exports PoolConfig

Populate

Re-exports Populate

PopulateHint

Re-exports PopulateHint

PopulateOptions

Re-exports PopulateOptions

PopulatePath

Re-exports PopulatePath

Primary

Re-exports Primary

PrimaryKey

Re-exports PrimaryKey

PrimaryKeyOptions

Re-exports PrimaryKeyOptions

PrimaryKeyProp

Re-exports PrimaryKeyProp

PrimaryProperty

Re-exports PrimaryProperty

Property

Re-exports Property

PropertyOptions

Re-exports PropertyOptions

QBFilterQuery

Re-exports QBFilterQuery

QBQueryOrderMap

Re-exports QBQueryOrderMap

QueryFlag

Re-exports QueryFlag

QueryHelper

Re-exports QueryHelper

QueryOperator

Re-exports QueryOperator

QueryOrder

Re-exports QueryOrder

QueryOrderKeys

Re-exports QueryOrderKeys

QueryOrderKeysFlat

Re-exports QueryOrderKeysFlat

QueryOrderMap

Re-exports QueryOrderMap

QueryOrderNumeric

Re-exports QueryOrderNumeric

QueryResult

Re-exports QueryResult

raw

Re-exports raw

RawQueryFragment

Re-exports RawQueryFragment

ReadOnlyException

Re-exports ReadOnlyException

ref

Re-exports ref

Ref

Re-exports Ref

Reference

Re-exports Reference

ReferenceKind

Re-exports ReferenceKind

ReferenceOptions

Re-exports ReferenceOptions

ReflectMetadataProvider

Re-exports ReflectMetadataProvider

RefreshDatabaseOptions

Re-exports RefreshDatabaseOptions

RegisterOptions

Re-exports RegisterOptions

rel

Re-exports rel

Rel

Re-exports Rel

RequestContext

Re-exports RequestContext

RequiredEntityData

Re-exports RequiredEntityData

Scalar

Re-exports Scalar

SCALAR_TYPES

Re-exports SCALAR_TYPES

ScalarRef

Re-exports ScalarRef

ScalarReference

Re-exports ScalarReference

SchemaGenerator

Renames and re-exports SqlSchemaGenerator

SeederOptions

Re-exports SeederOptions

Selected

Re-exports Selected

SerializationContext

Re-exports SerializationContext

serialize

Re-exports serialize

SerializedPrimaryKey

Re-exports SerializedPrimaryKey

SerializedPrimaryKeyOptions

Re-exports SerializedPrimaryKeyOptions

SerializeOptions

Re-exports SerializeOptions

ServerException

Re-exports ServerException

Settings

Re-exports Settings

SimpleColumnMeta

Re-exports SimpleColumnMeta

SimpleLogger

Re-exports SimpleLogger

SmallIntType

Re-exports SmallIntType

sql

Re-exports sql

SqlEntityManager

Renames and re-exports EntityManager

SqlEntityRepository

Renames and re-exports EntityRepository

StringType

Re-exports StringType

SyncCacheAdapter

Re-exports SyncCacheAdapter

SyntaxErrorException

Re-exports SyntaxErrorException

t

Re-exports t

TableExistsException

Re-exports TableExistsException

TableNotFoundException

Re-exports TableNotFoundException

TextType

Re-exports TextType

TimeType

Re-exports TimeType

TinyIntType

Re-exports TinyIntType

Transaction

Re-exports Transaction

Transactional

Re-exports Transactional

TransactionContext

Re-exports TransactionContext

TransactionEventArgs

Re-exports TransactionEventArgs

TransactionEventBroadcaster

Re-exports TransactionEventBroadcaster

TransactionEventType

Re-exports TransactionEventType

TransactionOptions

Re-exports TransactionOptions

TransformContext

Re-exports TransformContext

Type

Re-exports Type

TypeConfig

Re-exports TypeConfig

types

Re-exports types

Uint8ArrayType

Re-exports Uint8ArrayType

UmzugMigration

Re-exports UmzugMigration

UnboxArray

Re-exports UnboxArray

UnderscoreNamingStrategy

Re-exports UnderscoreNamingStrategy

Unique

Re-exports Unique

UniqueConstraintViolationException

Re-exports UniqueConstraintViolationException

UniqueOptions

Re-exports UniqueOptions

UnitOfWork

Re-exports UnitOfWork

UnknownType

Re-exports UnknownType

UpdateOptions

Re-exports UpdateOptions

UpdateSchemaOptions

Re-exports UpdateSchemaOptions

UpsertManyOptions

Re-exports UpsertManyOptions

UpsertOptions

Re-exports UpsertOptions

Utils

Re-exports Utils

UuidType

Re-exports UuidType

ValidationError

Re-exports ValidationError

wrap

Re-exports wrap

WrappedEntity

Re-exports WrappedEntity

Type Aliases

Field

Field<T>: AnyString | keyof T | RawQueryFragment | KnexStringRef | Knex.QueryBuilder

Type parameters

  • T

KnexStringRef

KnexStringRef: Knex.Ref<string, {}>

ModifyContext

ModifyContext<Entity, Context, Field, Alias, Select>: Compute<IsNever<Context> extends true ? AddToContext<GetType<Entity, object, Field>, object, Field, Alias, Select> : Context & AddToContext<GetType<Entity, Context, Field>, Context, Field, Alias, Select>>

Type parameters

  • Entity: object
  • Context
  • Field: string
  • Alias: string
  • Select: boolean = false

ModifyHint

ModifyHint<RootAlias, Context, Hint, Field, Select>: Hint | AddToHint<RootAlias, Context, Field, Select>

Type parameters

  • RootAlias
  • Context
  • Hint: string
  • Field: string
  • Select: boolean = false

MySqlIncrementOptions

MySqlIncrementOptions: { primaryKey?: boolean; type?: Column[type]; unsigned?: boolean }

Type declaration

  • optionalprimaryKey?: boolean
  • optionaltype?: Column[type]
  • optionalunsigned?: boolean

QBField

QBField<Entity, RootAlias, Context>: ((EntityRelations<Entity> | `${RootAlias}.${EntityRelations<Entity>}` | AddAliasesFromContext<Context>) & {}) | AnyString

Type parameters

  • Entity
  • RootAlias: string
  • Context

QBField2

QBField2<Entity, RootAlias, Context>: ((EntityKey<Entity> | `${RootAlias}.${EntityKey<Entity>}` | AddAliasesFromContext<Context>) & {}) | AnyString

Type parameters

  • Entity
  • RootAlias: string
  • Context

Variables

constMonkeyPatchable

MonkeyPatchable: { BetterSqlite3Dialect: any; Client: any; MsSqlColumnCompiler: any; MsSqlDialect: any; MsSqlQueryCompiler: any; MsSqlTableCompiler: any; MySqlColumnCompiler: any; MySqlDialect: any; MySqlQueryCompiler: any; PostgresDialect: any; PostgresDialectTableCompiler: any; PostgresQueryCompiler: any; QueryExecutioner: any; Sqlite3Dialect: any; Sqlite3DialectTableCompiler: any; TableCompiler: any } = ...

Type declaration

  • BetterSqlite3Dialect: any
  • Client: any
  • MsSqlColumnCompiler: any
  • MsSqlDialect: any
  • MsSqlQueryCompiler: any
  • MsSqlTableCompiler: any
  • MySqlColumnCompiler: any
  • MySqlDialect: any
  • MySqlQueryCompiler: any
  • PostgresDialect: any
  • PostgresDialectTableCompiler: any
  • PostgresQueryCompiler: any
  • QueryExecutioner: any
  • Sqlite3Dialect: any
  • Sqlite3DialectTableCompiler: any
  • TableCompiler: any
Page Options