Class ENUM<Member>

An enumeration, Postgres Only

Fallback policy: If this type is not supported, it will be replaced by a string type with a CHECK constraint to enforce a list of values.

Example

DataTypes.ENUM('value', 'another value')
DataTypes.ENUM(['value', 'another value'])
DataTypes.ENUM({
  values: ['value', 'another value'],
});

Type Parameters

Member extends string

Hierarchy (view full)

ABSTRACT<Member>
- ENUM

Constructors

constructor

new ENUM<Member>(options): ENUM<Member>
Type Parameters
- Member extends string
Parameters
- options: EnumOptions<Member>
  either array of values or options object with values array. It also supports variadic values.
Returns ENUM<Member>
Overrides ABSTRACT.constructor
- Defined in packages/core/src/abstract-dialect/data-types.ts:2243
new ENUM<Member>(members): ENUM<Member>
Type Parameters
- Member extends string
Parameters
- members: EnumValues<Member>
Returns ENUM<Member>
Overrides AbstractDataType<Member>.constructor
- Defined in packages/core/src/abstract-dialect/data-types.ts:2244
new ENUM<Member>(...members): ENUM<Member>
Type Parameters
- Member extends string
Parameters
- Rest ...members: Member[]
Returns ENUM<Member>
Overrides AbstractDataType<Member>.constructor
- Defined in packages/core/src/abstract-dialect/data-types.ts:2245

Properties

`Private` #dialect

#dialect: undefined | AbstractDialect<object, object>

`Readonly` options

options: NormalizedEnumOptions<Member>

usageContext

usageContext: undefined | DataTypeUseContext

Where this DataType is being used.

Methods

`Private` #getEnumValues

#getEnumValues(args): readonly Member[]
Parameters
- args: [Member | EnumOptions<Member> | EnumValues<Member>, ...Member[]]
Returns readonly Member[]
- Defined in packages/core/src/abstract-dialect/data-types.ts:2298

`Protected` _checkOptionSupport

_checkOptionSupport(dialect): void
Override this method to emit an error or a warning if the Data Type, as it is configured, is not compatible with the current dialect.
Parameters
- dialect: AbstractDialect<object, object>
  The dialect using this data type.
Returns void
Inherited from ABSTRACT._checkOptionSupport
- Defined in packages/core/src/abstract-dialect/data-types.ts:286

`Protected` _construct

_construct<Constructor>(...args): this
Type Parameters
- Constructor extends (new () => ABSTRACT<any>)
Parameters
- Rest ...args: ConstructorParameters<Constructor>
Returns this
Inherited from ABSTRACT._construct
- Defined in packages/core/src/abstract-dialect/data-types.ts:159

`Protected` _getDialect

_getDialect(): AbstractDialect<object, object>
Returns AbstractDialect<object, object>
Inherited from ABSTRACT._getDialect
- Defined in packages/core/src/abstract-dialect/data-types.ts:108

acceptsNull

acceptsNull(): boolean
Whether this DataType wishes to handle NULL values itself. This is almost exclusively used by JSON and JSONB which serialize null as the JSON string 'null'.

Returns boolean
Inherited from ABSTRACT.acceptsNull
- Defined in packages/core/src/abstract-dialect/data-types.ts:177

areValuesEqual

areValuesEqual(value, originalValue): boolean
Parameters
- value: Member
- originalValue: Member
Returns boolean
Inherited from ABSTRACT.areValuesEqual
- Defined in packages/core/src/abstract-dialect/data-types.ts:169

`Private` attachUsageContext

attachUsageContext(usageContext): this
Private
Parameters
- usageContext: DataTypeUseContext
Returns this
Inherited from ABSTRACT.attachUsageContext
- Defined in packages/core/src/abstract-dialect/data-types.ts:353

belongsToDialect

belongsToDialect(dialect): boolean
Parameters
- dialect: AbstractDialect<object, object>
Returns boolean
Inherited from ABSTRACT.belongsToDialect
- Defined in packages/core/src/abstract-dialect/data-types.ts:291

clone

clone(): this
Returns a copy of this DataType, without usage context. Designed to re-use a DataType on another Model.

Returns this
Inherited from ABSTRACT.clone
- Defined in packages/core/src/abstract-dialect/data-types.ts:333

escape

escape(value): string
Escapes a value for the purposes of inlining it in a SQL query. The resulting value will be inlined as-is with no further escaping.
Parameters
- value: Member
  The value to escape.
Returns string
Inherited from ABSTRACT.escape
- Defined in packages/core/src/abstract-dialect/data-types.ts:219

getBindParamSql

getBindParamSql(value, options): string
This method is called when AbstractQueryGenerator needs to add a bind parameter to a query it is building. This method allows for customizing both the SQL to add to the query, and convert the bind parameter value to a DB-compatible value.

If you only need to prepare the bind param value, implement toBindableValue instead.

