Skip to main content

Version: Next

MySqlTableBuilder

Hierarchy

TableBuilder
- MySqlTableBuilder

Methods

bigIncrements

bigIncrements(columnName?: string, options?: MySqlIncrementOptions): ColumnBuilder

Overrides Knex.TableBuilder.bigIncrements
Parameters
- optionalcolumnName: string
- optionaloptions: MySqlIncrementOptions
Returns ColumnBuilder

inheritedbigint

bigint(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.bigint
Parameters
- columnName: string
Returns ColumnBuilder

inheritedbigInteger

bigInteger(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.bigInteger
Parameters
- columnName: string
Returns ColumnBuilder

inheritedbinary

binary(columnName: string, length?: number): ColumnBuilder

Inherited from Knex.TableBuilder.binary
Parameters
- columnName: string
- optionallength: number
Returns ColumnBuilder

inheritedboolean

boolean(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.boolean
Parameters
- columnName: string
Returns ColumnBuilder

inheritedcheck

check(checkPredicate: string, bindings?: Record<string, any>, constraintName?: string): TableBuilder

Inherited from Knex.TableBuilder.check
Parameters
- checkPredicate: string
- optionalbindings: Record<string, any>
- optionalconstraintName: string
Returns TableBuilder

inheritedcomment

comment(val: string): void

Inherited from Knex.TableBuilder.comment
Parameters
- val: string
Returns void

inheriteddate

date(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.date
Parameters
- columnName: string
Returns ColumnBuilder

inheriteddatetime

datetime(columnName: string, options?: Readonly<{ precision?: number; useTz?: boolean }>): ColumnBuilder

Inherited from Knex.TableBuilder.datetime
Parameters
- columnName: string
- optionaloptions: Readonly<{ precision?: number; useTz?: boolean }>
Returns ColumnBuilder

inheriteddateTime

dateTime(columnName: string, options?: Readonly<{ precision?: number; useTz?: boolean }>): ColumnBuilder

Inherited from Knex.TableBuilder.dateTime
Parameters
- columnName: string
- optionaloptions: Readonly<{ precision?: number; useTz?: boolean }>
Returns ColumnBuilder

inheriteddecimal

decimal(columnName: string, precision?: null | number, scale?: number): ColumnBuilder

Inherited from Knex.TableBuilder.decimal
Parameters
- columnName: string
- optionalprecision: null | number
- optionalscale: number
Returns ColumnBuilder

inheriteddouble

double(columnName: string, precision?: number, scale?: number): ColumnBuilder

Inherited from Knex.TableBuilder.double
Parameters
- columnName: string
- optionalprecision: number
- optionalscale: number
Returns ColumnBuilder

inheriteddropChecks

dropChecks(checkConstraintNames: string | string[]): TableBuilder

Inherited from Knex.TableBuilder.dropChecks
Parameters
- checkConstraintNames: string | string[]
Returns TableBuilder

inheriteddropColumn

dropColumn(columnName: string): TableBuilder

Inherited from Knex.TableBuilder.dropColumn
Parameters
- columnName: string
Returns TableBuilder

inheriteddropColumns

dropColumns(...columnNames: string[]): TableBuilder

Inherited from Knex.TableBuilder.dropColumns
Parameters
- rest...columnNames: string[]
Returns TableBuilder

inheriteddropForeign

dropForeign(columnNames: string | readonly string[], foreignKeyName?: string): TableBuilder

Inherited from Knex.TableBuilder.dropForeign
Parameters
- columnNames: string | readonly string[]
- optionalforeignKeyName: string
Returns TableBuilder

inheriteddropIndex

dropIndex(columnNames: string | readonly (string | Raw<any>)[], indexName?: string): TableBuilder

Inherited from Knex.TableBuilder.dropIndex
Parameters
- columnNames: string | readonly (string | Raw<any>)[]
- optionalindexName: string
Returns TableBuilder

inheriteddropNullable

dropNullable(column: string): TableBuilder

Inherited from Knex.TableBuilder.dropNullable
Parameters
- column: string
Returns TableBuilder

inheriteddropPrimary

dropPrimary(constraintName?: string): TableBuilder

Inherited from Knex.TableBuilder.dropPrimary
Parameters
- optionalconstraintName: string
Returns TableBuilder

inheriteddropTimestamps

dropTimestamps(useCamelCase?: boolean): TableBuilder

Inherited from Knex.TableBuilder.dropTimestamps
Parameters
- optionaluseCamelCase: boolean
Returns TableBuilder

inheriteddropUnique

dropUnique(columnNames: readonly (string | Raw<any>)[], indexName?: string): TableBuilder

Inherited from Knex.TableBuilder.dropUnique
Parameters
- columnNames: readonly (string | Raw<any>)[]
- optionalindexName: string
Returns TableBuilder

inheritedenu

enu(columnName: string, values: null | readonly Value[], options?: EnumOptions): ColumnBuilder

Inherited from Knex.TableBuilder.enu
Parameters
- columnName: string
- values: null | readonly Value[]
- optionaloptions: EnumOptions
Returns ColumnBuilder

inheritedenum

enum(columnName: string, values: null | readonly Value[], options?: EnumOptions): ColumnBuilder

Inherited from Knex.TableBuilder.enum
Parameters
- columnName: string
- values: null | readonly Value[]
- optionaloptions: EnumOptions
Returns ColumnBuilder

inheritedfloat

float(columnName: string, precision?: number, scale?: number): ColumnBuilder

Inherited from Knex.TableBuilder.float
Parameters
- columnName: string
- optionalprecision: number
- optionalscale: number
Returns ColumnBuilder

inheritedforeign

foreign(column: string, foreignKeyName?: string): ForeignConstraintBuilder
foreign(columns: readonly string[], foreignKeyName?: string): MultikeyForeignConstraintBuilder

Inherited from Knex.TableBuilder.foreign
Parameters
- column: string
- optionalforeignKeyName: string
Returns ForeignConstraintBuilder

inheritedgeography

geography(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.geography
Parameters
- columnName: string
Returns ColumnBuilder

inheritedgeometry

geometry(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.geometry
Parameters
- columnName: string
Returns ColumnBuilder

increments

increments(columnName?: string, options?: MySqlIncrementOptions): ColumnBuilder

Overrides Knex.TableBuilder.increments
Parameters
- optionalcolumnName: string
- optionaloptions: MySqlIncrementOptions
Returns ColumnBuilder

inheritedindex

index(columnNames: string | readonly (string | Raw<any>)[], indexName?: string, indexType?: string): TableBuilder
index(columnNames: string | readonly (string | Raw<any>)[], indexName?: string, options?: Readonly<{ indexType?: string; predicate?: QueryBuilder<any, any>; storageEngineIndexType?: storageEngineIndexType }>): TableBuilder

Inherited from Knex.TableBuilder.index
Parameters
- columnNames: string | readonly (string | Raw<any>)[]
- optionalindexName: string
- optionalindexType: string
Returns TableBuilder

inheritedinteger

integer(columnName: string, length?: number): ColumnBuilder

Inherited from Knex.TableBuilder.integer
Parameters
- columnName: string
- optionallength: number
Returns ColumnBuilder

inheritedjson

json(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.json
Parameters
- columnName: string
Returns ColumnBuilder

inheritedjsonb

jsonb(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.jsonb
Parameters
- columnName: string
Returns ColumnBuilder

inheritedmediumint

mediumint(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.mediumint
Parameters
- columnName: string
Returns ColumnBuilder

inheritedpoint

point(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.point
Parameters
- columnName: string
Returns ColumnBuilder

inheritedprimary

primary(columnNames: readonly string[], options?: Readonly<{ constraintName?: string; deferrable?: deferrableType }>): TableBuilder
primary(columnNames: readonly string[], constraintName?: string): TableBuilder

Inherited from Knex.TableBuilder.primary
Parameters
- columnNames: readonly string[]
- optionaloptions: Readonly<{ constraintName?: string; deferrable?: deferrableType }>
Returns TableBuilder

inheritedqueryContext

queryContext(context: any): TableBuilder

Inherited from Knex.TableBuilder.queryContext
Parameters
- context: any
Returns TableBuilder

inheritedrenameColumn

renameColumn(from: string, to: string): TableBuilder

Inherited from Knex.TableBuilder.renameColumn
Parameters
- from: string
- to: string
Returns TableBuilder

inheritedsetNullable

setNullable(column: string): TableBuilder

Inherited from Knex.TableBuilder.setNullable
Parameters
- column: string
Returns TableBuilder

inheritedsmallint

smallint(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.smallint
Parameters
- columnName: string
Returns ColumnBuilder

inheritedspecificType

specificType(columnName: string, type: string): ColumnBuilder

Inherited from Knex.TableBuilder.specificType
Parameters
- columnName: string
- type: string
Returns ColumnBuilder

inheritedstring

string(columnName: string, length?: number): ColumnBuilder

Inherited from Knex.TableBuilder.string
Parameters
- columnName: string
- optionallength: number
Returns ColumnBuilder

inheritedtext

text(columnName: string, textType?: string): ColumnBuilder

Inherited from Knex.TableBuilder.text
Parameters
- columnName: string
- optionaltextType: string
Returns ColumnBuilder

inheritedtime

time(columnName: string): ColumnBuilder

Inherited from Knex.TableBuilder.time
Parameters
- columnName: string
Returns ColumnBuilder

inheritedtimestamp

timestamp(columnName: string, options?: Readonly<{ precision?: number; useTz?: boolean }>): ColumnBuilder
timestamp(columnName: string, withoutTz?: boolean, precision?: number): ColumnBuilder

Inherited from Knex.TableBuilder.timestamp
Parameters
- columnName: string
- optionaloptions: Readonly<{ precision?: number; useTz?: boolean }>
Returns ColumnBuilder

inheritedtimestamps

timestamps(useTimestamps?: boolean, defaultToNow?: boolean, useCamelCase?: boolean): ColumnBuilder
timestamps(options?: Readonly<{ defaultToNow?: boolean; useCamelCase?: boolean; useTimestamps?: boolean }>): void

Inherited from Knex.TableBuilder.timestamps
Parameters
- optionaluseTimestamps: boolean
- optionaldefaultToNow: boolean
- optionaluseCamelCase: boolean
Returns ColumnBuilder

inheritedtinyint

tinyint(columnName: string, length?: number): ColumnBuilder

Inherited from Knex.TableBuilder.tinyint
Parameters
- columnName: string
- optionallength: number
Returns ColumnBuilder

inheritedunique

unique(columnNames: string | readonly (string | Raw<any>)[], options?: Readonly<{ deferrable?: deferrableType; indexName?: string; predicate?: QueryBuilder<any, any>; storageEngineIndexType?: string; useConstraint?: boolean }>): TableBuilder
unique(columnNames: string | readonly (string | Raw<any>)[], indexName?: string): TableBuilder

Inherited from Knex.TableBuilder.unique
Parameters
- columnNames: string | readonly (string | Raw<any>)[]
- optionaloptions: Readonly<{ deferrable?: deferrableType; indexName?: string; predicate?: QueryBuilder<any, any>; storageEngineIndexType?: string; useConstraint?: boolean }>
Returns TableBuilder

inheriteduuid

uuid(columnName: string, options?: Readonly<{ primaryKey?: boolean; useBinaryUuid?: boolean }>): ColumnBuilder

Inherited from Knex.TableBuilder.uuid
Parameters
- columnName: string
- optionaloptions: Readonly<{ primaryKey?: boolean; useBinaryUuid?: boolean }>
Returns ColumnBuilder