Class Instance
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.
Instance instances operate with the concept of a dataValues property, which stores the actual values represented by the instance.
By default, the values from dataValues can also be accessed directly from the Instance, that is:
instance.field
// is the same as
instance.get('field')
// is the same as
instance.getDataValue('field')
However, if getters and/or setters are defined for field they will be invoked, instead of returning the value from dataValues.
Accessing properties directly or using get is preferred for regular use, getDataValue should only be used for custom getters.
See:
isNewRecord -> Boolean
Returns true if this instance has not yet been persisted to the database
Model() -> Model
Returns the Model the instance was created from.
See:
sequelize() -> Sequelize
A reference to the sequelize instance
See:
where() -> Object
Get an object representing the query for this instance, use with options.where
getDataValue(key) -> any
Get the value of the underlying data value
Params:
| Name | Type | Description |
|---|---|---|
| key | String |
setDataValue(key, value)
Update the underlying data value
Params:
| Name | Type | Description |
|---|---|---|
| key | String | |
| value | any |
get([key], [options]) -> Object|any
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.
Params:
| Name | Type | Description |
|---|---|---|
| [key] | String | |
| [options] | Object | |
| [options.plain=false] | Boolean | If set to true, included instances will be returned as plain objects |
set(key, value, [options])
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
will be called instead. To bypass the setter, you can pass raw: true in the options object.
If set is called with an object, it will loop over the object, and call set recursively for each key, value pair. If you set raw to true, the underlying dataValues will either be set directly to the object passed, or used to extend dataValues, if dataValues already contain values.
When set is called, the previous value of the field is stored and sets a changed flag(see changed).
Set can also be used to build instances for associations, if you have values for those. When using set with associations you need to make sure the property key matches the alias of the association while also making sure that the proper include options have been set (from .build() or .find())
If called with a dot.separated key on a JSON/JSONB attribute it will set the value nested and flag the entire object as changed.
See:
Params:
| Name | Type | Description |
|---|---|---|
| key | String | Object | |
| value | any | |
| [options] | Object | |
| [options.raw=false] | Boolean | If set to true, field and virtual setters will be ignored |
| [options.reset=false] | Boolean | Clear all previously set data values |
Aliases: setAttributes
changed([key]) -> Boolean|Array
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 and no keys have changed, it will return false.
Params:
| Name | Type | Description |
|---|---|---|
| [key] | String |
previous([key]) -> any|Array.<any>
Returns the previous value for key from _previousDataValues.
If called without a key, returns the previous values for all values which have changed
Params:
| Name | Type | Description |
|---|---|---|
| [key] | String |
save([options]) -> Promise.<this|Errors.ValidationError>
Validate this instance, and if the validation passes, persist it to the database. It will only save changed fields, and do nothing if no fields have changed.
On success, the callback will be called with this instance. On validation error, the callback will be called with an instance of Sequelize.ValidationError.
This error will have a property for each of the fields for which validation failed, with the error message for that field.
Params:
| Name | Type | Description |
|---|---|---|
| [options] | Object | |
| [options.fields] | Array.<string> | An optional array of strings, representing database columns. If fields is provided, only those columns will be validated and saved. |
| [options.silent=false] | Boolean | If true, the updatedAt timestamp will not be updated. |
| [options.validate=true] | Boolean | If false, validations won't be run. |
| [options.logging=false] | Function | A function that gets executed while running the query to log the sql. |
| [options.transaction] | Transaction | |
| [options.searchPath=DEFAULT] | String | An optional parameter to specify the schema search_path (Postgres only) |
reload([options]) -> Promise.<this>
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,
all references to the Instance are updated with the new data and no new objects are created.
See:
Params:
| Name | Type | Description |
|---|---|---|
| [options] | Object | Options that are passed on to Model.find |
| [options.logging=false] | Function | A function that gets executed while running the query to log the sql. |
validate([options]) -> Promise.<Errors.ValidationError|undefined>
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.
See:
Params:
| Name | Type | Description |
|---|---|---|
| [options] | Object | Options that are passed to the validator |
| [options.skip] | Array | An array of strings. All properties that are in this array will not be validated |
update(updates, options) -> Promise.<this>
This is the same as calling set and then calling save but it only saves the
exact values passed to it, making it more atomic and safer.
See:
Params:
| Name | Type | Description |
|---|---|---|
| updates | Object | See set |
| options | Object | See save |
Aliases: updateAttributes
destroy([options={}]) -> Promise.<undefined>
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.
Params:
| Name | Type | Description |
|---|---|---|
| [options={}] | Object | |
| [options.force=false] | Boolean | If set to true, paranoid models will actually be deleted |
| [options.logging=false] | Function | A function that gets executed while running the query to log the sql. |
| [options.transaction] | Transaction | |
| [options.searchPath=DEFAULT] | String | An optional parameter to specify the schema search_path (Postgres only) |
restore([options={}]) -> Promise.<undefined>
Restore the row corresponding to this instance. Only available for paranoid models.
Params:
| Name | Type | Description |
|---|---|---|
| [options={}] | Object | |
| [options.logging=false] | Function | A function that gets executed while running the query to log the sql. |
| [options.transaction] | Transaction |
increment(fields, [options]) -> Promise.<this>
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
SET column = column + X
query. To get the correct value after an increment into the Instance you should do a reload.
instance.increment('number') // increment number by 1
instance.increment(['number', 'count'], { by: 2 }) // increment number and count by 2
instance.increment({ answer: 42, tries: 1}, { by: 2 }) // increment answer by 42, and tries by 1.
// `by` is ignored, since each column has its own value
See:
Params:
| Name | Type | Description |
|---|---|---|
| fields | String | 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. |
| [options] | Object | |
| [options.by=1] | Integer | The number to increment by |
| [options.logging=false] | Function | A function that gets executed while running the query to log the sql. |
| [options.transaction] | Transaction | |
| [options.searchPath=DEFAULT] | String | An optional parameter to specify the schema search_path (Postgres only) |
decrement(fields, [options]) -> Promise
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
SET column = column - X
query. To get the correct value after an decrement into the Instance you should do a reload.
instance.decrement('number') // decrement number by 1
instance.decrement(['number', 'count'], { by: 2 }) // decrement number and count by 2
instance.decrement({ answer: 42, tries: 1}, { by: 2 }) // decrement answer by 42, and tries by 1.
// `by` is ignored, since each column has its own value
See:
Params:
| Name | Type | Description |
|---|---|---|
| fields | String | 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 |
| [options] | Object | |
| [options.by=1] | Integer | The number to decrement by |
| [options.logging=false] | Function | A function that gets executed while running the query to log the sql. |
| [options.transaction] | Transaction | |
| [options.searchPath=DEFAULT] | String | An optional parameter to specify the schema search_path (Postgres only) |
equals(other) -> Boolean
Check whether all values of this and other Instance are the same
Params:
| Name | Type | Description |
|---|---|---|
| other | Instance |
equalsOneOf(others) -> Boolean
Check if this is equal to one of others by calling equals
Params:
| Name | Type | Description |
|---|---|---|
| others | Array |
toJSON() -> object
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:
This document is automatically generated based on source code comments. Please do not edit it directly, as your changes will be ignored. Please write on IRC, open an issue or a create a pull request if you feel something can be improved. For help on how to write source code documentation see JSDoc and dox