Skip to content

public / sequelize

Go to a project

不要怂，就是干，撸起袖子干！

Commit 1e990afd by Jan Aagaard Meier
Options

[ci skip] Fix internal links in docs

1 parent 9817e589
Inline Side-by-side
Showing with 342 additions and 338 deletions
docs/api/associations.md
<a name="mixin"></a> <a name="mixin"></a>
# Mixin Mixin # Mixin Mixin
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/associations/mixin.js#L95) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/associations/mixin.js#L95)
Creating assocations in sequelize is done by calling one of the belongsTo / hasOne / hasMany functions Creating assocations in sequelize is done by calling one of the belongsTo / hasOne / hasMany functions
on a model (the source), and prodiving another model as the first argument to the function (the target). on a model (the source), and prodiving another model as the first argument to the function (the target).
...@@ -89,7 +89,7 @@ you should either disable some constraints, or rethink your associations complet ...@@ -89,7 +89,7 @@ you should either disable some constraints, or rethink your associations complet
<a name="hasone"></a> <a name="hasone"></a>
## `hasOne(target, [options])` ## `hasOne(target, [options])`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/associations/mixin.js#L145) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/associations/mixin.js#L145)
Creates an association between this (the source) and the provided target. The foreign key is added on the target. Creates an association between this (the source) and the provided target. The foreign key is added on the target.
Example: `User.hasOne(Profile)`. This will add userId to the profile table. Example: `User.hasOne(Profile)`. This will add userId to the profile table.
...@@ -121,7 +121,7 @@ All methods return a promise ...@@ -121,7 +121,7 @@ All methods return a promise
<a name="belongsto"></a> <a name="belongsto"></a>
## `belongsTo(target, [options])` ## `belongsTo(target, [options])`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/associations/mixin.js#L170) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/associations/mixin.js#L170)
Creates an association between this (the source) and the provided target. The foreign key is added on the source. Creates an association between this (the source) and the provided target. The foreign key is added on the source.
Example: `Profile.belongsTo(User)`. This will add userId to the profile table. Example: `Profile.belongsTo(User)`. This will add userId to the profile table.
...@@ -153,7 +153,7 @@ All methods return a promise ...@@ -153,7 +153,7 @@ All methods return a promise
<a name="hasmany"></a> <a name="hasmany"></a>
## `hasMany(target, [options])` ## `hasMany(target, [options])`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/associations/mixin.js#L245) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/associations/mixin.js#L245)
Create an association that is either 1:m or n:m. Create an association that is either 1:m or n:m.
```js ```js
...@@ -220,7 +220,7 @@ user.getProjects().success(function (projects) { ...@@ -220,7 +220,7 @@ user.getProjects().success(function (projects) {
| target | Model | | | target | Model | |
| [options] | object | | | [options] | object | |
| [options.hooks=false] | boolean | Set to true to run before-/afterDestroy hooks when an associated model is deleted because of a cascade. For example if `User.hasOne(Profile, {onDelete: 'cascade', hooks:true})`, the before-/afterDestroy hooks for profile will be called when a user is deleted. Otherwise the profile will be deleted without invoking any hooks | | [options.hooks=false] | boolean | Set to true to run before-/afterDestroy hooks when an associated model is deleted because of a cascade. For example if `User.hasOne(Profile, {onDelete: 'cascade', hooks:true})`, the before-/afterDestroy hooks for profile will be called when a user is deleted. Otherwise the profile will be deleted without invoking any hooks |
| [options.through] | Model &#124; string|object | The name of the table that is used to join source and target in n:m associations. Can also be a sequelize model if you want to define the junction table yourself and add extra attributes to it. | | [options.through] | Model &#124; string &#124; object | The name of the table that is used to join source and target in n:m associations. Can also be a sequelize model if you want to define the junction table yourself and add extra attributes to it. |
| [options.through.model] | Model | The model used to join both sides of the N:M association. | | [options.through.model] | Model | The model used to join both sides of the N:M association. |
| [options.through.scope] | object | A key/value set that will be used for association create and find defaults on the through model. (Remember to add the attributes to the through model) | | [options.through.scope] | object | A key/value set that will be used for association create and find defaults on the through model. (Remember to add the attributes to the through model) |
| [options.through.unique=true] | boolean | If true a unique key will be generated from the foreign keys used (might want to turn this off and create specific unique keys when using scopes) | | [options.through.unique=true] | boolean | If true a unique key will be generated from the foreign keys used (might want to turn this off and create specific unique keys when using scopes) |
...@@ -236,7 +236,7 @@ user.getProjects().success(function (projects) { ...@@ -236,7 +236,7 @@ user.getProjects().success(function (projects) {
<a name="belongstomany"></a> <a name="belongstomany"></a>
## `belongsToMany(target, [options])` ## `belongsToMany(target, [options])`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/associations/mixin.js#L339) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/associations/mixin.js#L339)
Create an N:M association with a join table Create an N:M association with a join table
```js ```js
...@@ -298,7 +298,7 @@ user.getProjects().then(function (projects) { ...@@ -298,7 +298,7 @@ user.getProjects().then(function (projects) {
| target | Model | | | target | Model | |
| [options] | object | | | [options] | object | |
| [options.hooks=false] | boolean | Set to true to run before-/afterDestroy hooks when an associated model is deleted because of a cascade. For example if `User.hasOne(Profile, {onDelete: 'cascade', hooks:true})`, the before-/afterDestroy hooks for profile will be called when a user is deleted. Otherwise the profile will be deleted without invoking any hooks | | [options.hooks=false] | boolean | Set to true to run before-/afterDestroy hooks when an associated model is deleted because of a cascade. For example if `User.hasOne(Profile, {onDelete: 'cascade', hooks:true})`, the before-/afterDestroy hooks for profile will be called when a user is deleted. Otherwise the profile will be deleted without invoking any hooks |
| [options.through] | Model &#124; string|object | The name of the table that is used to join source and target in n:m associations. Can also be a sequelize model if you want to define the junction table yourself and add extra attributes to it. | | [options.through] | Model &#124; string &#124; object | The name of the table that is used to join source and target in n:m associations. Can also be a sequelize model if you want to define the junction table yourself and add extra attributes to it. |
| [options.through.model] | Model | The model used to join both sides of the N:M association. | | [options.through.model] | Model | The model used to join both sides of the N:M association. |
| [options.through.scope] | object | A key/value set that will be used for association create and find defaults on the through model. (Remember to add the attributes to the through model) | | [options.through.scope] | object | A key/value set that will be used for association create and find defaults on the through model. (Remember to add the attributes to the through model) |
| [options.through.unique=true] | boolean | If true a unique key will be generated from the foreign keys used (might want to turn this off and create specific unique keys when using scopes) | | [options.through.unique=true] | boolean | If true a unique key will be generated from the foreign keys used (might want to turn this off and create specific unique keys when using scopes) |
......
docs/api/datatypes.md
<a name="datatypes"></a> <a name="datatypes"></a>
# Class DataTypes # Class DataTypes
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L309) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L36)
A convenience class holding commonly used data types. The datatypes are used when definining a new model using `Sequelize.define`, like this: A convenience class holding commonly used data types. The datatypes are used when definining a new model using `Sequelize.define`, like this:
```js ```js
sequelize.define('model', { sequelize.define('model', {
...@@ -31,8 +31,8 @@ sequelize.define('model', { ...@@ -31,8 +31,8 @@ sequelize.define('model', {
*** ***
<a name="string"></a> <a name="string"></a>
## `STRING` ## `STRING()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L317) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L54)
A variable length string. Default length 255 A variable length string. Default length 255
Available properties: `BINARY` Available properties: `BINARY`
...@@ -41,8 +41,8 @@ Available properties: `BINARY` ...@@ -41,8 +41,8 @@ Available properties: `BINARY`
*** ***
<a name="char"></a> <a name="char"></a>
## `CHAR` ## `CHAR()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L325) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L87)
A fixed length string. Default length 255 A fixed length string. Default length 255
Available properties: `BINARY` Available properties: `BINARY`
...@@ -51,15 +51,15 @@ Available properties: `BINARY` ...@@ -51,15 +51,15 @@ Available properties: `BINARY`
*** ***
<a name="text"></a> <a name="text"></a>
## `TEXT` ## `TEXT()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L330) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L108)
An unlimited length text column An unlimited length text column
*** ***
<a name="integer"></a> <a name="integer"></a>
## `INTEGER` ## `INTEGER()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L338) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L168)
A 32 bit integer. A 32 bit integer.
Available properties: `UNSIGNED`, `ZEROFILL` Available properties: `UNSIGNED`, `ZEROFILL`
...@@ -68,8 +68,8 @@ Available properties: `UNSIGNED`, `ZEROFILL` ...@@ -68,8 +68,8 @@ Available properties: `UNSIGNED`, `ZEROFILL`
*** ***
<a name="bigint"></a> <a name="bigint"></a>
## `BIGINT` ## `BIGINT()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L346) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L187)
A 64 bit integer. A 64 bit integer.
Available properties: `UNSIGNED`, `ZEROFILL` Available properties: `UNSIGNED`, `ZEROFILL`
...@@ -77,114 +77,114 @@ Available properties: `UNSIGNED`, `ZEROFILL` ...@@ -77,114 +77,114 @@ Available properties: `UNSIGNED`, `ZEROFILL`
*** ***
<a name="float"></a>
## `FLOAT()`
[View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L206)
Floating point number. Accepts one or two arguments for precision
Available properties: `UNSIGNED`, `ZEROFILL`
***
<a name="decimal"></a>
## `DECIMAL()`
[View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L225)
Decimal number. Accepts one or two arguments for precision
Available properties: `UNSIGNED`, `ZEROFILL`
***
<a name="boolean"></a>
## `BOOLEAN()`
[View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L248)
A boolean / tinyint column, depending on dialect
***
<a name="time"></a> <a name="time"></a>
## `TIME` ## `TIME()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L351) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L264)
A time column A time column
*** ***
<a name="date"></a> <a name="date"></a>
## `DATE` ## `DATE()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L356) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L279)
A datetime column A datetime column
*** ***
<a name="dateonly"></a> <a name="dateonly"></a>
## `DATEONLY` ## `DATEONLY()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L361) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L295)
A date only column A date only column
*** ***
<a name="boolean"></a> <a name="hstore"></a>
## `BOOLEAN` ## `HSTORE()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L366) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L311)
A boolean / tinyint column, depending on dialect A key / value column. Only available in postgres.
*** ***
<a name="float"></a> <a name="json"></a>
## `FLOAT` ## `JSON()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L374) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L323)
Floating point number. Accepts one or two arguments for precision A JSON string column. Only available in postgres.
Available properties: `UNSIGNED`, `ZEROFILL` ***
<a name="jsonb"></a>
## `JSONB()`
[View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L335)
A pre-processed JSON data column. Only available in postgres.
*** ***
<a name="now"></a> <a name="now"></a>
## `NOW` ## `NOW()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L379) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L347)
A default value of the current timestamp A default value of the current timestamp
*** ***
<a name="blob"></a> <a name="blob"></a>
## `BLOB` ## `BLOB()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L385) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L361)
Binary storage. Available lengths: `tiny`, `medium`, `long` Binary storage. Available lengths: `tiny`, `medium`, `long`
*** ***
<a name="decimal"></a>
## `DECIMAL`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L393)
Decimal number. Accepts one or two arguments for precision
Available properties: `UNSIGNED`, `ZEROFILL`
***
<a name="uuid"></a> <a name="uuid"></a>
## `UUID` ## `UUID()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L398) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L388)
A column storing a unique univeral identifier. Use with `UUIDV1` or `UUIDV4` for default values. A column storing a unique univeral identifier. Use with `UUIDV1` or `UUIDV4` for default values.
*** ***
<a name="uuidv1"></a> <a name="uuidv1"></a>
## `UUIDV1` ## `UUIDV1()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L403) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L401)
A default unique universal identifier generated following the UUID v1 standard A default unique universal identifier generated following the UUID v1 standard
*** ***
<a name="uuidv4"></a> <a name="uuidv4"></a>
## `UUIDV4` ## `UUIDV4()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L408) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L414)
A default unique universal identifier generated following the UUID v2 standard A default unique universal identifier generated following the UUID v2 standard
*** ***
<a name="hstore"></a>
## `HSTORE`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L414)
A key / value column. Only available in postgres.
***
<a name="json"></a>
## `JSON`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L420)
A JSON string column. Only available in postgres.
***
<a name="jsonb"></a>
## `JSONB`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L426)
A pre-processed JSON data column. Only available in postgres.
***
<a name="virtual"></a> <a name="virtual"></a>
## `VIRTUAL` ## `VIRTUAL()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L456) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L450)
A virtual value that is not stored in the DB. This could for example be useful if you want to provide a default value in your model A virtual value that is not stored in the DB. This could for example be useful if you want to provide a default value in your model
that is returned to the user but not stored in the DB. that is returned to the user but not stored in the DB.
...@@ -214,8 +214,8 @@ __Aliases:__ NONE ...@@ -214,8 +214,8 @@ __Aliases:__ NONE
*** ***
<a name="enum"></a> <a name="enum"></a>
## `ENUM` ## `ENUM()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L464) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L463)
An enumeration. `DataTypes.ENUM('value', 'another value')`. An enumeration. `DataTypes.ENUM('value', 'another value')`.
...@@ -223,7 +223,7 @@ An enumeration. `DataTypes.ENUM('value', 'another value')`. ...@@ -223,7 +223,7 @@ An enumeration. `DataTypes.ENUM('value', 'another value')`.
<a name="array"></a> <a name="array"></a>
## `ARRAY()` ## `ARRAY()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/data-types.js#L484) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/data-types.js#L480)
An array of `type`, e.g. `DataTypes.ARRAY(DataTypes.DECIMAL)`. Only available in postgres. An array of `type`, e.g. `DataTypes.ARRAY(DataTypes.DECIMAL)`. Only available in postgres.
*** ***
......
docs/api/errors.md
<a name="errors"></a> <a name="errors"></a>
# Class Errors # Class Errors
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L11) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L11)
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. 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. All sequelize errors inherit from the base JS error object.
...@@ -9,7 +9,7 @@ All sequelize errors inherit from the base JS error object. ...@@ -9,7 +9,7 @@ All sequelize errors inherit from the base JS error object.
<a name="baseerror"></a> <a name="baseerror"></a>
## `new BaseError()` ## `new BaseError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L20) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L20)
The Base Error all Sequelize Errors inherit from. The Base Error all Sequelize Errors inherit from.
__Aliases:__ Error __Aliases:__ Error
...@@ -18,7 +18,7 @@ __Aliases:__ Error ...@@ -18,7 +18,7 @@ __Aliases:__ Error
<a name="validationerror"></a> <a name="validationerror"></a>
## `new ValidationError(message, [errors])` ## `new ValidationError(message, [errors])`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L40) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L40)
Validation Error. Thrown when the sequelize validation has failed. The error contains an `errors` property, 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. which is an array with 1 or more ValidationErrorItems, one for each validation that failed.
...@@ -37,7 +37,7 @@ __Extends:__ BaseError ...@@ -37,7 +37,7 @@ __Extends:__ BaseError
<a name="get"></a> <a name="get"></a>
## `get(path)` ## `get(path)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L53) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L53)
Gets all validation error items for the path / field specified. Gets all validation error items for the path / field specified.
...@@ -52,14 +52,14 @@ Gets all validation error items for the path / field specified. ...@@ -52,14 +52,14 @@ Gets all validation error items for the path / field specified.
<a name="errors"></a> <a name="errors"></a>
## `errors()` ## `errors()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L67) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L67)
An array of ValidationErrorItems An array of ValidationErrorItems
*** ***
<a name="databaseerror"></a> <a name="databaseerror"></a>
## `new DatabaseError()` ## `new DatabaseError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L74) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L74)
A base class for all database related errors. A base class for all database related errors.
__Extends:__ BaseError __Extends:__ BaseError
...@@ -68,21 +68,21 @@ __Extends:__ BaseError ...@@ -68,21 +68,21 @@ __Extends:__ BaseError
<a name="parent"></a> <a name="parent"></a>
## `parent()` ## `parent()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L89) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L89)
The database specific error which triggered this one The database specific error which triggered this one
*** ***
<a name="sql"></a> <a name="sql"></a>
## `sql()` ## `sql()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L95) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L95)
The SQL that triggered the error The SQL that triggered the error
*** ***
<a name="timeouterror"></a> <a name="timeouterror"></a>
## `new TimeoutError()` ## `new TimeoutError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L102) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L102)
Thrown when a database query times out because of a deadlock Thrown when a database query times out because of a deadlock
__Extends:__ DatabaseError __Extends:__ DatabaseError
...@@ -91,7 +91,7 @@ __Extends:__ DatabaseError ...@@ -91,7 +91,7 @@ __Extends:__ DatabaseError
<a name="uniqueconstrainterror"></a> <a name="uniqueconstrainterror"></a>
## `new UniqueConstraintError()` ## `new UniqueConstraintError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L113) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L113)
Thrown when a unique constraint is violated in the database Thrown when a unique constraint is violated in the database
__Extends:__ DatabaseError __Extends:__ DatabaseError
...@@ -100,7 +100,7 @@ __Extends:__ DatabaseError ...@@ -100,7 +100,7 @@ __Extends:__ DatabaseError
<a name="foreignkeyconstrainterror"></a> <a name="foreignkeyconstrainterror"></a>
## `new ForeignKeyConstraintError()` ## `new ForeignKeyConstraintError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L132) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L132)
Thrown when a foreign key constraint is violated in the database Thrown when a foreign key constraint is violated in the database
__Extends:__ DatabaseError __Extends:__ DatabaseError
...@@ -109,35 +109,35 @@ __Extends:__ DatabaseError ...@@ -109,35 +109,35 @@ __Extends:__ DatabaseError
<a name="message"></a> <a name="message"></a>
## `message()` ## `message()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L152) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L152)
The message from the DB. The message from the DB.
*** ***
<a name="fields"></a> <a name="fields"></a>
## `fields()` ## `fields()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L158) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L158)
The fields of the unique constraint The fields of the unique constraint
*** ***
<a name="value"></a> <a name="value"></a>
## `value()` ## `value()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L164) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L164)
The value(s) which triggered the error The value(s) which triggered the error
*** ***
<a name="index"></a> <a name="index"></a>
## `index()` ## `index()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L170) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L170)
The name of the index that triggered the error The name of the index that triggered the error
*** ***
<a name="validationerroritem"></a> <a name="validationerroritem"></a>
## `new ValidationErrorItem(message, type, path, value)` ## `new ValidationErrorItem(message, type, path, value)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L182) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L182)
Validation Error Item Validation Error Item
Instances of this class are included in the `ValidationError.errors` property. Instances of this class are included in the `ValidationError.errors` property.
...@@ -156,7 +156,7 @@ Instances of this class are included in the `ValidationError.errors` property. ...@@ -156,7 +156,7 @@ Instances of this class are included in the `ValidationError.errors` property.
<a name="connectionerror"></a> <a name="connectionerror"></a>
## `new ConnectionError()` ## `new ConnectionError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L194) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L194)
A base class for all connection related errors. A base class for all connection related errors.
__Extends:__ BaseError __Extends:__ BaseError
...@@ -165,14 +165,14 @@ __Extends:__ BaseError ...@@ -165,14 +165,14 @@ __Extends:__ BaseError
<a name="parent"></a> <a name="parent"></a>
## `parent()` ## `parent()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L208) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L208)
The connection specific error which triggered this one The connection specific error which triggered this one
*** ***
<a name="connectionrefusederror"></a> <a name="connectionrefusederror"></a>
## `new ConnectionRefusedError()` ## `new ConnectionRefusedError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L215) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L215)
Thrown when a connection to a database is refused Thrown when a connection to a database is refused
__Extends:__ ConnectionError __Extends:__ ConnectionError
...@@ -181,7 +181,7 @@ __Extends:__ ConnectionError ...@@ -181,7 +181,7 @@ __Extends:__ ConnectionError
<a name="accessdeniederror"></a> <a name="accessdeniederror"></a>
## `new AccessDeniedError()` ## `new AccessDeniedError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L226) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L226)
Thrown when a connection to a database is refused due to insufficient privileges Thrown when a connection to a database is refused due to insufficient privileges
__Extends:__ ConnectionError __Extends:__ ConnectionError
...@@ -190,7 +190,7 @@ __Extends:__ ConnectionError ...@@ -190,7 +190,7 @@ __Extends:__ ConnectionError
<a name="hostnotfounderror"></a> <a name="hostnotfounderror"></a>
## `new HostNotFoundError()` ## `new HostNotFoundError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L237) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L237)
Thrown when a connection to a database has a hostname that was not found Thrown when a connection to a database has a hostname that was not found
__Extends:__ ConnectionError __Extends:__ ConnectionError
...@@ -199,7 +199,7 @@ __Extends:__ ConnectionError ...@@ -199,7 +199,7 @@ __Extends:__ ConnectionError
<a name="hostnotreachableerror"></a> <a name="hostnotreachableerror"></a>
## `new HostNotReachableError()` ## `new HostNotReachableError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L248) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L248)
Thrown when a connection to a database has a hostname that was not reachable Thrown when a connection to a database has a hostname that was not reachable
__Extends:__ ConnectionError __Extends:__ ConnectionError
...@@ -208,7 +208,7 @@ __Extends:__ ConnectionError ...@@ -208,7 +208,7 @@ __Extends:__ ConnectionError
<a name="invalidconnectionerror"></a> <a name="invalidconnectionerror"></a>
## `new InvalidConnectionError()` ## `new InvalidConnectionError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L259) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L259)
Thrown when a connection to a database has invalid values for any of the connection parameters Thrown when a connection to a database has invalid values for any of the connection parameters
__Extends:__ ConnectionError __Extends:__ ConnectionError
...@@ -217,7 +217,7 @@ __Extends:__ ConnectionError ...@@ -217,7 +217,7 @@ __Extends:__ ConnectionError
<a name="connectiontimedouterror"></a> <a name="connectiontimedouterror"></a>
## `new ConnectionTimedOutError()` ## `new ConnectionTimedOutError()`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/errors.js#L270) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/errors.js#L270)
Thrown when a connection to a database times out Thrown when a connection to a database times out
__Extends:__ ConnectionError __Extends:__ ConnectionError
......
docs/api/hooks.md
<a name="hooks"></a> <a name="hooks"></a>
# Mixin Hooks # Mixin Hooks
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L37) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L37)
Hooks are function that are called before and after (bulk-) creation/updating/deletion and validation. Hooks can be added to you models in three ways: Hooks are function that are called before and after (bulk-) creation/updating/deletion and validation. Hooks can be added to you models in three ways:
1. By specifying them as options in `sequelize.define` 1. By specifying them as options in `sequelize.define`
...@@ -31,14 +31,14 @@ Model.afterBulkUpdate(function () {}) ...@@ -31,14 +31,14 @@ Model.afterBulkUpdate(function () {})
**See:** **See:**
* [Sequelize#define](sequelize#define) * [Sequelize#define](api/sequelize#define)
*** ***
<a name="addhook"></a> <a name="addhook"></a>
## `addHook(hooktype, [name], fn)` ## `addHook(hooktype, [name], fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L149) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L149)
Add a hook to the model Add a hook to the model
...@@ -56,7 +56,7 @@ __Aliases:__ hook ...@@ -56,7 +56,7 @@ __Aliases:__ hook
<a name="hashook"></a> <a name="hashook"></a>
## `hasHook(hookType)` ## `hasHook(hookType)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L171) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L171)
Check whether the mode has any hooks of this type Check whether the mode has any hooks of this type
...@@ -72,7 +72,7 @@ __Aliases:__ hasHooks ...@@ -72,7 +72,7 @@ __Aliases:__ hasHooks
<a name="beforevalidate"></a> <a name="beforevalidate"></a>
## `beforeValidate(name, fn)` ## `beforeValidate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L181) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L181)
A hook that is run before validation A hook that is run before validation
**Params:** **Params:**
...@@ -87,7 +87,7 @@ A hook that is run before validation ...@@ -87,7 +87,7 @@ A hook that is run before validation
<a name="aftervalidate"></a> <a name="aftervalidate"></a>
## `afterValidate(name, fn)` ## `afterValidate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L190) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L190)
A hook that is run after validation A hook that is run after validation
**Params:** **Params:**
...@@ -102,7 +102,7 @@ A hook that is run after validation ...@@ -102,7 +102,7 @@ A hook that is run after validation
<a name="beforecreate"></a> <a name="beforecreate"></a>
## `beforeCreate(name, fn)` ## `beforeCreate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L199) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L199)
A hook that is run before creating a single instance A hook that is run before creating a single instance
**Params:** **Params:**
...@@ -117,7 +117,7 @@ A hook that is run before creating a single instance ...@@ -117,7 +117,7 @@ A hook that is run before creating a single instance
<a name="aftercreate"></a> <a name="aftercreate"></a>
## `afterCreate(name, fn)` ## `afterCreate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L208) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L208)
A hook that is run after creating a single instance A hook that is run after creating a single instance
**Params:** **Params:**
...@@ -132,7 +132,7 @@ A hook that is run after creating a single instance ...@@ -132,7 +132,7 @@ A hook that is run after creating a single instance
<a name="beforedestroy"></a> <a name="beforedestroy"></a>
## `beforeDestroy(name, fn)` ## `beforeDestroy(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L219) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L219)
A hook that is run before destroying a single instance A hook that is run before destroying a single instance
**Params:** **Params:**
...@@ -148,7 +148,7 @@ __Aliases:__ beforeDelete ...@@ -148,7 +148,7 @@ __Aliases:__ beforeDelete
<a name="afterdestroy"></a> <a name="afterdestroy"></a>
## `afterDestroy(name, fn)` ## `afterDestroy(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L234) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L234)
A hook that is run after destroying a single instance A hook that is run after destroying a single instance
**Params:** **Params:**
...@@ -164,7 +164,7 @@ __Aliases:__ afterDelete ...@@ -164,7 +164,7 @@ __Aliases:__ afterDelete
<a name="beforeupdate"></a> <a name="beforeupdate"></a>
## `beforeUpdate(name, fn)` ## `beforeUpdate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L247) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L247)
A hook that is run before updating a single instance A hook that is run before updating a single instance
**Params:** **Params:**
...@@ -179,7 +179,7 @@ A hook that is run before updating a single instance ...@@ -179,7 +179,7 @@ A hook that is run before updating a single instance
<a name="afterupdate"></a> <a name="afterupdate"></a>
## `afterUpdate(name, fn)` ## `afterUpdate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L256) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L256)
A hook that is run after updating a single instance A hook that is run after updating a single instance
**Params:** **Params:**
...@@ -194,7 +194,7 @@ A hook that is run after updating a single instance ...@@ -194,7 +194,7 @@ A hook that is run after updating a single instance
<a name="beforebulkcreate"></a> <a name="beforebulkcreate"></a>
## `beforeBulkCreate(name, fn)` ## `beforeBulkCreate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L265) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L265)
A hook that is run before creating instances in bulk A hook that is run before creating instances in bulk
**Params:** **Params:**
...@@ -209,7 +209,7 @@ A hook that is run before creating instances in bulk ...@@ -209,7 +209,7 @@ A hook that is run before creating instances in bulk
<a name="afterbulkcreate"></a> <a name="afterbulkcreate"></a>
## `afterBulkCreate(name, fn)` ## `afterBulkCreate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L274) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L274)
A hook that is run after creating instances in bulk A hook that is run after creating instances in bulk
**Params:** **Params:**
...@@ -224,7 +224,7 @@ A hook that is run after creating instances in bulk ...@@ -224,7 +224,7 @@ A hook that is run after creating instances in bulk
<a name="beforebulkdestroy"></a> <a name="beforebulkdestroy"></a>
## `beforeBulkDestroy(name, fn)` ## `beforeBulkDestroy(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L285) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L285)
A hook that is run before destroying instances in bulk A hook that is run before destroying instances in bulk
**Params:** **Params:**
...@@ -240,7 +240,7 @@ __Aliases:__ beforeBulkDelete ...@@ -240,7 +240,7 @@ __Aliases:__ beforeBulkDelete
<a name="afterbulkdestroy"></a> <a name="afterbulkdestroy"></a>
## `afterBulkDestroy(name, fn)` ## `afterBulkDestroy(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L300) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L300)
A hook that is run after destroying instances in bulk A hook that is run after destroying instances in bulk
**Params:** **Params:**
...@@ -256,7 +256,7 @@ __Aliases:__ afterBulkDelete ...@@ -256,7 +256,7 @@ __Aliases:__ afterBulkDelete
<a name="beforebulkupdate"></a> <a name="beforebulkupdate"></a>
## `beforeBulkUpdate(name, fn)` ## `beforeBulkUpdate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L313) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L313)
A hook that is run after updating instances in bulk A hook that is run after updating instances in bulk
**Params:** **Params:**
...@@ -271,7 +271,7 @@ A hook that is run after updating instances in bulk ...@@ -271,7 +271,7 @@ A hook that is run after updating instances in bulk
<a name="afterbulkupdate"></a> <a name="afterbulkupdate"></a>
## `afterBulkUpdate(name, fn)` ## `afterBulkUpdate(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L322) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L322)
A hook that is run after updating instances in bulk A hook that is run after updating instances in bulk
**Params:** **Params:**
...@@ -286,7 +286,7 @@ A hook that is run after updating instances in bulk ...@@ -286,7 +286,7 @@ A hook that is run after updating instances in bulk
<a name="beforefind"></a> <a name="beforefind"></a>
## `beforeFind(name, fn)` ## `beforeFind(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L331) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L331)
A hook that is run before a find (select) query A hook that is run before a find (select) query
**Params:** **Params:**
...@@ -301,7 +301,7 @@ A hook that is run before a find (select) query ...@@ -301,7 +301,7 @@ A hook that is run before a find (select) query
<a name="beforefindafterexpandincludeall"></a> <a name="beforefindafterexpandincludeall"></a>
## `beforeFindAfterExpandIncludeAll(name, fn)` ## `beforeFindAfterExpandIncludeAll(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L340) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L340)
A hook that is run before a find (select) query, after any { include: {all: ...} } options are expanded A hook that is run before a find (select) query, after any { include: {all: ...} } options are expanded
**Params:** **Params:**
...@@ -316,7 +316,7 @@ A hook that is run before a find (select) query, after any { include: {all: ...} ...@@ -316,7 +316,7 @@ A hook that is run before a find (select) query, after any { include: {all: ...}
<a name="beforefindafteroptions"></a> <a name="beforefindafteroptions"></a>
## `beforeFindAfterOptions(name, fn)` ## `beforeFindAfterOptions(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L349) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L349)
A hook that is run before a find (select) query, after all option parsing is complete A hook that is run before a find (select) query, after all option parsing is complete
**Params:** **Params:**
...@@ -331,7 +331,7 @@ A hook that is run before a find (select) query, after all option parsing is com ...@@ -331,7 +331,7 @@ A hook that is run before a find (select) query, after all option parsing is com
<a name="afterfind"></a> <a name="afterfind"></a>
## `afterFind(name, fn)` ## `afterFind(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L358) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L358)
A hook that is run after a find (select) query A hook that is run after a find (select) query
**Params:** **Params:**
...@@ -346,7 +346,7 @@ A hook that is run after a find (select) query ...@@ -346,7 +346,7 @@ A hook that is run after a find (select) query
<a name="beforedefine"></a> <a name="beforedefine"></a>
## `beforeDefine(name, fn)` ## `beforeDefine(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L367) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L367)
A hook that is run before a define call A hook that is run before a define call
**Params:** **Params:**
...@@ -361,7 +361,7 @@ A hook that is run before a define call ...@@ -361,7 +361,7 @@ A hook that is run before a define call
<a name="afterdefine"></a> <a name="afterdefine"></a>
## `afterDefine(name, fn)` ## `afterDefine(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L376) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L376)
A hook that is run after a define call A hook that is run after a define call
**Params:** **Params:**
...@@ -376,7 +376,7 @@ A hook that is run after a define call ...@@ -376,7 +376,7 @@ A hook that is run after a define call
<a name="beforeinit"></a> <a name="beforeinit"></a>
## `beforeInit(name, fn)` ## `beforeInit(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L385) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L385)
A hook that is run before Sequelize() call A hook that is run before Sequelize() call
**Params:** **Params:**
...@@ -391,7 +391,7 @@ A hook that is run before Sequelize() call ...@@ -391,7 +391,7 @@ A hook that is run before Sequelize() call
<a name="afterinit"></a> <a name="afterinit"></a>
## `afterInit(name, fn)` ## `afterInit(name, fn)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/hooks.js#L394) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/hooks.js#L394)
A hook that is run after Sequelize() call A hook that is run after Sequelize() call
**Params:** **Params:**
......
docs/api/instance.md
<a name="instance"></a> <a name="instance"></a>
# Class Instance # Class Instance
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L32) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L32)
This class represents an single instance, a database row. You might see it referred to as both Instance and instance. You should not This class represents an single instance, a database row. You might see it referred to as both Instance and instance. You should not
instantiate the Instance class directly, instead you access it using the finder and creation methods on the model. instantiate the Instance class directly, instead you access it using the finder and creation methods on the model.
...@@ -19,77 +19,77 @@ Accessing properties directly or using `get` is preferred for regular use, `getD ...@@ -19,77 +19,77 @@ Accessing properties directly or using `get` is preferred for regular use, `getD
**See:** **See:**
* [Sequelize#define](sequelize#define) * [Sequelize#define](api/sequelize#define)
*** ***
<a name="isnewrecord"></a> <a name="isnewrecord"></a>
## `isNewRecord` -> `Boolean` ## `isNewRecord` -> `Boolean`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L44) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L44)
Returns true if this instance has not yet been persisted to the database Returns true if this instance has not yet been persisted to the database
*** ***
<a name="model"></a> <a name="model"></a>
## `Model()` -> `Model` ## `Model()` -> `Model`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L53) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L53)
Returns the Model the instance was created from. Returns the Model the instance was created from.
**See:** **See:**
* [Model](model) * [Model](api/model)
*** ***
<a name="sequelize"></a> <a name="sequelize"></a>
## `sequelize()` -> `Sequelize` ## `sequelize()` -> `Sequelize`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L62) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L62)
A reference to the sequelize instance A reference to the sequelize instance
**See:** **See:**
* [Sequelize](sequelize) * [Sequelize](api/sequelize)
*** ***
<a name="isdeleted"></a> <a name="isdeleted"></a>
## `isDeleted()` -> `Boolean` ## `isDeleted()` -> `Boolean`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L75) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L75)
If timestamps and paranoid are enabled, returns whether the deletedAt timestamp of this instance is set. Otherwise, always returns false. If timestamps and paranoid are enabled, returns whether the deletedAt timestamp of this instance is set. Otherwise, always returns false.
*** ***
<a name="values"></a> <a name="values"></a>
## `values()` -> `Object` ## `values()` -> `Object`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L87) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L87)
Get the values of this Instance. Proxies to `this.get` Get the values of this Instance. Proxies to `this.get`
**See:** **See:**
* [Instance#get](instance#get) * [Instance#get](api/instance#get)
*** ***
<a name="isdirty"></a> <a name="isdirty"></a>
## `isDirty()` -> `Boolean` ## `isDirty()` -> `Boolean`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L100) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L100)
A getter for `this.changed()`. Returns true if any keys have changed. A getter for `this.changed()`. Returns true if any keys have changed.
**See:** **See:**
* [Instance#changed](instance#changed) * [Instance#changed](api/instance#changed)
*** ***
<a name="primarykeyvalues"></a> <a name="primarykeyvalues"></a>
## `primaryKeyValues()` -> `Object` ## `primaryKeyValues()` -> `Object`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L112) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L112)
Get the values of the primary keys of this instance. Get the values of the primary keys of this instance.
...@@ -97,7 +97,7 @@ Get the values of the primary keys of this instance. ...@@ -97,7 +97,7 @@ Get the values of the primary keys of this instance.
<a name="getdatavalue"></a> <a name="getdatavalue"></a>
## `getDataValue(key)` -> `any` ## `getDataValue(key)` -> `any`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L148) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L148)
Get the value of the underlying data value Get the value of the underlying data value
...@@ -112,7 +112,7 @@ Get the value of the underlying data value ...@@ -112,7 +112,7 @@ Get the value of the underlying data value
<a name="setdatavalue"></a> <a name="setdatavalue"></a>
## `setDataValue(key, value)` ## `setDataValue(key, value)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L158) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L158)
Update the underlying data value Update the underlying data value
...@@ -128,7 +128,7 @@ Update the underlying data value ...@@ -128,7 +128,7 @@ Update the underlying data value
<a name="get"></a> <a name="get"></a>
## `get([key], [options])` -> `Object|any` ## `get([key], [options])` -> `Object|any`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L172) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L172)
If no key is given, returns all values of the instance, also invoking virtual getters. If no key is given, returns all values of the instance, also invoking virtual getters.
If key is given and a field or virtual getter is present for the key it will call that getter - else it will return the value for key. If key is given and a field or virtual getter is present for the key it will call that getter - else it will return the value for key.
...@@ -147,7 +147,7 @@ If key is given and a field or virtual getter is present for the key it will cal ...@@ -147,7 +147,7 @@ If key is given and a field or virtual getter is present for the key it will cal
<a name="set"></a> <a name="set"></a>
## `set(key, value, [options])` ## `set(key, value, [options])`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L251) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L251)
Set is used to update values on the instance (the sequelize representation of the instance that is, remember that nothing will be persisted before you actually call `save`). Set is used to update values on the instance (the sequelize representation of the instance that is, remember that nothing will be persisted before you actually call `save`).
In its most basic form `set` will update a value stored in the underlying `dataValues` object. However, if a custom setter function is defined for the key, that function In its most basic form `set` will update a value stored in the underlying `dataValues` object. However, if a custom setter function is defined for the key, that function
will be called instead. To bypass the setter, you can pass `raw: true` in the options object. will be called instead. To bypass the setter, you can pass `raw: true` in the options object.
...@@ -162,7 +162,7 @@ Set can also be used to build instances for associations, if you have values for ...@@ -162,7 +162,7 @@ Set can also be used to build instances for associations, if you have values for
**See:** **See:**
* [Model#find](model#find) * [Model#find](api/model#find)
**Params:** **Params:**
...@@ -182,7 +182,7 @@ __Aliases:__ setAttributes ...@@ -182,7 +182,7 @@ __Aliases:__ setAttributes
<a name="changed"></a> <a name="changed"></a>
## `changed([key])` -> `Boolean|Array` ## `changed([key])` -> `Boolean|Array`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L377) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L385)
If changed is called with a string it will return a boolean indicating whether the value of that key in `dataValues` is different from the value in `_previousDataValues`. If changed is called with a string it will return a boolean indicating whether the value of that key in `dataValues` is different from the value in `_previousDataValues`.
If changed is called without an argument, it will return an array of keys that have changed. If changed is called without an argument, it will return an array of keys that have changed.
...@@ -199,7 +199,7 @@ If changed is called without an argument, it will return an array of keys that h ...@@ -199,7 +199,7 @@ If changed is called without an argument, it will return an array of keys that h
<a name="previous"></a> <a name="previous"></a>
## `previous(key)` -> `any` ## `previous(key)` -> `any`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L396) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L404)
Returns the previous value for key from `_previousDataValues`. Returns the previous value for key from `_previousDataValues`.
**Params:** **Params:**
...@@ -213,7 +213,7 @@ Returns the previous value for key from `_previousDataValues`. ...@@ -213,7 +213,7 @@ Returns the previous value for key from `_previousDataValues`.
<a name="save"></a> <a name="save"></a>
## `save([options])` -> `Promise<this|Errors.ValidationError>` ## `save([options])` -> `Promise<this|Errors.ValidationError>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L457) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L465)
Validate this instance, and if the validation passes, persist it to the database. Validate this instance, and if the validation passes, persist it to the database.
On success, the callback will be called with this instance. On validation error, the callback will be called with an instance of `Sequelize.ValidationError`. On success, the callback will be called with this instance. On validation error, the callback will be called with an instance of `Sequelize.ValidationError`.
...@@ -235,7 +235,7 @@ This error will have a property for each of the fields for which validation fail ...@@ -235,7 +235,7 @@ This error will have a property for each of the fields for which validation fail
<a name="reload"></a> <a name="reload"></a>
## `reload([options])` -> `Promise<this>` ## `reload([options])` -> `Promise<this>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L675) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L647)
Refresh the current instance in-place, i.e. update the object with current data from the DB and return the same object. Refresh the current instance in-place, i.e. update the object with current data from the DB and return the same object.
This is different from doing a `find(Instance.id)`, because that would create and return a new instance. With this method, This is different from doing a `find(Instance.id)`, because that would create and return a new instance. With this method,
all references to the Instance are updated with the new data and no new objects are created. all references to the Instance are updated with the new data and no new objects are created.
...@@ -243,7 +243,7 @@ all references to the Instance are updated with the new data and no new objects ...@@ -243,7 +243,7 @@ all references to the Instance are updated with the new data and no new objects
**See:** **See:**
* [Model#find](model#find) * [Model#find](api/model#find)
**Params:** **Params:**
...@@ -257,7 +257,7 @@ all references to the Instance are updated with the new data and no new objects ...@@ -257,7 +257,7 @@ all references to the Instance are updated with the new data and no new objects
<a name="validate"></a> <a name="validate"></a>
## `validate([options])` -> `Promise<undefined|Errors.ValidationError>` ## `validate([options])` -> `Promise<undefined|Errors.ValidationError>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L702) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L674)
Validate the attribute of this instance according to validation rules set in the model definition. Validate the attribute of this instance according to validation rules set in the model definition.
Emits null if and only if validation successful; otherwise an Error instance containing { field name : [error msgs] } entries. Emits null if and only if validation successful; otherwise an Error instance containing { field name : [error msgs] } entries.
...@@ -265,7 +265,7 @@ Emits null if and only if validation successful; otherwise an Error instance con ...@@ -265,7 +265,7 @@ Emits null if and only if validation successful; otherwise an Error instance con
**See:** **See:**
* [InstanceValidator](instancevalidator) * [InstanceValidator](api/instancevalidator)
**Params:** **Params:**
...@@ -280,14 +280,14 @@ Emits null if and only if validation successful; otherwise an Error instance con ...@@ -280,14 +280,14 @@ Emits null if and only if validation successful; otherwise an Error instance con
<a name="update"></a> <a name="update"></a>
## `update(updates, options)` -> `Promise<this>` ## `update(updates, options)` -> `Promise<this>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L721) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L693)
This is the same as calling `set` and then calling `save`. This is the same as calling `set` and then calling `save`.
**See:** **See:**
* [Instance#set](instance#set) * [Instance#set](api/instance#set)
* [Instance#save](instance#save) * [Instance#save](api/instance#save)
**Params:** **Params:**
...@@ -303,7 +303,7 @@ __Aliases:__ updateAttributes ...@@ -303,7 +303,7 @@ __Aliases:__ updateAttributes
<a name="destroy"></a> <a name="destroy"></a>
## `destroy([options={}])` -> `Promise<undefined>` ## `destroy([options={}])` -> `Promise<undefined>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L745) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L717)
Destroy the row corresponding to this instance. Depending on your setting for paranoid, the row will either be completely deleted, or have its deletedAt timestamp set to the current time. Destroy the row corresponding to this instance. Depending on your setting for paranoid, the row will either be completely deleted, or have its deletedAt timestamp set to the current time.
...@@ -320,7 +320,7 @@ Destroy the row corresponding to this instance. Depending on your setting for pa ...@@ -320,7 +320,7 @@ Destroy the row corresponding to this instance. Depending on your setting for pa
<a name="restore"></a> <a name="restore"></a>
## `restore([options={}])` -> `Promise<undefined>` ## `restore([options={}])` -> `Promise<undefined>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L788) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L760)
Restore the row corresponding to this instance. Only available for paranoid models. Restore the row corresponding to this instance. Only available for paranoid models.
...@@ -336,7 +336,7 @@ Restore the row corresponding to this instance. Only available for paranoid mode ...@@ -336,7 +336,7 @@ Restore the row corresponding to this instance. Only available for paranoid mode
<a name="increment"></a> <a name="increment"></a>
## `increment(fields, [options])` -> `Promise<this>` ## `increment(fields, [options])` -> `Promise<this>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L836) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L808)
Increment the value of one or more columns. This is done in the database, which means it does not use the values currently stored on the Instance. The increment is done using a Increment the value of one or more columns. This is done in the database, which means it does not use the values currently stored on the Instance. The increment is done using a
```sql ```sql
SET column = column + X SET column = column + X
...@@ -353,14 +353,14 @@ instance.increment({ answer: 42, tries: 1}, { by: 2 }) // increment answer by 42 ...@@ -353,14 +353,14 @@ instance.increment({ answer: 42, tries: 1}, { by: 2 }) // increment answer by 42
**See:** **See:**
* [Instance#reload](instance#reload) * [Instance#reload](api/instance#reload)
**Params:** **Params:**
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| fields | String &#124; Array|Object | If a string is provided, that column is incremented by the value of `by` given in options. If an array is provided, the same is true for each column. If and object is provided, each column is incremented by the value given | | fields | String &#124; Array &#124; Object | If a string is provided, that column is incremented by the value of `by` given in options. If an array is provided, the same is true for each column. If and object is provided, each column is incremented by the value given |
| [options] | Object | | | [options] | Object | |
| [options.by=1] | Integer | The number to increment by | | [options.by=1] | Integer | The number to increment by |
| [options.transaction] | Transaction | | | [options.transaction] | Transaction | |
...@@ -370,7 +370,7 @@ instance.increment({ answer: 42, tries: 1}, { by: 2 }) // increment answer by 42 ...@@ -370,7 +370,7 @@ instance.increment({ answer: 42, tries: 1}, { by: 2 }) // increment answer by 42
<a name="decrement"></a> <a name="decrement"></a>
## `decrement(fields, [options])` -> `Promise` ## `decrement(fields, [options])` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L923) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L895)
Decrement the value of one or more columns. This is done in the database, which means it does not use the values currently stored on the Instance. The decrement is done using a Decrement the value of one or more columns. This is done in the database, which means it does not use the values currently stored on the Instance. The decrement is done using a
```sql ```sql
SET column = column - X SET column = column - X
...@@ -387,14 +387,14 @@ instance.decrement({ answer: 42, tries: 1}, { by: 2 }) // decrement answer by 42 ...@@ -387,14 +387,14 @@ instance.decrement({ answer: 42, tries: 1}, { by: 2 }) // decrement answer by 42
**See:** **See:**
* [Instance#reload](instance#reload) * [Instance#reload](api/instance#reload)
**Params:** **Params:**
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| fields | String &#124; Array|Object | If a string is provided, that column is decremented by the value of `by` given in options. If an array is provided, the same is true for each column. If and object is provided, each column is decremented by the value given | | fields | String &#124; Array &#124; Object | If a string is provided, that column is decremented by the value of `by` given in options. If an array is provided, the same is true for each column. If and object is provided, each column is decremented by the value given |
| [options] | Object | | | [options] | Object | |
| [options.by=1] | Integer | The number to decrement by | | [options.by=1] | Integer | The number to decrement by |
| [options.transaction] | Transaction | | | [options.transaction] | Transaction | |
...@@ -404,7 +404,7 @@ instance.decrement({ answer: 42, tries: 1}, { by: 2 }) // decrement answer by 42 ...@@ -404,7 +404,7 @@ instance.decrement({ answer: 42, tries: 1}, { by: 2 }) // decrement answer by 42
<a name="equals"></a> <a name="equals"></a>
## `equals(other)` -> `Boolean` ## `equals(other)` -> `Boolean`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L957) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L929)
Check whether all values of this and `other` Instance are the same Check whether all values of this and `other` Instance are the same
...@@ -419,7 +419,7 @@ Check whether all values of this and `other` Instance are the same ...@@ -419,7 +419,7 @@ Check whether all values of this and `other` Instance are the same
<a name="equalsoneof"></a> <a name="equalsoneof"></a>
## `equalsOneOf(others)` -> `Boolean` ## `equalsOneOf(others)` -> `Boolean`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L977) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L949)
Check if this is eqaul to one of `others` by calling equals Check if this is eqaul to one of `others` by calling equals
...@@ -434,13 +434,13 @@ Check if this is eqaul to one of `others` by calling equals ...@@ -434,13 +434,13 @@ Check if this is eqaul to one of `others` by calling equals
<a name="tojson"></a> <a name="tojson"></a>
## `toJSON()` -> `object` ## `toJSON()` -> `object`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/instance.js#L995) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/instance.js#L967)
Convert the instance to a JSON representation. Proxies to calling `get` with no keys. This means get all values gotten from the DB, and apply all custom getters. Convert the instance to a JSON representation. Proxies to calling `get` with no keys. This means get all values gotten from the DB, and apply all custom getters.
**See:** **See:**
* [Instance#get](instance#get) * [Instance#get](api/instance#get)
*** ***
......
docs/api/model.md
<a name="model"></a> <a name="model"></a>
# Class Model # Class Model
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L25) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L25)
A Model represents a table in the database. Sometimes you might also see it refererred to as model, or simply as factory. This class should _not_ be instantiated directly, it is created using `sequelize.define`, and already created models can be loaded using `sequelize.import` A Model represents a table in the database. Sometimes you might also see it refererred to as model, or simply as factory. This class should _not_ be instantiated directly, it is created using `sequelize.define`, and already created models can be loaded using `sequelize.import`
### Mixes: ### Mixes:
...@@ -11,7 +11,7 @@ A Model represents a table in the database. Sometimes you might also see it refe ...@@ -11,7 +11,7 @@ A Model represents a table in the database. Sometimes you might also see it refe
<a name="removeattribute"></a> <a name="removeattribute"></a>
## `removeAttribute([attribute])` ## `removeAttribute([attribute])`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L371) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L375)
Remove attribute from model definition Remove attribute from model definition
**Params:** **Params:**
...@@ -25,19 +25,19 @@ Remove attribute from model definition ...@@ -25,19 +25,19 @@ Remove attribute from model definition
<a name="sync"></a> <a name="sync"></a>
## `sync()` -> `Promise<this>` ## `sync()` -> `Promise<this>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L381) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L385)
Sync this Model to the DB, that is create the table. Upon success, the callback will be called with the model instance (this) Sync this Model to the DB, that is create the table. Upon success, the callback will be called with the model instance (this)
**See:** **See:**
* [Sequelize#sync](sequelize#sync) * [Sequelize#sync](api/sequelize#sync)
*** ***
<a name="drop"></a> <a name="drop"></a>
## `drop([options])` -> `Promise` ## `drop([options])` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L417) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L421)
Drop the table represented by this Model Drop the table represented by this Model
**Params:** **Params:**
...@@ -52,7 +52,7 @@ Drop the table represented by this Model ...@@ -52,7 +52,7 @@ Drop the table represented by this Model
<a name="schema"></a> <a name="schema"></a>
## `schema(schema, [options])` -> `this` ## `schema(schema, [options])` -> `this`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L434) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L438)
Apply a schema to this model. For postgres, this will actually place the schema in front of the table name - `"schema"."tableName"`, Apply a schema to this model. For postgres, this will actually place the schema in front of the table name - `"schema"."tableName"`,
while the schema will be prepended to the table name for mysql and sqlite - `'schema.tablename'`. while the schema will be prepended to the table name for mysql and sqlite - `'schema.tablename'`.
...@@ -70,7 +70,7 @@ while the schema will be prepended to the table name for mysql and sqlite - `'sc ...@@ -70,7 +70,7 @@ while the schema will be prepended to the table name for mysql and sqlite - `'sc
<a name="gettablename"></a> <a name="gettablename"></a>
## `getTableName(options)` -> `String|Object` ## `getTableName(options)` -> `String|Object`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L457) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L461)
Get the tablename of the model, taking schema into account. The method will return The name as a string if the model has no schema, Get the tablename of the model, taking schema into account. The method will return The name as a string if the model has no schema,
or an object with `tableName`, `schema` and `delimiter` properties. or an object with `tableName`, `schema` and `delimiter` properties.
...@@ -86,7 +86,7 @@ or an object with `tableName`, `schema` and `delimiter` properties. ...@@ -86,7 +86,7 @@ or an object with `tableName`, `schema` and `delimiter` properties.
<a name="scope"></a> <a name="scope"></a>
## `scope(options*)` -> `Model` ## `scope(options*)` -> `Model`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L500) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L504)
Apply a scope created in `define` to the model. First let's look at how to create scopes: Apply a scope created in `define` to the model. First let's look at how to create scopes:
```js ```js
var Model = sequelize.define('model', attributes, { var Model = sequelize.define('model', attributes, {
...@@ -127,7 +127,7 @@ Model.scope({ method: ['complexFunction' 'dan@sequelize.com', 42]}).findAll() ...@@ -127,7 +127,7 @@ Model.scope({ method: ['complexFunction' 'dan@sequelize.com', 42]}).findAll()
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| options* | Array &#124; Object|String|null | The scope(s) to apply. Scopes can either be passed as consecutive arguments, or as an array of arguments. To apply simple scopes, pass them as strings. For scope function, pass an object, with a `method` property. The value can either be a string, if the method does not take any arguments, or an array, where the first element is the name of the method, and consecutive elements are arguments to that method. Pass null to remove all scopes, including the default. | | options* | Array &#124; Object &#124; String &#124; null | The scope(s) to apply. Scopes can either be passed as consecutive arguments, or as an array of arguments. To apply simple scopes, pass them as strings. For scope function, pass an object, with a `method` property. The value can either be a string, if the method does not take any arguments, or an array, where the first element is the name of the method, and consecutive elements are arguments to that method. Pass null to remove all scopes, including the default. |
__Returns:__ A reference to the model, with the scope(s) applied. Calling scope again on the returned model will clear the previous scope. __Returns:__ A reference to the model, with the scope(s) applied. Calling scope again on the returned model will clear the previous scope.
...@@ -135,7 +135,7 @@ __Returns:__ A reference to the model, with the scope(s) applied. Calling scope ...@@ -135,7 +135,7 @@ __Returns:__ A reference to the model, with the scope(s) applied. Calling scope
<a name="findall"></a> <a name="findall"></a>
## `findAll([options], [queryOptions])` -> `Promise<Array<Instance>>` ## `findAll([options], [queryOptions])` -> `Promise<Array<Instance>>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L675) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L679)
Search for multiple instances. Search for multiple instances.
__Simple search using AND and =__ __Simple search using AND and =__
...@@ -197,7 +197,7 @@ The success listener is called with an array of instances if the query succeeds. ...@@ -197,7 +197,7 @@ The success listener is called with an array of instances if the query succeeds.
**See:** **See:**
* [Sequelize#query](sequelize#query) * [Sequelize#query](api/sequelize#query)
**Params:** **Params:**
...@@ -216,7 +216,7 @@ The success listener is called with an array of instances if the query succeeds. ...@@ -216,7 +216,7 @@ The success listener is called with an array of instances if the query succeeds.
| [options.include[].attributes] | Array&lt;String&gt; | A list of attributes to select from the child model | | [options.include[].attributes] | Array&lt;String&gt; | A list of attributes to select from the child model |
| [options.include[].required] | Boolean | If true, converts to an inner join, which means that the parent model will only be loaded if it has any matching children. True if `include.where` is set, false otherwise. | | [options.include[].required] | Boolean | If true, converts to an inner join, which means that the parent model will only be loaded if it has any matching children. True if `include.where` is set, false otherwise. |
| [options.include[].include] | Array&lt;Object &#124; Model&gt; | Load further nested related models | | [options.include[].include] | Array&lt;Object &#124; Model&gt; | Load further nested related models |
| [options.order] | String &#124; Array|Sequelize.fn | Specifies an ordering. If a string is provided, it will be esacped. Using an array, you can provide several columns / functions to order by. Each element can be further wrapped in a two-element array. The first element is the column / function to order by, the second is the direction. For example: `order: [['name', 'DESC']]`. In this way the column will be escaped, but the direction will not. | | [options.order] | String &#124; Array &#124; Sequelize.fn | Specifies an ordering. If a string is provided, it will be esacped. Using an array, you can provide several columns / functions to order by. Each element can be further wrapped in a two-element array. The first element is the column / function to order by, the second is the direction. For example: `order: [['name', 'DESC']]`. In this way the column will be escaped, but the direction will not. |
| [options.limit] | Number | | | [options.limit] | Number | |
| [options.offset] | Number | | | [options.offset] | Number | |
| [options.transaction] | Transaction | | | [options.transaction] | Transaction | |
...@@ -229,13 +229,13 @@ __Aliases:__ all ...@@ -229,13 +229,13 @@ __Aliases:__ all
<a name="findone"></a> <a name="findone"></a>
## `findOne([options], [queryOptions])` -> `Promise<Instance>` ## `findOne([options], [queryOptions])` -> `Promise<Instance>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L759) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L763)
Search for a single instance. This applies LIMIT 1, so the listener will always be called with a single instance. Search for a single instance. This applies LIMIT 1, so the listener will always be called with a single instance.
**See:** **See:**
* [Model#findAll](model#findall) * [Model#findAll](api/model#findall)
**Params:** **Params:**
...@@ -252,7 +252,7 @@ __Aliases:__ find ...@@ -252,7 +252,7 @@ __Aliases:__ find
<a name="aggregate"></a> <a name="aggregate"></a>
## `aggregate(field, aggregateFunction, [options])` -> `Promise<options.dataType>` ## `aggregate(field, aggregateFunction, [options])` -> `Promise<options.dataType>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L796) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L801)
Run an aggregation method on the specified field Run an aggregation method on the specified field
...@@ -263,6 +263,7 @@ Run an aggregation method on the specified field ...@@ -263,6 +263,7 @@ Run an aggregation method on the specified field
| field | String | The field to aggregate over. Can be a field name or * | | field | String | The field to aggregate over. Can be a field name or * |
| aggregateFunction | String | The function to use for aggregation, e.g. sum, max etc. | | aggregateFunction | String | The function to use for aggregation, e.g. sum, max etc. |
| [options] | Object | Query options. See sequelize.query for full options | | [options] | Object | Query options. See sequelize.query for full options |
| [options.where] | Object | A hash of search attributes. |
| [options.dataType] | DataType &#124; String | The type of the result. If `field` is a field in this Model, the default will be the type of that field, otherwise defaults to float. | | [options.dataType] | DataType &#124; String | The type of the result. If `field` is a field in this Model, the default will be the type of that field, otherwise defaults to float. |
| [options.distinct] | boolean | Applies DISTINCT to the field being aggregated over | | [options.distinct] | boolean | Applies DISTINCT to the field being aggregated over |
| [options.transaction] | Transaction | | | [options.transaction] | Transaction | |
...@@ -272,7 +273,7 @@ Run an aggregation method on the specified field ...@@ -272,7 +273,7 @@ Run an aggregation method on the specified field
<a name="count"></a> <a name="count"></a>
## `count([options])` -> `Promise<Integer>` ## `count([options])` -> `Promise<Integer>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L830) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L838)
Count the number of records matching the provided where clause. Count the number of records matching the provided where clause.
If you provide an `include` option, the number of matching associations will be counted instead. If you provide an `include` option, the number of matching associations will be counted instead.
...@@ -283,6 +284,7 @@ If you provide an `include` option, the number of matching associations will be ...@@ -283,6 +284,7 @@ If you provide an `include` option, the number of matching associations will be
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| [options] | Object | | | [options] | Object | |
| [options.where] | Object | A hash of search attributes. |
| [options.include] | Object | Include options. See `find` for details | | [options.include] | Object | Include options. See `find` for details |
| [options.distinct] | boolean | Appliy COUNT(DISTINCT(col)) | | [options.distinct] | boolean | Appliy COUNT(DISTINCT(col)) |
...@@ -291,7 +293,7 @@ If you provide an `include` option, the number of matching associations will be ...@@ -291,7 +293,7 @@ If you provide an `include` option, the number of matching associations will be
<a name="findandcount"></a> <a name="findandcount"></a>
## `findAndCount([findOptions], [queryOptions])` -> `Promise<Object>` ## `findAndCount([findOptions], [queryOptions])` -> `Promise<Object>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L870) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L878)
Find all the rows matching your query, within a specified offset / limit, and get the total number of rows matching your query. This is very usefull for paging Find all the rows matching your query, within a specified offset / limit, and get the total number of rows matching your query. This is very usefull for paging
```js ```js
...@@ -307,7 +309,7 @@ In the above example, `result.rows` will contain rows 13 through 24, while `resu ...@@ -307,7 +309,7 @@ In the above example, `result.rows` will contain rows 13 through 24, while `resu
**See:** **See:**
* [Model#findAll](model#findall) * [Model#findAll](api/model#findall)
**Params:** **Params:**
...@@ -323,13 +325,13 @@ __Aliases:__ findAndCountAll ...@@ -323,13 +325,13 @@ __Aliases:__ findAndCountAll
<a name="max"></a> <a name="max"></a>
## `max(field, [options])` -> `Promise<Any>` ## `max(field, [options])` -> `Promise<Any>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L926) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L934)
Find the maximum value of field Find the maximum value of field
**See:** **See:**
* [Model#aggregate](model#aggregate) * [Model#aggregate](api/model#aggregate)
**Params:** **Params:**
...@@ -344,13 +346,13 @@ Find the maximum value of field ...@@ -344,13 +346,13 @@ Find the maximum value of field
<a name="min"></a> <a name="min"></a>
## `min(field, [options])` -> `Promise<Any>` ## `min(field, [options])` -> `Promise<Any>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L939) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L947)
Find the minimum value of field Find the minimum value of field
**See:** **See:**
* [Model#aggregate](model#aggregate) * [Model#aggregate](api/model#aggregate)
**Params:** **Params:**
...@@ -365,13 +367,13 @@ Find the minimum value of field ...@@ -365,13 +367,13 @@ Find the minimum value of field
<a name="sum"></a> <a name="sum"></a>
## `sum(field, [options])` -> `Promise<Number>` ## `sum(field, [options])` -> `Promise<Number>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L952) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L960)
Find the sum of field Find the sum of field
**See:** **See:**
* [Model#aggregate](model#aggregate) * [Model#aggregate](api/model#aggregate)
**Params:** **Params:**
...@@ -386,7 +388,7 @@ Find the sum of field ...@@ -386,7 +388,7 @@ Find the sum of field
<a name="build"></a> <a name="build"></a>
## `build(values, [options])` -> `Instance` ## `build(values, [options])` -> `Instance`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L968) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L976)
Builds a new model instance. Values is an object of key value pairs, must be defined but can be empty. Builds a new model instance. Values is an object of key value pairs, must be defined but can be empty.
...@@ -406,14 +408,14 @@ Builds a new model instance. Values is an object of key value pairs, must be def ...@@ -406,14 +408,14 @@ Builds a new model instance. Values is an object of key value pairs, must be def
<a name="create"></a> <a name="create"></a>
## `create(values, [options])` -> `Promise<Instance>` ## `create(values, [options])` -> `Promise<Instance>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L1038) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L1046)
Builds a new model instance and calls save on it. Builds a new model instance and calls save on it.
**See:** **See:**
* [Instance#build](instance#build) * [Instance#build](api/instance#build)
* [Instance#save](instance#save) * [Instance#save](api/instance#save)
**Params:** **Params:**
...@@ -435,7 +437,7 @@ Builds a new model instance and calls save on it. ...@@ -435,7 +437,7 @@ Builds a new model instance and calls save on it.
<a name="findorinitialize"></a> <a name="findorinitialize"></a>
## `findOrInitialize` -> `Promise<Instance>` ## `findOrInitialize` -> `Promise<Instance>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L1068) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L1076)
Find a row that matches the query, or build (but don't save) the row if none is found. Find a row that matches the query, or build (but don't save) the row if none is found.
The successfull result of the promise will be (instance, initialized) - Make sure to use .spread() The successfull result of the promise will be (instance, initialized) - Make sure to use .spread()
...@@ -455,7 +457,7 @@ __Aliases:__ findOrBuild ...@@ -455,7 +457,7 @@ __Aliases:__ findOrBuild
<a name="findorcreate"></a> <a name="findorcreate"></a>
## `findOrCreate(options, [queryOptions])` -> `Promise<Instance|created>` ## `findOrCreate(options, [queryOptions])` -> `Promise<Instance|created>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L1113) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L1121)
Find a row that matches the query, or build and save the row if none is found Find a row that matches the query, or build and save the row if none is found
The successfull result of the promise will be (instance, created) - Make sure to use .spread() The successfull result of the promise will be (instance, created) - Make sure to use .spread()
...@@ -478,7 +480,7 @@ If a transaction is created, a savepoint will be created instead, and any unique ...@@ -478,7 +480,7 @@ If a transaction is created, a savepoint will be created instead, and any unique
<a name="upsert"></a> <a name="upsert"></a>
## `upsert(values, [options])` -> `Promise<created>` ## `upsert(values, [options])` -> `Promise<created>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L1200) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L1209)
Insert or update a single row. An update will be executed if a row which matches the supplied values on either the primary key or a unique key is found. Note that the unique index must be defined in your sequelize model and not just in the table. Otherwise you may experience a unique constraint violation, because sequelize fails to identify the row that should be updated. Insert or update a single row. An update will be executed if a row which matches the supplied values on either the primary key or a unique key is found. Note that the unique index must be defined in your sequelize model and not just in the table. Otherwise you may experience a unique constraint violation, because sequelize fails to identify the row that should be updated.
**Implementation details:** **Implementation details:**
...@@ -506,7 +508,7 @@ __Aliases:__ insertOrUpdate ...@@ -506,7 +508,7 @@ __Aliases:__ insertOrUpdate
<a name="bulkcreate"></a> <a name="bulkcreate"></a>
## `bulkCreate(records, [options])` -> `Promise<Array<Instance>>` ## `bulkCreate(records, [options])` -> `Promise<Array<Instance>>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L1256) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L1263)
Create and insert multiple instances in bulk. Create and insert multiple instances in bulk.
The success handler is passed an array of instances, but please notice that these may not completely represent the state of the rows in the DB. This is because MySQL The success handler is passed an array of instances, but please notice that these may not completely represent the state of the rows in the DB. This is because MySQL
...@@ -533,7 +535,7 @@ To obtain Instances for the newly created values, you will need to query for the ...@@ -533,7 +535,7 @@ To obtain Instances for the newly created values, you will need to query for the
<a name="destroy"></a> <a name="destroy"></a>
## `destroy(options)` -> `Promise<undefined>` ## `destroy(options)` -> `Promise<undefined>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L1432) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L1437)
Delete multiple instances, or set their deletedAt timestamp to the current time if `paranoid` is enabled. Delete multiple instances, or set their deletedAt timestamp to the current time if `paranoid` is enabled.
...@@ -556,7 +558,7 @@ Delete multiple instances, or set their deletedAt timestamp to the current time ...@@ -556,7 +558,7 @@ Delete multiple instances, or set their deletedAt timestamp to the current time
<a name="restore"></a> <a name="restore"></a>
## `restore(options)` -> `Promise<undefined>` ## `restore(options)` -> `Promise<undefined>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L1507) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L1512)
Restore multiple instances if `paranoid` is enabled. Restore multiple instances if `paranoid` is enabled.
...@@ -576,7 +578,7 @@ Restore multiple instances if `paranoid` is enabled. ...@@ -576,7 +578,7 @@ Restore multiple instances if `paranoid` is enabled.
<a name="update"></a> <a name="update"></a>
## `update(values, options)` -> `Promise<Array<affectedCount|affectedRows>>` ## `update(values, options)` -> `Promise<Array<affectedCount|affectedRows>>`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L1577) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L1582)
Update multiple instances that match the where options. The promise returns an array with one or two elements. The first element is always the number Update multiple instances that match the where options. The promise returns an array with one or two elements. The first element is always the number
of affected rows, while the second element is the actual affected rows (only supported in postgres with `options.returning` true.) of affected rows, while the second element is the actual affected rows (only supported in postgres with `options.returning` true.)
...@@ -600,7 +602,7 @@ of affected rows, while the second element is the actual affected rows (only sup ...@@ -600,7 +602,7 @@ of affected rows, while the second element is the actual affected rows (only sup
<a name="describe"></a> <a name="describe"></a>
## `describe()` -> `Promise` ## `describe()` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/model.js#L1742) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/model.js#L1747)
Run a describe query on the table. The result will be return to the listener as a hash of attributes and their types. Run a describe query on the table. The result will be return to the listener as a hash of attributes and their types.
......
docs/api/promise.md
<a name="promise"></a> <a name="promise"></a>
# Class Promise # Class Promise
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/promise.js#L25) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/promise.js#L25)
A slightly modified version of bluebird promises. This means that, on top of the methods below, you can also call all the methods listed on the link below. A slightly modified version of bluebird promises. This means that, on top of the methods below, you can also call all the methods listed on the link below.
The main difference is that sequelize promises allows you to attach a listener that will be called with the generated SQL, each time a query is run. The main difference is that sequelize promises allows you to attach a listener that will be called with the generated SQL, each time a query is run.
...@@ -15,7 +15,7 @@ If you want to propagate SQL events across `then`, `all` calls etc., you must us ...@@ -15,7 +15,7 @@ If you want to propagate SQL events across `then`, `all` calls etc., you must us
<a name="on"></a> <a name="on"></a>
## `on(evt, fct)` ## `on(evt, fct)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/promise.js#L119) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/promise.js#L119)
Listen for events, event emitter style. Mostly for backwards compat. with EventEmitter Listen for events, event emitter style. Mostly for backwards compat. with EventEmitter
**Deprecated** **Deprecated**
...@@ -32,7 +32,7 @@ Listen for events, event emitter style. Mostly for backwards compat. with EventE ...@@ -32,7 +32,7 @@ Listen for events, event emitter style. Mostly for backwards compat. with EventE
<a name="emit"></a> <a name="emit"></a>
## `emit(type, value(s)*)` ## `emit(type, value(s)*)`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/promise.js#L140) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/promise.js#L140)
Emit an event from the emitter Emit an event from the emitter
**Deprecated** **Deprecated**
...@@ -48,7 +48,7 @@ Emit an event from the emitter ...@@ -48,7 +48,7 @@ Emit an event from the emitter
<a name="success"></a> <a name="success"></a>
## `success(onSuccess)` -> `this` ## `success(onSuccess)` -> `this`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/promise.js#L178) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/promise.js#L178)
Listen for success events. Listen for success events.
```js ```js
...@@ -71,7 +71,7 @@ __Aliases:__ ok ...@@ -71,7 +71,7 @@ __Aliases:__ ok
<a name="error"></a> <a name="error"></a>
## `error(onError)` -> `this` ## `error(onError)` -> `this`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/promise.js#L205) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/promise.js#L205)
Listen for error events Listen for error events
```js ```js
...@@ -94,7 +94,7 @@ __Aliases:__ fail, failure ...@@ -94,7 +94,7 @@ __Aliases:__ fail, failure
<a name="done"></a> <a name="done"></a>
## `done(onDone)` -> `this` ## `done(onDone)` -> `this`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/promise.js#L228) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/promise.js#L228)
Listen for both success and error events. Listen for both success and error events.
```js ```js
...@@ -117,7 +117,7 @@ __Aliases:__ complete ...@@ -117,7 +117,7 @@ __Aliases:__ complete
<a name="sql"></a> <a name="sql"></a>
## `sql(onSQL)` -> `this` ## `sql(onSQL)` -> `this`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/promise.js#L253) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/promise.js#L253)
Attach a function that is called every time the function that created this emitter executes a query. Attach a function that is called every time the function that created this emitter executes a query.
**Params:** **Params:**
...@@ -131,7 +131,7 @@ Attach a function that is called every time the function that created this emitt ...@@ -131,7 +131,7 @@ Attach a function that is called every time the function that created this emitt
<a name="proxy"></a> <a name="proxy"></a>
## `proxy(promise, [options])` -> `this` ## `proxy(promise, [options])` -> `this`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/promise.js#L268) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/promise.js#L268)
Proxy every event of this promise to another one. Proxy every event of this promise to another one.
**Deprecated** **Deprecated**
......
docs/api/sequelize.md
<a name="sequelize"></a> <a name="sequelize"></a>
# Class Sequelize # Class Sequelize
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L34) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L34)
This is the main class, the entry point to sequelize. To use it, you just need to import sequelize: This is the main class, the entry point to sequelize. To use it, you just need to import sequelize:
```js ```js
...@@ -14,7 +14,7 @@ In addition to sequelize, the connection library for the dialect you want to use ...@@ -14,7 +14,7 @@ In addition to sequelize, the connection library for the dialect you want to use
<a name="sequelize"></a> <a name="sequelize"></a>
## `new Sequelize(database, [username=null], [password=null], [options={}])` ## `new Sequelize(database, [username=null], [password=null], [options={}])`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L91) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L91)
Instantiate sequelize with name of database, username and password Instantiate sequelize with name of database, username and password
#### Example usage #### Example usage
...@@ -75,7 +75,7 @@ var sequelize = new Sequelize('mysql://localhost:3306/database', {}) ...@@ -75,7 +75,7 @@ var sequelize = new Sequelize('mysql://localhost:3306/database', {})
<a name="sequelize"></a> <a name="sequelize"></a>
## `new Sequelize(uri, [options={}])` ## `new Sequelize(uri, [options={}])`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L100) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L100)
Instantiate sequlize with an URI Instantiate sequlize with an URI
**Params:** **Params:**
...@@ -90,57 +90,57 @@ Instantiate sequlize with an URI ...@@ -90,57 +90,57 @@ Instantiate sequlize with an URI
<a name="models"></a> <a name="models"></a>
## `models` ## `models`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L198) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L199)
Models are stored here under the name given to `sequelize.define` Models are stored here under the name given to `sequelize.define`
*** ***
<a name="sequelize"></a> <a name="sequelize"></a>
## `Sequelize` ## `Sequelize`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L214) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L215)
A reference to Sequelize constructor from sequelize. Useful for accessing DataTypes, Errors etc. A reference to Sequelize constructor from sequelize. Useful for accessing DataTypes, Errors etc.
**See:** **See:**
* [Sequelize](sequelize) * [Sequelize](api/sequelize)
*** ***
<a name="utils"></a> <a name="utils"></a>
## `Utils` ## `Utils`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L221) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L222)
A reference to sequelize utilities. Most users will not need to use these utils directly. However, you might want to use `Sequelize.Utils._`, which is a reference to the lodash library, if you don't already have it imported in your project. A reference to sequelize utilities. Most users will not need to use these utils directly. However, you might want to use `Sequelize.Utils._`, which is a reference to the lodash library, if you don't already have it imported in your project.
**See:** **See:**
* [Utils](utils) * [Utils](api/utils)
*** ***
<a name="promise"></a> <a name="promise"></a>
## `Promise` ## `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L228) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L229)
A modified version of bluebird promises, that allows listening for sql events A modified version of bluebird promises, that allows listening for sql events
**See:** **See:**
* [Promise](promise) * [Promise](api/promise)
*** ***
<a name="querytypes"></a> <a name="querytypes"></a>
## `QueryTypes` ## `QueryTypes`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L234) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L235)
Available query types for use with `sequelize.query` Available query types for use with `sequelize.query`
*** ***
<a name="validator"></a> <a name="validator"></a>
## `Validator` ## `Validator`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L241) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L242)
Exposes the validator.js object, so you can extend it with custom validation functions. The validator is exposed both on the instance, and on the constructor. Exposes the validator.js object, so you can extend it with custom validation functions. The validator is exposed both on the instance, and on the constructor.
**See:** **See:**
...@@ -152,200 +152,200 @@ Exposes the validator.js object, so you can extend it with custom validation fun ...@@ -152,200 +152,200 @@ Exposes the validator.js object, so you can extend it with custom validation fun
<a name="transaction"></a> <a name="transaction"></a>
## `Transaction` ## `Transaction`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L261) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L262)
A reference to the sequelize transaction class. Use this to access isolationLevels when creating a transaction A reference to the sequelize transaction class. Use this to access isolationLevels when creating a transaction
**See:** **See:**
* [Transaction](transaction) * [Transaction](api/transaction)
* [Sequelize#transaction](sequelize#transaction) * [Sequelize#transaction](api/sequelize#transaction)
*** ***
<a name="instance"></a> <a name="instance"></a>
## `Instance` ## `Instance`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L268) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L269)
A reference to the sequelize instance class. A reference to the sequelize instance class.
**See:** **See:**
* [Instance](instance) * [Instance](api/instance)
*** ***
<a name="error"></a> <a name="error"></a>
## `Error` ## `Error`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L282) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L283)
A general error class A general error class
**See:** **See:**
* [Errors#BaseError](errors#baseerror) * [Errors#BaseError](api/errors#baseerror)
*** ***
<a name="validationerror"></a> <a name="validationerror"></a>
## `ValidationError` ## `ValidationError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L290) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L291)
Emitted when a validation fails Emitted when a validation fails
**See:** **See:**
* [Errors#ValidationError](errors#validationerror) * [Errors#ValidationError](api/errors#validationerror)
*** ***
<a name="validationerroritem"></a> <a name="validationerroritem"></a>
## `ValidationErrorItem` ## `ValidationErrorItem`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L298) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L299)
Describes a validation error on an instance path Describes a validation error on an instance path
**See:** **See:**
* [Errors#ValidationErrorItem](errors#validationerroritem) * [Errors#ValidationErrorItem](api/errors#validationerroritem)
*** ***
<a name="databaseerror"></a> <a name="databaseerror"></a>
## `DatabaseError` ## `DatabaseError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L305) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L306)
A base class for all database related errors. A base class for all database related errors.
**See:** **See:**
* [Errors#DatabaseError](errors#databaseerror) * [Errors#DatabaseError](api/errors#databaseerror)
*** ***
<a name="timeouterror"></a> <a name="timeouterror"></a>
## `TimeoutError` ## `TimeoutError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L312) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L313)
Thrown when a database query times out because of a deadlock Thrown when a database query times out because of a deadlock
**See:** **See:**
* [Errors#TimeoutError](errors#timeouterror) * [Errors#TimeoutError](api/errors#timeouterror)
*** ***
<a name="uniqueconstrainterror"></a> <a name="uniqueconstrainterror"></a>
## `UniqueConstraintError` ## `UniqueConstraintError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L319) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L320)
Thrown when a unique constraint is violated in the database Thrown when a unique constraint is violated in the database
**See:** **See:**
* [Errors#UniqueConstraintError](errors#uniqueconstrainterror) * [Errors#UniqueConstraintError](api/errors#uniqueconstrainterror)
*** ***
<a name="foreignkeyconstrainterror"></a> <a name="foreignkeyconstrainterror"></a>
## `ForeignKeyConstraintError` ## `ForeignKeyConstraintError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L326) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L327)
Thrown when a foreign key constraint is violated in the database Thrown when a foreign key constraint is violated in the database
**See:** **See:**
* [Errors#ForeignKeyConstraintError](errors#foreignkeyconstrainterror) * [Errors#ForeignKeyConstraintError](api/errors#foreignkeyconstrainterror)
*** ***
<a name="connectionerror"></a> <a name="connectionerror"></a>
## `ConnectionError` ## `ConnectionError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L333) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L334)
A base class for all connection related errors. A base class for all connection related errors.
**See:** **See:**
* [Errors#ConnectionError](errors#connectionerror) * [Errors#ConnectionError](api/errors#connectionerror)
*** ***
<a name="connectionrefusederror"></a> <a name="connectionrefusederror"></a>
## `ConnectionRefusedError` ## `ConnectionRefusedError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L340) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L341)
Thrown when a connection to a database is refused Thrown when a connection to a database is refused
**See:** **See:**
* [Errors#ConnectionRefusedError](errors#connectionrefusederror) * [Errors#ConnectionRefusedError](api/errors#connectionrefusederror)
*** ***
<a name="accessdeniederror"></a> <a name="accessdeniederror"></a>
## `AccessDeniedError` ## `AccessDeniedError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L347) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L348)
Thrown when a connection to a database is refused due to insufficient access Thrown when a connection to a database is refused due to insufficient access
**See:** **See:**
* [Errors#AccessDeniedError](errors#accessdeniederror) * [Errors#AccessDeniedError](api/errors#accessdeniederror)
*** ***
<a name="hostnotfounderror"></a> <a name="hostnotfounderror"></a>
## `HostNotFoundError` ## `HostNotFoundError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L354) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L355)
Thrown when a connection to a database has a hostname that was not found Thrown when a connection to a database has a hostname that was not found
**See:** **See:**
* [Errors#HostNotFoundError](errors#hostnotfounderror) * [Errors#HostNotFoundError](api/errors#hostnotfounderror)
*** ***
<a name="hostnotreachableerror"></a> <a name="hostnotreachableerror"></a>
## `HostNotReachableError` ## `HostNotReachableError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L361) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L362)
Thrown when a connection to a database has a hostname that was not reachable Thrown when a connection to a database has a hostname that was not reachable
**See:** **See:**
* [Errors#HostNotReachableError](errors#hostnotreachableerror) * [Errors#HostNotReachableError](api/errors#hostnotreachableerror)
*** ***
<a name="invalidconnectionerror"></a> <a name="invalidconnectionerror"></a>
## `InvalidConnectionError` ## `InvalidConnectionError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L368) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L369)
Thrown when a connection to a database has invalid values for any of the connection parameters Thrown when a connection to a database has invalid values for any of the connection parameters
**See:** **See:**
* [Errors#InvalidConnectionError](errors#invalidconnectionerror) * [Errors#InvalidConnectionError](api/errors#invalidconnectionerror)
*** ***
<a name="connectiontimedouterror"></a> <a name="connectiontimedouterror"></a>
## `ConnectionTimedOutError` ## `ConnectionTimedOutError`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L375) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L376)
Thrown when a connection to a database times out Thrown when a connection to a database times out
**See:** **See:**
* [Errors#ConnectionTimedOutError](errors#connectiontimedouterror) * [Errors#ConnectionTimedOutError](api/errors#connectiontimedouterror)
*** ***
<a name="getdialect"></a> <a name="getdialect"></a>
## `getDialect()` -> `String` ## `getDialect()` -> `String`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L383) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L384)
Returns the specified dialect. Returns the specified dialect.
__Returns:__ The specified dialect. __Returns:__ The specified dialect.
...@@ -354,13 +354,13 @@ __Returns:__ The specified dialect. ...@@ -354,13 +354,13 @@ __Returns:__ The specified dialect.
<a name="getqueryinterface"></a> <a name="getqueryinterface"></a>
## `getQueryInterface()` -> `QueryInterface` ## `getQueryInterface()` -> `QueryInterface`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L395) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L396)
Returns an instance of QueryInterface. Returns an instance of QueryInterface.
**See:** **See:**
* [QueryInterface](queryinterface) * [QueryInterface](api/queryinterface)
__Returns:__ An instance (singleton) of QueryInterface. __Returns:__ An instance (singleton) of QueryInterface.
...@@ -368,13 +368,13 @@ __Returns:__ An instance (singleton) of QueryInterface. ...@@ -368,13 +368,13 @@ __Returns:__ An instance (singleton) of QueryInterface.
<a name="getmigrator"></a> <a name="getmigrator"></a>
## `getMigrator([options={}], [force=false])` -> `Migrator` ## `getMigrator([options={}], [force=false])` -> `Migrator`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L409) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L410)
Returns an instance (singleton) of Migrator. Returns an instance (singleton) of Migrator.
**See:** **See:**
* [Migrator](migrator) * [Migrator](api/migrator)
**Params:** **Params:**
...@@ -390,7 +390,7 @@ __Returns:__ An instance of Migrator. ...@@ -390,7 +390,7 @@ __Returns:__ An instance of Migrator.
<a name="define"></a> <a name="define"></a>
## `define(modelName, attributes, [options])` -> `Model` ## `define(modelName, attributes, [options])` -> `Model`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L526) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L528)
Define a new model, representing a table in the DB. Define a new model, representing a table in the DB.
The table columns are define by the hash that is given as the second argument. Each attribute of the hash represents a column. A short table definition might look like this: The table columns are define by the hash that is given as the second argument. Each attribute of the hash represents a column. A short table definition might look like this:
...@@ -431,8 +431,8 @@ For more about validation, see http://sequelizejs.com/docs/latest/models#validat ...@@ -431,8 +431,8 @@ For more about validation, see http://sequelizejs.com/docs/latest/models#validat
**See:** **See:**
* [DataTypes](datatypes) * [DataTypes](api/datatypes)
* [Hooks](hooks) * [Hooks](api/hooks)
**Params:** **Params:**
...@@ -441,7 +441,7 @@ For more about validation, see http://sequelizejs.com/docs/latest/models#validat ...@@ -441,7 +441,7 @@ For more about validation, see http://sequelizejs.com/docs/latest/models#validat
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| modelName | String | The name of the model. The model will be stored in `sequelize.models` under this name | | modelName | String | The name of the model. The model will be stored in `sequelize.models` under this name |
| attributes | Object | An object, where each attribute is a column of the table. Each column can be either a DataType, a string or a type-description object, with the properties described below: | | attributes | Object | An object, where each attribute is a column of the table. Each column can be either a DataType, a string or a type-description object, with the properties described below: |
| attributes.column | String &#124; DataType|Object | The description of a database column | | attributes.column | String &#124; DataType &#124; Object | The description of a database column |
| attributes.column.type | String &#124; DataType | A string or a data type | | attributes.column.type | String &#124; DataType | A string or a data type |
| [attributes.column.allowNull=true] | Boolean | If false, the column will have a NOT NULL constraint, and a not null validation will be run before an instance is saved. | | [attributes.column.allowNull=true] | Boolean | If false, the column will have a NOT NULL constraint, and a not null validation will be run before an instance is saved. |
| [attributes.column.defaultValue=null] | Any | A literal default value, a javascript function, or an SQL function (see `sequelize.fn`) | | [attributes.column.defaultValue=null] | Any | A literal default value, a javascript function, or an SQL function (see `sequelize.fn`) |
...@@ -489,6 +489,7 @@ For more about validation, see http://sequelizejs.com/docs/latest/models#validat ...@@ -489,6 +489,7 @@ For more about validation, see http://sequelizejs.com/docs/latest/models#validat
| [options.charset] | String | | | [options.charset] | String | |
| [options.comment] | String | | | [options.comment] | String | |
| [options.collate] | String | | | [options.collate] | String | |
| [options.initialAutoIncrement] | String | Set the initial AUTO_INCREMENT value for the table in MySQL. |
| [options.hooks] | Object | An object of hook function that are called before and after certain lifecycle events. The possible hooks are: beforeValidate, afterValidate, beforeBulkCreate, beforeBulkDestroy, beforeBulkUpdate, beforeCreate, beforeDestroy, beforeUpdate, afterCreate, afterDestroy, afterUpdate, afterBulkCreate, afterBulkDestory and afterBulkUpdate. See Hooks for more information about hook functions and their signatures. Each property can either be a function, or an array of functions. | | [options.hooks] | Object | An object of hook function that are called before and after certain lifecycle events. The possible hooks are: beforeValidate, afterValidate, beforeBulkCreate, beforeBulkDestroy, beforeBulkUpdate, beforeCreate, beforeDestroy, beforeUpdate, afterCreate, afterDestroy, afterUpdate, afterBulkCreate, afterBulkDestory and afterBulkUpdate. See Hooks for more information about hook functions and their signatures. Each property can either be a function, or an array of functions. |
| [options.validate] | Object | An object of model wide validations. Validations have access to all model values via `this`. If the validator function takes an argument, it is asumed to be async, and is called with a callback that accepts an optional error. | | [options.validate] | Object | An object of model wide validations. Validations have access to all model values via `this`. If the validator function takes an argument, it is asumed to be async, and is called with a callback that accepts an optional error. |
...@@ -497,7 +498,7 @@ For more about validation, see http://sequelizejs.com/docs/latest/models#validat ...@@ -497,7 +498,7 @@ For more about validation, see http://sequelizejs.com/docs/latest/models#validat
<a name="model"></a> <a name="model"></a>
## `model(modelName)` -> `Model` ## `model(modelName)` -> `Model`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L578) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L580)
Fetch a DAO factory which is already defined Fetch a DAO factory which is already defined
...@@ -512,7 +513,7 @@ Fetch a DAO factory which is already defined ...@@ -512,7 +513,7 @@ Fetch a DAO factory which is already defined
<a name="isdefined"></a> <a name="isdefined"></a>
## `isDefined(modelName)` -> `Boolean` ## `isDefined(modelName)` -> `Boolean`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L592) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L594)
Checks whether a model with the given name is defined Checks whether a model with the given name is defined
...@@ -527,7 +528,7 @@ Checks whether a model with the given name is defined ...@@ -527,7 +528,7 @@ Checks whether a model with the given name is defined
<a name="import"></a> <a name="import"></a>
## `import(path)` -> `Model` ## `import(path)` -> `Model`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L606) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L608)
Imports a model defined in another file Imports a model defined in another file
Imported models are cached, so multiple calls to import with the same path will not load the file multiple times Imported models are cached, so multiple calls to import with the same path will not load the file multiple times
...@@ -545,7 +546,7 @@ See https://github.com/sequelize/sequelize/blob/master/examples/using-multiple-m ...@@ -545,7 +546,7 @@ See https://github.com/sequelize/sequelize/blob/master/examples/using-multiple-m
<a name="query"></a> <a name="query"></a>
## `query(sql, [callee], [options={}])` -> `Promise` ## `query(sql, [callee], [options={}])` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L661) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L663)
Execute a query on the DB, with the posibility to bypass all the sequelize goodness. Execute a query on the DB, with the posibility to bypass all the sequelize goodness.
By default, the function will return two arguments: an array of results, and a metadata object, containing number of affected rows etc. Use `.spread` to access the results. By default, the function will return two arguments: an array of results, and a metadata object, containing number of affected rows etc. Use `.spread` to access the results.
...@@ -565,7 +566,7 @@ sequlize.query('SELECT...', { type: sequelize.QueryTypes.SELECT }).then(function ...@@ -565,7 +566,7 @@ sequlize.query('SELECT...', { type: sequelize.QueryTypes.SELECT }).then(function
**See:** **See:**
* [Model#build](model#build) * [Model#build](api/model#build)
**Params:** **Params:**
...@@ -588,7 +589,7 @@ sequlize.query('SELECT...', { type: sequelize.QueryTypes.SELECT }).then(function ...@@ -588,7 +589,7 @@ sequlize.query('SELECT...', { type: sequelize.QueryTypes.SELECT }).then(function
<a name="set"></a> <a name="set"></a>
## `set(variables, options)` -> `Promise` ## `set(variables, options)` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L737) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L739)
Execute a query which would set an environment or user variable. The variables are set per connection, so this function needs a transaction. Execute a query which would set an environment or user variable. The variables are set per connection, so this function needs a transaction.
Only works for MySQL. Only works for MySQL.
...@@ -606,7 +607,7 @@ Only works for MySQL. ...@@ -606,7 +607,7 @@ Only works for MySQL.
<a name="escape"></a> <a name="escape"></a>
## `escape(value)` -> `String` ## `escape(value)` -> `String`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L771) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L773)
Escape value. Escape value.
...@@ -621,7 +622,7 @@ Escape value. ...@@ -621,7 +622,7 @@ Escape value.
<a name="createschema"></a> <a name="createschema"></a>
## `createSchema(schema)` -> `Promise` ## `createSchema(schema)` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L785) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L787)
Create a new database schema. Create a new database schema.
Note,that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html), Note,that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html),
...@@ -630,7 +631,7 @@ not a database table. In mysql and sqlite, this command will do nothing. ...@@ -630,7 +631,7 @@ not a database table. In mysql and sqlite, this command will do nothing.
**See:** **See:**
* [Model#schema](model#schema) * [Model#schema](api/model#schema)
**Params:** **Params:**
...@@ -644,7 +645,7 @@ not a database table. In mysql and sqlite, this command will do nothing. ...@@ -644,7 +645,7 @@ not a database table. In mysql and sqlite, this command will do nothing.
<a name="showallschemas"></a> <a name="showallschemas"></a>
## `showAllSchemas()` -> `Promise` ## `showAllSchemas()` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L796) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L798)
Show all defined schemas Show all defined schemas
Note,that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html), Note,that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html),
...@@ -654,7 +655,7 @@ not a database table. In mysql and sqlite, this will show all tables. ...@@ -654,7 +655,7 @@ not a database table. In mysql and sqlite, this will show all tables.
<a name="dropschema"></a> <a name="dropschema"></a>
## `dropSchema(schema)` -> `Promise` ## `dropSchema(schema)` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L808) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L810)
Drop a single schema Drop a single schema
Note,that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html), Note,that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html),
...@@ -671,7 +672,7 @@ not a database table. In mysql and sqlite, this drop a table matching the schema ...@@ -671,7 +672,7 @@ not a database table. In mysql and sqlite, this drop a table matching the schema
<a name="dropallschemas"></a> <a name="dropallschemas"></a>
## `dropAllSchemas()` -> `Promise` ## `dropAllSchemas()` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L819) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L821)
Drop all schemas Drop all schemas
Note,that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html), Note,that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html),
...@@ -681,7 +682,7 @@ not a database table. In mysql and sqlite, this is the equivalent of drop all ta ...@@ -681,7 +682,7 @@ not a database table. In mysql and sqlite, this is the equivalent of drop all ta
<a name="sync"></a> <a name="sync"></a>
## `sync([options={}])` -> `Promise` ## `sync([options={}])` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L833) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L835)
Sync all defined DAOs to the DB. Sync all defined DAOs to the DB.
...@@ -700,12 +701,12 @@ Sync all defined DAOs to the DB. ...@@ -700,12 +701,12 @@ Sync all defined DAOs to the DB.
<a name="drop"></a> <a name="drop"></a>
## `drop(options)` -> `Promise` ## `drop(options)` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L877) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L879)
Drop all tables defined through this sequelize instance. This is done by calling Model.drop on each model Drop all tables defined through this sequelize instance. This is done by calling Model.drop on each model
**See:** **See:**
* [Model#drop](model#drop) * [Model#drop](api/model#drop)
**Params:** **Params:**
...@@ -719,7 +720,7 @@ Drop all tables defined through this sequelize instance. This is done by calling ...@@ -719,7 +720,7 @@ Drop all tables defined through this sequelize instance. This is done by calling
<a name="authenticate"></a> <a name="authenticate"></a>
## `authenticate()` -> `Promise` ## `authenticate()` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L899) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L901)
Test the connection by trying to authenticate Test the connection by trying to authenticate
__Aliases:__ validate __Aliases:__ validate
...@@ -728,7 +729,7 @@ __Aliases:__ validate ...@@ -728,7 +729,7 @@ __Aliases:__ validate
<a name="fn "></a> <a name="fn "></a>
## `fn (fn, args)` -> `Sequelize.fn` ## `fn (fn, args)` -> `Sequelize.fn`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L934) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L936)
Creates a object representing a database function. This can be used in search queries, both in where and order parts, and as default values in column definitions. Creates a object representing a database function. This can be used in search queries, both in where and order parts, and as default values in column definitions.
If you want to refer to columns in your function, you should use `sequelize.col`, so that the columns are properly interpreted as columns and not a strings. If you want to refer to columns in your function, you should use `sequelize.col`, so that the columns are properly interpreted as columns and not a strings.
...@@ -742,10 +743,10 @@ instance.updateAttributes({ ...@@ -742,10 +743,10 @@ instance.updateAttributes({
**See:** **See:**
* [Model#find](model#find) * [Model#find](api/model#find)
* [Model#findAll](model#findall) * [Model#findAll](api/model#findall)
* [Model#define](model#define) * [Model#define](api/model#define)
* [Sequelize#col](sequelize#col) * [Sequelize#col](api/sequelize#col)
**Params:** **Params:**
...@@ -760,12 +761,12 @@ instance.updateAttributes({ ...@@ -760,12 +761,12 @@ instance.updateAttributes({
<a name="col"></a> <a name="col"></a>
## `col(col)` -> `Sequelize.col` ## `col(col)` -> `Sequelize.col`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L947) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L949)
Creates a object representing a column in the DB. This is often useful in conjunction with `sequelize.fn`, since raw string arguments to fn will be escaped. Creates a object representing a column in the DB. This is often useful in conjunction with `sequelize.fn`, since raw string arguments to fn will be escaped.
**See:** **See:**
* [Sequelize#fn](sequelize#fn) * [Sequelize#fn](api/sequelize#fn)
**Params:** **Params:**
...@@ -779,7 +780,7 @@ Creates a object representing a column in the DB. This is often useful in conjun ...@@ -779,7 +780,7 @@ Creates a object representing a column in the DB. This is often useful in conjun
<a name="cast"></a> <a name="cast"></a>
## `cast(val, type)` -> `Sequelize.cast` ## `cast(val, type)` -> `Sequelize.cast`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L961) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L963)
Creates a object representing a call to the cast function. Creates a object representing a call to the cast function.
...@@ -795,7 +796,7 @@ Creates a object representing a call to the cast function. ...@@ -795,7 +796,7 @@ Creates a object representing a call to the cast function.
<a name="literal"></a> <a name="literal"></a>
## `literal(val)` -> `Sequelize.literal` ## `literal(val)` -> `Sequelize.literal`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L974) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L976)
Creates a object representing a literal, i.e. something that will not be escaped. Creates a object representing a literal, i.e. something that will not be escaped.
...@@ -811,12 +812,12 @@ __Aliases:__ asIs ...@@ -811,12 +812,12 @@ __Aliases:__ asIs
<a name="and"></a> <a name="and"></a>
## `and(args)` -> `Sequelize.and` ## `and(args)` -> `Sequelize.and`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L987) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L989)
An AND query An AND query
**See:** **See:**
* [Model#find](model#find) * [Model#find](api/model#find)
**Params:** **Params:**
...@@ -830,12 +831,12 @@ An AND query ...@@ -830,12 +831,12 @@ An AND query
<a name="or"></a> <a name="or"></a>
## `or(args)` -> `Sequelize.or` ## `or(args)` -> `Sequelize.or`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L1000) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L1002)
An OR query An OR query
**See:** **See:**
* [Model#find](model#find) * [Model#find](api/model#find)
**Params:** **Params:**
...@@ -849,12 +850,12 @@ An OR query ...@@ -849,12 +850,12 @@ An OR query
<a name="json"></a> <a name="json"></a>
## `json(conditions, [value])` -> `Sequelize.json` ## `json(conditions, [value])` -> `Sequelize.json`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L1013) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L1015)
Creates an object representing nested where conditions for postgres's json data-type. Creates an object representing nested where conditions for postgres's json data-type.
**See:** **See:**
* [Model#find](model#find) * [Model#find](api/model#find)
**Params:** **Params:**
...@@ -862,14 +863,14 @@ Creates an object representing nested where conditions for postgres's json data- ...@@ -862,14 +863,14 @@ Creates an object representing nested where conditions for postgres's json data-
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| conditions | String &#124; Object | A hash containing strings/numbers or other nested hash, a string using dot notation or a string using postgres json syntax. | | conditions | String &#124; Object | A hash containing strings/numbers or other nested hash, a string using dot notation or a string using postgres json syntax. |
| [value] | String &#124; Number|Boolean | An optional value to compare against. Produces a string of the form "<json path> = '<value>'". | | [value] | String &#124; Number &#124; Boolean | An optional value to compare against. Produces a string of the form "<json path> = '<value>'". |
*** ***
<a name="where"></a> <a name="where"></a>
## `where(attr, [comparator='='], logic)` -> `Sequelize.where` ## `where(attr, [comparator='='], logic)` -> `Sequelize.where`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L1035) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L1037)
A way of specifying attr = condition. A way of specifying attr = condition.
The attr can either be an object taken from `Model.rawAttributes` (for example `Model.rawAttributes.id` or `Model.rawAttributes.name`). The The attr can either be an object taken from `Model.rawAttributes` (for example `Model.rawAttributes.id` or `Model.rawAttributes.name`). The
...@@ -880,7 +881,7 @@ For string attributes, use the regular `{ where: { attr: something }}` syntax. I ...@@ -880,7 +881,7 @@ For string attributes, use the regular `{ where: { attr: something }}` syntax. I
**See:** **See:**
* [Model#find](model#find) * [Model#find](api/model#find)
**Params:** **Params:**
...@@ -897,7 +898,7 @@ __Aliases:__ condition ...@@ -897,7 +898,7 @@ __Aliases:__ condition
<a name="transaction"></a> <a name="transaction"></a>
## `transaction([options={}])` -> `Promise` ## `transaction([options={}])` -> `Promise`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/sequelize.js#L1087) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/sequelize.js#L1089)
Start a transaction. When using transactions, you should pass the transaction in the options argument in order for the query to happen under that transaction Start a transaction. When using transactions, you should pass the transaction in the options argument in order for the query to happen under that transaction
```js ```js
...@@ -939,7 +940,7 @@ Note, that CLS is enabled for all sequelize instances, and all instances will sh ...@@ -939,7 +940,7 @@ Note, that CLS is enabled for all sequelize instances, and all instances will sh
**See:** **See:**
* [Transaction](transaction) * [Transaction](api/transaction)
**Params:** **Params:**
......
docs/api/transaction.md
<a name="transaction"></a> <a name="transaction"></a>
# Class Transaction # Class Transaction
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/transaction.js#L12) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/transaction.js#L12)
The transaction object is used to identify a running transaction. It is created by calling `Sequelize.transaction()`. The transaction object is used to identify a running transaction. It is created by calling `Sequelize.transaction()`.
To run a query under a transaction, you should pass the transaction in the options object. To run a query under a transaction, you should pass the transaction in the options object.
...@@ -9,7 +9,7 @@ To run a query under a transaction, you should pass the transaction in the optio ...@@ -9,7 +9,7 @@ To run a query under a transaction, you should pass the transaction in the optio
<a name="isolation_levels"></a> <a name="isolation_levels"></a>
## `ISOLATION_LEVELS` ## `ISOLATION_LEVELS`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/transaction.js#L45) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/transaction.js#L45)
The possible isolations levels to use when starting a transaction The possible isolations levels to use when starting a transaction
```js ```js
...@@ -26,7 +26,7 @@ The possible isolations levels to use when starting a transaction ...@@ -26,7 +26,7 @@ The possible isolations levels to use when starting a transaction
<a name="lock"></a> <a name="lock"></a>
## `LOCK` ## `LOCK`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/transaction.js#L67) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/transaction.js#L67)
Possible options for row locking. Used in conjuction with `find` calls: Possible options for row locking. Used in conjuction with `find` calls:
```js ```js
...@@ -44,7 +44,7 @@ Model.findAll({ ...@@ -44,7 +44,7 @@ Model.findAll({
<a name="commit"></a> <a name="commit"></a>
## `commit()` -> `this` ## `commit()` -> `this`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/transaction.js#L77) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/transaction.js#L77)
Commit the transaction Commit the transaction
...@@ -52,7 +52,7 @@ Commit the transaction ...@@ -52,7 +52,7 @@ Commit the transaction
<a name="rollback"></a> <a name="rollback"></a>
## `rollback()` -> `this` ## `rollback()` -> `this`
[View code](https://github.com/sequelize/sequelize/blob/dbcbddd0f1bbdad7ff8b4f939616f51b610619a4/lib/transaction.js#L98) [View code](https://github.com/sequelize/sequelize/blob/9817e58981f8536becdbe8e137debcc000cd56f9/lib/transaction.js#L98)
Rollback (abort) the transaction Rollback (abort) the transaction
......
docs/docs-generator.js
...@@ -213,7 +213,7 @@ var parseComments = function (comments, file) { ...@@ -213,7 +213,7 @@ var parseComments = function (comments, file) {
if (see.local) { if (see.local) {
link = see.local.match(/{(.*?(?:|#.*?))}/)[1]; link = see.local.match(/{(.*?(?:|#.*?))}/)[1];
comment.putLine('* [' + link + '](' + link.toLowerCase() + ')'); comment.putLine('* [' + link + '](api/' + link.toLowerCase() + ')');
} else { } else {
comment.putLine('* [' + see.title | see.url + '](' + see.url + ')'); comment.putLine('* [' + see.title | see.url + '](' + see.url + ')');
} }
......
lib/data-types.js
...@@ -3,6 +3,36 @@ ...@@ -3,6 +3,36 @@
var util = require('util') var util = require('util')
, _ = require('lodash'); , _ = require('lodash');
/**
* A convenience class holding commonly used data types. The datatypes are used when definining a new model using `Sequelize.define`, like this:
* ```js
* sequelize.define('model', {
* column: DataTypes.INTEGER
* })
* ```
* When defining a model you can just as easily pass a string as type, but often using the types defined here is beneficial. For example, using `DataTypes.BLOB`, mean
* that that column will be returned as an instance of `Buffer` when being fetched by sequelize.
*
* Some data types have special properties that can be accessed in order to change the data type. For example, to get an unsigned integer with zerofill you can do `DataTypes.INTEGER.UNSIGNED.ZEROFILL`.
* The order you access the properties in do not matter, so `DataTypes.INTEGER.ZEROFILL.UNSIGNED` is fine as well. The available properties are listed under each data type.
*
* To provide a length for the data type, you can invoke it like a function: `INTEGER(2)`
*
* Three of the values provided here (`NOW`, `UUIDV1` and `UUIDV4`) are special default values, that should not be used to define types. Instead they are used as shorthands for
* defining default values. For example, to get a uuid field with a default value generated following v1 of the UUID standard:
* ```js
* sequelize.define('model', {
* uuid: {
* type: DataTypes.UUID,
* defaultValue: DataTypes.UUIDV1,
* primaryKey: true
* }
* })
* ```
*
* @class DataTypes
*/
var ABSTRACT = function(options) { var ABSTRACT = function(options) {
}; };
...@@ -489,35 +519,6 @@ Object.keys(helpers).forEach(function (helper) { ...@@ -489,35 +519,6 @@ Object.keys(helpers).forEach(function (helper) {
}); });
}); });
/**
* A convenience class holding commonly used data types. The datatypes are used when definining a new model using `Sequelize.define`, like this:
* ```js
* sequelize.define('model', {
* column: DataTypes.INTEGER
* })
* ```
* When defining a model you can just as easily pass a string as type, but often using the types defined here is beneficial. For example, using `DataTypes.BLOB`, mean
* that that column will be returned as an instance of `Buffer` when being fetched by sequelize.
*
* Some data types have special properties that can be accessed in order to change the data type. For example, to get an unsigned integer with zerofill you can do `DataTypes.INTEGER.UNSIGNED.ZEROFILL`.
* The order you access the properties in do not matter, so `DataTypes.INTEGER.ZEROFILL.UNSIGNED` is fine as well. The available properties are listed under each data type.
*
* To provide a length for the data type, you can invoke it like a function: `INTEGER(2)`
*
* Three of the values provided here (`NOW`, `UUIDV1` and `UUIDV4`) are special default values, that should not be used to define types. Instead they are used as shorthands for
* defining default values. For example, to get a uuid field with a default value generated following v1 of the UUID standard:
* ```js
* sequelize.define('model', {
* uuid: {
* type: DataTypes.UUID,
* defaultValue: DataTypes.UUIDV1,
* primaryKey: true
* }
* })
* ```
*
* @class DataTypes
*/
module.exports = { module.exports = {
ABSTRACT: ABSTRACT, ABSTRACT: ABSTRACT,
STRING: STRING, STRING: STRING,
......
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!