Skip to main content
Version: 6.2

MongoPlatform

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

allowsComparingTuples

  • allowsComparingTuples(): boolean

  • Returns boolean

allowsMultiInsert

  • allowsMultiInsert(): boolean

  • Returns boolean

allowsUniqueBatchUpdates

  • allowsUniqueBatchUpdates(): boolean

  • Returns boolean

cloneEmbeddable

  • cloneEmbeddable<T>(data): T

  • Type parameters

    • T

    Parameters

    • data: T

    Returns T

convertDateToJSValue

  • convertDateToJSValue(value): string

  • Parameters

    • value: string | Date

    Returns string

convertIntervalToDatabaseValue

  • convertIntervalToDatabaseValue(value): unknown

  • Parameters

    • value: unknown

    Returns unknown

convertIntervalToJSValue

  • convertIntervalToJSValue(value): unknown

  • Parameters

    • value: string

    Returns unknown

convertJsonToDatabaseValue

  • convertJsonToDatabaseValue(value): unknown

  • Parameters

    • value: unknown

    Returns unknown

convertJsonToJSValue

  • convertJsonToJSValue(value): unknown

  • Parameters

    • value: unknown

    Returns unknown

convertsJsonAutomatically

  • convertsJsonAutomatically(): boolean

  • Returns boolean

