Type Alias DialectSupports

Type declaration

• alterColumn: { unique: boolean }

  • unique: boolean

    Can "ALTER TABLE x ALTER COLUMN y" add UNIQUE to the column in this dialect?

• autoIncrement: { defaultValue: boolean; identityInsert: boolean; update: boolean }

  features specific to autoIncrement values

  • defaultValue: boolean

    does the dialect support inserting default/null values for autoincrement fields

  • identityInsert: boolean

    does the dialect require modification of insert queries when inserting auto increment fields

  • update: boolean

    does the dialect support updating autoincrement fields

• bulkDefault: boolean

  Do we need to say DEFAULT for bulk insert

• connectionTransactionMethods: boolean

• constraints: {
      add: boolean;
      check: boolean;
      default: boolean;
      deferrable: boolean;
      foreignKey: boolean;
      foreignKeyChecksDisableable: boolean;
      onUpdate: boolean;
      primaryKey: boolean;
      remove: boolean;
      removeOptions: { cascade: boolean; ifExists: boolean };
      restrict: boolean;
      unique: boolean;
  }

  • add: boolean

  • check: boolean

  • default: boolean

  • deferrable: boolean

    This dialect supports marking a column's constraints as deferrable. e.g. 'DEFERRABLE' and 'INITIALLY DEFERRED'

  • foreignKey: boolean

  • foreignKeyChecksDisableable: boolean

    Whether this dialect supports disabling foreign key checks for the current session

  • onUpdate: boolean

  • primaryKey: boolean

  • remove: boolean

  • removeOptions: { cascade: boolean; ifExists: boolean }

  • restrict: boolean

  • unique: boolean

• createSchema: {
      authorization: boolean;
      charset: boolean;
      collate: boolean;
      comment: boolean;
      ifNotExists: boolean;
      replace: boolean;
  }

• dataTypes: {
      ARRAY: boolean;
      BIGINT: boolean;
      CHAR: boolean;
      CIDR: boolean;
      CITEXT: boolean;
      COLLATE_BINARY: boolean;
      DATEONLY: { infinity: boolean };
      DATETIME: { infinity: boolean };
      DECIMAL: false | SupportableExactDecimalOptions;
      DOUBLE: SupportableFloatOptions;
      FLOAT: SupportableFloatOptions;
      GEOGRAPHY: boolean;
      GEOMETRY: boolean;
      HSTORE: boolean;
      INET: boolean;
      INTS: SupportableNumericOptions;
      JSON: boolean;
      JSONB: boolean;
      MACADDR: boolean;
      MACADDR8: boolean;
      RANGE: boolean;
      REAL: SupportableFloatOptions;
      TIME: { precision: boolean };
      TSVECTOR: boolean;
  }

  • ARRAY: boolean

  • BIGINT: boolean

    This dialect supports big integers

  • CHAR: boolean

  • CIDR: boolean

  • CITEXT: boolean

    This dialect supports case-insensitive text

  • COLLATE_BINARY: boolean

    Whether this dialect provides a binary collation on text, varchar & char columns.

  • DATEONLY: { infinity: boolean }

    • infinity: boolean

      Whether "infinity" is a valid value in this dialect's DATEONLY data type

  • DATETIME: { infinity: boolean }

    • infinity: boolean

      Whether "infinity" is a valid value in this dialect's DATETIME data type

  • DECIMAL: false | SupportableExactDecimalOptions

    This dialect supports arbitrary precision numbers

  • DOUBLE: SupportableFloatOptions

    This dialect supports 8 byte long floating point numbers

  • FLOAT: SupportableFloatOptions

    This dialect supports 4 byte long floating point numbers

  • GEOGRAPHY: boolean

  • GEOMETRY: boolean

  • HSTORE: boolean

  • INET: boolean

  • INTS: SupportableNumericOptions

    Options supportable by all int types (from tinyint to bigint)

  • JSON: boolean

    The dialect is considered to support JSON if it provides either:

    • A JSON data type.
    • An SQL function that can be used as a CHECK constraint on a text column, to ensure its contents are valid JSON.

  • JSONB: boolean

  • MACADDR: boolean

  • MACADDR8: boolean

  • RANGE: boolean

  • REAL: SupportableFloatOptions

    Deprecated

  • TIME: { precision: boolean }

    • precision: boolean

      Whether the dialect supports TIME(precision)

  • TSVECTOR: boolean

