MySqlTableBuilder

Hierarchy

• TableBuilder
  • MySqlTableBuilder

Index

Methods

• bigIncrements
• bigint
• bigInteger
• binary
• boolean
• check
• comment
• date
• datetime
• dateTime
• decimal
• double
• dropChecks
• dropColumn
• dropColumns
• dropForeign
• dropIndex
• dropNullable
• dropPrimary
• dropTimestamps
• dropUnique
• enu
• enum
• float
• foreign
• geography
• geometry
• increments
• index
• integer
• json
• jsonb
• mediumint
• point
• primary
• queryContext
• renameColumn
• setNullable
• smallint
• specificType
• string
• text
• time
• timestamp
• timestamps
• tinyint
• unique
• uuid

Methods

bigIncrements

• bigIncrements(columnName, options): ColumnBuilder

• Overrides Knex.TableBuilder.bigIncrements

  Parameters

  • optionalcolumnName: string

  • optionaloptions: MySqlIncrementOptions

  Returns ColumnBuilder

inheritedbigint

• bigint(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.bigint

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedbigInteger

• bigInteger(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.bigInteger

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedbinary

• binary(columnName, length): ColumnBuilder

• Inherited from Knex.TableBuilder.binary

  Parameters

  • columnName: string

  • optionallength: number

  Returns ColumnBuilder

inheritedboolean

• boolean(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.boolean

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedcheck

• check(checkPredicate, bindings, constraintName): TableBuilder

• Inherited from Knex.TableBuilder.check

  Parameters

  • checkPredicate: string

  • optionalbindings: Record<string, any>

  • optionalconstraintName: string

  Returns TableBuilder

inheritedcomment

• comment(val): void

• Inherited from Knex.TableBuilder.comment

  Parameters

  • val: string

  Returns void

inheriteddate

• date(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.date

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheriteddatetime

• datetime(columnName, options): ColumnBuilder

• Inherited from Knex.TableBuilder.datetime

  Parameters

  • columnName: string

  • optionaloptions: Readonly<{ precision?: number; useTz?: boolean }>

  Returns ColumnBuilder

inheriteddateTime

• dateTime(columnName, options): ColumnBuilder

• Inherited from Knex.TableBuilder.dateTime

  Parameters

  • columnName: string

  • optionaloptions: Readonly<{ precision?: number; useTz?: boolean }>

  Returns ColumnBuilder

inheriteddecimal

• decimal(columnName, precision, scale): ColumnBuilder

• Inherited from Knex.TableBuilder.decimal

  Parameters

  • columnName: string

  • optionalprecision: null | number

  • optionalscale: number

  Returns ColumnBuilder

inheriteddouble

• double(columnName, precision, scale): ColumnBuilder

• Inherited from Knex.TableBuilder.double

  Parameters

  • columnName: string

  • optionalprecision: number

  • optionalscale: number

  Returns ColumnBuilder

inheriteddropChecks

• dropChecks(checkConstraintNames): TableBuilder

• Inherited from Knex.TableBuilder.dropChecks

  Parameters

  • checkConstraintNames: string | string[]

  Returns TableBuilder

inheriteddropColumn

• dropColumn(columnName): TableBuilder

• Inherited from Knex.TableBuilder.dropColumn

  Parameters

  • columnName: string

  Returns TableBuilder

inheriteddropColumns

• dropColumns(...columnNames): TableBuilder

• Inherited from Knex.TableBuilder.dropColumns

  Parameters

  • rest...columnNames: string[]

  Returns TableBuilder

inheriteddropForeign

• dropForeign(columnNames, foreignKeyName): TableBuilder

• Inherited from Knex.TableBuilder.dropForeign

  Parameters

  • columnNames: string | readonly string[]

  • optionalforeignKeyName: string

  Returns TableBuilder

inheriteddropIndex

• dropIndex(columnNames, indexName): TableBuilder

• Inherited from Knex.TableBuilder.dropIndex

  Parameters

  • columnNames: string | readonly (string | Raw<any>)[]

  • optionalindexName: string

  Returns TableBuilder

inheriteddropNullable

• dropNullable(column): TableBuilder

• Inherited from Knex.TableBuilder.dropNullable

  Parameters

  • column: string

  Returns TableBuilder

inheriteddropPrimary

• dropPrimary(constraintName): TableBuilder

• Inherited from Knex.TableBuilder.dropPrimary

  Parameters

  • optionalconstraintName: string

  Returns TableBuilder

inheriteddropTimestamps

• dropTimestamps(useCamelCase): TableBuilder

• Inherited from Knex.TableBuilder.dropTimestamps

  Parameters

  • optionaluseCamelCase: boolean

  Returns TableBuilder

inheriteddropUnique

• dropUnique(columnNames, indexName): TableBuilder

• Inherited from Knex.TableBuilder.dropUnique

  Parameters

  • columnNames: readonly (string | Raw<any>)[]

  • optionalindexName: string

  Returns TableBuilder

inheritedenu

• enu(columnName, values, options): ColumnBuilder

• Inherited from Knex.TableBuilder.enu

  Parameters

  • columnName: string

  • values: null | readonly Value[]

  • optionaloptions: EnumOptions

  Returns ColumnBuilder

inheritedenum

• enum(columnName, values, options): ColumnBuilder

• Inherited from Knex.TableBuilder.enum

  Parameters

  • columnName: string

  • values: null | readonly Value[]

  • optionaloptions: EnumOptions

  Returns ColumnBuilder

inheritedfloat

• float(columnName, precision, scale): ColumnBuilder

• Inherited from Knex.TableBuilder.float

  Parameters

  • columnName: string

  • optionalprecision: number

  • optionalscale: number

  Returns ColumnBuilder

inheritedforeign

• foreign(column, foreignKeyName): ForeignConstraintBuilder
• foreign(columns, foreignKeyName): MultikeyForeignConstraintBuilder

• Inherited from Knex.TableBuilder.foreign

  Parameters

  • column: string

  • optionalforeignKeyName: string

  Returns ForeignConstraintBuilder

inheritedgeography

• geography(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.geography

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedgeometry

• geometry(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.geometry

  Parameters

  • columnName: string

  Returns ColumnBuilder

increments

• increments(columnName, options): ColumnBuilder

• Overrides Knex.TableBuilder.increments

  Parameters

  • optionalcolumnName: string

  • optionaloptions: MySqlIncrementOptions

  Returns ColumnBuilder

inheritedindex

• index(columnNames, indexName, indexType): TableBuilder
• index(columnNames, indexName, options): TableBuilder

• Inherited from Knex.TableBuilder.index

  Parameters

  • columnNames: string | readonly (string | Raw<any>)[]

  • optionalindexName: string

  • optionalindexType: string

  Returns TableBuilder

inheritedinteger

• integer(columnName, length): ColumnBuilder

• Inherited from Knex.TableBuilder.integer

  Parameters

  • columnName: string

  • optionallength: number

  Returns ColumnBuilder

inheritedjson

• json(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.json

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedjsonb

• jsonb(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.jsonb

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedmediumint

• mediumint(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.mediumint

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedpoint

• point(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.point

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedprimary

• primary(columnNames, options): TableBuilder
• primary(columnNames, constraintName): TableBuilder

• Inherited from Knex.TableBuilder.primary

  Parameters

  • columnNames: readonly string[]

  • optionaloptions: Readonly<{ constraintName?: string; deferrable?: deferrableType }>

  Returns TableBuilder

inheritedqueryContext

• queryContext(context): TableBuilder

• Inherited from Knex.TableBuilder.queryContext

  Parameters

  • context: any

  Returns TableBuilder

inheritedrenameColumn

• renameColumn(from, to): TableBuilder

• Inherited from Knex.TableBuilder.renameColumn

  Parameters

  • from: string

  • to: string

  Returns TableBuilder

inheritedsetNullable

• setNullable(column): TableBuilder

• Inherited from Knex.TableBuilder.setNullable

  Parameters

  • column: string

  Returns TableBuilder

inheritedsmallint

• smallint(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.smallint

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedspecificType

• specificType(columnName, type): ColumnBuilder

• Inherited from Knex.TableBuilder.specificType

  Parameters

  • columnName: string

  • type: string

  Returns ColumnBuilder

inheritedstring

• string(columnName, length): ColumnBuilder

• Inherited from Knex.TableBuilder.string

  Parameters

  • columnName: string

  • optionallength: number

  Returns ColumnBuilder

inheritedtext

• text(columnName, textType): ColumnBuilder

• Inherited from Knex.TableBuilder.text

  Parameters

  • columnName: string

  • optionaltextType: string

  Returns ColumnBuilder

inheritedtime

• time(columnName): ColumnBuilder

• Inherited from Knex.TableBuilder.time

  Parameters

  • columnName: string

  Returns ColumnBuilder

inheritedtimestamp

• timestamp(columnName, options): ColumnBuilder
• timestamp(columnName, withoutTz, precision): ColumnBuilder

• Inherited from Knex.TableBuilder.timestamp

  Parameters

  • columnName: string

  • optionaloptions: Readonly<{ precision?: number; useTz?: boolean }>

  Returns ColumnBuilder

inheritedtimestamps

• timestamps(useTimestamps, defaultToNow, useCamelCase): ColumnBuilder
• timestamps(options): void

• Inherited from Knex.TableBuilder.timestamps

  Parameters

  • optionaluseTimestamps: boolean

  • optionaldefaultToNow: boolean

  • optionaluseCamelCase: boolean

  Returns ColumnBuilder

inheritedtinyint

• tinyint(columnName, length): ColumnBuilder

• Inherited from Knex.TableBuilder.tinyint

  Parameters

  • columnName: string

  • optionallength: number

  Returns ColumnBuilder

inheritedunique

• unique(columnNames, options): TableBuilder
• unique(columnNames, indexName): 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, options): ColumnBuilder

• Inherited from Knex.TableBuilder.uuid

  Parameters

  • columnName: string

  • optionaloptions: Readonly<{ primaryKey?: boolean; useBinaryUuid?: boolean }>

  Returns ColumnBuilder