Guides Reference Source

References

summary
public	C Model A Model represents a table in the database.
public	C Sequelize This is the main class, the entry point to sequelize.
public	C Transaction The transaction object is used to identify a running transaction.
public	F format(arr: unknown[], dialect: AbstractDialect): * this function was deprecated. use {@link injectReplacements} instead. This method has been removed in v7.
public	F formatNamedParameters(sql: string, parameters: object, dialect: AbstractDialect): * this function was deprecated. use {@link injectReplacements} instead. This method has been removed in v7.
public	F safeStringifyJson(value: any): string Stringify a value as JSON with some differences: bigints are stringified as a json string.
public	V DataTypes: * A convenience class holding commonly used data types.
public	V Deferrable: {"INITIALLY_DEFERRED": , "INITIALLY_IMMEDIATE": , "NOT": , "SET_DEFERRED": , "SET_IMMEDIATE": *} A collection of properties related to deferrable constraints.
public	V IndexHints: * An enum of index hints to be used in mysql for querying with index hints
public	V QueryTypes: * An enum of query types used by `sequelize.query`
public	V TableHints: * An enum of table hints to be used in mssql for querying with table hints

associations

summary
public	C Association Creating associations in sequelize is done by calling one of the belongsTo / hasOne / hasMany / belongsToMany functions on a model (the source), and providing another model as the first argument to the function (the target).
public	C BelongsToMany Many-to-many association with a join table.
public	C BelongsTo One-to-one association
public	C HasMany One-to-many association
public	C HasOne One-to-one association

dialects/abstract

summary
public	C QueryInterface

dialects/db2

summary
public	C Db2QueryInterface The interface that Sequelize uses to talk with Db2 database

dialects/mssql

summary
public	C AsyncQueueError Thrown when a connection to a database is closed while an operation is in progress
public	C MSSqlQueryInterface The interface that Sequelize uses to talk with MSSQL database

dialects/mysql

summary
public	C MySQLQueryInterface The interface that Sequelize uses to talk with MySQL/MariaDB database

dialects/oracle

summary
public	C OracleQueryInterface The interface that Sequelize uses to talk with Oracle database

dialects/postgres

summary
public	C PostgresQueryInterface The interface that Sequelize uses to talk with Postgres database

dialects/snowflake

summary
public	C SnowflakeQueryInterface The interface that Sequelize uses to talk with Snowflake database

dialects/sqlite

summary
public	C SQLiteQueryInterface The interface that Sequelize uses to talk with SQLite database

errors

summary
public	C AggregateError(errors: *) A wrapper for multiple Errors
public	C AssociationError Thrown when an association is improperly constructed (see message for details)
public	C BaseError The Base Error all Sequelize Errors inherit from.
public	C BulkRecordError(error: , record: ) Thrown when bulk operation fails, it represent per record level error.
public	C ConnectionError A base class for all connection related errors.
public	C DatabaseError A base class for all database related errors.
public	C EagerLoadingError Thrown when an include statement is improperly constructed (see message for details)
public	C EmptyResultError Thrown when a record was not found, Usually used with rejectOnEmpty mode (see message for details)
public	C InstanceError Thrown when a some problem occurred with Instance methods (see message for details)
public	C OptimisticLockError Thrown when attempting to update a stale model instance
public	C QueryError Thrown when a query is passed invalid options (see message for details)
public	C SequelizeScopeError Scope Error.
public	C ValidationError(message: , errors: ) Validation Error.
public	C ValidationErrorItem Validation Error Item Instances of this class are included in the `ValidationError.errors` property.
public	V ValidationErrorItemOrigin: * An enum that defines valid ValidationErrorItem `origin` values
public	V ValidationErrorItemType: * An enum that is used internally by the `ValidationErrorItem` class that maps current `type` strings (as given to ValidationErrorItem.constructor()) to our new `origin` values.

errors/connection

summary
public	C AccessDeniedError Thrown when a connection to a database is refused due to insufficient privileges
public	C ConnectionAcquireTimeoutError Thrown when connection is not acquired due to timeout
public	C ConnectionRefusedError Thrown when a connection to a database is refused
public	C ConnectionTimedOutError Thrown when a connection to a database times out
public	C HostNotFoundError Thrown when a connection to a database has a hostname that was not found
public	C HostNotReachableError Thrown when a connection to a database has a hostname that was not reachable
public	C InvalidConnectionError Thrown when a connection to a database has invalid values for any of the connection parameters

errors/database

summary
public	C ExclusionConstraintError Thrown when an exclusion constraint is violated in the database
public	C ForeignKeyConstraintError Thrown when a foreign key constraint is violated in the database
public	C TimeoutError Thrown when a database query times out because of a deadlock
public	C UnknownConstraintError Thrown when constraint name is not found in the database

errors/validation

summary
public	C UniqueConstraintError Thrown when a unique constraint is violated in the database

utils

summary
public	F injectReplacements(sqlString: , dialect: , replacements: ): Inlines replacements in places where they would be valid SQL values.

Directories