Class ABSTRACT<AcceptedType>Abstract

constructor

• new ABSTRACT<AcceptedType>(): ABSTRACT<AcceptedType>

• Type Parameters

  • AcceptedType

  Returns ABSTRACT<AcceptedType>

usageContext

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

areValuesEqual

• areValuesEqual(value, originalValue): boolean

• Parameters

  • value: AcceptedType
  • originalValue: AcceptedType

  Returns boolean

belongsToDialect

• belongsToDialect(dialect): boolean

• Parameters

  • dialect: AbstractDialect<object, object>

  Returns boolean

clone

• clone(): this

• Returns a copy of this DataType, without usage context. Designed to re-use a DataType on another Model.

  Returns this

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: AcceptedType

    The value to escape.

  Returns string

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: AcceptedType

    The value to bind.
  • options: BindParamOptions

    Options.

  Returns string

getDataTypeId

• getDataTypeId(): string

• Returns string

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

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

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: AcceptedType

    The value to convert.

  Returns unknown

toDialectDataType

• toDialectDataType(dialect): this

• Returns this DataType, using its dialect-specific subclass.

  Parameters

  • dialect: AbstractDialect<object, object>

  Returns this

Abstract toSql

• toSql(): string

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

  Returns string

toString

• toString(): string

• Returns string

validate

• validate(value): asserts value is AcceptedType

• 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 AcceptedType

withUsageContext

• withUsageContext(usageContext): this

• Parameters

  • usageContext: DataTypeUseContext

  Returns this

Static getDataTypeId

• getDataTypeId(): string

• Returns string

Static toString

• toString(): string

• Returns string