Interface Options

Options for the constructor of the Sequelize main class.

Hierarchy

Properties

benchmark? clientMinMessages? database? databaseVersion? define? dialect? dialectModule? dialectModulePath? dialectOptions? hooks? host? isolationLevel? keepDefaultTimezone? logQueryParameters? logging? minifyAliases? native? omitNull? operatorsAliases? password? pool? port? protocol? query? quoteIdentifiers? replication? retry? schema? set? ssl? standardConformingStrings? storage? sync? timezone? transactionType? typeValidation? username?

Properties

Optional benchmark

benchmark?: boolean

Pass query execution time in milliseconds as second argument to logging function (options.logging).

Optional clientMinMessages

clientMinMessages?: string | boolean

The 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

Deprecated

Default

'warning'

Optional database

database?: string

The name of the database

Optional databaseVersion

databaseVersion?: string | number

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

Optional define

define?: ModelOptions<Model<any, any>>

Default options for model definitions. See Model.init.

Optional dialect

dialect?: Dialect

The dialect of the database you are connecting to. One of mysql, postgres, sqlite, mariadb and mssql.

Default

'mysql'

Optional dialectModule

dialectModule?: object

If specified, will use the provided module as the dialect.

Example

dialectModule: require('@myorg/tedious'),

Optional dialectModulePath

dialectModulePath?: string

If 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

Optional dialectOptions

dialectOptions?: DialectOptions

An object of additional options, which are passed directly to the connection library

Optional hooks

hooks?: Partial<SequelizeHooks<Model<any, any>, any, any>>

Sets global permanent hooks.

Optional host

host?: string

The host of the relational database.

Default

'localhost'

Optional isolationLevel

isolationLevel?: ISOLATION_LEVELS

Set the default transaction isolation level. See Sequelize.Transaction.ISOLATION_LEVELS for possible options.

Default

'REPEATABLE_READ'

Optional keepDefaultTimezone

keepDefaultTimezone?: boolean

A flag that defines if the default timezone is used to convert dates from the database.

Default

false

Optional logQueryParameters

logQueryParameters?: boolean

Set to true to show bind parameters in log.

Default

false

Optional logging

logging?: boolean | ((sql: string, timing?: number) => void)

A function that gets executed while running the query to log the sql.

Optional minifyAliases

minifyAliases?: boolean

Set to true to automatically minify aliases generated by sequelize. Mostly useful to circumvent the POSTGRES alias limit of 64 characters.

Default

false

Optional native

native?: boolean

A flag that defines if native library shall be used or not. Currently only has an effect for postgres

Default

false

Optional omitNull

omitNull?: boolean

A flag that defines if null values should be passed to SQL queries or not.

Default

false

Optional operatorsAliases

operatorsAliases?: OperatorsAliases

Sets available operator aliases. See (https://sequelize.org/docs/v7/core-concepts/model-querying-basics/#operators) for more information. WARNING: Setting this to boolean value was deprecated and is no-op.

Default

all aliases

Optional password

password?: string

The password which is used to authenticate against the database.

Optional pool

pool?: PoolOptions

Connection pool options

Optional port

port?: string | number

The port of the relational database.

Optional protocol

protocol?: string

The protocol of the relational database.

Default

'tcp'

Optional query

query?: QueryOptions

Default options for sequelize.query

Optional quoteIdentifiers

quoteIdentifiers?: boolean

Set to false to make table names and attributes case-insensitive on Postgres and skip double quoting of them.

Default

true

Optional replication

replication?: null | false | ReplicationOptions

Use read / write replication. To enable replication, pass an object, with two properties, read and write. Write should be an object (a single server for handling writes), and read an array of object (several servers to handle reads). Each read/write server can have the following properties: host, port, username, password, database. Connection strings can be used instead of objects.

Default

false

Optional retry

retry?: RetryOptions

Optional schema

schema?: string

If defined the connection will use the provided schema instead of the default ("public").

Optional set

set?: DefaultSetOptions

Default options for sequelize.set

Optional ssl

ssl?: boolean

A flag that defines if is used SSL.

Optional standardConformingStrings

standardConformingStrings?: boolean

The 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!

Default

true

Optional storage

storage?: string

Only used by sqlite.

Default

':memory:'

Optional sync

sync?: SyncOptions

Default options for sequelize.sync

Optional timezone

timezone?: string

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.

Default

'+00:00'

Optional transactionType

transactionType?: TRANSACTION_TYPES

Set the default transaction type. See Sequelize.Transaction.TYPES for possible options. Sqlite only.

Default

'DEFERRED'

Optional typeValidation

typeValidation?: boolean

Run built in type validators on insert and update, e.g. validate that arguments passed to integer fields are integer-like.

Default

false

Optional username

username?: string

The username which is used to authenticate against the database.

Settings

Member Visibility

Theme

Generated using TypeDoc