Optional benchmarkOptional clientThe PostgreSQL client_min_messages session parameter.
Set to false to not override the database's default.
Deprecated in v7, please use the sequelize option "dialectOptions.clientMinMessages" instead
'warning'
Optional databaseThe name of the database
Optional databaseThe version of the Database Sequelize will connect to. If unspecified, or set to 0, Sequelize will retrieve it during its first connection to the Database.
The precision for the createdAt/updatedAt/deletedAt DATETIME columns that Sequelize adds to models.
Can be a number between 0 and 6, or null to use the default precision of the database. Defaults to 6.
6
How nested transaction blocks behave by default. See ManagedTransactionOptions#nestMode for more information.
TransactionNestMode.reuse
Optional defineDefault options for model definitions. See Model.init.
The dialect of the database you are connecting to. One of mysql, postgres, sqlite, mariadb and mssql.
'mysql'
Optional dialectIf specified, will use the provided module as the dialect.
`dialectModule: require('@myorg/tedious'),`
Optional dialectIf specified, load the dialect library from this path. For example, if you want to use pg.js instead of pg when connecting to a pg database, you should specify 'pg.js' here
An object of additional options, which are passed directly to the connection library
Disable the use of AsyncLocalStorage to automatically pass transactions started by Sequelize#transaction. You will need to pass transactions around manually if you disable this.
Optional foreignSQLite only. If set to false, foreign keys will not be enforced by SQLite.
true
Optional hooksSets global permanent hooks.
Optional hostThe host of the relational database.
'localhost'
Set the default transaction isolation level. See Sequelize.Transaction.ISOLATION_LEVELS for possible
options.
'REPEATABLE_READ'
Optional keepA flag that defines if the default timezone is used to convert dates from the database.
false
Optional logSet to true to show bind parameters in log.
false
Optional loggingA function that gets executed while running the query to log the sql.
Optional timing: numberOptional minifySet to true to automatically minify aliases generated by sequelize.
Mostly useful to circumvent the POSTGRES alias limit of 64 characters.
false
Optional modelsA list of models to load and init.
This option is only useful if you created your models using decorators. Models created using Model.init or Sequelize#define don't need to be specified in this option.
Use importModels to load models dynamically:
import { User } from './models/user.js';
new Sequelize({
models: [User],
});
new Sequelize({
models: await importModels(__dirname + '/*.model.ts'),
});
Optional nativeA flag that defines if native library shall be used or not. Currently only has an effect for postgres
false
Disable built in type validators on insert and update, e.g. don't validate that arguments passed to integer fields are integer-like.
false
Optional omitA flag that defines if null values should be passed to SQL queries or not.
false
Optional passwordThe password which is used to authenticate against the database.
Optional poolConnection pool options
Optional portThe port of the relational database.
Optional protocolThe protocol of the relational database.
'tcp'
Optional queryDefault options for sequelize.query
Optional quoteSet to false to make table names and attributes case-insensitive on Postgres and skip double quoting of
them.
true
Readonly replicationOptional retryOptional schemaIf defined the connection will use the provided schema instead of the default ("public").
Optional setDefault options for sequelize.set
Optional sslA flag that defines if is used SSL.
Optional standardThe PostgreSQL standard_conforming_strings session parameter. Set to false to not set the option.
WARNING: Setting this to false may expose vulnerabilities and is not recommended!
true
Optional storageOnly used by sqlite.
':memory:'
Optional syncDefault options for sequelize.sync
The timezone used when converting a date from the database into a JavaScript date. The timezone is also used to SET TIMEZONE when connecting to the server, to ensure that the result of NOW, CURRENT_TIMESTAMP and other time related functions have in the right timezone. For best cross platform performance use the format +/-HH:MM. Will also accept string versions of timezones supported by Intl.Locale (e.g. 'America/Los_Angeles'); this is useful to capture daylight savings time changes.
'+00:00'
Set the default transaction type. See Sequelize.Transaction.TYPES for possible options. Sqlite only.
'DEFERRED'
Optional usernameThe username which is used to authenticate against the database.
Generated using TypeDoc
Pass query execution time in milliseconds as second argument to logging function (options.logging).