• DEFAULT: boolean

• DEFAULT VALUES: boolean

• delete: { limit: boolean }

• dropSchema: { cascade: boolean; ifExists: boolean }

• dropTable: { cascade: boolean; concurrentDropConstraints: boolean }

• escapeStringConstants: boolean

  This dialect supports E-prefixed strings, e.g. "E'foo'", which enables the ability to use backslash escapes inside the string.

• EXCEPTION: boolean

• finalTable: boolean

• OptionalforShare?: "LOCK IN SHARE MODE" | "FOR SHARE"

• globalTimeZoneConfig: boolean

  Whether this dialect supports changing the global timezone option

• groupedLimit: boolean

• index: {
      collate: boolean;
      concurrently: boolean;
      functionBased: boolean;
      include: boolean;
      length: boolean;
      operator: boolean;
      parser: boolean;
      type: boolean;
      using: boolean | number;
      where: boolean;
  }

• indexHints: boolean

• indexViaAlter: boolean

• inserts: {
      conflictFields: boolean;
      ignoreDuplicates: false | string;
      onConflictDoNothing: string;
      onConflictWhere: boolean;
      updateOnDuplicate: boolean | string;
  }

  • conflictFields: boolean

    whether the dialect supports specifying conflict fields or not

  • ignoreDuplicates: false | string

  • onConflictDoNothing: string

    dialect specific words for ON CONFLICT DO NOTHING

  • onConflictWhere: boolean

    whether dialect supports ON CONFLICT WHERE

  • updateOnDuplicate: boolean | string

    whether dialect supports ON DUPLICATE KEY UPDATE

• IREGEXP: boolean

  Case-insensitive regexp operator support ('~*' in postgres).

• isolationLevels: boolean

• jsonExtraction: { quoted: boolean; unquoted: boolean }

  Whether this dialect supports returning quoted & unquoted JSON strings

• jsonOperations: boolean

  Whether this dialect supports SQL JSON functions

• LIMIT ON UPDATE: boolean

• lock: boolean

• lockKey: boolean

• lockOf: boolean

• lockOuterJoinFailure: boolean

• maxExecutionTimeHint: { select: boolean }

• migrations: boolean

• multiDatabases: boolean

  Whether 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.

• ON DUPLICATE KEY: boolean

• ORDER NULLS: boolean

• randomFloatGeneration: boolean

  Whether this dialect provides a native way to generate random values between 0 and 1

• REGEXP: boolean

• removeColumn: { cascade: boolean; ifExists: boolean }

• renameTable: { changeSchema: boolean; changeSchemaAndTable: boolean }

• returnIntoValues: boolean

  does the dialect support returning values for inserted/updated fields in outBinds

• returnValues: false | "output" | "returning"

  does the dialect support returning values for inserted/updated fields

• RIGHT JOIN: boolean

• savepoints: boolean

• schemas: boolean

  Whether 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.

• searchPath: boolean

• select: { dummyTable: null | string }

  • dummyTable: null | string

    The dummy table to use when we do not care about the source of the data, e.g. when selecting the result of a function or a literal value.

    If null, not specifying the FROM clause is supported. If a string, the name of the dummy table to use, e.g. DUAL (Oracle) or SYSIBM.SYSDUMMY1 (IBMi).

• settingIsolationLevelDuringTransaction: boolean

• skipLocked: boolean

• startTransaction: { readOnly: boolean; transactionType: boolean; useBegin: boolean }

• tableHints: boolean

• tmpTableTrigger: boolean

• topLevelOrderByRequired: boolean

  does the dialect support topLevelOrderBy (ORDER BY clause) to get desired results

• transactions: boolean

• truncate: { cascade: boolean; restartIdentity: boolean }

• UNION: boolean

• UNION ALL: boolean

• upserts: boolean

• uuidV1Generation: boolean

  Whether this dialect provides a native way to generate UUID v1 values

• uuidV4Generation: boolean

  Whether this dialect provides a native way to generate UUID v4 values

• uuidV7Generation: boolean

  Whether this dialect provides a native way to generate UUID v7 values

• VALUES (): boolean