Class Errors
Sequelize provides a host of custom error classes, to allow you to do easier debugging. All of these errors are exposed on the sequelize object and the sequelize constructor. All sequelize errors inherit from the base JS error object.
new BaseError()
The Base Error all Sequelize Errors inherit from. Aliases: Error
new ValidationError(message, [errors])
Validation Error. Thrown when the sequelize validation has failed. The error contains an errors
property,
which is an array with 1 or more ValidationErrorItems, one for each validation that failed.
Params:
Name | Type | Description |
---|---|---|
message | string | Error message |
[errors] | Array | Array of ValidationErrorItem objects describing the validation errors |
Extends: BaseError
errors
An array of ValidationErrorItems
get(path)
Gets all validation error items for the path / field specified.
Params:
Name | Type | Description |
---|---|---|
path | string | The path to be checked for error items |
new DatabaseError()
A base class for all database related errors.
Extends: BaseError
parent
The database specific error which triggered this one
sql
The SQL that triggered the error
message()
The message from the DB.
fields()
The fields of the unique constraint
value()
The value(s) which triggered the error
index()
The name of the index that triggered the error
new TimeoutError()
Thrown when a database query times out because of a deadlock
Extends: DatabaseError
new UniqueConstraintError()
Thrown when a unique constraint is violated in the database
Extends: DatabaseError
new ForeignKeyConstraintError()
Thrown when a foreign key constraint is violated in the database
Extends: DatabaseError
new ExclusionConstraintError()
Thrown when an exclusion constraint is violated in the database
Extends: DatabaseError
new ValidationErrorItem(message, type, path, value)
Validation Error Item
Instances of this class are included in the ValidationError.errors
property.
Params:
Name | Type | Description |
---|---|---|
message | string | An error message |
type | string | The type of the validation error |
path | string | The field that triggered the validation error |
value | string | The value that generated the error |
new ConnectionError()
A base class for all connection related errors.
Extends: BaseError
parent
The connection specific error which triggered this one
new ConnectionRefusedError()
Thrown when a connection to a database is refused
Extends: ConnectionError
new AccessDeniedError()
Thrown when a connection to a database is refused due to insufficient privileges
Extends: ConnectionError
new HostNotFoundError()
Thrown when a connection to a database has a hostname that was not found
Extends: ConnectionError
new HostNotReachableError()
Thrown when a connection to a database has a hostname that was not reachable
Extends: ConnectionError
new InvalidConnectionError()
Thrown when a connection to a database has invalid values for any of the connection parameters
Extends: ConnectionError
new ConnectionTimedOutError()
Thrown when a connection to a database times out
Extends: ConnectionError
new InstanceError()
Thrown when a some problem occurred with Instance methods (see message for details)
Extends: BaseError
This document is automatically generated based on source code comments. Please do not edit it directly, as your changes will be ignored. Please write on IRC, open an issue or a create a pull request if you feel something can be improved. For help on how to write source code documentation see JSDoc and dox