This method must return the SQL to add to the query. You can obtain a bind parameter ID by calling BindParamOptions#bindParam with the value associated to that bind parameter.

An example of a data type that requires customizing the SQL is the GEOMETRY data type.
Parameters
- value: Member
  The value to bind.
- options: BindParamOptions
  Options.
Returns string
Inherited from ABSTRACT.getBindParamSql
- Defined in packages/core/src/abstract-dialect/data-types.ts:245

getDataTypeId

getDataTypeId(): string
Returns string
Inherited from ABSTRACT.getDataTypeId
- Defined in packages/core/src/abstract-dialect/data-types.ts:97

parseDatabaseValue

parseDatabaseValue(value): unknown
Called when a value is retrieved from the Database, and its DataType is specified. Used to normalize values from the database.

Note: It is also possible to do an initial parsing of a Database value using AbstractDialect#registerDataTypeParser. That normalization uses the type ID from the database instead of a Sequelize Data Type to determine which parser to use, and is called before this method.
Parameters
- value: unknown
  The value to parse.
Returns unknown
Inherited from ABSTRACT.parseDatabaseValue
- Defined in packages/core/src/abstract-dialect/data-types.ts:191

sanitize

sanitize(value): unknown
Used to normalize a value when Model#set is called. That is, when a user sets a value on a Model instance.
Parameters
- value: unknown
Returns unknown
Inherited from ABSTRACT.sanitize
- Defined in packages/core/src/abstract-dialect/data-types.ts:201

toBindableValue

toBindableValue(value): unknown
Converts a JS value to a value compatible with the connector library for this Data Type. Unlike escape, this value does not need to be escaped. It is passed separately to the database, which will handle escaping.
Parameters
- value: Member
  The value to convert.
Returns unknown
Inherited from ABSTRACT.toBindableValue
- Defined in packages/core/src/abstract-dialect/data-types.ts:257

toDialectDataType

toDialectDataType(dialect): this
Returns this DataType, using its dialect-specific subclass.
Parameters
- dialect: AbstractDialect<object, object>
Returns this
Inherited from ABSTRACT.toDialectDataType
- Defined in packages/core/src/abstract-dialect/data-types.ts:300

toSql

toSql(): string
Returns a SQL declaration of this data type. e.g. 'VARCHAR(255)', 'TEXT', etc…

Returns string
Overrides ABSTRACT.toSql
- Defined in packages/core/src/abstract-dialect/data-types.ts:2353

toString

toString(): string
Returns string
Inherited from ABSTRACT.toString
- Defined in packages/core/src/abstract-dialect/data-types.ts:261

validate

validate(value): asserts value is Member
Checks whether the JS value is compatible with (or can be converted to) the SQL data type. Throws if that is not the case.
Parameters
- value: any
Returns asserts value is Member
Overrides ABSTRACT.validate
- Defined in packages/core/src/abstract-dialect/data-types.ts:2345

withUsageContext

withUsageContext(usageContext): this
Parameters
- usageContext: DataTypeUseContext
Returns this
Inherited from ABSTRACT.withUsageContext
- Defined in packages/core/src/abstract-dialect/data-types.ts:339

`Static` getDataTypeId

getDataTypeId(): string
Returns string
Inherited from ABSTRACT.getDataTypeId
- Defined in packages/core/src/abstract-dialect/data-types.ts:93

`Static` toString

toString(): string
Returns string
Inherited from ABSTRACT.toString
- Defined in packages/core/src/abstract-dialect/data-types.ts:270

Class ENUM<Member>

Example

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ENUM<Member>

Type Parameters

Parameters

Returns ENUM<Member>

Type Parameters

Parameters

Returns ENUM<Member>

Properties

Private #dialect

Readonly options

usageContext

Methods

Private #getEnumValues

Parameters

Returns readonly Member[]

Protected _checkOptionSupport

Parameters

Returns void

Protected _construct

Type Parameters

Parameters

Returns this

Protected _getDialect

Returns AbstractDialect<object, object>

acceptsNull

Returns boolean

areValuesEqual

Parameters

Returns boolean

Private attachUsageContext

Parameters

Returns this

belongsToDialect

Parameters

Returns boolean

clone

Returns this

escape

Parameters

Returns string

getBindParamSql

Parameters

Returns string

getDataTypeId

Returns string

parseDatabaseValue

Parameters

Returns unknown

sanitize

Parameters

Returns unknown

toBindableValue

Parameters

Returns unknown

toDialectDataType

Parameters

Returns this

toSql

Returns string

toString

Returns string

validate

Parameters

Returns asserts value is Member

withUsageContext

Parameters

Returns this

Static getDataTypeId

`Private` #dialect

`Readonly` options

`Private` #getEnumValues

`Protected` _checkOptionSupport

`Protected` _construct

`Protected` _getDialect

`Private` attachUsageContext

`Static` getDataTypeId

`Static` toString