Class ENUM

constructor

• new ENUM(...values: (string | string[])[]): ENUM

  Create an ENUM data type

  Parameters

  • ...values: (string | string[])[]

    Either an array of values or individual string values

  Returns ENUM

  Example

  // Array of values
  DataTypes.ENUM(['active', 'inactive', 'pending'])
  // Individual values
  DataTypes.ENUM('active', 'inactive', 'pending')
  Copy

key

values

Optionalname

setName

• setName(name: string): this

  Set a name for the enum type (useful for PostgreSQL/MySQL)

  Parameters

  • name: string

  Returns this

toSqlString

• toSqlString(dialect?: string): string

  Parameters

  • Optionaldialect: string

  Returns string

getValues

• getValues(): string[]

  Get the values for validation

  Returns string[]

validate

• validate(value: string): boolean

  Validate if a value is valid for this ENUM

  Parameters

  • value: string

  Returns boolean

toAlterTableSql

• toAlterTableSql(
      dialect: string,
      tableName: string,
      columnName: string,
      _columnDefinition?: string,
  ): string

  Generate an ALTER TABLE statement to add/modify ENUM column Note: MySQL uses MODIFY COLUMN, PostgreSQL needs type recreation

  Parameters

  • dialect: string
  • tableName: string
  • columnName: string
  • Optional_columnDefinition: string

  Returns string