API Reference Source

References

summary
public

C Model

A Model represents a table in the database.

public

This is the main class, the entry point to sequelize.

public

The transaction object is used to identify a running transaction.

public

V DataTypes: *

A convenience class holding commonly used data types.

public

V Deferrable: *

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 Op: {"eq": *, "ne": *, "gte": *, "gt": *, "lte": *, "lt": *, "not": *, "is": *, "in": *, "notIn": *, "like": *, "notLike": *, "iLike": *, "notILike": *, "startsWith": *, "endsWith": *, "substring": *, "regexp": *, "notRegexp": *, "iRegexp": *, "notIRegexp": *, "between": *, "notBetween": *, "overlap": *, "contains": *, "contained": *, "adjacent": *, "strictLeft": *, "strictRight": *, "noExtendRight": *, "noExtendLeft": *, "and": *, "or": *, "any": *, "all": *, "values": *, "col": *, "placeholder": *, "join": *}

Operator symbols to be used when querying data

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

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

Many-to-many association with a join table.

public

One-to-one association

public

One-to-many association

public

C HasOne

One-to-one association

dialects/abstract

summary
public

The interface that Sequelize uses to talk to all databases

dialects/mssql

summary
public

Thrown when a connection to a database is closed while an operation is in progress

public

The interface that Sequelize uses to talk with MSSQL database

dialects/mysql

summary
public

The interface that Sequelize uses to talk with MySQL/MariaDB database

dialects/postgres

summary
public

The interface that Sequelize uses to talk with Postgres database

dialects/sqlite

summary
public

The interface that Sequelize uses to talk with SQLite database

errors

summary
public

C AggregateError(errors: Error[])

A wrapper for multiple Errors

public

Thrown when an association is improperly constructed (see message for details)

public

Sequelize provides a host of custom error classes, to allow you to do easier debugging.

public

C BulkRecordError(error: Error, record: object)

Thrown when bulk operation fails, it represent per record level error.

public

A base class for all connection related errors.

public

A base class for all database related errors.

public

Thrown when an include statement is improperly constructed (see message for details)

public

Thrown when a record was not found, Usually used with rejectOnEmpty mode (see message for details)

public

Thrown when a some problem occurred with Instance methods (see message for details)

public

Thrown when attempting to update a stale model instance

public

Thrown when a query is passed invalid options (see message for details)

public

Scope Error.

public

C ValidationError(message: string, errors: Array)

Validation Error.

public

Validation Error Item Instances of this class are included in the ValidationError.errors property.

errors/connection

summary
public

Thrown when a connection to a database is refused due to insufficient privileges

public

Thrown when connection is not acquired due to timeout

public

Thrown when a connection to a database is refused

public

Thrown when a connection to a database times out

public

Thrown when a connection to a database has a hostname that was not found

public

Thrown when a connection to a database has a hostname that was not reachable

public

Thrown when a connection to a database has invalid values for any of the connection parameters

errors/database

summary
public

Thrown when an exclusion constraint is violated in the database

public

Thrown when a foreign key constraint is violated in the database

public

Thrown when a database query times out because of a deadlock

public

Thrown when constraint name is not found in the database

errors/validation

summary
public

Thrown when a unique constraint is violated in the database