Abstract
Private
#basePrivate
#datadialect-specific implementation of shared data types
Private
#dataPrivate
#printedReadonly
DataAbstract
Readonly
QueryAbstract
Readonly
TICK_Abstract
Readonly
TICK_Abstract
Readonly
connectionAbstract
Readonly
dataAbstract
Readonly
defaultReadonly
nameAbstract
Readonly
queryAbstract
Readonly
queryReadonly
sequelizeStatic
Readonly
supportsList of features this dialect supports.
Important: Dialect implementations inherit these values. When changing a default, ensure the implementations still properly declare which feature they support.
Abstract
createReturns the dialect-specific implementation of a shared data type, or null if no such implementation exists (in which case you need to use the base implementation).
The shared data type.
Abstract
getUsed to register a base parser for a Database type. Parsers are based on the Database Type, not the JS type. Only one parser can be assigned as the parser for a Database Type. For this reason, prefer neutral implementations.
For instance, when implementing "parse" for a Date type, prefer returning a String rather than a Date object.
The DataTypes.ABSTRACT#parseDatabaseValue method will then be called on the DataType instance defined by the user, which can decide on a more specific JS type (e.g. parse the date string & return a Date instance or a Temporal instance).
You typically do not need to implement this method. This is used to provide default parsers when no DataType is provided (e.g. raw queries that don't specify a model). Sequelize already provides a default parser for most types. For a custom Data Type, implementing DataTypes.ABSTRACT#parseDatabaseValue is typically what you want.
Dialect-specific DB data type identifiers that will use this parser.
The parser function to call when parsing the data type. Parameters are dialect-specific.
Protected
Static
extendOptional
DEFAULT?: booleanOptional
DEFAULT VALUES?: booleanOptional
EXCEPTION?: booleanOptional
IREGEXP?: booleanCase-insensitive regexp operator support ('~*' in postgres).
Optional
LIMIT ON UPDATE?: booleanOptional
ON DUPLICATE KEY?: booleanOptional
ORDER NULLS?: booleanOptional
REGEXP?: booleanOptional
RIGHT JOIN?: booleanOptional
UNION?: booleanOptional
UNION ALL?: booleanOptional
VALUES ()?: booleanOptional
alterOptional
autoOptional
bulkOptional
constraints?: { restrict?: boolean; deferrable?: boolean; unique?: boolean; default?: boolean; check?: boolean; foreignKey?: boolean; foreignKeyChecksDisableable?: boolean; primaryKey?: boolean; onUpdate?: boolean; add?: boolean; remove?: boolean; removeOptions?: { ...; }; }Optional
dataOptional
dropOptional
escapeThis dialect supports E-prefixed strings, e.g. "E'foo'", which enables the ability to use backslash escapes inside of the string.
Optional
finalOptional
forOptional
globalWhether this dialect supports changing the global timezone option
Optional
groupedOptional
index?: { collate?: boolean; length?: boolean; parser?: boolean; concurrently?: boolean; type?: boolean; using?: number | boolean; functionBased?: boolean; operator?: boolean; where?: boolean; include?: boolean; }Optional
indexOptional
indexOptional
inserts?: { ignoreDuplicates?: string; updateOnDuplicate?: string | boolean; onConflictDoNothing?: string; onConflictWhere?: boolean; conflictFields?: boolean; }Optional
jsonWhether this dialect supports returning quoted & unquoted JSON strings
Optional
jsonWhether this dialect supports SQL JSON functions
Optional
lock?: booleanOptional
lockOptional
lockOptional
lockOptional
maxOptional
migrations?: booleanOptional
multiWhether this dialect has native support for having multiple databases per instance (in the postgres or mssql sense). For the purposes of Sequelize, a database is considered to be a grouping of schemas. For instance, in MySQL, "CREATE DATABASE" creates what we consider to be a schema, so we do not consider that MySQL supports this option.
Optional
removeOptional
renameOptional
returnOptional
schemas?: booleanWhether this dialect has native support for schemas. For the purposes of Sequelize, a Schema is considered to be a grouping of tables. For instance, in MySQL, "CREATE DATABASE" creates what we consider to be a schema.
Optional
searchOptional
settingOptional
skipOptional
tableOptional
tmpOptional
transactionOptional
transactions?: booleanOptional
truncate?: { cascade?: boolean; }Optional
upserts?: booleanStatic
getGenerated using TypeDoc
base implementations of shared data types