denormalizePrimaryKey

  • denormalizePrimaryKey(data): IPrimaryKeyValue

  • Converts scalar primary key representation to native driver wrapper (e.g. string to mongodb's ObjectId)

    Parameters

    • data: string | number

    Returns IPrimaryKeyValue

extractSimpleType

  • extractSimpleType(type): string

  • Parameters

    • type: string

    Returns string

formatQuery

  • formatQuery(sql, params): string

  • Parameters

    • sql: string
    • params: readonly any[]

    Returns string

generateCustomOrder

  • generateCustomOrder(escapedColumn, values): void

  • Generates a custom order by statement given a set of in order values, eg. ORDER BY (CASE WHEN priority = 'low' THEN 1 WHEN priority = 'medium' THEN 2 ELSE NULL END)

    Parameters

    • escapedColumn: string
    • values: unknown[]

    Returns void

getArrayDeclarationSQL

  • getArrayDeclarationSQL(): string

  • Returns string

getBigIntTypeDeclarationSQL

  • getBigIntTypeDeclarationSQL(column): string

  • Parameters

    • column: { autoincrement?: boolean; length?: number; unsigned?: boolean }
      • optionalautoincrement: boolean
      • optionallength: number
      • optionalunsigned: boolean

    Returns string

getBlobDeclarationSQL

  • getBlobDeclarationSQL(): string

  • Returns string

getBooleanTypeDeclarationSQL

  • getBooleanTypeDeclarationSQL(): string

  • Returns string

getConfig

getCurrentTimestampSQL

  • getCurrentTimestampSQL(length): string

  • Returns the SQL specific for the platform to get the current timestamp

    Parameters

    • optionallength: number

    Returns string

getDateTimeTypeDeclarationSQL

  • getDateTimeTypeDeclarationSQL(column): string

  • Parameters

    • column: { length?: number }
      • optionallength: number

    Returns string

getDateTypeDeclarationSQL

  • getDateTypeDeclarationSQL(length): string

  • Parameters

    • optionallength: number

    Returns string

getDecimalTypeDeclarationSQL

  • getDecimalTypeDeclarationSQL(column): string

  • Parameters

    • column: { precision?: number; scale?: number }
      • optionalprecision: number
      • optionalscale: number

    Returns string

getDefaultCharset

  • getDefaultCharset(): string

  • Returns string

getDefaultDateTimeLength

  • getDefaultDateTimeLength(): number

  • Returns number

getDefaultMappedType

  • getDefaultMappedType(type): Type<unknown, unknown>

  • Parameters

    • type: string

    Returns Type<unknown, unknown>

getDefaultPrimaryName

  • getDefaultPrimaryName(tableName, columns): string

  • Parameters

    • tableName: string
    • columns: string[]

    Returns string

getDefaultSchemaName

  • getDefaultSchemaName(): undefined | string

  • Returns undefined | string

getDefaultVersionLength

  • getDefaultVersionLength(): number

  • Returns number

getDoubleDeclarationSQL

  • getDoubleDeclarationSQL(): string

  • Returns string

getEnumTypeDeclarationSQL

  • getEnumTypeDeclarationSQL(column): string

  • Parameters

    • column: { autoincrement?: boolean; fieldNames: string[]; items?: unknown[]; length?: number; unsigned?: boolean }
      • optionalautoincrement: boolean
      • fieldNames: string[]
      • optionalitems: unknown[]
      • optionallength: number
      • optionalunsigned: boolean

    Returns string

getExceptionConverter

getFloatDeclarationSQL

  • getFloatDeclarationSQL(): string

  • Returns string

getFullTextIndexExpression

  • getFullTextIndexExpression(indexName, schemaName, tableName, columns): string

  • Parameters

    • indexName: string
    • schemaName: undefined | string
    • tableName: string
    • columns: SimpleColumnMeta[]

    Returns string

getFullTextWhereClause

  • getFullTextWhereClause(prop): string

  • Parameters

    Returns string

getIndexName

  • getIndexName(tableName, columns, type): string

  • Returns the default name of index for the given columns

    Parameters

    • tableName: string
    • columns: string[]
    • type: primary | index | unique | foreign | sequence

    Returns string

getIntegerTypeDeclarationSQL

  • getIntegerTypeDeclarationSQL(column): string

  • Parameters

    • column: { autoincrement?: boolean; length?: number; unsigned?: boolean }
      • optionalautoincrement: boolean
      • optionallength: number
      • optionalunsigned: boolean

    Returns string

getIntervalTypeDeclarationSQL

  • getIntervalTypeDeclarationSQL(column): string

  • Parameters

    • column: { length?: number }
      • optionallength: number

    Returns string

getJsonDeclarationSQL

  • getJsonDeclarationSQL(): string

  • Returns string

getJsonIndexDefinition

  • getJsonIndexDefinition(index): string[]

  • Parameters

    • index: { columnNames: string[] }
      • columnNames: string[]

    Returns string[]

getMappedType

  • getMappedType(type): Type<unknown, unknown>

  • Parameters

    • type: string

    Returns Type<unknown, unknown>

getMediumIntTypeDeclarationSQL

  • getMediumIntTypeDeclarationSQL(column): string

  • Parameters

    • column: { autoincrement?: boolean; length?: number; unsigned?: boolean }
      • optionalautoincrement: boolean
      • optionallength: number
      • optionalunsigned: boolean

    Returns string

getNamingStrategy

getRegExpOperator

  • getRegExpOperator(val, flags): string

  • Parameters

    • optionalval: unknown
    • optionalflags: string

    Returns string

getRegExpValue

  • getRegExpValue(val): { $flags?: string; $re: string }

  • Parameters

    • val: RegExp

    Returns { $flags?: string; $re: string }

    • optional$flags?: string
    • $re: string

getRepositoryClass

getSchemaGenerator

getSchemaHelper

  • getSchemaHelper(): unknown

  • Returns unknown

getSearchJsonPropertyKey

  • getSearchJsonPropertyKey(path, type, aliased, value): string

  • Parameters

    • path: string[]
    • type: string
    • aliased: boolean
    • optionalvalue: unknown

    Returns string

getSearchJsonPropertySQL

  • getSearchJsonPropertySQL(path, type, aliased): string

  • Parameters

    • path: string
    • type: string
    • aliased: boolean

    Returns string

getSerializedPrimaryKeyField

  • getSerializedPrimaryKeyField(field): string

  • Used when serializing via toObject and toJSON methods, allows to use different PK field name (like id instead of _id)

    Parameters

    • field: string

    Returns string

getSmallIntTypeDeclarationSQL

  • getSmallIntTypeDeclarationSQL(column): string

  • Parameters

    • column: { autoincrement?: boolean; length?: number; unsigned?: boolean }
      • optionalautoincrement: boolean
      • optionallength: number
      • optionalunsigned: boolean

    Returns string

getTextTypeDeclarationSQL

  • getTextTypeDeclarationSQL(_column): string

  • Parameters

    • _column: { length?: number }
      • optionallength: number

    Returns string

getTimeTypeDeclarationSQL

  • getTimeTypeDeclarationSQL(length): string

  • Parameters

    • optionallength: number

    Returns string

getTimezone

  • getTimezone(): undefined | string

  • Returns undefined | string

getTinyIntTypeDeclarationSQL

  • getTinyIntTypeDeclarationSQL(column): string

  • Parameters

    • column: { autoincrement?: boolean; length?: number; unsigned?: boolean }
      • optionalautoincrement: boolean
      • optionallength: number
      • optionalunsigned: boolean

    Returns string

getUuidTypeDeclarationSQL

  • getUuidTypeDeclarationSQL(column): string

  • Parameters

    • column: { length?: number }
      • optionallength: number

    Returns string

getVarcharTypeDeclarationSQL

  • getVarcharTypeDeclarationSQL(column): string

  • Parameters

    • column: { length?: number }
      • optionallength: number

    Returns string

indexForeignKeys

  • indexForeignKeys(): boolean

  • Returns boolean

isAllowedTopLevelOperator

  • isAllowedTopLevelOperator(operator): boolean

  • Parameters

    • operator: string

    Returns boolean

isBigIntProperty

  • isBigIntProperty(prop): boolean

  • Parameters

    Returns boolean

isNumericColumn

  • isNumericColumn(mappedType): boolean

  • Parameters

    • mappedType: Type<unknown, unknown>

    Returns boolean

isPopulated

  • isPopulated<T>(key, populate): boolean

  • Type parameters

    • T

    Parameters

    Returns boolean

isRaw

  • isRaw(value): boolean

  • Parameters

    • value: any

    Returns boolean

lookupExtensions

  • lookupExtensions(orm): void

marshallArray

  • marshallArray(values): string

  • Parameters

    • values: string[]

    Returns string

normalizePrimaryKey

  • normalizePrimaryKey<T>(data): T

  • Normalizes primary key wrapper to scalar value (e.g. mongodb's ObjectId to string)

    Type parameters

    • T: string | number = string | number

    Parameters

    Returns T

parseDate

  • parseDate(value): Date

  • Parameters

    • value: string | number

    Returns Date

processDateProperty

  • processDateProperty(value): string | number | Date

  • Parameters

    • value: unknown

    Returns string | number | Date

quoteIdentifier

  • quoteIdentifier(id, quote): string

  • Parameters

    • id: string
    • quote: string = '`'

    Returns string

quoteValue

  • quoteValue(value): string

  • Parameters

    • value: any

    Returns string

quoteVersionValue

  • quoteVersionValue(value, prop): string | number | Date

  • Parameters

    Returns string | number | Date

setConfig

  • setConfig(config): void

shouldHaveColumn

  • shouldHaveColumn<T>(prop, populate, exclude): boolean

  • Type parameters

    • T

    Parameters

    Returns boolean

supportsCreatingFullTextIndex

  • supportsCreatingFullTextIndex(): boolean

  • Returns boolean

supportsCustomPrimaryKeyNames

  • supportsCustomPrimaryKeyNames(): boolean

  • Returns boolean

supportsDownMigrations

  • supportsDownMigrations(): boolean

  • Currently not supported due to how knex does complex sqlite diffing (always based on current schema)

    Returns boolean

supportsMultipleCascadePaths

  • supportsMultipleCascadePaths(): boolean

  • Returns boolean

supportsMultipleStatements

  • supportsMultipleStatements(): boolean

  • Returns boolean

supportsNativeEnums

  • supportsNativeEnums(): boolean

  • for postgres native enums

    Returns boolean

supportsTransactions

  • supportsTransactions(): boolean

  • Returns boolean

supportsUnsigned

  • supportsUnsigned(): boolean

  • Returns boolean

unmarshallArray

  • unmarshallArray(value): string[]

  • Parameters

    • value: string

    Returns string[]

usesBatchInserts

  • usesBatchInserts(): boolean

  • Whether or not the driver supports retuning list of created PKs back when multi-inserting

    Returns boolean

usesBatchUpdates

  • usesBatchUpdates(): boolean

  • Whether or not the driver supports updating many records at once

    Returns boolean

usesCascadeStatement

  • usesCascadeStatement(): boolean

  • Returns boolean

usesDefaultKeyword

  • usesDefaultKeyword(): boolean

  • Returns boolean

usesDifferentSerializedPrimaryKey

  • usesDifferentSerializedPrimaryKey(): boolean

  • Returns boolean

usesImplicitTransactions

  • usesImplicitTransactions(): boolean

  • Returns boolean

usesOutputStatement

  • usesOutputStatement(): boolean

  • Returns boolean

usesPivotTable

  • usesPivotTable(): boolean

  • Returns boolean

usesReturningStatement

  • usesReturningStatement(): boolean

  • Returns boolean

validateMetadata

  • validateMetadata(meta): void

  • Parameters

    Returns void

Page Options