[ { "__docId__": 0, "kind": "file", "name": "lib/associations/base.js", "content": "", "static": true, "longname": "lib/associations/base.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1, "kind": "variable", "name": "AssociationError", "memberof": "lib/associations/base.js", "static": true, "longname": "lib/associations/base.js~AssociationError", "access": null, "export": false, "importPath": "sequelize/lib/associations/base.js", "importStyle": null, "description": null, "lineNumber": 2, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 2, "kind": "class", "name": "Association", "memberof": "lib/associations/base.js", "static": true, "longname": "lib/associations/base.js~Association", "access": null, "export": false, "importPath": "sequelize/lib/associations/base.js", "importStyle": null, "description": "Creating associations in sequelize is done by calling one of the belongsTo / hasOne / hasMany / belongsToMany functions on a model (the source), and providing another model as the first argument to the function (the target).\n\n* hasOne - adds a foreign key to the target and singular association mixins to the source.\n* belongsTo - add a foreign key and singular association mixins to the source.\n* hasMany - adds a foreign key to target and plural association mixins to the source.\n* belongsToMany - creates an N:M association with a join table and adds plural association mixins to the source. The junction table is created with sourceId and targetId.\n\nCreating an association will add a foreign key constraint to the attributes. All associations use `CASCADE` on update and `SET NULL` on delete, except for n:m, which also uses `CASCADE` on delete.\n\nWhen creating associations, you can provide an alias, via the `as` option. This is useful if the same model is associated twice, or you want your association to be called something other than the name of the target model.\n\nAs an example, consider the case where users have many pictures, one of which is their profile picture. All pictures have a `userId`, but in addition the user model also has a `profilePictureId`, to be able to easily load the user's profile picture.\n\n```js\nUser.hasMany(Picture)\nUser.belongsTo(Picture, { as: 'ProfilePicture', constraints: false })\n\nuser.getPictures() // gets you all pictures\nuser.getProfilePicture() // gets you only the profile picture\n\nUser.findAll({\n where: ...,\n include: [\n { model: Picture }, // load all pictures\n { model: Picture, as: 'ProfilePicture' }, // load the profile picture.\n // Notice that the spelling must be the exact same as the one in the association\n ]\n})\n```\nTo get full control over the foreign key column added by sequelize, you can use the `foreignKey` option. It can either be a string, that specifies the name, or and object type definition,\nequivalent to those passed to `sequelize.define`.\n\n```js\nUser.hasMany(Picture, { foreignKey: 'uid' })\n```\n\nThe foreign key column in Picture will now be called `uid` instead of the default `userId`.\n\n```js\nUser.hasMany(Picture, {\n foreignKey: {\n name: 'uid',\n allowNull: false\n }\n})\n```\n\nThis specifies that the `uid` column cannot be null. In most cases this will already be covered by the foreign key constraints, which sequelize creates automatically, but can be useful in case where the foreign keys are disabled, e.g. due to circular references (see `constraints: false` below).\n\nWhen fetching associated models, you can limit your query to only load some models. These queries are written in the same way as queries to `find`/`findAll`. To only get pictures in JPG, you can do:\n\n```js\nuser.getPictures({\n where: {\n format: 'jpg'\n }\n})\n```\n\nThere are several ways to update and add new associations. Continuing with our example of users and pictures:\n```js\nuser.addPicture(p) // Add a single picture\nuser.setPictures([p1, p2]) // Associate user with ONLY these two picture, all other associations will be deleted\nuser.addPictures([p1, p2]) // Associate user with these two pictures, but don't touch any current associations\n```\n\nYou don't have to pass in a complete object to the association functions, if your associated model has a single primary key:\n\n```js\nuser.addPicture(req.query.pid) // Here pid is just an integer, representing the primary key of the picture\n```\n\nIn the example above we have specified that a user belongs to his profile picture. Conceptually, this might not make sense, but since we want to add the foreign key to the user model this is the way to do it.\n\nNote how we also specified `constraints: false` for profile picture. This is because we add a foreign key from user to picture (profilePictureId), and from picture to user (userId). If we were to add foreign keys to both, it would create a cyclic dependency, and sequelize would not know which table to create first, since user depends on picture, and picture depends on user. These kinds of problems are detected by sequelize before the models are synced to the database, and you will get an error along the lines of `Error: Cyclic dependency found. 'users' is dependent of itself`. If you encounter this, you should either disable some constraints, or rethink your associations completely.", "lineNumber": 82, "interface": false }, { "__docId__": 3, "kind": "constructor", "name": "constructor", "memberof": "lib/associations/base.js~Association", "generator": false, "async": false, "static": false, "longname": "lib/associations/base.js~Association#constructor", "access": null, "description": null, "lineNumber": 83, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "source", "types": [ "*" ] }, { "name": "target", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 4, "kind": "member", "name": "source", "memberof": "lib/associations/base.js~Association", "static": false, "longname": "lib/associations/base.js~Association#source", "access": null, "description": "", "lineNumber": 88, "type": { "nullable": null, "types": [ "Model" ], "spread": false, "description": null } }, { "__docId__": 5, "kind": "member", "name": "target", "memberof": "lib/associations/base.js~Association", "static": false, "longname": "lib/associations/base.js~Association#target", "access": null, "description": "", "lineNumber": 92, "type": { "nullable": null, "types": [ "Model" ], "spread": false, "description": null } }, { "__docId__": 6, "kind": "member", "name": "options", "memberof": "lib/associations/base.js~Association", "static": false, "longname": "lib/associations/base.js~Association#options", "access": null, "description": null, "lineNumber": 93, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 7, "kind": "member", "name": "scope", "memberof": "lib/associations/base.js~Association", "static": false, "longname": "lib/associations/base.js~Association#scope", "access": null, "description": null, "lineNumber": 94, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 8, "kind": "member", "name": "isSelfAssociation", "memberof": "lib/associations/base.js~Association", "static": false, "longname": "lib/associations/base.js~Association#isSelfAssociation", "access": null, "description": null, "lineNumber": 95, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 9, "kind": "member", "name": "as", "memberof": "lib/associations/base.js~Association", "static": false, "longname": "lib/associations/base.js~Association#as", "access": null, "description": null, "lineNumber": 96, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 10, "kind": "member", "name": "associationType", "memberof": "lib/associations/base.js~Association", "static": false, "longname": "lib/associations/base.js~Association#associationType", "access": null, "description": "The type of the association. One of `HasMany`, `BelongsTo`, `HasOne`, `BelongsToMany`", "lineNumber": 101, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 11, "kind": "method", "name": "toInstanceArray", "memberof": "lib/associations/base.js~Association", "generator": false, "async": false, "static": false, "longname": "lib/associations/base.js~Association#toInstanceArray", "access": null, "description": null, "lineNumber": 110, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "objs", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 12, "kind": "method", "name": "inspect", "memberof": "lib/associations/base.js~Association", "generator": false, "async": false, "static": false, "longname": "lib/associations/base.js~Association#inspect", "access": null, "description": null, "lineNumber": 125, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 13, "kind": "file", "name": "lib/associations/belongs-to-many.js", "content": "", "static": true, "longname": "lib/associations/belongs-to-many.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 14, "kind": "variable", "name": "Utils", "memberof": "lib/associations/belongs-to-many.js", "static": true, "longname": "lib/associations/belongs-to-many.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to-many.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 15, "kind": "variable", "name": "Helpers", "memberof": "lib/associations/belongs-to-many.js", "static": true, "longname": "lib/associations/belongs-to-many.js~Helpers", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to-many.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 16, "kind": "variable", "name": "_", "memberof": "lib/associations/belongs-to-many.js", "static": true, "longname": "lib/associations/belongs-to-many.js~_", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to-many.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 17, "kind": "variable", "name": "Association", "memberof": "lib/associations/belongs-to-many.js", "static": true, "longname": "lib/associations/belongs-to-many.js~Association", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to-many.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 18, "kind": "variable", "name": "BelongsTo", "memberof": "lib/associations/belongs-to-many.js", "static": true, "longname": "lib/associations/belongs-to-many.js~BelongsTo", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to-many.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 19, "kind": "variable", "name": "HasMany", "memberof": "lib/associations/belongs-to-many.js", "static": true, "longname": "lib/associations/belongs-to-many.js~HasMany", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to-many.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 20, "kind": "variable", "name": "HasOne", "memberof": "lib/associations/belongs-to-many.js", "static": true, "longname": "lib/associations/belongs-to-many.js~HasOne", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to-many.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 21, "kind": "variable", "name": "AssociationError", "memberof": "lib/associations/belongs-to-many.js", "static": true, "longname": "lib/associations/belongs-to-many.js~AssociationError", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to-many.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 22, "kind": "class", "name": "BelongsToMany", "memberof": "lib/associations/belongs-to-many.js", "static": true, "longname": "lib/associations/belongs-to-many.js~BelongsToMany", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to-many.js", "importStyle": null, "description": "Many-to-many association with a join table.\n\nWhen the join table has additional attributes, these can be passed in the options object:\n\n```js\nUserProject = sequelize.define('user_project', {\n role: Sequelize.STRING\n});\nUser.belongsToMany(Project, { through: UserProject });\nProject.belongsToMany(User, { through: UserProject });\n// through is required!\n\nuser.addProject(project, { through: { role: 'manager' }});\n```\n\nAll methods allow you to pass either a persisted instance, its primary key, or a mixture:\n\n```js\nProject.create({ id: 11 }).then(function (project) {\n user.addProjects([project, 12]);\n});\n```\n\nIf you want to set several target instances, but with different attributes you have to set the attributes on the instance, using a property with the name of the through model:\n\n```js\np1.UserProjects = {\n started: true\n}\nuser.setProjects([p1, p2], { through: { started: false }}) // The default value is false, but p1 overrides that.\n```\n\nSimilarly, when fetching through a join table with custom attributes, these attributes will be available as an object with the name of the through model.\n```js\nuser.getProjects().then(function (projects) {\n let p1 = projects[0]\n p1.UserProjects.started // Is this project started yet?\n})\n```\n\nIn the API reference below, add the name of the association to the method, e.g. for `User.belongsToMany(Project)` the getter will be `user.getProjects()`.", "see": [ "{@link Model.belongsToMany}" ], "lineNumber": 57, "interface": false, "extends": [ "Association" ] }, { "__docId__": 23, "kind": "constructor", "name": "constructor", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#constructor", "access": null, "description": null, "lineNumber": 58, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "source", "types": [ "*" ] }, { "name": "target", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 24, "kind": "member", "name": "associationType", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#associationType", "access": null, "description": null, "lineNumber": 71, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 25, "kind": "member", "name": "targetAssociation", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#targetAssociation", "access": null, "description": null, "lineNumber": 72, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 26, "kind": "member", "name": "sequelize", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#sequelize", "access": null, "description": null, "lineNumber": 73, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 27, "kind": "member", "name": "through", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#through", "access": null, "description": null, "lineNumber": 74, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 28, "kind": "member", "name": "isMultiAssociation", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#isMultiAssociation", "access": null, "description": null, "lineNumber": 75, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 29, "kind": "member", "name": "doubleLinked", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#doubleLinked", "access": null, "description": null, "lineNumber": 76, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 30, "kind": "member", "name": "isAliased", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#isAliased", "access": null, "description": null, "lineNumber": 83, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 31, "kind": "member", "name": "as", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#as", "access": null, "description": null, "lineNumber": 87, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 32, "kind": "member", "name": "as", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#as", "access": null, "description": null, "lineNumber": 95, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 33, "kind": "member", "name": "combinedTableName", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#combinedTableName", "access": null, "description": null, "lineNumber": 99, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 34, "kind": "member", "name": "targetAssociation", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#targetAssociation", "access": null, "description": null, "lineNumber": 108, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 35, "kind": "member", "name": "foreignKeyAttribute", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#foreignKeyAttribute", "access": null, "description": null, "lineNumber": 115, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 36, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#foreignKey", "access": null, "description": null, "lineNumber": 116, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 37, "kind": "member", "name": "foreignKeyDefault", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#foreignKeyDefault", "access": null, "description": null, "lineNumber": 119, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 38, "kind": "member", "name": "foreignKeyAttribute", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#foreignKeyAttribute", "access": null, "description": null, "lineNumber": 122, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 39, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#foreignKey", "access": null, "description": null, "lineNumber": 123, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 40, "kind": "member", "name": "otherKeyAttribute", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#otherKeyAttribute", "access": null, "description": null, "lineNumber": 133, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 41, "kind": "member", "name": "otherKey", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#otherKey", "access": null, "description": null, "lineNumber": 134, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 42, "kind": "member", "name": "otherKeyDefault", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#otherKeyDefault", "access": null, "description": null, "lineNumber": 137, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 43, "kind": "member", "name": "otherKeyAttribute", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#otherKeyAttribute", "access": null, "description": null, "lineNumber": 140, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 44, "kind": "member", "name": "otherKey", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#otherKey", "access": null, "description": null, "lineNumber": 141, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 45, "kind": "member", "name": "paired", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#paired", "access": null, "description": null, "lineNumber": 163, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 46, "kind": "member", "name": "options", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#options", "access": null, "description": null, "lineNumber": 181, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 47, "kind": "member", "name": "otherKey", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#otherKey", "access": null, "description": null, "lineNumber": 187, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 48, "kind": "member", "name": "throughModel", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#throughModel", "access": null, "description": null, "lineNumber": 201, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 49, "kind": "member", "name": "associationAccessor", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#associationAccessor", "access": null, "description": null, "lineNumber": 206, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 50, "kind": "member", "name": "accessors", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#accessors", "access": null, "description": null, "lineNumber": 212, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"get\": *, \"set\": *, \"addMultiple\": *, \"add\": *, \"create\": *, \"remove\": *, \"removeMultiple\": *, \"hasSingle\": *, \"hasAll\": *, \"count\": *}" ] } }, { "__docId__": 51, "kind": "method", "name": "injectAttributes", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#injectAttributes", "access": null, "description": null, "lineNumber": 228, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 52, "kind": "member", "name": "identifier", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#identifier", "access": null, "description": null, "lineNumber": 230, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 53, "kind": "member", "name": "foreignIdentifier", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#foreignIdentifier", "access": null, "description": null, "lineNumber": 231, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 54, "kind": "member", "name": "primaryKeyDeleted", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#primaryKeyDeleted", "access": null, "description": null, "lineNumber": 245, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 55, "kind": "member", "name": "identifierField", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#identifierField", "access": null, "description": null, "lineNumber": 304, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 56, "kind": "member", "name": "foreignIdentifierField", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#foreignIdentifierField", "access": null, "description": null, "lineNumber": 305, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 57, "kind": "member", "name": "toSource", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#toSource", "access": null, "description": null, "lineNumber": 313, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 58, "kind": "member", "name": "manyFromSource", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#manyFromSource", "access": null, "description": null, "lineNumber": 316, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 59, "kind": "member", "name": "oneFromSource", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#oneFromSource", "access": null, "description": null, "lineNumber": 319, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 60, "kind": "member", "name": "toTarget", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#toTarget", "access": null, "description": null, "lineNumber": 324, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 61, "kind": "member", "name": "manyFromTarget", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#manyFromTarget", "access": null, "description": null, "lineNumber": 327, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 62, "kind": "member", "name": "oneFromTarget", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#oneFromTarget", "access": null, "description": null, "lineNumber": 330, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 63, "kind": "method", "name": "mixin", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#mixin", "access": null, "description": null, "lineNumber": 351, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "obj", "types": [ "*" ] } ] }, { "__docId__": 64, "kind": "method", "name": "get", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#get", "access": null, "description": "Get everything currently associated with this, using an optional where clause.", "see": [ "{@link Model.findAll} for a full explanation of options" ], "lineNumber": 373, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.where", "description": "An optional where clause to limit the associated models" }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "name": "options.scope", "description": "Apply a scope on the related model, or remove its default scope by passing false" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.schema", "description": "Apply a schema on the related model" } ], "return": { "nullable": null, "types": [ "Promise>" ], "spread": false, "description": "" } }, { "__docId__": 65, "kind": "method", "name": "count", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#count", "access": null, "description": "Count everything currently associated with this, using an optional where clause.", "lineNumber": 440, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.where", "description": "An optional where clause to limit the associated models" }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "name": "options.scope", "description": "Apply a scope on the related model, or remove its default scope by passing false" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 66, "kind": "method", "name": "has", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#has", "access": null, "description": "Check if one or more instance(s) are associated with this. If a list of instances is passed, the function returns true if _all_ instances are associated", "lineNumber": 463, "params": [ { "nullable": null, "types": [ "Model[]", "Model", "string[]", "String", "number[]", "Number" ], "spread": false, "optional": true, "name": "instance(s)", "description": "Can be an array of instances or their primary keys" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to getAssociations" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 67, "kind": "method", "name": "set", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#set", "access": null, "description": "Set the associated models by passing an array of instances or their primary keys. Everything that it not in the passed array will be un-associated.", "lineNumber": 506, "params": [ { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "newAssociations", "description": "An array of persisted instances or primary key of instances to associate with this. Pass `null` or `undefined` to remove all associations." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `through.findAll`, `bulkCreate`, `update` and `destroy`" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.validate", "description": "Run validation for the join model" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.through", "description": "Additional attributes for the join table." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 68, "kind": "method", "name": "add", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#add", "access": null, "description": "Associate one ore several rows with `this`.", "lineNumber": 599, "params": [ { "nullable": null, "types": [ "Model[]", "Model", "string[]", "string", "number[]", "Number" ], "spread": false, "optional": true, "name": "newAssociation(s)", "description": "A single instance or primary key, or a mixed array of persisted instances or primary keys" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `through.findAll`, `bulkCreate` and `update`" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.validate", "description": "Run validation for the join model." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.through", "description": "Additional attributes for the join table." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 69, "kind": "method", "name": "remove", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#remove", "access": null, "description": "Un-associate one or more instance(s).", "lineNumber": 681, "params": [ { "nullable": null, "types": [ "Model", "String", "Number" ], "spread": false, "optional": true, "name": "oldAssociated", "description": "Can be an Instance or its primary key, or a mixed array of instances and primary keys" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `through.destroy`" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 70, "kind": "method", "name": "create", "memberof": "lib/associations/belongs-to-many.js~BelongsToMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to-many.js~BelongsToMany#create", "access": null, "description": "Create a new instance of the associated model and associate it with this.", "lineNumber": 703, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "values", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to create and add" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.through", "description": "Additional attributes for the join table" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 71, "kind": "file", "name": "lib/associations/belongs-to.js", "content": "", "static": true, "longname": "lib/associations/belongs-to.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 72, "kind": "variable", "name": "Utils", "memberof": "lib/associations/belongs-to.js", "static": true, "longname": "lib/associations/belongs-to.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 73, "kind": "variable", "name": "Helpers", "memberof": "lib/associations/belongs-to.js", "static": true, "longname": "lib/associations/belongs-to.js~Helpers", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 74, "kind": "variable", "name": "_", "memberof": "lib/associations/belongs-to.js", "static": true, "longname": "lib/associations/belongs-to.js~_", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 75, "kind": "variable", "name": "Transaction", "memberof": "lib/associations/belongs-to.js", "static": true, "longname": "lib/associations/belongs-to.js~Transaction", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 76, "kind": "variable", "name": "Association", "memberof": "lib/associations/belongs-to.js", "static": true, "longname": "lib/associations/belongs-to.js~Association", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 77, "kind": "class", "name": "BelongsTo", "memberof": "lib/associations/belongs-to.js", "static": true, "longname": "lib/associations/belongs-to.js~BelongsTo", "access": null, "export": false, "importPath": "sequelize/lib/associations/belongs-to.js", "importStyle": null, "description": "One-to-one association\n\nIn the API reference below, add the name of the association to the method, e.g. for `User.belongsTo(Project)` the getter will be `user.getProject()`.", "see": [ "{@link Model.belongsTo}" ], "lineNumber": 16, "interface": false, "extends": [ "Association" ] }, { "__docId__": 78, "kind": "constructor", "name": "constructor", "memberof": "lib/associations/belongs-to.js~BelongsTo", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#constructor", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "source", "types": [ "*" ] }, { "name": "target", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 79, "kind": "member", "name": "associationType", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#associationType", "access": null, "description": null, "lineNumber": 20, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 80, "kind": "member", "name": "isSingleAssociation", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#isSingleAssociation", "access": null, "description": null, "lineNumber": 21, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 81, "kind": "member", "name": "foreignKeyAttribute", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#foreignKeyAttribute", "access": null, "description": null, "lineNumber": 22, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 82, "kind": "member", "name": "isAliased", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#isAliased", "access": null, "description": null, "lineNumber": 25, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 83, "kind": "member", "name": "as", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#as", "access": null, "description": null, "lineNumber": 30, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 84, "kind": "member", "name": "foreignKeyAttribute", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#foreignKeyAttribute", "access": null, "description": null, "lineNumber": 35, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 85, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#foreignKey", "access": null, "description": null, "lineNumber": 36, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 86, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#foreignKey", "access": null, "description": null, "lineNumber": 38, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 87, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#foreignKey", "access": null, "description": null, "lineNumber": 42, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 88, "kind": "member", "name": "identifier", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#identifier", "access": null, "description": null, "lineNumber": 51, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 89, "kind": "member", "name": "identifierField", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#identifierField", "access": null, "description": null, "lineNumber": 54, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 90, "kind": "member", "name": "targetKey", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#targetKey", "access": null, "description": null, "lineNumber": 57, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 91, "kind": "member", "name": "targetKeyField", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#targetKeyField", "access": null, "description": null, "lineNumber": 58, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 92, "kind": "member", "name": "targetKeyIsPrimary", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#targetKeyIsPrimary", "access": null, "description": null, "lineNumber": 59, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 93, "kind": "member", "name": "targetIdentifier", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#targetIdentifier", "access": null, "description": null, "lineNumber": 61, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 94, "kind": "member", "name": "associationAccessor", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#associationAccessor", "access": null, "description": null, "lineNumber": 62, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 95, "kind": "member", "name": "accessors", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#accessors", "access": null, "description": null, "lineNumber": 68, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"get\": *, \"set\": *, \"create\": *}" ] } }, { "__docId__": 96, "kind": "method", "name": "injectAttributes", "memberof": "lib/associations/belongs-to.js~BelongsTo", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#injectAttributes", "access": null, "description": null, "lineNumber": 76, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 97, "kind": "member", "name": "identifierField", "memberof": "lib/associations/belongs-to.js~BelongsTo", "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#identifierField", "access": null, "description": null, "lineNumber": 93, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 98, "kind": "method", "name": "mixin", "memberof": "lib/associations/belongs-to.js~BelongsTo", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#mixin", "access": null, "description": null, "lineNumber": 102, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "obj", "types": [ "*" ] } ] }, { "__docId__": 99, "kind": "method", "name": "get", "memberof": "lib/associations/belongs-to.js~BelongsTo", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#get", "access": null, "description": "Get the associated instance.", "see": [ "{@link Model.findOne} for a full explanation of options" ], "lineNumber": 117, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "name": "options.scope", "description": "Apply a scope on the related model, or remove its default scope by passing false." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.schema", "description": "Apply a schema on the related model" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 100, "kind": "method", "name": "set", "memberof": "lib/associations/belongs-to.js~BelongsTo", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#set", "access": null, "description": "Set the associated model.", "lineNumber": 185, "params": [ { "nullable": null, "types": [ "Model", "String", "Number" ], "spread": false, "optional": true, "name": "newAssociation", "description": "An persisted instance or the primary key of an instance to associate with this. Pass `null` or `undefined` to remove the association." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `this.save`" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.save", "description": "Skip saving this after setting the foreign key if false." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 101, "kind": "method", "name": "create", "memberof": "lib/associations/belongs-to.js~BelongsTo", "generator": false, "async": false, "static": false, "longname": "lib/associations/belongs-to.js~BelongsTo#create", "access": null, "description": "Create a new instance of the associated model and associate it with this.", "see": [ "{@link Model#create} for a full explanation of options" ], "lineNumber": 217, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "values", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `target.create` and setAssociation." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 102, "kind": "file", "name": "lib/associations/has-many.js", "content": "", "static": true, "longname": "lib/associations/has-many.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 103, "kind": "variable", "name": "Utils", "memberof": "lib/associations/has-many.js", "static": true, "longname": "lib/associations/has-many.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-many.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 104, "kind": "variable", "name": "Helpers", "memberof": "lib/associations/has-many.js", "static": true, "longname": "lib/associations/has-many.js~Helpers", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-many.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 105, "kind": "variable", "name": "_", "memberof": "lib/associations/has-many.js", "static": true, "longname": "lib/associations/has-many.js~_", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-many.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 106, "kind": "variable", "name": "Association", "memberof": "lib/associations/has-many.js", "static": true, "longname": "lib/associations/has-many.js~Association", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-many.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 107, "kind": "class", "name": "HasMany", "memberof": "lib/associations/has-many.js", "static": true, "longname": "lib/associations/has-many.js~HasMany", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-many.js", "importStyle": null, "description": "One-to-many association\n\nIn the API reference below, add the name of the association to the method, e.g. for `User.hasMany(Project)` the getter will be `user.getProjects()`.\nIf the association is aliased, use the alias instead, e.g. `User.hasMany(Project, { as: 'jobs' })` will be `user.getJobs()`.", "see": [ "{@link Model.hasMany}" ], "lineNumber": 16, "interface": false, "extends": [ "Association" ] }, { "__docId__": 108, "kind": "constructor", "name": "constructor", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#constructor", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "source", "types": [ "*" ] }, { "name": "target", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 109, "kind": "member", "name": "associationType", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#associationType", "access": null, "description": null, "lineNumber": 20, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 110, "kind": "member", "name": "targetAssociation", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#targetAssociation", "access": null, "description": null, "lineNumber": 21, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 111, "kind": "member", "name": "sequelize", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#sequelize", "access": null, "description": null, "lineNumber": 22, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 112, "kind": "member", "name": "through", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#through", "access": null, "description": null, "lineNumber": 23, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 113, "kind": "member", "name": "isMultiAssociation", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#isMultiAssociation", "access": null, "description": null, "lineNumber": 24, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 114, "kind": "member", "name": "foreignKeyAttribute", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#foreignKeyAttribute", "access": null, "description": null, "lineNumber": 25, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 115, "kind": "member", "name": "targetAssociation", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#targetAssociation", "access": null, "description": null, "lineNumber": 35, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 116, "kind": "member", "name": "isAliased", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#isAliased", "access": null, "description": null, "lineNumber": 39, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 117, "kind": "member", "name": "as", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#as", "access": null, "description": null, "lineNumber": 43, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 118, "kind": "member", "name": "as", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#as", "access": null, "description": null, "lineNumber": 51, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 119, "kind": "member", "name": "foreignKeyAttribute", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#foreignKeyAttribute", "access": null, "description": null, "lineNumber": 59, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 120, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#foreignKey", "access": null, "description": null, "lineNumber": 60, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 121, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#foreignKey", "access": null, "description": null, "lineNumber": 62, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 122, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#foreignKey", "access": null, "description": null, "lineNumber": 66, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 123, "kind": "member", "name": "identifierField", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#identifierField", "access": null, "description": null, "lineNumber": 76, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 124, "kind": "member", "name": "foreignKeyField", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#foreignKeyField", "access": null, "description": null, "lineNumber": 77, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 125, "kind": "member", "name": "sourceKey", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#sourceKey", "access": null, "description": null, "lineNumber": 80, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 126, "kind": "member", "name": "sourceKeyField", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#sourceKeyField", "access": null, "description": null, "lineNumber": 82, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 127, "kind": "member", "name": "sourceKeyField", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#sourceKeyField", "access": null, "description": null, "lineNumber": 84, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 128, "kind": "member", "name": "sourceKeyAttribute", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#sourceKeyAttribute", "access": null, "description": null, "lineNumber": 88, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 129, "kind": "member", "name": "sourceKeyAttribute", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#sourceKeyAttribute", "access": null, "description": null, "lineNumber": 90, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 130, "kind": "member", "name": "sourceIdentifier", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#sourceIdentifier", "access": null, "description": null, "lineNumber": 92, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 131, "kind": "member", "name": "associationAccessor", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#associationAccessor", "access": null, "description": null, "lineNumber": 93, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 132, "kind": "member", "name": "accessors", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#accessors", "access": null, "description": null, "lineNumber": 99, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"get\": *, \"set\": *, \"addMultiple\": *, \"add\": *, \"create\": *, \"remove\": *, \"removeMultiple\": *, \"hasSingle\": *, \"hasAll\": *, \"count\": *}" ] } }, { "__docId__": 133, "kind": "method", "name": "injectAttributes", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#injectAttributes", "access": null, "description": null, "lineNumber": 115, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 134, "kind": "member", "name": "identifierField", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#identifierField", "access": null, "description": null, "lineNumber": 131, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 135, "kind": "member", "name": "foreignKeyField", "memberof": "lib/associations/has-many.js~HasMany", "static": false, "longname": "lib/associations/has-many.js~HasMany#foreignKeyField", "access": null, "description": null, "lineNumber": 132, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 136, "kind": "method", "name": "mixin", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#mixin", "access": null, "description": null, "lineNumber": 142, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "obj", "types": [ "*" ] } ] }, { "__docId__": 137, "kind": "method", "name": "get", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#get", "access": null, "description": "Get everything currently associated with this, using an optional where clause.", "see": [ "{@link Model.findAll} for a full explanation of options" ], "lineNumber": 164, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.where", "description": "An optional where clause to limit the associated models" }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "name": "options.scope", "description": "Apply a scope on the related model, or remove its default scope by passing false" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.schema", "description": "Apply a schema on the related model" } ], "return": { "nullable": null, "types": [ "Promise>" ], "spread": false, "description": "" } }, { "__docId__": 138, "kind": "method", "name": "count", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#count", "access": null, "description": "Count everything currently associated with this, using an optional where clause.", "lineNumber": 245, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.where", "description": "An optional where clause to limit the associated models" }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "name": "options.scope", "description": "Apply a scope on the related model, or remove its default scope by passing false" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 139, "kind": "method", "name": "has", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#has", "access": null, "description": "Check if one or more rows are associated with `this`.", "lineNumber": 267, "params": [ { "nullable": null, "types": [ "Model[]", "Model", "string[]", "String", "number[]", "Number" ], "spread": false, "optional": true, "name": "instance(s)", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to getAssociations" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 140, "kind": "method", "name": "set", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#set", "access": null, "description": "Set the associated models by passing an array of persisted instances or their primary keys. Everything that is not in the passed array will be un-associated", "lineNumber": 308, "params": [ { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "newAssociations", "description": "An array of persisted instances or primary key of instances to associate with this. Pass `null` or `undefined` to remove all associations." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `target.findAll` and `update`." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.validate", "description": "Run validation for the join model" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 141, "kind": "method", "name": "add", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#add", "access": null, "description": "Associate one or more target rows with `this`. This method accepts a Model / string / number to associate a single row,\nor a mixed array of Model / string / numbers to associate multiple rows.", "lineNumber": 381, "params": [ { "nullable": null, "types": [ "Model[]", "Model", "string[]", "string", "number[]", "number" ], "spread": false, "optional": true, "name": "newAssociation(s)", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `target.update`." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 142, "kind": "method", "name": "remove", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#remove", "access": null, "description": "Un-associate one or several target rows.", "lineNumber": 409, "params": [ { "nullable": null, "types": [ "Model[]", "Model", "String[]", "string", "Number[]", "number" ], "spread": false, "optional": true, "name": "oldAssociatedInstance(s)", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `target.update`" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 143, "kind": "method", "name": "create", "memberof": "lib/associations/has-many.js~HasMany", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-many.js~HasMany#create", "access": null, "description": "Create a new instance of the associated model and associate it with this.", "lineNumber": 434, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "values", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `target.create`." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 144, "kind": "file", "name": "lib/associations/has-one.js", "content": "", "static": true, "longname": "lib/associations/has-one.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 145, "kind": "variable", "name": "Utils", "memberof": "lib/associations/has-one.js", "static": true, "longname": "lib/associations/has-one.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-one.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 146, "kind": "variable", "name": "Helpers", "memberof": "lib/associations/has-one.js", "static": true, "longname": "lib/associations/has-one.js~Helpers", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-one.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 147, "kind": "variable", "name": "_", "memberof": "lib/associations/has-one.js", "static": true, "longname": "lib/associations/has-one.js~_", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-one.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 148, "kind": "variable", "name": "Association", "memberof": "lib/associations/has-one.js", "static": true, "longname": "lib/associations/has-one.js~Association", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-one.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 149, "kind": "class", "name": "HasOne", "memberof": "lib/associations/has-one.js", "static": true, "longname": "lib/associations/has-one.js~HasOne", "access": null, "export": false, "importPath": "sequelize/lib/associations/has-one.js", "importStyle": null, "description": "One-to-one association\n\nIn the API reference below, add the name of the association to the method, e.g. for `User.hasOne(Project)` the getter will be `user.getProject()`.\nThis is almost the same as `belongsTo` with one exception - The foreign key will be defined on the target model.", "see": [ "{@link Model.hasOne}" ], "lineNumber": 16, "interface": false, "extends": [ "Association" ] }, { "__docId__": 150, "kind": "constructor", "name": "constructor", "memberof": "lib/associations/has-one.js~HasOne", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-one.js~HasOne#constructor", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "source", "types": [ "*" ] }, { "name": "target", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 151, "kind": "member", "name": "associationType", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#associationType", "access": null, "description": null, "lineNumber": 20, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 152, "kind": "member", "name": "isSingleAssociation", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#isSingleAssociation", "access": null, "description": null, "lineNumber": 21, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 153, "kind": "member", "name": "foreignKeyAttribute", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#foreignKeyAttribute", "access": null, "description": null, "lineNumber": 22, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 154, "kind": "member", "name": "isAliased", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#isAliased", "access": null, "description": null, "lineNumber": 25, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 155, "kind": "member", "name": "as", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#as", "access": null, "description": null, "lineNumber": 30, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 156, "kind": "member", "name": "foreignKeyAttribute", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#foreignKeyAttribute", "access": null, "description": null, "lineNumber": 35, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 157, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#foreignKey", "access": null, "description": null, "lineNumber": 36, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 158, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#foreignKey", "access": null, "description": null, "lineNumber": 38, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 159, "kind": "member", "name": "foreignKey", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#foreignKey", "access": null, "description": null, "lineNumber": 42, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 160, "kind": "member", "name": "sourceIdentifier", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#sourceIdentifier", "access": null, "description": null, "lineNumber": 51, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 161, "kind": "member", "name": "sourceKey", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#sourceKey", "access": null, "description": null, "lineNumber": 52, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 162, "kind": "member", "name": "sourceKeyIsPrimary", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#sourceKeyIsPrimary", "access": null, "description": null, "lineNumber": 53, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 163, "kind": "member", "name": "associationAccessor", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#associationAccessor", "access": null, "description": null, "lineNumber": 55, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 164, "kind": "member", "name": "identifierField", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#identifierField", "access": null, "description": null, "lineNumber": 59, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 165, "kind": "member", "name": "accessors", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#accessors", "access": null, "description": null, "lineNumber": 65, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"get\": *, \"set\": *, \"create\": *}" ] } }, { "__docId__": 166, "kind": "method", "name": "injectAttributes", "memberof": "lib/associations/has-one.js~HasOne", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-one.js~HasOne#injectAttributes", "access": null, "description": null, "lineNumber": 73, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 167, "kind": "member", "name": "identifierField", "memberof": "lib/associations/has-one.js~HasOne", "static": false, "longname": "lib/associations/has-one.js~HasOne#identifierField", "access": null, "description": null, "lineNumber": 83, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 168, "kind": "method", "name": "mixin", "memberof": "lib/associations/has-one.js~HasOne", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-one.js~HasOne#mixin", "access": null, "description": null, "lineNumber": 101, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "obj", "types": [ "*" ] } ] }, { "__docId__": 169, "kind": "method", "name": "get", "memberof": "lib/associations/has-one.js~HasOne", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-one.js~HasOne#get", "access": null, "description": "Get the associated instance.", "see": [ "{@link Model.findOne} for a full explanation of options" ], "lineNumber": 116, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "name": "options.scope", "description": "Apply a scope on the related model, or remove its default scope by passing false" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.schema", "description": "Apply a schema on the related model" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 170, "kind": "method", "name": "set", "memberof": "lib/associations/has-one.js~HasOne", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-one.js~HasOne#set", "access": null, "description": "Set the associated model.", "lineNumber": 181, "params": [ { "nullable": null, "types": [ "Model", "String", "Number" ], "spread": false, "optional": true, "name": "newAssociation", "description": "An persisted instance or the primary key of a persisted instance to associate with this. Pass `null` or `undefined` to remove the association." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to getAssociation and `target.save`" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 171, "kind": "method", "name": "create", "memberof": "lib/associations/has-one.js~HasOne", "generator": false, "async": false, "static": false, "longname": "lib/associations/has-one.js~HasOne#create", "access": null, "description": "Create a new instance of the associated model and associate it with this.", "see": [ "{@link Model#create} for a full explanation of options" ], "lineNumber": 232, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "values", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options passed to `target.create` and setAssociation." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 172, "kind": "file", "name": "lib/associations/helpers.js", "content": "", "static": true, "longname": "lib/associations/helpers.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 173, "kind": "variable", "name": "Utils", "memberof": "lib/associations/helpers.js", "static": true, "longname": "lib/associations/helpers.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/associations/helpers.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 174, "kind": "function", "name": "checkNamingCollision", "memberof": "lib/associations/helpers.js", "generator": false, "async": false, "static": true, "longname": "lib/associations/helpers.js~checkNamingCollision", "access": null, "export": false, "importPath": "sequelize/lib/associations/helpers.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "association", "types": [ "*" ] } ] }, { "__docId__": 175, "kind": "function", "name": "addForeignKeyConstraints", "memberof": "lib/associations/helpers.js", "generator": false, "async": false, "static": true, "longname": "lib/associations/helpers.js~addForeignKeyConstraints", "access": null, "export": false, "importPath": "sequelize/lib/associations/helpers.js", "importStyle": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "newAttribute", "types": [ "*" ] }, { "name": "source", "types": [ "*" ] }, { "name": "target", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] }, { "name": "key", "types": [ "*" ] } ] }, { "__docId__": 176, "kind": "function", "name": "mixinMethods", "memberof": "lib/associations/helpers.js", "generator": false, "async": false, "static": true, "longname": "lib/associations/helpers.js~mixinMethods", "access": "private", "export": false, "importPath": "sequelize/lib/associations/helpers.js", "importStyle": null, "description": "Mixin (inject) association methods to model prototype", "lineNumber": 57, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "Association", "description": "instance" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "Model", "description": "prototype" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": false, "name": "Method", "description": "names to inject" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "Mapping", "description": "between model and association method names" } ] }, { "__docId__": 177, "kind": "file", "name": "lib/associations/index.js", "content": "", "static": true, "longname": "lib/associations/index.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 178, "kind": "variable", "name": "Association", "memberof": "lib/associations/index.js", "static": true, "longname": "lib/associations/index.js~Association", "access": null, "export": false, "importPath": "sequelize/lib/associations/index.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 179, "kind": "file", "name": "lib/associations/mixin.js", "content": "", "static": true, "longname": "lib/associations/mixin.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 180, "kind": "variable", "name": "Utils", "memberof": "lib/associations/mixin.js", "static": true, "longname": "lib/associations/mixin.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/associations/mixin.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 181, "kind": "variable", "name": "_", "memberof": "lib/associations/mixin.js", "static": true, "longname": "lib/associations/mixin.js~_", "access": null, "export": false, "importPath": "sequelize/lib/associations/mixin.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 182, "kind": "variable", "name": "HasOne", "memberof": "lib/associations/mixin.js", "static": true, "longname": "lib/associations/mixin.js~HasOne", "access": null, "export": false, "importPath": "sequelize/lib/associations/mixin.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 183, "kind": "variable", "name": "HasMany", "memberof": "lib/associations/mixin.js", "static": true, "longname": "lib/associations/mixin.js~HasMany", "access": null, "export": false, "importPath": "sequelize/lib/associations/mixin.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 184, "kind": "variable", "name": "BelongsToMany", "memberof": "lib/associations/mixin.js", "static": true, "longname": "lib/associations/mixin.js~BelongsToMany", "access": null, "export": false, "importPath": "sequelize/lib/associations/mixin.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 185, "kind": "variable", "name": "BelongsTo", "memberof": "lib/associations/mixin.js", "static": true, "longname": "lib/associations/mixin.js~BelongsTo", "access": null, "export": false, "importPath": "sequelize/lib/associations/mixin.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 186, "kind": "variable", "name": "Mixin", "memberof": "lib/associations/mixin.js", "static": true, "longname": "lib/associations/mixin.js~Mixin", "access": null, "export": false, "importPath": "sequelize/lib/associations/mixin.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"hasMany\": function, \"belongsToMany\": function, \"getAssociations\": function, \"getAssociationForAlias\": function, \"verifyAssociationAlias\": function}" ] } }, { "__docId__": 187, "kind": "function", "name": "singleLinked", "memberof": "lib/associations/mixin.js", "generator": false, "async": false, "static": true, "longname": "lib/associations/mixin.js~singleLinked", "access": null, "export": false, "importPath": "sequelize/lib/associations/mixin.js", "importStyle": null, "description": null, "lineNumber": 78, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "Type", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 188, "kind": "file", "name": "lib/data-types.js", "content": "", "static": true, "longname": "lib/data-types.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 189, "kind": "variable", "name": "util", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~util", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 190, "kind": "variable", "name": "inherits", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~inherits", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 191, "kind": "variable", "name": "_", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~_", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 192, "kind": "variable", "name": "Wkt", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~Wkt", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 193, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 194, "kind": "variable", "name": "warnings", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~warnings", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 195, "kind": "variable", "name": "Validator", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~Validator", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 196, "kind": "variable", "name": "momentTz", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~momentTz", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 197, "kind": "variable", "name": "moment", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~moment", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 198, "kind": "variable", "name": "Utils", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 199, "kind": "function", "name": "ABSTRACT", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~ABSTRACT", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 200, "kind": "function", "name": "toString", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toString", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 19, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 201, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 22, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 202, "kind": "function", "name": "warn", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~warn", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 25, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "link", "types": [ "*" ] }, { "name": "text", "types": [ "*" ] } ] }, { "__docId__": 203, "kind": "function", "name": "stringify", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~stringify", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 31, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 204, "kind": "function", "name": "STRING", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~STRING", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 38, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] }, { "name": "binary", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 205, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 50, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 206, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 53, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 207, "kind": "function", "name": "CHAR", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~CHAR", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 71, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] }, { "name": "binary", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 208, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 80, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 209, "kind": "function", "name": "TEXT", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~TEXT", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 84, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 210, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 93, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 211, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 105, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 212, "kind": "function", "name": "NUMBER", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~NUMBER", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 113, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 213, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 125, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 214, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 143, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 215, "kind": "function", "name": "INTEGER", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~INTEGER", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 166, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 216, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 174, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 217, "kind": "function", "name": "BIGINT", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~BIGINT", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 182, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 218, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 190, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 219, "kind": "function", "name": "FLOAT", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~FLOAT", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 198, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] }, { "name": "decimals", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 220, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 206, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 221, "kind": "function", "name": "REAL", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~REAL", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 214, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] }, { "name": "decimals", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 222, "kind": "function", "name": "DOUBLE", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~DOUBLE", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 223, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] }, { "name": "decimals", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 223, "kind": "function", "name": "DECIMAL", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~DECIMAL", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 232, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "precision", "types": [ "*" ] }, { "name": "scale", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 224, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 240, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 225, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 248, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 226, "kind": "function", "name": "BOOLEAN", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~BOOLEAN", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 270, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 227, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 276, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 228, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 279, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 229, "kind": "function", "name": "TIME", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~TIME", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 287, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 230, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 293, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 231, "kind": "function", "name": "DATE", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~DATE", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 297, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 232, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 308, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 233, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 311, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 234, "kind": "function", "name": "_applyTimezone", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~_applyTimezone", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 319, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "date", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 235, "kind": "function", "name": "_stringify", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~_stringify", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 333, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "date", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 236, "kind": "function", "name": "DATEONLY", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~DATEONLY", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 340, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 237, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 346, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 238, "kind": "function", "name": "_stringify", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~_stringify", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 350, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "date", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 239, "kind": "function", "name": "HSTORE", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~HSTORE", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 354, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 240, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 360, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 241, "kind": "function", "name": "JSONTYPE", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~JSONTYPE", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 368, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 242, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 374, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 243, "kind": "function", "name": "_stringify", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~_stringify", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 378, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 244, "kind": "function", "name": "JSONB", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~JSONB", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 382, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 245, "kind": "function", "name": "NOW", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~NOW", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 390, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 246, "kind": "function", "name": "BLOB", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~BLOB", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 397, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "length", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 247, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 406, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 248, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 418, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 249, "kind": "function", "name": "_stringify", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~_stringify", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 427, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 250, "kind": "function", "name": "_hexify", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~_hexify", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 440, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "hex", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 251, "kind": "function", "name": "RANGE", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~RANGE", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 444, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "subtype", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 252, "kind": "variable", "name": "pgRangeSubtypes", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~pgRangeSubtypes", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 460, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"integer\": string, \"bigint\": string, \"decimal\": string, \"dateonly\": string, \"date\": string, \"datenotz\": string}" ] } }, { "__docId__": 253, "kind": "variable", "name": "pgRangeCastTypes", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~pgRangeCastTypes", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 469, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"integer\": string, \"bigint\": string, \"decimal\": string, \"dateonly\": string, \"date\": string, \"datenotz\": string}" ] } }, { "__docId__": 254, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 479, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 255, "kind": "function", "name": "toCastType", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toCastType", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 482, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 256, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 485, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 257, "kind": "function", "name": "UUID", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~UUID", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 501, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 258, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 507, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 259, "kind": "function", "name": "UUIDV1", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~UUIDV1", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 515, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 260, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 521, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 261, "kind": "function", "name": "UUIDV4", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~UUIDV4", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 529, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 262, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 535, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 263, "kind": "function", "name": "VIRTUAL", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~VIRTUAL", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 543, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "ReturnType", "types": [ "*" ] }, { "name": "fields", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 264, "kind": "function", "name": "ENUM", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~ENUM", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 554, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 265, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 567, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 266, "kind": "function", "name": "ARRAY", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~ARRAY", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 575, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "type", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 267, "kind": "function", "name": "toSql", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 583, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 268, "kind": "function", "name": "validate", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 586, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 269, "kind": "function", "name": "is", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~is", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 593, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "obj", "types": [ "*" ] }, { "name": "type", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 270, "kind": "variable", "name": "helpers", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~helpers", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 597, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"BINARY\": *, \"UNSIGNED\": *, \"ZEROFILL\": *, \"PRECISION\": *, \"SCALE\": *}" ] } }, { "__docId__": 271, "kind": "function", "name": "GEOMETRY", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~GEOMETRY", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 605, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "type", "types": [ "*" ] }, { "name": "srid", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 272, "kind": "function", "name": "_stringify", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~_stringify", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 619, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 273, "kind": "function", "name": "GEOGRAPHY", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~GEOGRAPHY", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 623, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "type", "types": [ "*" ] }, { "name": "srid", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 274, "kind": "function", "name": "_stringify", "memberof": "lib/data-types.js", "generator": false, "async": false, "static": true, "longname": "lib/data-types.js~_stringify", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": null, "lineNumber": 637, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 275, "kind": "variable", "name": "DataTypes", "memberof": "lib/data-types.js", "static": true, "longname": "lib/data-types.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/data-types.js", "importStyle": null, "description": "A convenience class holding commonly used data types. The datatypes are used when defining a new model using `Sequelize.define`, like this:\n```js\nsequelize.define('model', {\n column: DataTypes.INTEGER\n})\n```\nWhen 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\nthat that column will be returned as an instance of `Buffer` when being fetched by sequelize.\n\nTo provide a length for the data type, you can invoke it like a function: `INTEGER(2)`\n\nSome data types have special properties that can be accessed in order to change the data type.\nFor example, to get an unsigned integer with zerofill you can do `DataTypes.INTEGER.UNSIGNED.ZEROFILL`.\nThe order you access the properties in do not matter, so `DataTypes.INTEGER.ZEROFILL.UNSIGNED` is fine as well.\n\n* All number types (`INTEGER`, `BIGINT`, `FLOAT`, `DOUBLE`, `REAL`, `DECIMAL`) expose the properties `UNSIGNED` and `ZEROFILL`\n* The `CHAR` and `STRING` types expose the `BINARY` property\n\n\nThree 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\ndefining default values. For example, to get a uuid field with a default value generated following v1 of the UUID standard:\n```js`\nsequelize.define('model',` {\n uuid: {\n type: DataTypes.UUID,\n defaultValue: DataTypes.UUIDV1,\n primaryKey: true\n }\n})\n```\nThere may be times when you want to generate your own UUID conforming to some other algorithm. This is accomplished\nusing the defaultValue property as well, but instead of specifying one of the supplied UUID types, you return a value\nfrom a function.\n```js\nsequelize.define('model', {\n uuid: {\n type: DataTypes.UUID,\n defaultValue: function() {\n return generateMyId()\n },\n primaryKey: true\n }\n})\n```", "lineNumber": 804, "properties": [ { "nullable": null, "types": [ "function(length=255: integer)" ], "spread": false, "optional": false, "name": "STRING", "description": "A variable length string" }, { "nullable": null, "types": [ "function(length=255: integer)" ], "spread": false, "optional": false, "name": "CHAR", "description": "A fixed length string." }, { "nullable": null, "types": [ "function([length]: string)" ], "spread": false, "optional": false, "name": "TEXT", "description": "An unlimited length text column. Available lengths: `tiny`, `medium`, `long`" }, { "nullable": null, "types": [ "function(length=255: integer)" ], "spread": false, "optional": false, "name": "INTEGER", "description": "A 32 bit integer." }, { "nullable": null, "types": [ "function(length: integer)" ], "spread": false, "optional": false, "name": "BIGINT", "description": "A 64 bit integer. Note: an attribute defined as `BIGINT` will be treated like a `string` due this [feature from node-postgres](https://github.com/brianc/node-postgres/pull/353) to prevent precision loss. To have this attribute as a `number`, this is a possible [workaround](https://github.com/sequelize/sequelize/issues/2383#issuecomment-58006083)." }, { "nullable": null, "types": [ "function(length: integer, decimals: integer)" ], "spread": false, "optional": false, "name": "FLOAT", "description": "Floating point number (4-byte precision)." }, { "nullable": null, "types": [ "function(length: integer, decimals: integer)" ], "spread": false, "optional": false, "name": "DOUBLE", "description": "Floating point number (8-byte precision)." }, { "nullable": null, "types": [ "function(precision: integer, scale: integer)" ], "spread": false, "optional": false, "name": "DECIMAL", "description": "Decimal number." }, { "nullable": null, "types": [ "function(length: integer, decimals: integer)" ], "spread": false, "optional": false, "name": "REAL", "description": "Floating point number (4-byte precision)." }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "BOOLEAN", "description": "A boolean / tinyint column, depending on dialect" }, { "nullable": null, "types": [ "function(length: string)" ], "spread": false, "optional": false, "name": "BLOB", "description": "Binary storage. Available lengths: `tiny`, `medium`, `long`" }, { "nullable": null, "types": [ "function(values: string[])" ], "spread": false, "optional": false, "name": "ENUM", "description": "An enumeration. `DataTypes.ENUM('value', 'another value')`." }, { "nullable": null, "types": [ "function(length: integer)" ], "spread": false, "optional": false, "name": "DATE", "description": "A datetime column" }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "DATEONLY", "description": "A date only column (no timestamp)" }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "TIME", "description": "A time column" }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "NOW", "description": "A default value of the current timestamp" }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "UUID", "description": "A column storing a unique universal identifier. Use with `UUIDV1` or `UUIDV4` for default values." }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "UUIDV1", "description": "A default unique universal identifier generated following the UUID v1 standard" }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "UUIDV4", "description": "A default unique universal identifier generated following the UUID v4 standard" }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "HSTORE", "description": "A key / value store column. Only available in postgres." }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "JSON", "description": "A JSON string column. Only available in postgres and sqlite." }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "JSONB", "description": "A binary storage JSON column. Only available in postgres." }, { "nullable": null, "types": [ "function(type: DataTypes)" ], "spread": false, "optional": false, "name": "ARRAY", "description": "An array of `type`, e.g. `DataTypes.ARRAY(DataTypes.DECIMAL)`. Only available in postgres." }, { "nullable": null, "types": [ "function(type: DataTypes)" ], "spread": false, "optional": false, "name": "RANGE", "description": "Range types are data types representing a range of values of some element type (called the range's subtype).\nOnly available in postgres. See [the Postgres documentation](http://www.postgresql.org/docs/9.4/static/rangetypes.html) for more details" }, { "nullable": null, "types": [ "function(type: string, srid: string)" ], "spread": false, "optional": false, "name": "GEOMETRY", "description": "A column storing Geometry information. It is only available in PostgreSQL (with PostGIS) or MySQL.\nIn MySQL, allowable Geometry types are `POINT`, `LINESTRING`, `POLYGON`.\n\nGeoJSON is accepted as input and returned as output.\nIn PostGIS, the GeoJSON is parsed using the PostGIS function `ST_GeomFromGeoJSON`.\nIn MySQL it is parsed using the function `GeomFromText`.\nTherefore, one can just follow the [GeoJSON spec](http://geojson.org/geojson-spec.html) for handling geometry objects. See the following examples:\n\n```js\n// Create a new point:\nconst point = { type: 'Point', coordinates: [39.807222,-76.984722]};\n\nUser.create({username: 'username', geometry: point });\n\n// Create a new linestring:\nconst line = { type: 'LineString', 'coordinates': [ [100.0, 0.0], [101.0, 1.0] ] };\n\nUser.create({username: 'username', geometry: line });\n\n// Create a new polygon:\nconst polygon = { type: 'Polygon', coordinates: [\n [ [100.0, 0.0], [101.0, 0.0], [101.0, 1.0],\n [100.0, 1.0], [100.0, 0.0] ]\n ]};\n\nUser.create({username: 'username', geometry: polygon });\n\n// Create a new point with a custom SRID:\nconst point = {\n type: 'Point',\n coordinates: [39.807222,-76.984722],\n crs: { type: 'name', properties: { name: 'EPSG:4326'} }\n};\n\nUser.create({username: 'username', geometry: point })\n```" }, { "nullable": null, "types": [ "function(type: string, srid: string)" ], "spread": false, "optional": false, "name": "GEOGRAPHY", "description": "A geography datatype represents two dimensional spacial objects in an elliptic coord system." }, { "nullable": null, "types": [ "function(returnType: DataTypes, fields: string[])" ], "spread": false, "optional": false, "name": "VIRTUAL", "description": "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.\n\nYou could also use it to validate a value before permuting and storing it. Checking password length before hashing it for example:\n```js\nsequelize.define('user', {\n password_hash: DataTypes.STRING,\n password: {\n type: DataTypes.VIRTUAL,\n set: function (val) {\n // Remember to set the data value, otherwise it won't be validated\n this.setDataValue('password', val);\n this.setDataValue('password_hash', this.salt + val);\n },\n validate: {\n isLongEnough: function (val) {\n if (val.length < 7) {\n throw new Error(\"Please choose a longer password\")\n }\n }\n }\n }\n})\n```\nIn the above code the password is stored plainly in the password field so it can be validated, but is never stored in the DB.\n\nVIRTUAL also takes a return type and dependency fields as arguments\nIf a virtual attribute is present in `attributes` it will automatically pull in the extra fields as well.\nReturn type is mostly useful for setups that rely on types like GraphQL.\n```js\n{\n active: {\n type: new DataTypes.VIRTUAL(DataTypes.BOOLEAN, ['createdAt']),\n get: function() {\n return this.get('createdAt') > Date.now() - (7 * 24 * 60 * 60 * 1000)\n }\n }\n}\n```" } ], "type": { "types": [ "*" ] } }, { "__docId__": 276, "kind": "file", "name": "lib/deferrable.js", "content": "", "static": true, "longname": "lib/deferrable.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 277, "kind": "variable", "name": "util", "memberof": "lib/deferrable.js", "static": true, "longname": "lib/deferrable.js~util", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 278, "kind": "variable", "name": "Deferrable", "memberof": "lib/deferrable.js", "static": true, "longname": "lib/deferrable.js~Deferrable", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": "A collection of properties related to deferrable constraints. It can be used to\nmake foreign key constraints deferrable and to set the constraints within a\ntransaction. This is only supported in PostgreSQL.\n\nThe foreign keys can be configured like this. It will create a foreign key\nthat will check the constraints immediately when the data was inserted.\n\n```js\nsequelize.define('Model', {\n foreign_id: {\n type: Sequelize.INTEGER,\n references: {\n model: OtherModel,\n key: 'id',\n deferrable: Sequelize.Deferrable.INITIALLY_IMMEDIATE\n }\n }\n});\n```\n\nThe constraints can be configured in a transaction like this. It will\ntrigger a query once the transaction has been started and set the constraints\nto be checked at the very end of the transaction.\n\n```js\nsequelize.transaction({\n deferrable: Sequelize.Deferrable.SET_DEFERRED\n});\n```", "lineNumber": 43, "properties": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "INITIALLY_DEFERRED", "description": "Defer constraints checks to the end of transactions." }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "INITIALLY_IMMEDIATE", "description": "Trigger the constraint checks immediately" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "NOT", "description": "Set the constraints to not deferred. This is the default in PostgreSQL and it make it impossible to dynamically defer the constraints within a transaction." }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "SET_DEFERRED", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "SET_IMMEDIATE", "description": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 279, "kind": "function", "name": "ABSTRACT", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~ABSTRACT", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 51, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 280, "kind": "function", "name": "toString", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~toString", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 53, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 281, "kind": "function", "name": "INITIALLY_DEFERRED", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~INITIALLY_DEFERRED", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 57, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 282, "kind": "function", "name": "toSql", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 64, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 283, "kind": "function", "name": "INITIALLY_IMMEDIATE", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~INITIALLY_IMMEDIATE", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 68, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 284, "kind": "function", "name": "toSql", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 75, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 285, "kind": "function", "name": "NOT", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~NOT", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 79, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 286, "kind": "function", "name": "toSql", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 86, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 287, "kind": "function", "name": "SET_DEFERRED", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~SET_DEFERRED", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 90, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "constraints", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 288, "kind": "function", "name": "toSql", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 99, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "queryGenerator", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 289, "kind": "function", "name": "SET_IMMEDIATE", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~SET_IMMEDIATE", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 103, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "constraints", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 290, "kind": "function", "name": "toSql", "memberof": "lib/deferrable.js", "generator": false, "async": false, "static": true, "longname": "lib/deferrable.js~toSql", "access": null, "export": false, "importPath": "sequelize/lib/deferrable.js", "importStyle": null, "description": null, "lineNumber": 112, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "queryGenerator", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 291, "kind": "file", "name": "lib/dialects/abstract/connection-manager.js", "content": "", "static": true, "longname": "lib/dialects/abstract/connection-manager.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 292, "kind": "variable", "name": "Pooling", "memberof": "lib/dialects/abstract/connection-manager.js", "static": true, "longname": "lib/dialects/abstract/connection-manager.js~Pooling", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 293, "kind": "variable", "name": "Promise", "memberof": "lib/dialects/abstract/connection-manager.js", "static": true, "longname": "lib/dialects/abstract/connection-manager.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 294, "kind": "variable", "name": "_", "memberof": "lib/dialects/abstract/connection-manager.js", "static": true, "longname": "lib/dialects/abstract/connection-manager.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 295, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/abstract/connection-manager.js", "static": true, "longname": "lib/dialects/abstract/connection-manager.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 296, "kind": "variable", "name": "debug", "memberof": "lib/dialects/abstract/connection-manager.js", "static": true, "longname": "lib/dialects/abstract/connection-manager.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 297, "kind": "variable", "name": "semver", "memberof": "lib/dialects/abstract/connection-manager.js", "static": true, "longname": "lib/dialects/abstract/connection-manager.js~semver", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 298, "kind": "variable", "name": "timers", "memberof": "lib/dialects/abstract/connection-manager.js", "static": true, "longname": "lib/dialects/abstract/connection-manager.js~timers", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 299, "kind": "variable", "name": "defaultPoolingConfig", "memberof": "lib/dialects/abstract/connection-manager.js", "static": true, "longname": "lib/dialects/abstract/connection-manager.js~defaultPoolingConfig", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"max\": number, \"min\": *, \"idle\": number, \"acquire\": number, \"handleDisconnects\": boolean}" ] } }, { "__docId__": 300, "kind": "class", "name": "ConnectionManager", "memberof": "lib/dialects/abstract/connection-manager.js", "static": true, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 19, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false }, { "__docId__": 301, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#constructor", "access": null, "description": null, "lineNumber": 20, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dialect", "types": [ "*" ] }, { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 302, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#sequelize", "access": null, "description": null, "lineNumber": 23, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 303, "kind": "member", "name": "config", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#config", "access": null, "description": null, "lineNumber": 24, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 304, "kind": "member", "name": "dialect", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#dialect", "access": null, "description": null, "lineNumber": 25, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 305, "kind": "member", "name": "versionPromise", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#versionPromise", "access": null, "description": null, "lineNumber": 26, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 306, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 27, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 307, "kind": "member", "name": "dialectName", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#dialectName", "access": null, "description": null, "lineNumber": 28, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 308, "kind": "member", "name": "onProcessExit", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#onProcessExit", "access": null, "description": null, "lineNumber": 40, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 309, "kind": "method", "name": "refreshTypeParser", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#refreshTypeParser", "access": null, "description": null, "lineNumber": 47, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dataTypes", "types": [ "*" ] } ] }, { "__docId__": 310, "kind": "method", "name": "onProcessExit", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#onProcessExit", "access": null, "description": null, "lineNumber": 59, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 311, "kind": "method", "name": "close", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#close", "access": null, "description": null, "lineNumber": 70, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 312, "kind": "method", "name": "initPools", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#initPools", "access": null, "description": null, "lineNumber": 82, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 313, "kind": "member", "name": "pool", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#pool", "access": null, "description": null, "lineNumber": 86, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 314, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 91, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 315, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 98, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 316, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 118, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 317, "kind": "member", "name": "pool", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#pool", "access": null, "description": null, "lineNumber": 140, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"release\": *, \"acquire\": *, \"destroy\": *, \"clear\": *, \"drain\": *, \"read\": *, \"write\": *}" ] } }, { "__docId__": 318, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 181, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 319, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 185, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 320, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 208, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 321, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 212, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 322, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 231, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 323, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 235, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 324, "kind": "method", "name": "getConnection", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#getConnection", "access": null, "description": null, "lineNumber": 239, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 325, "kind": "member", "name": "versionPromise", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#versionPromise", "access": null, "description": null, "lineNumber": 255, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 326, "kind": "member", "name": "versionPromise", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#versionPromise", "access": null, "description": null, "lineNumber": 260, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 327, "kind": "member", "name": "poolError", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#poolError", "access": null, "description": null, "lineNumber": 280, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 328, "kind": "method", "name": "releaseConnection", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#releaseConnection", "access": null, "description": null, "lineNumber": 295, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 329, "kind": "method", "name": "_connect", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#_connect", "access": null, "description": null, "lineNumber": 301, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "config", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 330, "kind": "method", "name": "_disconnect", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#_disconnect", "access": null, "description": null, "lineNumber": 307, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 331, "kind": "method", "name": "_validate", "memberof": "lib/dialects/abstract/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/connection-manager.js~ConnectionManager#_validate", "access": null, "description": null, "lineNumber": 311, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 332, "kind": "file", "name": "lib/dialects/abstract/index.js", "content": "", "static": true, "longname": "lib/dialects/abstract/index.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 333, "kind": "class", "name": "AbstractDialect", "memberof": "lib/dialects/abstract/index.js", "static": true, "longname": "lib/dialects/abstract/index.js~AbstractDialect", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/index.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false }, { "__docId__": 334, "kind": "file", "name": "lib/dialects/abstract/query-generator.js", "content": "", "static": true, "longname": "lib/dialects/abstract/query-generator.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 335, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 336, "kind": "variable", "name": "SqlString", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~SqlString", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 337, "kind": "variable", "name": "Model", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~Model", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 338, "kind": "variable", "name": "DataTypes", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 339, "kind": "variable", "name": "util", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~util", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 340, "kind": "variable", "name": "_", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 341, "kind": "variable", "name": "Dottie", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~Dottie", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 342, "kind": "variable", "name": "BelongsTo", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~BelongsTo", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 343, "kind": "variable", "name": "BelongsToMany", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~BelongsToMany", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 344, "kind": "variable", "name": "HasMany", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~HasMany", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 345, "kind": "variable", "name": "uuid", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~uuid", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 346, "kind": "variable", "name": "semver", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~semver", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 347, "kind": "variable", "name": "QueryGenerator", "memberof": "lib/dialects/abstract/query-generator.js", "static": true, "longname": "lib/dialects/abstract/query-generator.js~QueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query-generator.js", "importStyle": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"options\": *, \"extractTableDetails\": function, \"addSchema\": function, \"dropSchema\": function, \"describeTableQuery\": function, \"dropTableQuery\": function, \"renameTableQuery\": function, \"insertQuery\": function, \"bulkInsertQuery\": function, \"updateQuery\": function, \"arithmeticQuery\": function, \"nameIndexes\": function, \"addIndexQuery\": function, \"quoteTable\": function, \"quote\": function, \"quoteIdentifiers\": function, \"escape\": function, \"selectQuery\": function, \"escapeAttributes\": function, \"generateInclude\": function, \"generateJoin\": function, \"generateThroughJoin\": function, \"getQueryOrders\": function, \"selectFromTableFragment\": function, \"setAutocommitQuery\": function, \"setIsolationLevelQuery\": function, \"generateTransactionId\": function, \"startTransactionQuery\": function, \"deferConstraintsQuery\": function, \"setConstraintQuery\": function, \"setDeferredQuery\": function, \"setImmediateQuery\": function, \"commitTransactionQuery\": function, \"rollbackTransactionQuery\": function, \"addLimitAndOffset\": function, \"handleSequelizeMethod\": function, \"whereQuery\": function, \"whereItemsQuery\": function, \"whereItemQuery\": function, \"getWhereConditions\": function, \"parseConditionObject\": function, \"jsonPathExtractionQuery\": function, \"isIdentifierQuoted\": function, \"booleanValue\": function}" ] } }, { "__docId__": 348, "kind": "file", "name": "lib/dialects/abstract/query.js", "content": "", "static": true, "longname": "lib/dialects/abstract/query.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 349, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/abstract/query.js", "static": true, "longname": "lib/dialects/abstract/query.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 350, "kind": "variable", "name": "SqlString", "memberof": "lib/dialects/abstract/query.js", "static": true, "longname": "lib/dialects/abstract/query.js~SqlString", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 351, "kind": "variable", "name": "Dot", "memberof": "lib/dialects/abstract/query.js", "static": true, "longname": "lib/dialects/abstract/query.js~Dot", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 352, "kind": "variable", "name": "QueryTypes", "memberof": "lib/dialects/abstract/query.js", "static": true, "longname": "lib/dialects/abstract/query.js~QueryTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 353, "kind": "class", "name": "AbstractQuery", "memberof": "lib/dialects/abstract/query.js", "static": true, "longname": "lib/dialects/abstract/query.js~AbstractQuery", "access": null, "export": false, "importPath": "sequelize/lib/dialects/abstract/query.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false }, { "__docId__": 354, "kind": "method", "name": "formatBindParameters", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": true, "longname": "lib/dialects/abstract/query.js~AbstractQuery.formatBindParameters", "access": "private", "description": "rewrite query with parameters\n\nExamples:\n\n query.formatBindParameters('select $1 as foo', ['fooval']);\n\n query.formatBindParameters('select $foo as foo', { foo: 'fooval' });\n\nOptions\n skipUnescape: bool, skip unescaping $$\n skipValueReplace: bool, do not replace (but do unescape $$). Check correct syntax and if all values are available", "lineNumber": 24, "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "dialect", "types": [ "*" ] }, { "name": "replacementFunc", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "undefined[]" ] } }, { "__docId__": 355, "kind": "method", "name": "run", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#run", "access": "private", "description": "Execute the passed sql query.\n\nExamples:\n\n query.run('SELECT 1')", "lineNumber": 100, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "sql", "description": "The SQL query which should be executed." } ] }, { "__docId__": 356, "kind": "method", "name": "checkLoggingOption", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#checkLoggingOption", "access": "private", "description": "Check the logging option of the instance and print deprecation warnings.", "lineNumber": 110, "params": [], "return": { "nullable": null, "types": [ "void" ], "spread": false, "description": "" } }, { "__docId__": 357, "kind": "method", "name": "getInsertIdField", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#getInsertIdField", "access": "private", "description": "Get the attributes of an insert query, which contains the just inserted id.", "lineNumber": 123, "params": [], "return": { "nullable": null, "types": [ "String" ], "spread": false, "description": "The field name." } }, { "__docId__": 358, "kind": "method", "name": "findTableNameInAttribute", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#findTableNameInAttribute", "access": "private", "description": "Iterate over all known tables and search their names inside the sql query.\nThis method will also check association aliases ('as' option).", "lineNumber": 135, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "attribute", "description": "An attribute of a SQL query. (?)" } ], "return": { "nullable": null, "types": [ "String" ], "spread": false, "description": "The found tableName / alias." } }, { "__docId__": 359, "kind": "method", "name": "getUniqueConstraintErrorMessage", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#getUniqueConstraintErrorMessage", "access": null, "description": null, "lineNumber": 152, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "field", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 360, "kind": "method", "name": "isRawQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isRawQuery", "access": null, "description": null, "lineNumber": 167, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 361, "kind": "method", "name": "isVersionQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isVersionQuery", "access": null, "description": null, "lineNumber": 171, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 362, "kind": "method", "name": "isUpsertQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isUpsertQuery", "access": null, "description": null, "lineNumber": 175, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 363, "kind": "method", "name": "isInsertQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isInsertQuery", "access": null, "description": null, "lineNumber": 179, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "results", "types": [ "*" ] }, { "name": "metaData", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 364, "kind": "method", "name": "handleInsertQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#handleInsertQuery", "access": null, "description": null, "lineNumber": 198, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "results", "types": [ "*" ] }, { "name": "metaData", "types": [ "*" ] } ] }, { "__docId__": 365, "kind": "method", "name": "isShowTablesQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isShowTablesQuery", "access": null, "description": null, "lineNumber": 211, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 366, "kind": "method", "name": "handleShowTablesQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#handleShowTablesQuery", "access": null, "description": null, "lineNumber": 215, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "results", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 367, "kind": "method", "name": "isShowIndexesQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isShowIndexesQuery", "access": null, "description": null, "lineNumber": 219, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 368, "kind": "method", "name": "isDescribeQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isDescribeQuery", "access": null, "description": null, "lineNumber": 223, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 369, "kind": "method", "name": "isSelectQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isSelectQuery", "access": null, "description": null, "lineNumber": 227, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 370, "kind": "method", "name": "isBulkUpdateQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isBulkUpdateQuery", "access": null, "description": null, "lineNumber": 231, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 371, "kind": "method", "name": "isBulkDeleteQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isBulkDeleteQuery", "access": null, "description": null, "lineNumber": 235, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 372, "kind": "method", "name": "isForeignKeysQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isForeignKeysQuery", "access": null, "description": null, "lineNumber": 239, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 373, "kind": "method", "name": "isUpdateQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isUpdateQuery", "access": null, "description": null, "lineNumber": 243, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 374, "kind": "method", "name": "handleSelectQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#handleSelectQuery", "access": null, "description": null, "lineNumber": 247, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "results", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 375, "kind": "method", "name": "isShowOrDescribeQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isShowOrDescribeQuery", "access": null, "description": null, "lineNumber": 312, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 376, "kind": "method", "name": "isCallQuery", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": false, "longname": "lib/dialects/abstract/query.js~AbstractQuery#isCallQuery", "access": null, "description": null, "lineNumber": 321, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 377, "kind": "method", "name": "_groupJoinData", "memberof": "lib/dialects/abstract/query.js~AbstractQuery", "generator": false, "async": false, "static": true, "longname": "lib/dialects/abstract/query.js~AbstractQuery._groupJoinData", "access": "private", "description": "The function takes the result of the query execution and groups\nthe associated data by the callee.\n\nExample:\n groupJoinData([\n {\n some: 'data',\n id: 1,\n association: { foo: 'bar', id: 1 }\n }, {\n some: 'data',\n id: 1,\n association: { foo: 'bar', id: 2 }\n }, {\n some: 'data',\n id: 1,\n association: { foo: 'bar', id: 3 }\n }\n ])\n\nResult:\n Something like this:\n\n [\n {\n some: 'data',\n id: 1,\n association: [\n { foo: 'bar', id: 1 },\n { foo: 'bar', id: 2 },\n { foo: 'bar', id: 3 }\n ]\n }\n ]", "lineNumber": 362, "params": [ { "name": "rows", "types": [ "*" ] }, { "name": "includeOptions", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 378, "kind": "file", "name": "lib/dialects/mssql/connection-manager.js", "content": "", "static": true, "longname": "lib/dialects/mssql/connection-manager.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 379, "kind": "variable", "name": "AbstractConnectionManager", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~AbstractConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 380, "kind": "variable", "name": "ResourceLock", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~ResourceLock", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 381, "kind": "variable", "name": "Promise", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 382, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 383, "kind": "variable", "name": "debug", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 384, "kind": "variable", "name": "debugTedious", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~debugTedious", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 385, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 386, "kind": "variable", "name": "parserStore", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~parserStore", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 387, "kind": "variable", "name": "_", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 388, "kind": "class", "name": "ConnectionManager", "memberof": "lib/dialects/mssql/connection-manager.js", "static": true, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractConnectionManager" ] }, { "__docId__": 389, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager#constructor", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dialect", "types": [ "*" ] }, { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 390, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager#sequelize", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 391, "kind": "member", "name": "lib", "memberof": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager#lib", "access": null, "description": null, "lineNumber": 21, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 392, "kind": "member", "name": "lib", "memberof": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager#lib", "access": null, "description": null, "lineNumber": 23, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 393, "kind": "method", "name": "_refreshTypeParser", "memberof": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager#_refreshTypeParser", "access": null, "description": null, "lineNumber": 34, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dataType", "types": [ "*" ] } ] }, { "__docId__": 394, "kind": "method", "name": "_clearTypeParser", "memberof": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager#_clearTypeParser", "access": null, "description": null, "lineNumber": 38, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 395, "kind": "method", "name": "connect", "memberof": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager#connect", "access": null, "description": null, "lineNumber": 42, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "config", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 396, "kind": "method", "name": "disconnect", "memberof": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager#disconnect", "access": null, "description": null, "lineNumber": 132, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connectionLock", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 397, "kind": "method", "name": "validate", "memberof": "lib/dialects/mssql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/connection-manager.js~ConnectionManager#validate", "access": null, "description": null, "lineNumber": 147, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connectionLock", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 398, "kind": "file", "name": "lib/dialects/mssql/data-types.js", "content": "", "static": true, "longname": "lib/dialects/mssql/data-types.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 399, "kind": "variable", "name": "_", "memberof": "lib/dialects/mssql/data-types.js", "static": true, "longname": "lib/dialects/mssql/data-types.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/data-types.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 400, "kind": "variable", "name": "moment", "memberof": "lib/dialects/mssql/data-types.js", "static": true, "longname": "lib/dialects/mssql/data-types.js~moment", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/data-types.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 401, "kind": "variable", "name": "inherits", "memberof": "lib/dialects/mssql/data-types.js", "static": true, "longname": "lib/dialects/mssql/data-types.js~inherits", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/data-types.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 402, "kind": "file", "name": "lib/dialects/mssql/index.js", "content": "", "static": true, "longname": "lib/dialects/mssql/index.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 403, "kind": "variable", "name": "_", "memberof": "lib/dialects/mssql/index.js", "static": true, "longname": "lib/dialects/mssql/index.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/index.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 404, "kind": "variable", "name": "AbstractDialect", "memberof": "lib/dialects/mssql/index.js", "static": true, "longname": "lib/dialects/mssql/index.js~AbstractDialect", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/index.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 405, "kind": "variable", "name": "ConnectionManager", "memberof": "lib/dialects/mssql/index.js", "static": true, "longname": "lib/dialects/mssql/index.js~ConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/index.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 406, "kind": "variable", "name": "Query", "memberof": "lib/dialects/mssql/index.js", "static": true, "longname": "lib/dialects/mssql/index.js~Query", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/index.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 407, "kind": "variable", "name": "QueryGenerator", "memberof": "lib/dialects/mssql/index.js", "static": true, "longname": "lib/dialects/mssql/index.js~QueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/index.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 408, "kind": "variable", "name": "DataTypes", "memberof": "lib/dialects/mssql/index.js", "static": true, "longname": "lib/dialects/mssql/index.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/index.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 409, "kind": "class", "name": "MssqlDialect", "memberof": "lib/dialects/mssql/index.js", "static": true, "longname": "lib/dialects/mssql/index.js~MssqlDialect", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/index.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractDialect" ] }, { "__docId__": 410, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/mssql/index.js~MssqlDialect", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/index.js~MssqlDialect#constructor", "access": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 411, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/mssql/index.js~MssqlDialect", "static": false, "longname": "lib/dialects/mssql/index.js~MssqlDialect#sequelize", "access": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 412, "kind": "member", "name": "connectionManager", "memberof": "lib/dialects/mssql/index.js~MssqlDialect", "static": false, "longname": "lib/dialects/mssql/index.js~MssqlDialect#connectionManager", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 413, "kind": "member", "name": "QueryGenerator", "memberof": "lib/dialects/mssql/index.js~MssqlDialect", "static": false, "longname": "lib/dialects/mssql/index.js~MssqlDialect#QueryGenerator", "access": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 414, "kind": "file", "name": "lib/dialects/mssql/query-generator.js", "content": "", "static": true, "longname": "lib/dialects/mssql/query-generator.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 415, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/mssql/query-generator.js", "static": true, "longname": "lib/dialects/mssql/query-generator.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query-generator.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 416, "kind": "function", "name": "throwMethodUndefined", "memberof": "lib/dialects/mssql/query-generator.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/mssql/query-generator.js~throwMethodUndefined", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query-generator.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "methodName", "types": [ "*" ] } ] }, { "__docId__": 417, "kind": "variable", "name": "QueryGenerator", "memberof": "lib/dialects/mssql/query-generator.js", "static": true, "longname": "lib/dialects/mssql/query-generator.js~QueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query-generator.js", "importStyle": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"__proto__\": *, \"options\": *, \"dialect\": string, \"createSchema\": function, \"showSchemasQuery\": function, \"versionQuery\": function, \"createTableQuery\": function, \"describeTableQuery\": function, \"renameTableQuery\": function, \"showTablesQuery\": function, \"dropTableQuery\": function, \"addColumnQuery\": function, \"removeColumnQuery\": function, \"changeColumnQuery\": function, \"renameColumnQuery\": function, \"bulkInsertQuery\": function, \"updateQuery\": function, \"upsertQuery\": function, \"deleteQuery\": function, \"showIndexesQuery\": function, \"removeIndexQuery\": function, \"attributeToSQL\": function, \"attributesToSQL\": function, \"findAutoIncrementField\": function, \"createTrigger\": function, \"dropTrigger\": function, \"renameTrigger\": function, \"createFunction\": function, \"dropFunction\": function, \"renameFunction\": function, \"quoteIdentifier\": function, \"getForeignKeysQuery\": function, \"getForeignKeyQuery\": function, \"getPrimaryKeyConstraintQuery\": function, \"dropForeignKeyQuery\": function, \"getDefaultConstraintQuery\": function, \"dropConstraintQuery\": function, \"setAutocommitQuery\": function, \"setIsolationLevelQuery\": function, \"generateTransactionId\": function, \"startTransactionQuery\": function, \"commitTransactionQuery\": function, \"rollbackTransactionQuery\": function, \"selectFromTableFragment\": function, \"addLimitAndOffset\": function, \"booleanValue\": function}" ] } }, { "__docId__": 418, "kind": "function", "name": "wrapSingleQuote", "memberof": "lib/dialects/mssql/query-generator.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/mssql/query-generator.js~wrapSingleQuote", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query-generator.js", "importStyle": null, "description": null, "lineNumber": 857, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "identifier", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 419, "kind": "file", "name": "lib/dialects/mssql/query-interface.js", "content": "", "static": true, "longname": "lib/dialects/mssql/query-interface.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 420, "kind": "function", "name": "removeColumn", "memberof": "lib/dialects/mssql/query-interface.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/mssql/query-interface.js~removeColumn", "access": "private", "export": false, "importPath": "sequelize/lib/dialects/mssql/query-interface.js", "importStyle": null, "description": "A wrapper that fixes MSSQL's inability to cleanly remove columns from existing tables if they have a default constraint.", "lineNumber": 23, "unknown": [ { "tagName": "@method", "tagValue": "removeColumn" }, { "tagName": "@for", "tagValue": " QueryInterface" } ], "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "tableName", "description": "The name of the table." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "attributeName", "description": "The name of the attribute that we want to remove." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean", "Function" ], "spread": false, "optional": true, "name": "options.logging", "description": "A function that logs the sql queries, or false for explicitly not logging these queries" } ], "return": { "types": [ "*" ] } }, { "__docId__": 421, "kind": "file", "name": "lib/dialects/mssql/query.js", "content": "", "static": true, "longname": "lib/dialects/mssql/query.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 422, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/mssql/query.js", "static": true, "longname": "lib/dialects/mssql/query.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 423, "kind": "variable", "name": "debug", "memberof": "lib/dialects/mssql/query.js", "static": true, "longname": "lib/dialects/mssql/query.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 424, "kind": "variable", "name": "Promise", "memberof": "lib/dialects/mssql/query.js", "static": true, "longname": "lib/dialects/mssql/query.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 425, "kind": "variable", "name": "AbstractQuery", "memberof": "lib/dialects/mssql/query.js", "static": true, "longname": "lib/dialects/mssql/query.js~AbstractQuery", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 426, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/dialects/mssql/query.js", "static": true, "longname": "lib/dialects/mssql/query.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 427, "kind": "variable", "name": "parserStore", "memberof": "lib/dialects/mssql/query.js", "static": true, "longname": "lib/dialects/mssql/query.js~parserStore", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 428, "kind": "variable", "name": "_", "memberof": "lib/dialects/mssql/query.js", "static": true, "longname": "lib/dialects/mssql/query.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 429, "kind": "class", "name": "Query", "memberof": "lib/dialects/mssql/query.js", "static": true, "longname": "lib/dialects/mssql/query.js~Query", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/query.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractQuery" ] }, { "__docId__": 430, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#constructor", "access": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] }, { "name": "sequelize", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 431, "kind": "member", "name": "connection", "memberof": "lib/dialects/mssql/query.js~Query", "static": false, "longname": "lib/dialects/mssql/query.js~Query#connection", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 432, "kind": "member", "name": "instance", "memberof": "lib/dialects/mssql/query.js~Query", "static": false, "longname": "lib/dialects/mssql/query.js~Query#instance", "access": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 433, "kind": "member", "name": "model", "memberof": "lib/dialects/mssql/query.js~Query", "static": false, "longname": "lib/dialects/mssql/query.js~Query#model", "access": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 434, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/mssql/query.js~Query", "static": false, "longname": "lib/dialects/mssql/query.js~Query#sequelize", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 435, "kind": "member", "name": "options", "memberof": "lib/dialects/mssql/query.js~Query", "static": false, "longname": "lib/dialects/mssql/query.js~Query#options", "access": null, "description": null, "lineNumber": 18, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 436, "kind": "method", "name": "getInsertIdField", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#getInsertIdField", "access": null, "description": null, "lineNumber": 27, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 437, "kind": "method", "name": "_run", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#_run", "access": null, "description": null, "lineNumber": 31, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] }, { "name": "sql", "types": [ "*" ] }, { "name": "parameters", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 438, "kind": "member", "name": "sql", "memberof": "lib/dialects/mssql/query.js~Query", "static": false, "longname": "lib/dialects/mssql/query.js~Query#sql", "access": null, "description": null, "lineNumber": 32, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 439, "kind": "method", "name": "run", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#run", "access": null, "description": null, "lineNumber": 118, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "parameters", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 440, "kind": "method", "name": "formatResults", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#formatResults", "access": "private", "description": "High level function that handles the results of a query execution.\n\n\nExample:\n query.formatResults([\n {\n id: 1, // this is from the main table\n attr2: 'snafu', // this is from the main table\n Tasks.id: 1, // this is from the associated table\n Tasks.title: 'task' // this is from the associated table\n }\n ])", "lineNumber": 139, "params": [ { "nullable": null, "types": [ "Array" ], "spread": false, "optional": false, "name": "data", "description": "The result of the query execution." } ], "return": { "types": [ "*" ] } }, { "__docId__": 441, "kind": "method", "name": "handleShowTablesQuery", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#handleShowTablesQuery", "access": null, "description": null, "lineNumber": 205, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "results", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 442, "kind": "method", "name": "formatError", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#formatError", "access": null, "description": null, "lineNumber": 214, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "err", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 443, "kind": "method", "name": "isShowOrDescribeQuery", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#isShowOrDescribeQuery", "access": null, "description": null, "lineNumber": 262, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 444, "kind": "method", "name": "isShowIndexesQuery", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#isShowIndexesQuery", "access": null, "description": null, "lineNumber": 272, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 445, "kind": "method", "name": "handleShowIndexesQuery", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#handleShowIndexesQuery", "access": null, "description": null, "lineNumber": 276, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "data", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 446, "kind": "method", "name": "handleInsertQuery", "memberof": "lib/dialects/mssql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mssql/query.js~Query#handleInsertQuery", "access": null, "description": null, "lineNumber": 311, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "results", "types": [ "*" ] }, { "name": "metaData", "types": [ "*" ] } ] }, { "__docId__": 447, "kind": "file", "name": "lib/dialects/mssql/resource-lock.js", "content": "", "static": true, "longname": "lib/dialects/mssql/resource-lock.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 448, "kind": "variable", "name": "Promise", "memberof": "lib/dialects/mssql/resource-lock.js", "static": true, "longname": "lib/dialects/mssql/resource-lock.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/resource-lock.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 449, "kind": "function", "name": "ResourceLock", "memberof": "lib/dialects/mssql/resource-lock.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/mssql/resource-lock.js~ResourceLock", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/resource-lock.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "resource", "types": [ "*" ] } ] }, { "__docId__": 450, "kind": "function", "name": "unwrap", "memberof": "lib/dialects/mssql/resource-lock.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/mssql/resource-lock.js~unwrap", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/resource-lock.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 451, "kind": "function", "name": "lock", "memberof": "lib/dialects/mssql/resource-lock.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/mssql/resource-lock.js~lock", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mssql/resource-lock.js", "importStyle": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 452, "kind": "file", "name": "lib/dialects/mysql/connection-manager.js", "content": "", "static": true, "longname": "lib/dialects/mysql/connection-manager.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 453, "kind": "variable", "name": "AbstractConnectionManager", "memberof": "lib/dialects/mysql/connection-manager.js", "static": true, "longname": "lib/dialects/mysql/connection-manager.js~AbstractConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 454, "kind": "variable", "name": "SequelizeErrors", "memberof": "lib/dialects/mysql/connection-manager.js", "static": true, "longname": "lib/dialects/mysql/connection-manager.js~SequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 455, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/mysql/connection-manager.js", "static": true, "longname": "lib/dialects/mysql/connection-manager.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 456, "kind": "variable", "name": "DataTypes", "memberof": "lib/dialects/mysql/connection-manager.js", "static": true, "longname": "lib/dialects/mysql/connection-manager.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 457, "kind": "variable", "name": "momentTz", "memberof": "lib/dialects/mysql/connection-manager.js", "static": true, "longname": "lib/dialects/mysql/connection-manager.js~momentTz", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 458, "kind": "variable", "name": "debug", "memberof": "lib/dialects/mysql/connection-manager.js", "static": true, "longname": "lib/dialects/mysql/connection-manager.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 459, "kind": "variable", "name": "parserMap", "memberof": "lib/dialects/mysql/connection-manager.js", "static": true, "longname": "lib/dialects/mysql/connection-manager.js~parserMap", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "Map" ] } }, { "__docId__": 460, "kind": "class", "name": "ConnectionManager", "memberof": "lib/dialects/mysql/connection-manager.js", "static": true, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "access": "private", "export": false, "importPath": "sequelize/lib/dialects/mysql/connection-manager.js", "importStyle": null, "description": "MySQL Connection Managger\n\nGet connections, validate and disconnect them.\nAbstractConnectionManager pooling use it to handle MySQL specific connections\nUse https://github.com/sidorares/node-mysql2 to connect with MySQL server", "lineNumber": 23, "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "Class" }, "interface": false, "extends": [ "*" ] }, { "__docId__": 461, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager#constructor", "access": null, "description": null, "lineNumber": 24, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dialect", "types": [ "*" ] }, { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 462, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager#sequelize", "access": null, "description": null, "lineNumber": 27, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 463, "kind": "member", "name": "lib", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager#lib", "access": null, "description": null, "lineNumber": 31, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 464, "kind": "member", "name": "lib", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager#lib", "access": null, "description": null, "lineNumber": 33, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 465, "kind": "method", "name": "_refreshTypeParser", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager#_refreshTypeParser", "access": null, "description": null, "lineNumber": 46, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dataType", "types": [ "*" ] } ] }, { "__docId__": 466, "kind": "method", "name": "_clearTypeParser", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager#_clearTypeParser", "access": null, "description": null, "lineNumber": 52, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 467, "kind": "method", "name": "_typecast", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": true, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager._typecast", "access": null, "description": null, "lineNumber": 56, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "field", "types": [ "*" ] }, { "name": "next", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 468, "kind": "method", "name": "connect", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager#connect", "access": "private", "description": "Connect with MySQL database based on config, Handle any errors in connection\nSet the pool handlers on connection.error\nAlso set proper timezone once conection is connected", "lineNumber": 71, "params": [ { "name": "config", "types": [ "*" ] } ], "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "Promise" } }, { "__docId__": 469, "kind": "method", "name": "disconnect", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager#disconnect", "access": null, "description": null, "lineNumber": 166, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 470, "kind": "method", "name": "validate", "memberof": "lib/dialects/mysql/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/connection-manager.js~ConnectionManager#validate", "access": null, "description": null, "lineNumber": 186, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 471, "kind": "file", "name": "lib/dialects/mysql/data-types.js", "content": "", "static": true, "longname": "lib/dialects/mysql/data-types.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 472, "kind": "variable", "name": "wkx", "memberof": "lib/dialects/mysql/data-types.js", "static": true, "longname": "lib/dialects/mysql/data-types.js~wkx", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/data-types.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 473, "kind": "variable", "name": "_", "memberof": "lib/dialects/mysql/data-types.js", "static": true, "longname": "lib/dialects/mysql/data-types.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/data-types.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 474, "kind": "variable", "name": "moment", "memberof": "lib/dialects/mysql/data-types.js", "static": true, "longname": "lib/dialects/mysql/data-types.js~moment", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/data-types.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 475, "kind": "variable", "name": "inherits", "memberof": "lib/dialects/mysql/data-types.js", "static": true, "longname": "lib/dialects/mysql/data-types.js~inherits", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/data-types.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 476, "kind": "file", "name": "lib/dialects/mysql/index.js", "content": "", "static": true, "longname": "lib/dialects/mysql/index.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 477, "kind": "variable", "name": "_", "memberof": "lib/dialects/mysql/index.js", "static": true, "longname": "lib/dialects/mysql/index.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/index.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 478, "kind": "variable", "name": "AbstractDialect", "memberof": "lib/dialects/mysql/index.js", "static": true, "longname": "lib/dialects/mysql/index.js~AbstractDialect", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/index.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 479, "kind": "variable", "name": "ConnectionManager", "memberof": "lib/dialects/mysql/index.js", "static": true, "longname": "lib/dialects/mysql/index.js~ConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/index.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 480, "kind": "variable", "name": "Query", "memberof": "lib/dialects/mysql/index.js", "static": true, "longname": "lib/dialects/mysql/index.js~Query", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/index.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 481, "kind": "variable", "name": "QueryGenerator", "memberof": "lib/dialects/mysql/index.js", "static": true, "longname": "lib/dialects/mysql/index.js~QueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/index.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 482, "kind": "variable", "name": "DataTypes", "memberof": "lib/dialects/mysql/index.js", "static": true, "longname": "lib/dialects/mysql/index.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/index.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 483, "kind": "class", "name": "MysqlDialect", "memberof": "lib/dialects/mysql/index.js", "static": true, "longname": "lib/dialects/mysql/index.js~MysqlDialect", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/index.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractDialect" ] }, { "__docId__": 484, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/mysql/index.js~MysqlDialect", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/index.js~MysqlDialect#constructor", "access": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 485, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/mysql/index.js~MysqlDialect", "static": false, "longname": "lib/dialects/mysql/index.js~MysqlDialect#sequelize", "access": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 486, "kind": "member", "name": "connectionManager", "memberof": "lib/dialects/mysql/index.js~MysqlDialect", "static": false, "longname": "lib/dialects/mysql/index.js~MysqlDialect#connectionManager", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 487, "kind": "member", "name": "QueryGenerator", "memberof": "lib/dialects/mysql/index.js~MysqlDialect", "static": false, "longname": "lib/dialects/mysql/index.js~MysqlDialect#QueryGenerator", "access": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 488, "kind": "file", "name": "lib/dialects/mysql/query-generator.js", "content": "", "static": true, "longname": "lib/dialects/mysql/query-generator.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 489, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/mysql/query-generator.js", "static": true, "longname": "lib/dialects/mysql/query-generator.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query-generator.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 490, "kind": "variable", "name": "AbstractQueryGenerator", "memberof": "lib/dialects/mysql/query-generator.js", "static": true, "longname": "lib/dialects/mysql/query-generator.js~AbstractQueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query-generator.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 491, "kind": "variable", "name": "QueryGenerator", "memberof": "lib/dialects/mysql/query-generator.js", "static": true, "longname": "lib/dialects/mysql/query-generator.js~QueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query-generator.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"__proto__\": *, \"dialect\": string, \"createSchema\": function, \"showSchemasQuery\": function, \"versionQuery\": function, \"createTableQuery\": function, \"showTablesQuery\": function, \"addColumnQuery\": function, \"removeColumnQuery\": function, \"changeColumnQuery\": function, \"renameColumnQuery\": function, \"upsertQuery\": function, \"deleteQuery\": function, \"showIndexesQuery\": function, \"removeIndexQuery\": function, \"attributeToSQL\": function, \"attributesToSQL\": function, \"findAutoIncrementField\": function, \"quoteIdentifier\": function, \"getForeignKeysQuery\": function, \"getForeignKeyQuery\": function, \"dropForeignKeyQuery\": function}" ] } }, { "__docId__": 492, "kind": "function", "name": "wrapSingleQuote", "memberof": "lib/dialects/mysql/query-generator.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/mysql/query-generator.js~wrapSingleQuote", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query-generator.js", "importStyle": null, "description": null, "lineNumber": 350, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "identifier", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 493, "kind": "file", "name": "lib/dialects/mysql/query-interface.js", "content": "", "static": true, "longname": "lib/dialects/mysql/query-interface.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 494, "kind": "variable", "name": "_", "memberof": "lib/dialects/mysql/query-interface.js", "static": true, "longname": "lib/dialects/mysql/query-interface.js~_", "access": "private", "export": false, "importPath": "sequelize/lib/dialects/mysql/query-interface.js", "importStyle": null, "description": "Returns an object that treats MySQL's inabilities to do certain queries.", "lineNumber": 11, "unknown": [ { "tagName": "@class", "tagValue": "QueryInterface" } ], "type": { "types": [ "*" ] } }, { "__docId__": 495, "kind": "function", "name": "removeColumn", "memberof": "lib/dialects/mysql/query-interface.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/mysql/query-interface.js~removeColumn", "access": "private", "export": false, "importPath": "sequelize/lib/dialects/mysql/query-interface.js", "importStyle": null, "description": "A wrapper that fixes MySQL's inability to cleanly remove columns from existing tables if they have a foreign key constraint.", "lineNumber": 24, "unknown": [ { "tagName": "@method", "tagValue": "removeColumn" }, { "tagName": "@for", "tagValue": " QueryInterface" } ], "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "tableName", "description": "The name of the table." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "columnName", "description": "The name of the attribute that we want to remove." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" } ], "return": { "types": [ "*" ] } }, { "__docId__": 496, "kind": "file", "name": "lib/dialects/mysql/query.js", "content": "", "static": true, "longname": "lib/dialects/mysql/query.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 497, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/mysql/query.js", "static": true, "longname": "lib/dialects/mysql/query.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 498, "kind": "variable", "name": "debug", "memberof": "lib/dialects/mysql/query.js", "static": true, "longname": "lib/dialects/mysql/query.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 499, "kind": "variable", "name": "AbstractQuery", "memberof": "lib/dialects/mysql/query.js", "static": true, "longname": "lib/dialects/mysql/query.js~AbstractQuery", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 500, "kind": "variable", "name": "uuid", "memberof": "lib/dialects/mysql/query.js", "static": true, "longname": "lib/dialects/mysql/query.js~uuid", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 501, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/dialects/mysql/query.js", "static": true, "longname": "lib/dialects/mysql/query.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 502, "kind": "variable", "name": "_", "memberof": "lib/dialects/mysql/query.js", "static": true, "longname": "lib/dialects/mysql/query.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 503, "kind": "class", "name": "Query", "memberof": "lib/dialects/mysql/query.js", "static": true, "longname": "lib/dialects/mysql/query.js~Query", "access": null, "export": false, "importPath": "sequelize/lib/dialects/mysql/query.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractQuery" ] }, { "__docId__": 504, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/mysql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/query.js~Query#constructor", "access": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] }, { "name": "sequelize", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 505, "kind": "member", "name": "connection", "memberof": "lib/dialects/mysql/query.js~Query", "static": false, "longname": "lib/dialects/mysql/query.js~Query#connection", "access": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 506, "kind": "member", "name": "instance", "memberof": "lib/dialects/mysql/query.js~Query", "static": false, "longname": "lib/dialects/mysql/query.js~Query#instance", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 507, "kind": "member", "name": "model", "memberof": "lib/dialects/mysql/query.js~Query", "static": false, "longname": "lib/dialects/mysql/query.js~Query#model", "access": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 508, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/mysql/query.js~Query", "static": false, "longname": "lib/dialects/mysql/query.js~Query#sequelize", "access": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 509, "kind": "member", "name": "uuid", "memberof": "lib/dialects/mysql/query.js~Query", "static": false, "longname": "lib/dialects/mysql/query.js~Query#uuid", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 510, "kind": "member", "name": "options", "memberof": "lib/dialects/mysql/query.js~Query", "static": false, "longname": "lib/dialects/mysql/query.js~Query#options", "access": null, "description": null, "lineNumber": 18, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 511, "kind": "method", "name": "run", "memberof": "lib/dialects/mysql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/query.js~Query#run", "access": null, "description": null, "lineNumber": 28, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "parameters", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 512, "kind": "member", "name": "sql", "memberof": "lib/dialects/mysql/query.js~Query", "static": false, "longname": "lib/dialects/mysql/query.js~Query#sql", "access": null, "description": null, "lineNumber": 29, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 513, "kind": "method", "name": "formatResults", "memberof": "lib/dialects/mysql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/query.js~Query#formatResults", "access": "private", "description": "High level function that handles the results of a query execution.\n\n\nExample:\n query.formatResults([\n {\n id: 1, // this is from the main table\n attr2: 'snafu', // this is from the main table\n Tasks.id: 1, // this is from the associated table\n Tasks.title: 'task' // this is from the associated table\n }\n ])", "lineNumber": 89, "params": [ { "nullable": null, "types": [ "Array" ], "spread": false, "optional": false, "name": "data", "description": "The result of the query execution." } ], "return": { "types": [ "*" ] } }, { "__docId__": 514, "kind": "method", "name": "logWarnings", "memberof": "lib/dialects/mysql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/query.js~Query#logWarnings", "access": null, "description": null, "lineNumber": 152, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "results", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 515, "kind": "method", "name": "formatError", "memberof": "lib/dialects/mysql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/query.js~Query#formatError", "access": null, "description": null, "lineNumber": 174, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "err", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 516, "kind": "method", "name": "handleShowIndexesQuery", "memberof": "lib/dialects/mysql/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/mysql/query.js~Query#handleShowIndexesQuery", "access": null, "description": null, "lineNumber": 224, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "data", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 517, "kind": "file", "name": "lib/dialects/parserStore.js", "content": "", "static": true, "longname": "lib/dialects/parserStore.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 518, "kind": "variable", "name": "stores", "memberof": "lib/dialects/parserStore.js", "static": true, "longname": "lib/dialects/parserStore.js~stores", "access": null, "export": false, "importPath": "sequelize/lib/dialects/parserStore.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "Map" ] } }, { "__docId__": 519, "kind": "file", "name": "lib/dialects/postgres/connection-manager.js", "content": "", "static": true, "longname": "lib/dialects/postgres/connection-manager.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 520, "kind": "variable", "name": "AbstractConnectionManager", "memberof": "lib/dialects/postgres/connection-manager.js", "static": true, "longname": "lib/dialects/postgres/connection-manager.js~AbstractConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 521, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/postgres/connection-manager.js", "static": true, "longname": "lib/dialects/postgres/connection-manager.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 522, "kind": "variable", "name": "debug", "memberof": "lib/dialects/postgres/connection-manager.js", "static": true, "longname": "lib/dialects/postgres/connection-manager.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 523, "kind": "variable", "name": "Promise", "memberof": "lib/dialects/postgres/connection-manager.js", "static": true, "longname": "lib/dialects/postgres/connection-manager.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 524, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/dialects/postgres/connection-manager.js", "static": true, "longname": "lib/dialects/postgres/connection-manager.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 525, "kind": "variable", "name": "semver", "memberof": "lib/dialects/postgres/connection-manager.js", "static": true, "longname": "lib/dialects/postgres/connection-manager.js~semver", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 526, "kind": "variable", "name": "dataTypes", "memberof": "lib/dialects/postgres/connection-manager.js", "static": true, "longname": "lib/dialects/postgres/connection-manager.js~dataTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 527, "kind": "variable", "name": "moment", "memberof": "lib/dialects/postgres/connection-manager.js", "static": true, "longname": "lib/dialects/postgres/connection-manager.js~moment", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 528, "kind": "class", "name": "ConnectionManager", "memberof": "lib/dialects/postgres/connection-manager.js", "static": true, "longname": "lib/dialects/postgres/connection-manager.js~ConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractConnectionManager" ] }, { "__docId__": 529, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/postgres/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/connection-manager.js~ConnectionManager#constructor", "access": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dialect", "types": [ "*" ] }, { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 530, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/postgres/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/postgres/connection-manager.js~ConnectionManager#sequelize", "access": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 531, "kind": "member", "name": "lib", "memberof": "lib/dialects/postgres/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/postgres/connection-manager.js~ConnectionManager#lib", "access": null, "description": null, "lineNumber": 25, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 532, "kind": "method", "name": "_refreshTypeParser", "memberof": "lib/dialects/postgres/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/connection-manager.js~ConnectionManager#_refreshTypeParser", "access": null, "description": null, "lineNumber": 37, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dataType", "types": [ "*" ] } ] }, { "__docId__": 533, "kind": "method", "name": "connect", "memberof": "lib/dialects/postgres/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/connection-manager.js~ConnectionManager#connect", "access": null, "description": null, "lineNumber": 56, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "config", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 534, "kind": "method", "name": "disconnect", "memberof": "lib/dialects/postgres/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/connection-manager.js~ConnectionManager#disconnect", "access": null, "description": null, "lineNumber": 175, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 535, "kind": "method", "name": "validate", "memberof": "lib/dialects/postgres/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/connection-manager.js~ConnectionManager#validate", "access": null, "description": null, "lineNumber": 182, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 536, "kind": "file", "name": "lib/dialects/postgres/data-types.js", "content": "", "static": true, "longname": "lib/dialects/postgres/data-types.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 537, "kind": "variable", "name": "_", "memberof": "lib/dialects/postgres/data-types.js", "static": true, "longname": "lib/dialects/postgres/data-types.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/data-types.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 538, "kind": "variable", "name": "wkx", "memberof": "lib/dialects/postgres/data-types.js", "static": true, "longname": "lib/dialects/postgres/data-types.js~wkx", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/data-types.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 539, "kind": "variable", "name": "inherits", "memberof": "lib/dialects/postgres/data-types.js", "static": true, "longname": "lib/dialects/postgres/data-types.js~inherits", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/data-types.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 540, "kind": "file", "name": "lib/dialects/postgres/hstore.js", "content": "", "static": true, "longname": "lib/dialects/postgres/hstore.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 541, "kind": "variable", "name": "hstore", "memberof": "lib/dialects/postgres/hstore.js", "static": true, "longname": "lib/dialects/postgres/hstore.js~hstore", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/hstore.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 542, "kind": "function", "name": "stringify", "memberof": "lib/dialects/postgres/hstore.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/postgres/hstore.js~stringify", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/hstore.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "data", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 543, "kind": "function", "name": "parse", "memberof": "lib/dialects/postgres/hstore.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/postgres/hstore.js~parse", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/hstore.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 544, "kind": "file", "name": "lib/dialects/postgres/index.js", "content": "", "static": true, "longname": "lib/dialects/postgres/index.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 545, "kind": "variable", "name": "_", "memberof": "lib/dialects/postgres/index.js", "static": true, "longname": "lib/dialects/postgres/index.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/index.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 546, "kind": "variable", "name": "AbstractDialect", "memberof": "lib/dialects/postgres/index.js", "static": true, "longname": "lib/dialects/postgres/index.js~AbstractDialect", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/index.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 547, "kind": "variable", "name": "ConnectionManager", "memberof": "lib/dialects/postgres/index.js", "static": true, "longname": "lib/dialects/postgres/index.js~ConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/index.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 548, "kind": "variable", "name": "Query", "memberof": "lib/dialects/postgres/index.js", "static": true, "longname": "lib/dialects/postgres/index.js~Query", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/index.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 549, "kind": "variable", "name": "QueryGenerator", "memberof": "lib/dialects/postgres/index.js", "static": true, "longname": "lib/dialects/postgres/index.js~QueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/index.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 550, "kind": "variable", "name": "DataTypes", "memberof": "lib/dialects/postgres/index.js", "static": true, "longname": "lib/dialects/postgres/index.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/index.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 551, "kind": "class", "name": "PostgresDialect", "memberof": "lib/dialects/postgres/index.js", "static": true, "longname": "lib/dialects/postgres/index.js~PostgresDialect", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/index.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractDialect" ] }, { "__docId__": 552, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/postgres/index.js~PostgresDialect", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/index.js~PostgresDialect#constructor", "access": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 553, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/postgres/index.js~PostgresDialect", "static": false, "longname": "lib/dialects/postgres/index.js~PostgresDialect#sequelize", "access": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 554, "kind": "member", "name": "connectionManager", "memberof": "lib/dialects/postgres/index.js~PostgresDialect", "static": false, "longname": "lib/dialects/postgres/index.js~PostgresDialect#connectionManager", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 555, "kind": "member", "name": "QueryGenerator", "memberof": "lib/dialects/postgres/index.js~PostgresDialect", "static": false, "longname": "lib/dialects/postgres/index.js~PostgresDialect#QueryGenerator", "access": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 556, "kind": "file", "name": "lib/dialects/postgres/query-generator.js", "content": "", "static": true, "longname": "lib/dialects/postgres/query-generator.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 557, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/postgres/query-generator.js", "static": true, "longname": "lib/dialects/postgres/query-generator.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query-generator.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 558, "kind": "variable", "name": "util", "memberof": "lib/dialects/postgres/query-generator.js", "static": true, "longname": "lib/dialects/postgres/query-generator.js~util", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query-generator.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 559, "kind": "variable", "name": "DataTypes", "memberof": "lib/dialects/postgres/query-generator.js", "static": true, "longname": "lib/dialects/postgres/query-generator.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query-generator.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 560, "kind": "variable", "name": "AbstractQueryGenerator", "memberof": "lib/dialects/postgres/query-generator.js", "static": true, "longname": "lib/dialects/postgres/query-generator.js~AbstractQueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query-generator.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 561, "kind": "variable", "name": "semver", "memberof": "lib/dialects/postgres/query-generator.js", "static": true, "longname": "lib/dialects/postgres/query-generator.js~semver", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query-generator.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 562, "kind": "variable", "name": "_", "memberof": "lib/dialects/postgres/query-generator.js", "static": true, "longname": "lib/dialects/postgres/query-generator.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query-generator.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 563, "kind": "variable", "name": "QueryGenerator", "memberof": "lib/dialects/postgres/query-generator.js", "static": true, "longname": "lib/dialects/postgres/query-generator.js~QueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query-generator.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"__proto__\": *, \"options\": *, \"dialect\": string, \"setSearchPath\": function, \"createSchema\": function, \"dropSchema\": function, \"showSchemasQuery\": function, \"versionQuery\": function, \"createTableQuery\": function, \"dropTableQuery\": function, \"showTablesQuery\": function, \"describeTableQuery\": function, \"checkValidJsonStatement\": function, \"jsonPathExtractionQuery\": function, \"handleSequelizeMethod\": function, \"addColumnQuery\": function, \"removeColumnQuery\": function, \"changeColumnQuery\": function, \"renameColumnQuery\": function, \"fn\": function, \"exceptionFn\": function, \"upsertQuery\": function, \"deleteQuery\": function, \"showIndexesQuery\": function, \"removeIndexQuery\": function, \"addLimitAndOffset\": function, \"attributeToSQL\": function, \"deferConstraintsQuery\": function, \"setConstraintQuery\": function, \"setDeferredQuery\": function, \"setImmediateQuery\": function, \"attributesToSQL\": function, \"findAutoIncrementField\": function, \"createTrigger\": function, \"dropTrigger\": function, \"renameTrigger\": function, \"createFunction\": function, \"dropFunction\": function, \"renameFunction\": function, \"databaseConnectionUri\": function, \"pgEscapeAndQuote\": function, \"expandFunctionParamList\": function, \"expandOptions\": function, \"decodeTriggerEventType\": function, \"triggerEventTypeIsConstraint\": function, \"expandTriggerEventSpec\": function, \"pgEnumName\": function, \"pgListEnums\": function, \"pgEnum\": function, \"pgEnumAdd\": function, \"pgEnumDrop\": function, \"fromArray\": function, \"padInt\": function, \"dataTypeMapping\": function, \"quoteIdentifier\": function, \"getForeignKeysQuery\": function, \"dropForeignKeyQuery\": function, \"setAutocommitQuery\": function}" ] } }, { "__docId__": 564, "kind": "file", "name": "lib/dialects/postgres/query.js", "content": "", "static": true, "longname": "lib/dialects/postgres/query.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 565, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/postgres/query.js", "static": true, "longname": "lib/dialects/postgres/query.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 566, "kind": "variable", "name": "debug", "memberof": "lib/dialects/postgres/query.js", "static": true, "longname": "lib/dialects/postgres/query.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 567, "kind": "variable", "name": "AbstractQuery", "memberof": "lib/dialects/postgres/query.js", "static": true, "longname": "lib/dialects/postgres/query.js~AbstractQuery", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 568, "kind": "variable", "name": "QueryTypes", "memberof": "lib/dialects/postgres/query.js", "static": true, "longname": "lib/dialects/postgres/query.js~QueryTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 569, "kind": "variable", "name": "Promise", "memberof": "lib/dialects/postgres/query.js", "static": true, "longname": "lib/dialects/postgres/query.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 570, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/dialects/postgres/query.js", "static": true, "longname": "lib/dialects/postgres/query.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 571, "kind": "variable", "name": "_", "memberof": "lib/dialects/postgres/query.js", "static": true, "longname": "lib/dialects/postgres/query.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 572, "kind": "class", "name": "Query", "memberof": "lib/dialects/postgres/query.js", "static": true, "longname": "lib/dialects/postgres/query.js~Query", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/query.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractQuery" ] }, { "__docId__": 573, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/postgres/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/query.js~Query#constructor", "access": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "client", "types": [ "*" ] }, { "name": "sequelize", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 574, "kind": "member", "name": "client", "memberof": "lib/dialects/postgres/query.js~Query", "static": false, "longname": "lib/dialects/postgres/query.js~Query#client", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 575, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/postgres/query.js~Query", "static": false, "longname": "lib/dialects/postgres/query.js~Query#sequelize", "access": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 576, "kind": "member", "name": "instance", "memberof": "lib/dialects/postgres/query.js~Query", "static": false, "longname": "lib/dialects/postgres/query.js~Query#instance", "access": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 577, "kind": "member", "name": "model", "memberof": "lib/dialects/postgres/query.js~Query", "static": false, "longname": "lib/dialects/postgres/query.js~Query#model", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 578, "kind": "member", "name": "options", "memberof": "lib/dialects/postgres/query.js~Query", "static": false, "longname": "lib/dialects/postgres/query.js~Query#options", "access": null, "description": null, "lineNumber": 18, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 579, "kind": "method", "name": "formatBindParameters", "memberof": "lib/dialects/postgres/query.js~Query", "generator": false, "async": false, "static": true, "longname": "lib/dialects/postgres/query.js~Query.formatBindParameters", "access": "private", "description": "rewrite query with parameters", "lineNumber": 31, "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "dialect", "types": [ "*" ] } ], "return": { "types": [ "undefined[]" ] } }, { "__docId__": 580, "kind": "method", "name": "run", "memberof": "lib/dialects/postgres/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/query.js~Query#run", "access": null, "description": null, "lineNumber": 56, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "parameters", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 581, "kind": "member", "name": "sql", "memberof": "lib/dialects/postgres/query.js~Query", "static": false, "longname": "lib/dialects/postgres/query.js~Query#sql", "access": null, "description": null, "lineNumber": 57, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 582, "kind": "member", "name": "sql", "memberof": "lib/dialects/postgres/query.js~Query", "static": false, "longname": "lib/dialects/postgres/query.js~Query#sql", "access": null, "description": null, "lineNumber": 60, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 583, "kind": "method", "name": "formatError", "memberof": "lib/dialects/postgres/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/query.js~Query#formatError", "access": null, "description": null, "lineNumber": 282, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "err", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 584, "kind": "method", "name": "isForeignKeysQuery", "memberof": "lib/dialects/postgres/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/query.js~Query#isForeignKeysQuery", "access": null, "description": null, "lineNumber": 355, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 585, "kind": "method", "name": "getInsertIdField", "memberof": "lib/dialects/postgres/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/postgres/query.js~Query#getInsertIdField", "access": null, "description": null, "lineNumber": 359, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 586, "kind": "file", "name": "lib/dialects/postgres/range.js", "content": "", "static": true, "longname": "lib/dialects/postgres/range.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 587, "kind": "variable", "name": "_", "memberof": "lib/dialects/postgres/range.js", "static": true, "longname": "lib/dialects/postgres/range.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/range.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 588, "kind": "function", "name": "stringifyRangeBound", "memberof": "lib/dialects/postgres/range.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/postgres/range.js~stringifyRangeBound", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/range.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "bound", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 589, "kind": "function", "name": "parseRangeBound", "memberof": "lib/dialects/postgres/range.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/postgres/range.js~parseRangeBound", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/range.js", "importStyle": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "bound", "types": [ "*" ] }, { "name": "parseType", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 590, "kind": "function", "name": "stringify", "memberof": "lib/dialects/postgres/range.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/postgres/range.js~stringify", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/range.js", "importStyle": null, "description": null, "lineNumber": 27, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "data", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 591, "kind": "function", "name": "parse", "memberof": "lib/dialects/postgres/range.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/postgres/range.js~parse", "access": null, "export": false, "importPath": "sequelize/lib/dialects/postgres/range.js", "importStyle": null, "description": null, "lineNumber": 56, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "parser", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 592, "kind": "file", "name": "lib/dialects/sqlite/connection-manager.js", "content": "", "static": true, "longname": "lib/dialects/sqlite/connection-manager.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 593, "kind": "variable", "name": "AbstractConnectionManager", "memberof": "lib/dialects/sqlite/connection-manager.js", "static": true, "longname": "lib/dialects/sqlite/connection-manager.js~AbstractConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 594, "kind": "variable", "name": "Promise", "memberof": "lib/dialects/sqlite/connection-manager.js", "static": true, "longname": "lib/dialects/sqlite/connection-manager.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 595, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/sqlite/connection-manager.js", "static": true, "longname": "lib/dialects/sqlite/connection-manager.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 596, "kind": "variable", "name": "debug", "memberof": "lib/dialects/sqlite/connection-manager.js", "static": true, "longname": "lib/dialects/sqlite/connection-manager.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 597, "kind": "variable", "name": "dataTypes", "memberof": "lib/dialects/sqlite/connection-manager.js", "static": true, "longname": "lib/dialects/sqlite/connection-manager.js~dataTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 598, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/dialects/sqlite/connection-manager.js", "static": true, "longname": "lib/dialects/sqlite/connection-manager.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 599, "kind": "variable", "name": "parserStore", "memberof": "lib/dialects/sqlite/connection-manager.js", "static": true, "longname": "lib/dialects/sqlite/connection-manager.js~parserStore", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 600, "kind": "class", "name": "ConnectionManager", "memberof": "lib/dialects/sqlite/connection-manager.js", "static": true, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/connection-manager.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractConnectionManager" ] }, { "__docId__": 601, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#constructor", "access": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dialect", "types": [ "*" ] }, { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 602, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#sequelize", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 603, "kind": "member", "name": "config", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#config", "access": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 604, "kind": "member", "name": "dialect", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#dialect", "access": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 605, "kind": "member", "name": "dialectName", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#dialectName", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 606, "kind": "member", "name": "connections", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#connections", "access": null, "description": null, "lineNumber": 18, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 607, "kind": "member", "name": "lib", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#lib", "access": null, "description": null, "lineNumber": 25, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 608, "kind": "member", "name": "lib", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#lib", "access": null, "description": null, "lineNumber": 27, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 609, "kind": "method", "name": "_refreshTypeParser", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#_refreshTypeParser", "access": null, "description": null, "lineNumber": 40, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dataType", "types": [ "*" ] } ] }, { "__docId__": 610, "kind": "method", "name": "_clearTypeParser", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#_clearTypeParser", "access": null, "description": null, "lineNumber": 44, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 611, "kind": "method", "name": "getConnection", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#getConnection", "access": null, "description": null, "lineNumber": 48, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 612, "kind": "method", "name": "releaseConnection", "memberof": "lib/dialects/sqlite/connection-manager.js~ConnectionManager", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/connection-manager.js~ConnectionManager#releaseConnection", "access": null, "description": null, "lineNumber": 86, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "connection", "types": [ "*" ] }, { "name": "force", "types": [ "*" ] } ] }, { "__docId__": 613, "kind": "file", "name": "lib/dialects/sqlite/data-types.js", "content": "", "static": true, "longname": "lib/dialects/sqlite/data-types.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 614, "kind": "variable", "name": "_", "memberof": "lib/dialects/sqlite/data-types.js", "static": true, "longname": "lib/dialects/sqlite/data-types.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/data-types.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 615, "kind": "variable", "name": "inherits", "memberof": "lib/dialects/sqlite/data-types.js", "static": true, "longname": "lib/dialects/sqlite/data-types.js~inherits", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/data-types.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 616, "kind": "file", "name": "lib/dialects/sqlite/index.js", "content": "", "static": true, "longname": "lib/dialects/sqlite/index.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 617, "kind": "variable", "name": "_", "memberof": "lib/dialects/sqlite/index.js", "static": true, "longname": "lib/dialects/sqlite/index.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/index.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 618, "kind": "variable", "name": "AbstractDialect", "memberof": "lib/dialects/sqlite/index.js", "static": true, "longname": "lib/dialects/sqlite/index.js~AbstractDialect", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/index.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 619, "kind": "variable", "name": "ConnectionManager", "memberof": "lib/dialects/sqlite/index.js", "static": true, "longname": "lib/dialects/sqlite/index.js~ConnectionManager", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/index.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 620, "kind": "variable", "name": "Query", "memberof": "lib/dialects/sqlite/index.js", "static": true, "longname": "lib/dialects/sqlite/index.js~Query", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/index.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 621, "kind": "variable", "name": "QueryGenerator", "memberof": "lib/dialects/sqlite/index.js", "static": true, "longname": "lib/dialects/sqlite/index.js~QueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/index.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 622, "kind": "variable", "name": "DataTypes", "memberof": "lib/dialects/sqlite/index.js", "static": true, "longname": "lib/dialects/sqlite/index.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/index.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 623, "kind": "class", "name": "SqliteDialect", "memberof": "lib/dialects/sqlite/index.js", "static": true, "longname": "lib/dialects/sqlite/index.js~SqliteDialect", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/index.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractDialect" ] }, { "__docId__": 624, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/sqlite/index.js~SqliteDialect", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/index.js~SqliteDialect#constructor", "access": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 625, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/sqlite/index.js~SqliteDialect", "static": false, "longname": "lib/dialects/sqlite/index.js~SqliteDialect#sequelize", "access": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 626, "kind": "member", "name": "connectionManager", "memberof": "lib/dialects/sqlite/index.js~SqliteDialect", "static": false, "longname": "lib/dialects/sqlite/index.js~SqliteDialect#connectionManager", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 627, "kind": "member", "name": "QueryGenerator", "memberof": "lib/dialects/sqlite/index.js~SqliteDialect", "static": false, "longname": "lib/dialects/sqlite/index.js~SqliteDialect#QueryGenerator", "access": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 628, "kind": "file", "name": "lib/dialects/sqlite/query-generator.js", "content": "", "static": true, "longname": "lib/dialects/sqlite/query-generator.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 629, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/sqlite/query-generator.js", "static": true, "longname": "lib/dialects/sqlite/query-generator.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-generator.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 630, "kind": "variable", "name": "util", "memberof": "lib/dialects/sqlite/query-generator.js", "static": true, "longname": "lib/dialects/sqlite/query-generator.js~util", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-generator.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 631, "kind": "variable", "name": "Transaction", "memberof": "lib/dialects/sqlite/query-generator.js", "static": true, "longname": "lib/dialects/sqlite/query-generator.js~Transaction", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-generator.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 632, "kind": "variable", "name": "_", "memberof": "lib/dialects/sqlite/query-generator.js", "static": true, "longname": "lib/dialects/sqlite/query-generator.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-generator.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 633, "kind": "variable", "name": "MySqlQueryGenerator", "memberof": "lib/dialects/sqlite/query-generator.js", "static": true, "longname": "lib/dialects/sqlite/query-generator.js~MySqlQueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-generator.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 634, "kind": "variable", "name": "AbstractQueryGenerator", "memberof": "lib/dialects/sqlite/query-generator.js", "static": true, "longname": "lib/dialects/sqlite/query-generator.js~AbstractQueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-generator.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 635, "kind": "variable", "name": "QueryGenerator", "memberof": "lib/dialects/sqlite/query-generator.js", "static": true, "longname": "lib/dialects/sqlite/query-generator.js~QueryGenerator", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-generator.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"__proto__\": *, \"options\": *, \"dialect\": string, \"createSchema\": function, \"showSchemasQuery\": function, \"versionQuery\": function, \"createTableQuery\": function, \"booleanValue\": function, \"checkValidJsonStatement\": function, \"jsonPathExtractionQuery\": function, \"handleSequelizeMethod\": function, \"addColumnQuery\": function, \"showTablesQuery\": function, \"upsertQuery\": function, \"updateQuery\": function, \"deleteQuery\": function, \"attributesToSQL\": function, \"findAutoIncrementField\": function, \"showIndexesQuery\": function, \"removeIndexQuery\": function, \"describeTableQuery\": function, \"removeColumnQuery\": function, \"renameColumnQuery\": function, \"startTransactionQuery\": function, \"setAutocommitQuery\": function, \"setIsolationLevelQuery\": function, \"replaceBooleanDefaults\": function, \"quoteIdentifier\": function, \"getForeignKeysQuery\": function}" ] } }, { "__docId__": 636, "kind": "file", "name": "lib/dialects/sqlite/query-interface.js", "content": "", "static": true, "longname": "lib/dialects/sqlite/query-interface.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 637, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/sqlite/query-interface.js", "static": true, "longname": "lib/dialects/sqlite/query-interface.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-interface.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 638, "kind": "variable", "name": "Promise", "memberof": "lib/dialects/sqlite/query-interface.js", "static": true, "longname": "lib/dialects/sqlite/query-interface.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-interface.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 639, "kind": "function", "name": "removeColumn", "memberof": "lib/dialects/sqlite/query-interface.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/sqlite/query-interface.js~removeColumn", "access": "private", "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-interface.js", "importStyle": null, "description": "A wrapper that fixes SQLite's inability to remove columns from existing tables.\nIt will create a backup of the table, drop the table afterwards and create a\nnew table with the same name but without the obsolete column.", "lineNumber": 30, "since": "1.6.0", "unknown": [ { "tagName": "@method", "tagValue": "removeColumn" }, { "tagName": "@for", "tagValue": " QueryInterface" } ], "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "tableName", "description": "The name of the table." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "attributeName", "description": "The name of the attribute that we want to remove." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean", "Function" ], "spread": false, "optional": true, "name": "options.logging", "description": "A function that logs the sql queries, or false for explicitly not logging these queries" } ], "return": { "types": [ "*" ] } }, { "__docId__": 640, "kind": "function", "name": "changeColumn", "memberof": "lib/dialects/sqlite/query-interface.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/sqlite/query-interface.js~changeColumn", "access": "private", "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-interface.js", "importStyle": null, "description": "A wrapper that fixes SQLite's inability to change columns from existing tables.\nIt will create a backup of the table, drop the table afterwards and create a\nnew table with the same name but with a modified version of the respective column.", "lineNumber": 61, "since": "1.6.0", "unknown": [ { "tagName": "@method", "tagValue": "changeColumn" }, { "tagName": "@for", "tagValue": " QueryInterface" } ], "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "tableName", "description": "The name of the table." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "attributes", "description": "An object with the attribute's name as key and it's options as value object." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean", "Function" ], "spread": false, "optional": true, "name": "options.logging", "description": "A function that logs the sql queries, or false for explicitly not logging these queries" } ], "return": { "types": [ "*" ] } }, { "__docId__": 641, "kind": "function", "name": "renameColumn", "memberof": "lib/dialects/sqlite/query-interface.js", "generator": false, "async": false, "static": true, "longname": "lib/dialects/sqlite/query-interface.js~renameColumn", "access": "private", "export": false, "importPath": "sequelize/lib/dialects/sqlite/query-interface.js", "importStyle": null, "description": "A wrapper that fixes SQLite's inability to rename columns from existing tables.\nIt will create a backup of the table, drop the table afterwards and create a\nnew table with the same name but with a renamed version of the respective column.", "lineNumber": 94, "since": "1.6.0", "unknown": [ { "tagName": "@method", "tagValue": "renameColumn" }, { "tagName": "@for", "tagValue": " QueryInterface" } ], "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "tableName", "description": "The name of the table." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "attrNameBefore", "description": "The name of the attribute before it was renamed." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "attrNameAfter", "description": "The name of the attribute after it was renamed." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean", "Function" ], "spread": false, "optional": true, "name": "options.logging", "description": "A function that logs the sql queries, or false for explicitly not logging these queries" } ], "return": { "types": [ "*" ] } }, { "__docId__": 642, "kind": "file", "name": "lib/dialects/sqlite/query.js", "content": "", "static": true, "longname": "lib/dialects/sqlite/query.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 643, "kind": "variable", "name": "_", "memberof": "lib/dialects/sqlite/query.js", "static": true, "longname": "lib/dialects/sqlite/query.js~_", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 644, "kind": "variable", "name": "Utils", "memberof": "lib/dialects/sqlite/query.js", "static": true, "longname": "lib/dialects/sqlite/query.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 645, "kind": "variable", "name": "debug", "memberof": "lib/dialects/sqlite/query.js", "static": true, "longname": "lib/dialects/sqlite/query.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 646, "kind": "variable", "name": "Promise", "memberof": "lib/dialects/sqlite/query.js", "static": true, "longname": "lib/dialects/sqlite/query.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 647, "kind": "variable", "name": "AbstractQuery", "memberof": "lib/dialects/sqlite/query.js", "static": true, "longname": "lib/dialects/sqlite/query.js~AbstractQuery", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 648, "kind": "variable", "name": "QueryTypes", "memberof": "lib/dialects/sqlite/query.js", "static": true, "longname": "lib/dialects/sqlite/query.js~QueryTypes", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 649, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/dialects/sqlite/query.js", "static": true, "longname": "lib/dialects/sqlite/query.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 650, "kind": "variable", "name": "parserStore", "memberof": "lib/dialects/sqlite/query.js", "static": true, "longname": "lib/dialects/sqlite/query.js~parserStore", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 651, "kind": "class", "name": "Query", "memberof": "lib/dialects/sqlite/query.js", "static": true, "longname": "lib/dialects/sqlite/query.js~Query", "access": null, "export": false, "importPath": "sequelize/lib/dialects/sqlite/query.js", "importStyle": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "AbstractQuery" ] }, { "__docId__": 652, "kind": "constructor", "name": "constructor", "memberof": "lib/dialects/sqlite/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/query.js~Query#constructor", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "database", "types": [ "*" ] }, { "name": "sequelize", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 653, "kind": "member", "name": "database", "memberof": "lib/dialects/sqlite/query.js~Query", "static": false, "longname": "lib/dialects/sqlite/query.js~Query#database", "access": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 654, "kind": "member", "name": "sequelize", "memberof": "lib/dialects/sqlite/query.js~Query", "static": false, "longname": "lib/dialects/sqlite/query.js~Query#sequelize", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 655, "kind": "member", "name": "instance", "memberof": "lib/dialects/sqlite/query.js~Query", "static": false, "longname": "lib/dialects/sqlite/query.js~Query#instance", "access": null, "description": null, "lineNumber": 18, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 656, "kind": "member", "name": "model", "memberof": "lib/dialects/sqlite/query.js~Query", "static": false, "longname": "lib/dialects/sqlite/query.js~Query#model", "access": null, "description": null, "lineNumber": 19, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 657, "kind": "member", "name": "options", "memberof": "lib/dialects/sqlite/query.js~Query", "static": false, "longname": "lib/dialects/sqlite/query.js~Query#options", "access": null, "description": null, "lineNumber": 20, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 658, "kind": "method", "name": "getInsertIdField", "memberof": "lib/dialects/sqlite/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/query.js~Query#getInsertIdField", "access": null, "description": null, "lineNumber": 29, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 659, "kind": "method", "name": "formatBindParameters", "memberof": "lib/dialects/sqlite/query.js~Query", "generator": false, "async": false, "static": true, "longname": "lib/dialects/sqlite/query.js~Query.formatBindParameters", "access": "private", "description": "rewrite query with parameters", "lineNumber": 37, "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "dialect", "types": [ "*" ] } ], "return": { "types": [ "undefined[]" ] } }, { "__docId__": 660, "kind": "method", "name": "_collectModels", "memberof": "lib/dialects/sqlite/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/query.js~Query#_collectModels", "access": null, "description": null, "lineNumber": 57, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "include", "types": [ "*" ] }, { "name": "prefix", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 661, "kind": "method", "name": "run", "memberof": "lib/dialects/sqlite/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/query.js~Query#run", "access": null, "description": null, "lineNumber": 79, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "parameters", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 662, "kind": "member", "name": "sql", "memberof": "lib/dialects/sqlite/query.js~Query", "static": false, "longname": "lib/dialects/sqlite/query.js~Query#sql", "access": null, "description": null, "lineNumber": 80, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 663, "kind": "member", "name": "sql", "memberof": "lib/dialects/sqlite/query.js~Query", "static": false, "longname": "lib/dialects/sqlite/query.js~Query#sql", "access": null, "description": null, "lineNumber": 85, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 664, "kind": "method", "name": "applyParsers", "memberof": "lib/dialects/sqlite/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/query.js~Query#applyParsers", "access": null, "description": null, "lineNumber": 298, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "type", "types": [ "*" ] }, { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 665, "kind": "method", "name": "formatError", "memberof": "lib/dialects/sqlite/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/query.js~Query#formatError", "access": null, "description": null, "lineNumber": 313, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "err", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 666, "kind": "method", "name": "handleShowIndexesQuery", "memberof": "lib/dialects/sqlite/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/query.js~Query#handleShowIndexesQuery", "access": null, "description": null, "lineNumber": 367, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "data", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 667, "kind": "method", "name": "getDatabaseMethod", "memberof": "lib/dialects/sqlite/query.js~Query", "generator": false, "async": false, "static": false, "longname": "lib/dialects/sqlite/query.js~Query#getDatabaseMethod", "access": null, "description": null, "lineNumber": 389, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "string" ] } }, { "__docId__": 668, "kind": "file", "name": "lib/errors/index.js", "content": "", "static": true, "longname": "lib/errors/index.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 669, "kind": "class", "name": "BaseError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~BaseError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "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.\nAll sequelize errors inherit from the base JS error object.\n\nThis means that errors can be accessed using `Sequelize.ValidationError` or `sequelize.ValidationError`\nThe Base Error all Sequelize Errors inherit from.", "lineNumber": 10, "interface": false, "extends": [ "Error" ] }, { "__docId__": 670, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~BaseError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~BaseError#constructor", "access": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] } ] }, { "__docId__": 671, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~BaseError", "static": false, "longname": "lib/errors/index.js~BaseError#name", "access": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 672, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~BaseError", "static": false, "longname": "lib/errors/index.js~BaseError#message", "access": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 673, "kind": "class", "name": "SequelizeScopeError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~SequelizeScopeError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Scope Error. Thrown when the sequelize cannot query the specified scope.", "lineNumber": 23, "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 674, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~SequelizeScopeError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~SequelizeScopeError#constructor", "access": null, "description": null, "lineNumber": 24, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 675, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~SequelizeScopeError", "static": false, "longname": "lib/errors/index.js~SequelizeScopeError#name", "access": null, "description": null, "lineNumber": 26, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 676, "kind": "class", "name": "ValidationError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~ValidationError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Validation Error. Thrown when the sequelize validation has failed. The error contains an `errors` property,\nwhich is an array with 1 or more ValidationErrorItems, one for each validation that failed.", "lineNumber": 40, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "message", "description": "Error message" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "errors", "description": "Array of ValidationErrorItem objects describing the validation errors" } ], "properties": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "errors", "description": "An array of ValidationErrorItems" } ], "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 677, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~ValidationError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~ValidationError#constructor", "access": null, "description": null, "lineNumber": 41, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] }, { "name": "errors", "types": [ "*" ] } ] }, { "__docId__": 678, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~ValidationError", "static": false, "longname": "lib/errors/index.js~ValidationError#name", "access": null, "description": null, "lineNumber": 43, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 679, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~ValidationError", "static": false, "longname": "lib/errors/index.js~ValidationError#message", "access": null, "description": null, "lineNumber": 44, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 680, "kind": "member", "name": "errors", "memberof": "lib/errors/index.js~ValidationError", "static": false, "longname": "lib/errors/index.js~ValidationError#errors", "access": null, "description": "", "lineNumber": 49, "type": { "nullable": null, "types": [ "ValidationErrorItem[]" ], "spread": false, "description": null } }, { "__docId__": 681, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~ValidationError", "static": false, "longname": "lib/errors/index.js~ValidationError#message", "access": null, "description": null, "lineNumber": 53, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 682, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~ValidationError", "static": false, "longname": "lib/errors/index.js~ValidationError#message", "access": null, "description": null, "lineNumber": 57, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 683, "kind": "method", "name": "get", "memberof": "lib/errors/index.js~ValidationError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~ValidationError#get", "access": null, "description": "Gets all validation error items for the path / field specified.", "lineNumber": 67, "unknown": [ { "tagName": "@returns", "tagValue": "{ValidationErrorItem[]} Validation error items for the specified path" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "The path to be checked for error items" } ], "return": { "nullable": null, "types": [ "ValidationErrorItem[]" ], "spread": false, "description": "Validation error items for the specified path" } }, { "__docId__": 684, "kind": "class", "name": "OptimisticLockError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~OptimisticLockError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when attempting to update a stale model instance", "lineNumber": 81, "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 685, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~OptimisticLockError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~OptimisticLockError#constructor", "access": null, "description": null, "lineNumber": 82, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 686, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~OptimisticLockError", "static": false, "longname": "lib/errors/index.js~OptimisticLockError#name", "access": null, "description": null, "lineNumber": 86, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 687, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~OptimisticLockError", "static": false, "longname": "lib/errors/index.js~OptimisticLockError#message", "access": null, "description": null, "lineNumber": 87, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 688, "kind": "member", "name": "modelName", "memberof": "lib/errors/index.js~OptimisticLockError", "static": false, "longname": "lib/errors/index.js~OptimisticLockError#modelName", "access": null, "description": "The name of the model on which the update was attempted", "lineNumber": 92, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 689, "kind": "member", "name": "values", "memberof": "lib/errors/index.js~OptimisticLockError", "static": false, "longname": "lib/errors/index.js~OptimisticLockError#values", "access": null, "description": "The values of the attempted update", "lineNumber": 97, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 690, "kind": "member", "name": "where", "memberof": "lib/errors/index.js~OptimisticLockError", "static": false, "longname": "lib/errors/index.js~OptimisticLockError#where", "access": null, "description": "", "lineNumber": 102, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 691, "kind": "class", "name": "DatabaseError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~DatabaseError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "A base class for all database related errors.", "lineNumber": 110, "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 692, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~DatabaseError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~DatabaseError#constructor", "access": null, "description": null, "lineNumber": 111, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 693, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~DatabaseError", "static": false, "longname": "lib/errors/index.js~DatabaseError#name", "access": null, "description": null, "lineNumber": 113, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 694, "kind": "member", "name": "parent", "memberof": "lib/errors/index.js~DatabaseError", "static": false, "longname": "lib/errors/index.js~DatabaseError#parent", "access": null, "description": "", "lineNumber": 117, "type": { "nullable": null, "types": [ "Error" ], "spread": false, "description": null } }, { "__docId__": 695, "kind": "member", "name": "original", "memberof": "lib/errors/index.js~DatabaseError", "static": false, "longname": "lib/errors/index.js~DatabaseError#original", "access": null, "description": "", "lineNumber": 121, "type": { "nullable": null, "types": [ "Error" ], "spread": false, "description": null } }, { "__docId__": 696, "kind": "member", "name": "sql", "memberof": "lib/errors/index.js~DatabaseError", "static": false, "longname": "lib/errors/index.js~DatabaseError#sql", "access": null, "description": "The SQL that triggered the error", "lineNumber": 126, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 697, "kind": "class", "name": "TimeoutError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~TimeoutError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a database query times out because of a deadlock", "lineNumber": 134, "interface": false, "extends": [ "DatabaseError" ] }, { "__docId__": 698, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~TimeoutError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~TimeoutError#constructor", "access": null, "description": null, "lineNumber": 135, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 699, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~TimeoutError", "static": false, "longname": "lib/errors/index.js~TimeoutError#name", "access": null, "description": null, "lineNumber": 137, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 700, "kind": "class", "name": "UniqueConstraintError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~UniqueConstraintError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a unique constraint is violated in the database", "lineNumber": 145, "interface": false, "extends": [ "ValidationError" ] }, { "__docId__": 701, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~UniqueConstraintError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~UniqueConstraintError#constructor", "access": null, "description": null, "lineNumber": 146, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 702, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~UniqueConstraintError", "static": false, "longname": "lib/errors/index.js~UniqueConstraintError#name", "access": null, "description": null, "lineNumber": 153, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 703, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~UniqueConstraintError", "static": false, "longname": "lib/errors/index.js~UniqueConstraintError#message", "access": null, "description": null, "lineNumber": 154, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 704, "kind": "member", "name": "errors", "memberof": "lib/errors/index.js~UniqueConstraintError", "static": false, "longname": "lib/errors/index.js~UniqueConstraintError#errors", "access": null, "description": null, "lineNumber": 155, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 705, "kind": "member", "name": "fields", "memberof": "lib/errors/index.js~UniqueConstraintError", "static": false, "longname": "lib/errors/index.js~UniqueConstraintError#fields", "access": null, "description": null, "lineNumber": 156, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 706, "kind": "member", "name": "parent", "memberof": "lib/errors/index.js~UniqueConstraintError", "static": false, "longname": "lib/errors/index.js~UniqueConstraintError#parent", "access": null, "description": null, "lineNumber": 157, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 707, "kind": "member", "name": "original", "memberof": "lib/errors/index.js~UniqueConstraintError", "static": false, "longname": "lib/errors/index.js~UniqueConstraintError#original", "access": null, "description": null, "lineNumber": 158, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 708, "kind": "member", "name": "sql", "memberof": "lib/errors/index.js~UniqueConstraintError", "static": false, "longname": "lib/errors/index.js~UniqueConstraintError#sql", "access": null, "description": null, "lineNumber": 159, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 709, "kind": "class", "name": "ForeignKeyConstraintError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~ForeignKeyConstraintError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a foreign key constraint is violated in the database", "lineNumber": 167, "interface": false, "extends": [ "DatabaseError" ] }, { "__docId__": 710, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~ForeignKeyConstraintError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~ForeignKeyConstraintError#constructor", "access": null, "description": null, "lineNumber": 168, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 711, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~ForeignKeyConstraintError", "static": false, "longname": "lib/errors/index.js~ForeignKeyConstraintError#name", "access": null, "description": null, "lineNumber": 173, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 712, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~ForeignKeyConstraintError", "static": false, "longname": "lib/errors/index.js~ForeignKeyConstraintError#message", "access": null, "description": null, "lineNumber": 175, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 713, "kind": "member", "name": "fields", "memberof": "lib/errors/index.js~ForeignKeyConstraintError", "static": false, "longname": "lib/errors/index.js~ForeignKeyConstraintError#fields", "access": null, "description": null, "lineNumber": 176, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 714, "kind": "member", "name": "table", "memberof": "lib/errors/index.js~ForeignKeyConstraintError", "static": false, "longname": "lib/errors/index.js~ForeignKeyConstraintError#table", "access": null, "description": null, "lineNumber": 177, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 715, "kind": "member", "name": "value", "memberof": "lib/errors/index.js~ForeignKeyConstraintError", "static": false, "longname": "lib/errors/index.js~ForeignKeyConstraintError#value", "access": null, "description": null, "lineNumber": 178, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 716, "kind": "member", "name": "index", "memberof": "lib/errors/index.js~ForeignKeyConstraintError", "static": false, "longname": "lib/errors/index.js~ForeignKeyConstraintError#index", "access": null, "description": null, "lineNumber": 179, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 717, "kind": "class", "name": "ExclusionConstraintError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~ExclusionConstraintError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when an exclusion constraint is violated in the database", "lineNumber": 187, "interface": false, "extends": [ "DatabaseError" ] }, { "__docId__": 718, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~ExclusionConstraintError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~ExclusionConstraintError#constructor", "access": null, "description": null, "lineNumber": 188, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 719, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~ExclusionConstraintError", "static": false, "longname": "lib/errors/index.js~ExclusionConstraintError#name", "access": null, "description": null, "lineNumber": 193, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 720, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~ExclusionConstraintError", "static": false, "longname": "lib/errors/index.js~ExclusionConstraintError#message", "access": null, "description": null, "lineNumber": 195, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 721, "kind": "member", "name": "constraint", "memberof": "lib/errors/index.js~ExclusionConstraintError", "static": false, "longname": "lib/errors/index.js~ExclusionConstraintError#constraint", "access": null, "description": null, "lineNumber": 196, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 722, "kind": "member", "name": "fields", "memberof": "lib/errors/index.js~ExclusionConstraintError", "static": false, "longname": "lib/errors/index.js~ExclusionConstraintError#fields", "access": null, "description": null, "lineNumber": 197, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 723, "kind": "member", "name": "table", "memberof": "lib/errors/index.js~ExclusionConstraintError", "static": false, "longname": "lib/errors/index.js~ExclusionConstraintError#table", "access": null, "description": null, "lineNumber": 198, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 724, "kind": "class", "name": "ValidationErrorItem", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~ValidationErrorItem", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Validation Error Item\nInstances of this class are included in the `ValidationError.errors` property.", "lineNumber": 212, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "message", "description": "An error message" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The type of the validation error" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "The field that triggered the validation error" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "value", "description": "The value that generated the error" } ], "interface": false }, { "__docId__": 725, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~ValidationErrorItem", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~ValidationErrorItem#constructor", "access": null, "description": null, "lineNumber": 213, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] }, { "name": "type", "types": [ "*" ] }, { "name": "path", "types": [ "*" ] }, { "name": "value", "types": [ "*" ] } ] }, { "__docId__": 726, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~ValidationErrorItem", "static": false, "longname": "lib/errors/index.js~ValidationErrorItem#message", "access": null, "description": null, "lineNumber": 214, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 727, "kind": "member", "name": "type", "memberof": "lib/errors/index.js~ValidationErrorItem", "static": false, "longname": "lib/errors/index.js~ValidationErrorItem#type", "access": null, "description": null, "lineNumber": 215, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 728, "kind": "member", "name": "path", "memberof": "lib/errors/index.js~ValidationErrorItem", "static": false, "longname": "lib/errors/index.js~ValidationErrorItem#path", "access": null, "description": null, "lineNumber": 216, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 729, "kind": "member", "name": "value", "memberof": "lib/errors/index.js~ValidationErrorItem", "static": false, "longname": "lib/errors/index.js~ValidationErrorItem#value", "access": null, "description": null, "lineNumber": 217, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 730, "kind": "class", "name": "ConnectionError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~ConnectionError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "A base class for all connection related errors.", "lineNumber": 225, "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 731, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~ConnectionError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~ConnectionError#constructor", "access": null, "description": null, "lineNumber": 226, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 732, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~ConnectionError", "static": false, "longname": "lib/errors/index.js~ConnectionError#name", "access": null, "description": null, "lineNumber": 228, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 733, "kind": "member", "name": "parent", "memberof": "lib/errors/index.js~ConnectionError", "static": false, "longname": "lib/errors/index.js~ConnectionError#parent", "access": null, "description": "The connection specific error which triggered this one", "lineNumber": 233, "type": { "nullable": null, "types": [ "Error" ], "spread": false, "description": null } }, { "__docId__": 734, "kind": "member", "name": "original", "memberof": "lib/errors/index.js~ConnectionError", "static": false, "longname": "lib/errors/index.js~ConnectionError#original", "access": null, "description": null, "lineNumber": 234, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 735, "kind": "class", "name": "ConnectionRefusedError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~ConnectionRefusedError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a connection to a database is refused", "lineNumber": 242, "interface": false, "extends": [ "ConnectionError" ] }, { "__docId__": 736, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~ConnectionRefusedError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~ConnectionRefusedError#constructor", "access": null, "description": null, "lineNumber": 243, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 737, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~ConnectionRefusedError", "static": false, "longname": "lib/errors/index.js~ConnectionRefusedError#name", "access": null, "description": null, "lineNumber": 245, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 738, "kind": "class", "name": "AccessDeniedError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~AccessDeniedError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a connection to a database is refused due to insufficient privileges", "lineNumber": 253, "interface": false, "extends": [ "ConnectionError" ] }, { "__docId__": 739, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~AccessDeniedError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~AccessDeniedError#constructor", "access": null, "description": null, "lineNumber": 254, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 740, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~AccessDeniedError", "static": false, "longname": "lib/errors/index.js~AccessDeniedError#name", "access": null, "description": null, "lineNumber": 256, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 741, "kind": "class", "name": "HostNotFoundError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~HostNotFoundError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a connection to a database has a hostname that was not found", "lineNumber": 264, "interface": false, "extends": [ "ConnectionError" ] }, { "__docId__": 742, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~HostNotFoundError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~HostNotFoundError#constructor", "access": null, "description": null, "lineNumber": 265, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 743, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~HostNotFoundError", "static": false, "longname": "lib/errors/index.js~HostNotFoundError#name", "access": null, "description": null, "lineNumber": 267, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 744, "kind": "class", "name": "HostNotReachableError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~HostNotReachableError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a connection to a database has a hostname that was not reachable", "lineNumber": 275, "interface": false, "extends": [ "ConnectionError" ] }, { "__docId__": 745, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~HostNotReachableError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~HostNotReachableError#constructor", "access": null, "description": null, "lineNumber": 276, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 746, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~HostNotReachableError", "static": false, "longname": "lib/errors/index.js~HostNotReachableError#name", "access": null, "description": null, "lineNumber": 278, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 747, "kind": "class", "name": "InvalidConnectionError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~InvalidConnectionError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a connection to a database has invalid values for any of the connection parameters", "lineNumber": 286, "interface": false, "extends": [ "ConnectionError" ] }, { "__docId__": 748, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~InvalidConnectionError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~InvalidConnectionError#constructor", "access": null, "description": null, "lineNumber": 287, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 749, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~InvalidConnectionError", "static": false, "longname": "lib/errors/index.js~InvalidConnectionError#name", "access": null, "description": null, "lineNumber": 289, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 750, "kind": "class", "name": "ConnectionTimedOutError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~ConnectionTimedOutError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a connection to a database times out", "lineNumber": 297, "interface": false, "extends": [ "ConnectionError" ] }, { "__docId__": 751, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~ConnectionTimedOutError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~ConnectionTimedOutError#constructor", "access": null, "description": null, "lineNumber": 298, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "parent", "types": [ "*" ] } ] }, { "__docId__": 752, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~ConnectionTimedOutError", "static": false, "longname": "lib/errors/index.js~ConnectionTimedOutError#name", "access": null, "description": null, "lineNumber": 300, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 753, "kind": "class", "name": "InstanceError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~InstanceError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a some problem occurred with Instance methods (see message for details)", "lineNumber": 308, "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 754, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~InstanceError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~InstanceError#constructor", "access": null, "description": null, "lineNumber": 309, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] } ] }, { "__docId__": 755, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~InstanceError", "static": false, "longname": "lib/errors/index.js~InstanceError#name", "access": null, "description": null, "lineNumber": 311, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 756, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~InstanceError", "static": false, "longname": "lib/errors/index.js~InstanceError#message", "access": null, "description": null, "lineNumber": 312, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 757, "kind": "class", "name": "EmptyResultError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~EmptyResultError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a record was not found, Usually used with rejectOnEmpty mode (see message for details)", "lineNumber": 320, "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 758, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~EmptyResultError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~EmptyResultError#constructor", "access": null, "description": null, "lineNumber": 321, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] } ] }, { "__docId__": 759, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~EmptyResultError", "static": false, "longname": "lib/errors/index.js~EmptyResultError#name", "access": null, "description": null, "lineNumber": 323, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 760, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~EmptyResultError", "static": false, "longname": "lib/errors/index.js~EmptyResultError#message", "access": null, "description": null, "lineNumber": 324, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 761, "kind": "class", "name": "EagerLoadingError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~EagerLoadingError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when an include statement is improperly constructed (see message for details)", "lineNumber": 332, "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 762, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~EagerLoadingError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~EagerLoadingError#constructor", "access": null, "description": null, "lineNumber": 333, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] } ] }, { "__docId__": 763, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~EagerLoadingError", "static": false, "longname": "lib/errors/index.js~EagerLoadingError#name", "access": null, "description": null, "lineNumber": 335, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 764, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~EagerLoadingError", "static": false, "longname": "lib/errors/index.js~EagerLoadingError#message", "access": null, "description": null, "lineNumber": 336, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 765, "kind": "class", "name": "AssociationError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~AssociationError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when an association is improperly constructed (see message for details)", "lineNumber": 344, "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 766, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~AssociationError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~AssociationError#constructor", "access": null, "description": null, "lineNumber": 345, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] } ] }, { "__docId__": 767, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~AssociationError", "static": false, "longname": "lib/errors/index.js~AssociationError#name", "access": null, "description": null, "lineNumber": 347, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 768, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~AssociationError", "static": false, "longname": "lib/errors/index.js~AssociationError#message", "access": null, "description": null, "lineNumber": 348, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 769, "kind": "class", "name": "QueryError", "memberof": "lib/errors/index.js", "static": true, "longname": "lib/errors/index.js~QueryError", "access": null, "export": false, "importPath": "sequelize/lib/errors/index.js", "importStyle": null, "description": "Thrown when a query is passed invalid options (see message for details)", "lineNumber": 355, "interface": false, "extends": [ "BaseError" ] }, { "__docId__": 770, "kind": "constructor", "name": "constructor", "memberof": "lib/errors/index.js~QueryError", "generator": false, "async": false, "static": false, "longname": "lib/errors/index.js~QueryError#constructor", "access": null, "description": null, "lineNumber": 356, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] } ] }, { "__docId__": 771, "kind": "member", "name": "name", "memberof": "lib/errors/index.js~QueryError", "static": false, "longname": "lib/errors/index.js~QueryError#name", "access": null, "description": null, "lineNumber": 358, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 772, "kind": "member", "name": "message", "memberof": "lib/errors/index.js~QueryError", "static": false, "longname": "lib/errors/index.js~QueryError#message", "access": null, "description": null, "lineNumber": 359, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 773, "kind": "file", "name": "lib/errors.js", "content": "", "static": true, "longname": "lib/errors.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 774, "kind": "file", "name": "lib/hooks.js", "content": "", "static": true, "longname": "lib/hooks.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 775, "kind": "variable", "name": "Utils", "memberof": "lib/hooks.js", "static": true, "longname": "lib/hooks.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/hooks.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 776, "kind": "variable", "name": "Promise", "memberof": "lib/hooks.js", "static": true, "longname": "lib/hooks.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/hooks.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 777, "kind": "variable", "name": "debug", "memberof": "lib/hooks.js", "static": true, "longname": "lib/hooks.js~debug", "access": null, "export": false, "importPath": "sequelize/lib/hooks.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 778, "kind": "variable", "name": "hookTypes", "memberof": "lib/hooks.js", "static": true, "longname": "lib/hooks.js~hookTypes", "access": null, "export": false, "importPath": "sequelize/lib/hooks.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"beforeValidate\": *, \"afterValidate\": *, \"validationFailed\": *, \"beforeCreate\": *, \"afterCreate\": *, \"beforeDestroy\": *, \"afterDestroy\": *, \"beforeRestore\": *, \"afterRestore\": *, \"beforeUpdate\": *, \"afterUpdate\": *, \"beforeSave\": *, \"afterSave\": *, \"beforeUpsert\": *, \"afterUpsert\": *, \"beforeBulkCreate\": *, \"afterBulkCreate\": *, \"beforeBulkDestroy\": *, \"afterBulkDestroy\": *, \"beforeBulkRestore\": *, \"afterBulkRestore\": *, \"beforeBulkUpdate\": *, \"afterBulkUpdate\": *, \"beforeFind\": *, \"beforeFindAfterExpandIncludeAll\": *, \"beforeFindAfterOptions\": *, \"afterFind\": *, \"beforeCount\": *, \"beforeDefine\": *, \"afterDefine\": *, \"beforeInit\": *, \"afterInit\": *, \"beforeConnect\": *, \"afterConnect\": *, \"beforeSync\": *, \"afterSync\": *, \"beforeBulkSync\": *, \"afterBulkSync\": *}" ] } }, { "__docId__": 779, "kind": "variable", "name": "hookAliases", "memberof": "lib/hooks.js", "static": true, "longname": "lib/hooks.js~hookAliases", "access": null, "export": false, "importPath": "sequelize/lib/hooks.js", "importStyle": null, "description": null, "lineNumber": 49, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"beforeDelete\": string, \"afterDelete\": string, \"beforeBulkDelete\": string, \"afterBulkDelete\": string, \"beforeConnection\": string}" ] } }, { "__docId__": 780, "kind": "function", "name": "getProxiedHooks", "memberof": "lib/hooks.js", "generator": false, "async": false, "static": true, "longname": "lib/hooks.js~getProxiedHooks", "access": "private", "export": false, "importPath": "sequelize/lib/hooks.js", "importStyle": null, "description": "get array of current hook and its proxied hooks combined", "lineNumber": 62, "params": [ { "name": "hookType", "types": [ "*" ] } ] }, { "__docId__": 781, "kind": "variable", "name": "Hooks", "memberof": "lib/hooks.js", "static": true, "longname": "lib/hooks.js~Hooks", "access": null, "export": false, "importPath": "sequelize/lib/hooks.js", "importStyle": null, "description": null, "lineNumber": 68, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"replaceHookAliases\": function, \"runHooks\": function, \"hook\": function, \"addHook\": function, \"removeHook\": function, \"hasHook\": function}" ] } }, { "__docId__": 782, "kind": "function", "name": "applyTo", "memberof": "lib/hooks.js", "generator": false, "async": false, "static": true, "longname": "lib/hooks.js~applyTo", "access": null, "export": false, "importPath": "sequelize/lib/hooks.js", "importStyle": null, "description": null, "lineNumber": 211, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "target", "types": [ "*" ] } ] }, { "__docId__": 783, "kind": "file", "name": "lib/instance-validator.js", "content": "", "static": true, "longname": "lib/instance-validator.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 784, "kind": "variable", "name": "validator", "memberof": "lib/instance-validator.js", "static": true, "longname": "lib/instance-validator.js~validator", "access": null, "export": false, "importPath": "sequelize/lib/instance-validator.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 785, "kind": "variable", "name": "extendModelValidations", "memberof": "lib/instance-validator.js", "static": true, "longname": "lib/instance-validator.js~extendModelValidations", "access": null, "export": false, "importPath": "sequelize/lib/instance-validator.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 786, "kind": "variable", "name": "Utils", "memberof": "lib/instance-validator.js", "static": true, "longname": "lib/instance-validator.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/instance-validator.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 787, "kind": "variable", "name": "sequelizeError", "memberof": "lib/instance-validator.js", "static": true, "longname": "lib/instance-validator.js~sequelizeError", "access": null, "export": false, "importPath": "sequelize/lib/instance-validator.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 788, "kind": "variable", "name": "Promise", "memberof": "lib/instance-validator.js", "static": true, "longname": "lib/instance-validator.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/instance-validator.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 789, "kind": "variable", "name": "DataTypes", "memberof": "lib/instance-validator.js", "static": true, "longname": "lib/instance-validator.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/instance-validator.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 790, "kind": "variable", "name": "_", "memberof": "lib/instance-validator.js", "static": true, "longname": "lib/instance-validator.js~_", "access": null, "export": false, "importPath": "sequelize/lib/instance-validator.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 791, "kind": "class", "name": "InstanceValidator", "memberof": "lib/instance-validator.js", "static": true, "longname": "lib/instance-validator.js~InstanceValidator", "access": "private", "export": false, "importPath": "sequelize/lib/instance-validator.js", "importStyle": null, "description": "The Main Instance Validator.", "lineNumber": 19, "unknown": [ { "tagName": "@constructor", "tagValue": "" } ], "params": [ { "nullable": null, "types": [ "Instance" ], "spread": false, "optional": false, "name": "modelInstance", "description": "The model instance." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "A dict with options." } ], "interface": false }, { "__docId__": 792, "kind": "constructor", "name": "constructor", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#constructor", "access": null, "description": null, "lineNumber": 21, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "modelInstance", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 793, "kind": "member", "name": "options", "memberof": "lib/instance-validator.js~InstanceValidator", "static": false, "longname": "lib/instance-validator.js~InstanceValidator#options", "access": null, "description": null, "lineNumber": 29, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 794, "kind": "member", "name": "modelInstance", "memberof": "lib/instance-validator.js~InstanceValidator", "static": false, "longname": "lib/instance-validator.js~InstanceValidator#modelInstance", "access": null, "description": null, "lineNumber": 33, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 795, "kind": "member", "name": "validator", "memberof": "lib/instance-validator.js~InstanceValidator", "static": false, "longname": "lib/instance-validator.js~InstanceValidator#validator", "access": "private", "description": "Exposes a reference to validator.js. This allows you to add custom validations using `validator.extend`", "lineNumber": 40, "type": { "types": [ "*" ] } }, { "__docId__": 796, "kind": "member", "name": "errors", "memberof": "lib/instance-validator.js~InstanceValidator", "static": false, "longname": "lib/instance-validator.js~InstanceValidator#errors", "access": "private", "description": " All errors will be stored here from the validations.", "lineNumber": 49, "type": { "nullable": null, "types": [ "Array" ], "spread": false, "description": null } }, { "__docId__": 797, "kind": "member", "name": "inProgress", "memberof": "lib/instance-validator.js~InstanceValidator", "static": false, "longname": "lib/instance-validator.js~InstanceValidator#inProgress", "access": "private", "description": "", "lineNumber": 55, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 798, "kind": "method", "name": "_validate", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_validate", "access": "private", "description": "The main entry point for the Validation module, invoke to start the dance.", "lineNumber": 66, "params": [], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 799, "kind": "member", "name": "inProgress", "memberof": "lib/instance-validator.js~InstanceValidator", "static": false, "longname": "lib/instance-validator.js~InstanceValidator#inProgress", "access": null, "description": null, "lineNumber": 70, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 800, "kind": "method", "name": "validate", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#validate", "access": "private", "description": "Invoke the Validation sequence:\n - Before Validation Model Hooks\n - Validation\n - On validation success: After Validation Model Hooks\n - On validation failure: Validation Failed Model Hooks", "lineNumber": 91, "params": [], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 801, "kind": "method", "name": "_builtinValidators", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_builtinValidators", "access": "private", "description": "Will run all the built-in validators.", "lineNumber": 113, "params": [], "return": { "nullable": null, "types": [ "Promise(Array.)" ], "spread": false, "description": "A promise from .reflect()." } }, { "__docId__": 802, "kind": "method", "name": "_customValidators", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_customValidators", "access": "private", "description": "Will run all the custom validators.", "lineNumber": 142, "params": [], "return": { "nullable": null, "types": [ "Promise(Array.)" ], "spread": false, "description": "A promise from .reflect()." } }, { "__docId__": 803, "kind": "method", "name": "_builtinAttrValidate", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_builtinAttrValidate", "access": "private", "description": "Validate a single attribute with all the defined built-in validators.", "lineNumber": 169, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "value", "description": "Anything." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "field", "description": "The field name." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "A promise, will always resolve,\n auto populates error on this.error local object." } }, { "__docId__": 804, "kind": "method", "name": "_invokeCustomValidator", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_invokeCustomValidator", "access": "private", "description": "Prepare and invoke a custom validator.", "lineNumber": 216, "params": [ { "nullable": null, "types": [ "Function" ], "spread": false, "optional": false, "name": "validator", "description": "The custom validator." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "validatorType", "description": "the custom validator type (name)." }, { "nullable": null, "types": [ "boolean=" ], "spread": false, "optional": false, "name": "optAttrDefined", "description": "Set to true if custom validator was defined\n from the Attribute" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "A promise." } }, { "__docId__": 805, "kind": "method", "name": "_invokeBuiltinValidator", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_invokeBuiltinValidator", "access": "private", "description": "Prepare and invoke a build-in validator.", "lineNumber": 259, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "value", "description": "Anything." }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "test", "description": "The test case." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "validatorType", "description": "One of known to Sequelize validators." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "field", "description": "The field that is being validated" } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "An object with specific keys to invoke the validator." } }, { "__docId__": 806, "kind": "method", "name": "_extractValidatorArgs", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_extractValidatorArgs", "access": "private", "description": "Will extract arguments for the validator.", "lineNumber": 283, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "test", "description": "The test case." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "validatorType", "description": "One of known to Sequelize validators." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "field", "description": "The field that is being validated." } ], "return": { "types": [ "*" ] } }, { "__docId__": 807, "kind": "method", "name": "_validateSchema", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_validateSchema", "access": "private", "description": "Will validate a single field against its schema definition (isnull).", "lineNumber": 309, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "rawAttribute", "description": "As defined in the Schema." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "field", "description": "The field name." }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "value", "description": "anything." } ] }, { "__docId__": 808, "kind": "method", "name": "_handleReflectedResult", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_handleReflectedResult", "access": "private", "description": "Handles the returned result of a Promise.reflect.\n\nIf errors are found it populates this.error.", "lineNumber": 340, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "field", "description": "The attribute name." }, { "nullable": null, "types": [ "string", "number" ], "spread": false, "optional": false, "name": "value", "description": "The data value." }, { "nullable": null, "types": [ "Array." ], "spread": false, "optional": false, "name": "Promise", "description": "inspection objects." } ] }, { "__docId__": 809, "kind": "method", "name": "_pushError", "memberof": "lib/instance-validator.js~InstanceValidator", "generator": false, "async": false, "static": false, "longname": "lib/instance-validator.js~InstanceValidator#_pushError", "access": "private", "description": "Signs all errors retaining the original.", "lineNumber": 358, "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "isBuiltin", "description": "Determines if error is from builtin validator." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "errorKey", "description": "The error key to assign on this.errors object." }, { "nullable": null, "types": [ "Error", "string" ], "spread": false, "optional": false, "name": "rawError", "description": "The original error." }, { "nullable": null, "types": [ "string", "number" ], "spread": false, "optional": false, "name": "value", "description": "The data that triggered the error." } ] }, { "__docId__": 810, "kind": "file", "name": "lib/model/attribute.js", "content": "", "static": true, "longname": "lib/model/attribute.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 811, "kind": "class", "name": "Attribute", "memberof": "lib/model/attribute.js", "static": true, "longname": "lib/model/attribute.js~Attribute", "access": null, "export": false, "importPath": "sequelize/lib/model/attribute.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false }, { "__docId__": 812, "kind": "constructor", "name": "constructor", "memberof": "lib/model/attribute.js~Attribute", "generator": false, "async": false, "static": false, "longname": "lib/model/attribute.js~Attribute#constructor", "access": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 813, "kind": "member", "name": "type", "memberof": "lib/model/attribute.js~Attribute", "static": false, "longname": "lib/model/attribute.js~Attribute#type", "access": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 814, "kind": "file", "name": "lib/model-manager.js", "content": "", "static": true, "longname": "lib/model-manager.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 815, "kind": "variable", "name": "Toposort", "memberof": "lib/model-manager.js", "static": true, "longname": "lib/model-manager.js~Toposort", "access": null, "export": false, "importPath": "sequelize/lib/model-manager.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 816, "kind": "variable", "name": "_", "memberof": "lib/model-manager.js", "static": true, "longname": "lib/model-manager.js~_", "access": null, "export": false, "importPath": "sequelize/lib/model-manager.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 817, "kind": "class", "name": "ModelManager", "memberof": "lib/model-manager.js", "static": true, "longname": "lib/model-manager.js~ModelManager", "access": null, "export": false, "importPath": "sequelize/lib/model-manager.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false }, { "__docId__": 818, "kind": "constructor", "name": "constructor", "memberof": "lib/model-manager.js~ModelManager", "generator": false, "async": false, "static": false, "longname": "lib/model-manager.js~ModelManager#constructor", "access": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 819, "kind": "member", "name": "models", "memberof": "lib/model-manager.js~ModelManager", "static": false, "longname": "lib/model-manager.js~ModelManager#models", "access": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 820, "kind": "member", "name": "sequelize", "memberof": "lib/model-manager.js~ModelManager", "static": false, "longname": "lib/model-manager.js~ModelManager#sequelize", "access": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 821, "kind": "method", "name": "addModel", "memberof": "lib/model-manager.js~ModelManager", "generator": false, "async": false, "static": false, "longname": "lib/model-manager.js~ModelManager#addModel", "access": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "model", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 822, "kind": "method", "name": "removeModel", "memberof": "lib/model-manager.js~ModelManager", "generator": false, "async": false, "static": false, "longname": "lib/model-manager.js~ModelManager#removeModel", "access": null, "description": null, "lineNumber": 19, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "modelToRemove", "types": [ "*" ] } ] }, { "__docId__": 823, "kind": "member", "name": "models", "memberof": "lib/model-manager.js~ModelManager", "static": false, "longname": "lib/model-manager.js~ModelManager#models", "access": null, "description": null, "lineNumber": 20, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 824, "kind": "method", "name": "getModel", "memberof": "lib/model-manager.js~ModelManager", "generator": false, "async": false, "static": false, "longname": "lib/model-manager.js~ModelManager#getModel", "access": null, "description": null, "lineNumber": 25, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "against", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 825, "kind": "get", "name": "all", "memberof": "lib/model-manager.js~ModelManager", "generator": false, "async": false, "static": false, "longname": "lib/model-manager.js~ModelManager#all", "access": null, "description": null, "lineNumber": 35, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 826, "kind": "method", "name": "forEachModel", "memberof": "lib/model-manager.js~ModelManager", "generator": false, "async": false, "static": false, "longname": "lib/model-manager.js~ModelManager#forEachModel", "access": "private", "description": "Iterate over Models in an order suitable for e.g. creating tables. Will\ntake foreign key constraints into account so that dependencies are visited\nbefore dependents.", "lineNumber": 45, "params": [ { "name": "iterator", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 827, "kind": "file", "name": "lib/model.js", "content": "", "static": true, "longname": "lib/model.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 828, "kind": "variable", "name": "Utils", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 829, "kind": "variable", "name": "BelongsTo", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~BelongsTo", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 830, "kind": "variable", "name": "BelongsToMany", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~BelongsToMany", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 831, "kind": "variable", "name": "InstanceValidator", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~InstanceValidator", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 832, "kind": "variable", "name": "QueryTypes", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~QueryTypes", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 833, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 834, "kind": "variable", "name": "Dottie", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~Dottie", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 835, "kind": "variable", "name": "Promise", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 836, "kind": "variable", "name": "_", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~_", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 837, "kind": "variable", "name": "moment", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~moment", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 838, "kind": "variable", "name": "Association", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~Association", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 839, "kind": "variable", "name": "HasMany", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~HasMany", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 840, "kind": "variable", "name": "DataTypes", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 841, "kind": "variable", "name": "Hooks", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~Hooks", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 842, "kind": "variable", "name": "associationsMixin", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~associationsMixin", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 843, "kind": "variable", "name": "defaultsOptions", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~defaultsOptions", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": null, "lineNumber": 18, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"raw\": boolean}" ] } }, { "__docId__": 844, "kind": "class", "name": "Model", "memberof": "lib/model.js", "static": true, "longname": "lib/model.js~Model", "access": null, "export": false, "importPath": "sequelize/lib/model.js", "importStyle": null, "description": "A Model represents a table in the database. Instances of this class represent a database row.\n\nModel instances operate with the concept of a `dataValues` property, which stores the actual values represented by the instance.\nBy default, the values from dataValues can also be accessed directly from the Instance, that is:\n```js\ninstance.field\n// is the same as\ninstance.get('field')\n// is the same as\ninstance.getDataValue('field')\n```\nHowever, if getters and/or setters are defined for `field` they will be invoked, instead of returning the value from `dataValues`.\nAccessing properties directly or using `get` is preferred for regular use, `getDataValue` should only be used for custom getters.", "see": [ "{@link Sequelize#define} for more information about getters and setters" ], "lineNumber": 39, "unknown": [ { "tagName": "@class", "tagValue": "Model" }, { "tagName": "@mixes", "tagValue": "Hooks" } ], "interface": false }, { "__docId__": 845, "kind": "get", "name": "QueryInterface", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.QueryInterface", "access": null, "description": null, "lineNumber": 41, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 846, "kind": "get", "name": "QueryGenerator", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.QueryGenerator", "access": null, "description": null, "lineNumber": 45, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 847, "kind": "method", "name": "_paranoidClause", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._paranoidClause", "access": null, "description": null, "lineNumber": 50, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "model", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 848, "kind": "method", "name": "_addDefaultAttributes", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._addDefaultAttributes", "access": null, "description": null, "lineNumber": 93, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 849, "kind": "member", "name": "rawAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.rawAttributes", "access": null, "description": null, "lineNumber": 146, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 850, "kind": "method", "name": "_findAutoIncrementField", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._findAutoIncrementField", "access": null, "description": null, "lineNumber": 167, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 851, "kind": "member", "name": "autoIncrementField", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.autoIncrementField", "access": null, "description": null, "lineNumber": 170, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 852, "kind": "member", "name": "autoIncrementField", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.autoIncrementField", "access": null, "description": null, "lineNumber": 176, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 853, "kind": "method", "name": "_conformOptions", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._conformOptions", "access": null, "description": null, "lineNumber": 181, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] }, { "name": "self", "types": [ "*" ] } ] }, { "__docId__": 854, "kind": "method", "name": "_transformStringAssociation", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._transformStringAssociation", "access": null, "description": null, "lineNumber": 201, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "include", "types": [ "*" ] }, { "name": "self", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 855, "kind": "method", "name": "_conformInclude", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._conformInclude", "access": null, "description": null, "lineNumber": 211, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "include", "types": [ "*" ] }, { "name": "self", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 856, "kind": "method", "name": "_expandIncludeAllElement", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._expandIncludeAllElement", "access": null, "description": null, "lineNumber": 257, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "includes", "types": [ "*" ] }, { "name": "include", "types": [ "*" ] } ] }, { "__docId__": 857, "kind": "method", "name": "_validateIncludedElements", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._validateIncludedElements", "access": null, "description": null, "lineNumber": 359, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] }, { "name": "tableNames", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 858, "kind": "method", "name": "_validateIncludedElement", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._validateIncludedElement", "access": null, "description": null, "lineNumber": 448, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "include", "types": [ "*" ] }, { "name": "tableNames", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 859, "kind": "method", "name": "_getIncludedAssociation", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._getIncludedAssociation", "access": null, "description": null, "lineNumber": 563, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "targetModel", "types": [ "*" ] }, { "name": "targetAlias", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 860, "kind": "method", "name": "_expandIncludeAll", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._expandIncludeAll", "access": null, "description": null, "lineNumber": 590, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 861, "kind": "method", "name": "init", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.init", "access": null, "description": "Initialize a model, representing a table in the DB, with attributes and options.\n\nThe 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:\n\n```js\nProject.init({\n columnA: {\n type: Sequelize.BOOLEAN,\n validate: {\n is: ['[a-z]','i'], // will only allow letters\n max: 23, // only allow values <= 23\n isIn: {\n args: [['en', 'zh']],\n msg: \"Must be English or Chinese\"\n }\n },\n field: 'column_a'\n // Other attributes here\n },\n columnB: Sequelize.STRING,\n columnC: 'MY VERY OWN COLUMN TYPE'\n}, {sequelize})\n\nsequelize.models.modelName // The model will now be available in models under the class name\n```\n\n\nAs shown above, column definitions can be either strings, a reference to one of the datatypes that are predefined on the Sequelize constructor, or an object that allows you to specify both the type of the column, and other attributes such as default values, foreign key constraints and custom setters and getters.\n\nFor a list of possible data types, see {@link DataTypes}\n\nFor more about validation, see http://docs.sequelizejs.com/en/latest/docs/models-definition/#validations", "see": [ "{@link DataTypes}", "{@link Hooks}" ], "lineNumber": 701, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "attributes", "description": "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:" }, { "nullable": null, "types": [ "String", "DataTypes", "Object" ], "spread": false, "optional": false, "name": "attributes.column", "description": "The description of a database column" }, { "nullable": null, "types": [ "String", "DataTypes" ], "spread": false, "optional": false, "name": "attributes.column.type", "description": "A string or a data type" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "attributes.column.allowNull", "description": "If false, the column will have a NOT NULL constraint, and a not null validation will be run before an instance is saved." }, { "nullable": null, "types": [ "any" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "attributes.column.defaultValue", "description": "A literal default value, a JavaScript function, or an SQL function (see `sequelize.fn`)" }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "attributes.column.unique", "description": "If true, the column will get a unique constraint. If a string is provided, the column will be part of a composite unique index. If multiple columns have the same string, they will be part of the same unique index" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "attributes.column.primaryKey", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "attributes.column.field", "description": "If set, sequelize will map the attribute name to a different name in the database" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "attributes.column.autoIncrement", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "attributes.column.comment", "description": "" }, { "nullable": null, "types": [ "String", "Model" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "attributes.column.references", "description": "An object with reference configurations" }, { "nullable": null, "types": [ "String", "Model" ], "spread": false, "optional": true, "name": "attributes.column.references.model", "description": "If this column references another table, provide it here as a Model, or a string" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'id'", "defaultRaw": "'id'", "name": "attributes.column.references.key", "description": "The column of the foreign table that this column references" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "attributes.column.onUpdate", "description": "What should happen when the referenced key is updated. One of CASCADE, RESTRICT, SET DEFAULT, SET NULL or NO ACTION" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "attributes.column.onDelete", "description": "What should happen when the referenced key is deleted. One of CASCADE, RESTRICT, SET DEFAULT, SET NULL or NO ACTION" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "name": "attributes.column.get", "description": "Provide a custom getter for this column. Use `this.getDataValue(String)` to manipulate the underlying values." }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "name": "attributes.column.set", "description": "Provide a custom setter for this column. Use `this.setDataValue(String, Value)` to manipulate the underlying values." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "attributes.validate", "description": "An object of validations to execute for this column every time the model is saved. Can be either the name of a validation provided by validator.js, a validation function provided by extending validator.js (see the `DAOValidator` property for more details), or a custom validation function. Custom validation functions are called with the value of the field, and can possibly take a second callback argument, to signal that they are asynchronous. If the validator is sync, it should throw in the case of a failed validation, it it is async, the callback should be called with the error text." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "These options are merged with the default define options provided to the Sequelize constructor" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options.defaultScope", "description": "Define the default search scope to use for this model. Scopes have the same form as the options passed to find / findAll" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.scopes", "description": "More scopes, defined in the same way as defaultScope above. See `Model.scope` for more information about how scopes are defined, and what you can do with them" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.omitNull", "description": "Don't persist null values. This means that all columns with null values will not be saved" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.timestamps", "description": "Adds createdAt and updatedAt timestamps to the model." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.paranoid", "description": "Calling `destroy` will not delete the model, but instead set a `deletedAt` timestamp if this is true. Needs `timestamps=true` to work" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.underscored", "description": "Converts all camelCased columns to underscored if true" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.underscoredAll", "description": "Converts camelCased model names to underscored table names if true" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.freezeTableName", "description": "If freezeTableName is true, sequelize will not try to alter the model name to get the table name. Otherwise, the model name will be pluralized" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.name", "description": "An object with two attributes, `singular` and `plural`, which are used when this model is associated to others." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "Utils.singularize(modelName)", "defaultRaw": "Utils.singularize(modelName)", "name": "options.name.singular", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "Utils.pluralize(modelName)", "defaultRaw": "Utils.pluralize(modelName)", "name": "options.name.plural", "description": "" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.indexes", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.indexes[].name", "description": "The name of the index. Defaults to model name + _ + fields concatenated" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.indexes[].type", "description": "Index type. Only used by mysql. One of `UNIQUE`, `FULLTEXT` and `SPATIAL`" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.indexes[].method", "description": "The method to create the index by (`USING` statement in SQL). BTREE and HASH are supported by mysql and postgres, and postgres additionally supports GIST and GIN." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.indexes[].unique", "description": "Should the index by unique? Can also be triggered by setting type to `UNIQUE`" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.indexes[].concurrently", "description": "PostgreSQL will build the index without taking any write locks. Postgres only" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.indexes[].fields", "description": "An array of the fields to index. Each field can either be a string containing the name of the field, a sequelize object (e.g `sequelize.fn`), or an object with the following attributes: `attribute` (field name), `length` (create a prefix index of length chars), `order` (the direction the column should be sorted in), `collate` (the collation (sort order) for the column)" }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "name": "options.createdAt", "description": "Override the name of the createdAt column if a string is provided, or disable it if false. Timestamps must be true. Not affected by underscored setting." }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "name": "options.updatedAt", "description": "Override the name of the updatedAt column if a string is provided, or disable it if false. Timestamps must be true. Not affected by underscored setting." }, { "nullable": null, "types": [ "String", "Boolean" ], "spread": false, "optional": true, "name": "options.deletedAt", "description": "Override the name of the deletedAt column if a string is provided, or disable it if false. Timestamps must be true. Not affected by underscored setting." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.tableName", "description": "Defaults to pluralized model name, unless freezeTableName is true, in which case it uses model name verbatim" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'public'", "defaultRaw": "'public'", "name": "options.schema", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.engine", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.charset", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.comment", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.collate", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.initialAutoIncrement", "description": "Set the initial AUTO_INCREMENT value for the table in MySQL." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.hooks", "description": "An object of hook function that are called before and after certain lifecycle events. The possible hooks are: beforeValidate, afterValidate, validationFailed, 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." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.validate", "description": "An object of model wide validations. Validations have access to all model values via `this`. If the validator function takes an argument, it is assumed to be async, and is called with a callback that accepts an optional error." } ], "return": { "nullable": null, "types": [ "Model" ], "spread": false, "description": "" } }, { "__docId__": 862, "kind": "member", "name": "sequelize", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.sequelize", "access": null, "description": null, "lineNumber": 707, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 863, "kind": "member", "name": "options", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.options", "access": null, "description": null, "lineNumber": 733, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 864, "kind": "member", "name": "associations", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.associations", "access": null, "description": null, "lineNumber": 755, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 865, "kind": "member", "name": "underscored", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.underscored", "access": null, "description": null, "lineNumber": 761, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 866, "kind": "member", "name": "tableName", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.tableName", "access": null, "description": null, "lineNumber": 764, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 867, "kind": "member", "name": "tableName", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.tableName", "access": null, "description": null, "lineNumber": 766, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 868, "kind": "member", "name": "_schema", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._schema", "access": null, "description": null, "lineNumber": 769, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 869, "kind": "member", "name": "_schemaDelimiter", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._schemaDelimiter", "access": null, "description": null, "lineNumber": 770, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 870, "kind": "member", "name": "attributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.attributes", "access": null, "description": null, "lineNumber": 783, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 871, "kind": "member", "name": "primaryKeys", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.primaryKeys", "access": null, "description": null, "lineNumber": 798, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 872, "kind": "member", "name": "_timestampAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._timestampAttributes", "access": null, "description": null, "lineNumber": 801, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 873, "kind": "member", "name": "_versionAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._versionAttribute", "access": null, "description": null, "lineNumber": 815, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 874, "kind": "member", "name": "_versionAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._versionAttribute", "access": null, "description": null, "lineNumber": 817, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 875, "kind": "member", "name": "_readOnlyAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._readOnlyAttributes", "access": null, "description": null, "lineNumber": 822, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 876, "kind": "member", "name": "_hasReadOnlyAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasReadOnlyAttributes", "access": null, "description": null, "lineNumber": 826, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 877, "kind": "member", "name": "_isReadOnlyAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._isReadOnlyAttribute", "access": null, "description": null, "lineNumber": 827, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 878, "kind": "member", "name": "_scope", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._scope", "access": null, "description": null, "lineNumber": 833, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 879, "kind": "method", "name": "_conformIndex", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._conformIndex", "access": null, "description": null, "lineNumber": 867, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "index", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 880, "kind": "method", "name": "refreshAttributes", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.refreshAttributes", "access": null, "description": null, "lineNumber": 880, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 881, "kind": "member", "name": "_booleanAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._booleanAttributes", "access": null, "description": null, "lineNumber": 933, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 882, "kind": "member", "name": "_dateAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._dateAttributes", "access": null, "description": null, "lineNumber": 934, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 883, "kind": "member", "name": "_hstoreAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hstoreAttributes", "access": null, "description": null, "lineNumber": 935, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 884, "kind": "member", "name": "_rangeAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._rangeAttributes", "access": null, "description": null, "lineNumber": 936, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 885, "kind": "member", "name": "_jsonAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._jsonAttributes", "access": null, "description": null, "lineNumber": 937, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 886, "kind": "member", "name": "_geometryAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._geometryAttributes", "access": null, "description": null, "lineNumber": 938, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 887, "kind": "member", "name": "_virtualAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._virtualAttributes", "access": null, "description": null, "lineNumber": 939, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 888, "kind": "member", "name": "_defaultValues", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._defaultValues", "access": null, "description": null, "lineNumber": 940, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 889, "kind": "member", "name": "fieldRawAttributesMap", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.fieldRawAttributesMap", "access": null, "description": null, "lineNumber": 943, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 890, "kind": "member", "name": "primaryKeys", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.primaryKeys", "access": null, "description": null, "lineNumber": 945, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 891, "kind": "member", "name": "fieldAttributeMap", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.fieldAttributeMap", "access": null, "description": null, "lineNumber": 1019, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 892, "kind": "member", "name": "uniqueKeys", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.uniqueKeys", "access": null, "description": null, "lineNumber": 1026, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 893, "kind": "member", "name": "_hasBooleanAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasBooleanAttributes", "access": null, "description": null, "lineNumber": 1028, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 894, "kind": "member", "name": "_isBooleanAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._isBooleanAttribute", "access": null, "description": null, "lineNumber": 1029, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 895, "kind": "member", "name": "_hasDateAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasDateAttributes", "access": null, "description": null, "lineNumber": 1031, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 896, "kind": "member", "name": "_isDateAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._isDateAttribute", "access": null, "description": null, "lineNumber": 1032, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 897, "kind": "member", "name": "_hasHstoreAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasHstoreAttributes", "access": null, "description": null, "lineNumber": 1034, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 898, "kind": "member", "name": "_isHstoreAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._isHstoreAttribute", "access": null, "description": null, "lineNumber": 1035, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 899, "kind": "member", "name": "_hasRangeAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasRangeAttributes", "access": null, "description": null, "lineNumber": 1037, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 900, "kind": "member", "name": "_isRangeAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._isRangeAttribute", "access": null, "description": null, "lineNumber": 1038, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 901, "kind": "member", "name": "_hasJsonAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasJsonAttributes", "access": null, "description": null, "lineNumber": 1040, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 902, "kind": "member", "name": "_isJsonAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._isJsonAttribute", "access": null, "description": null, "lineNumber": 1041, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 903, "kind": "member", "name": "_hasVirtualAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasVirtualAttributes", "access": null, "description": null, "lineNumber": 1043, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 904, "kind": "member", "name": "_isVirtualAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._isVirtualAttribute", "access": null, "description": null, "lineNumber": 1044, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 905, "kind": "member", "name": "_hasGeometryAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasGeometryAttributes", "access": null, "description": null, "lineNumber": 1046, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 906, "kind": "member", "name": "_isGeometryAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._isGeometryAttribute", "access": null, "description": null, "lineNumber": 1047, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 907, "kind": "member", "name": "_hasDefaultValues", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasDefaultValues", "access": null, "description": null, "lineNumber": 1049, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 908, "kind": "member", "name": "attributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.attributes", "access": null, "description": null, "lineNumber": 1051, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 909, "kind": "member", "name": "tableAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.tableAttributes", "access": null, "description": null, "lineNumber": 1052, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 910, "kind": "member", "name": "primaryKeyAttributes", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.primaryKeyAttributes", "access": null, "description": null, "lineNumber": 1071, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 911, "kind": "member", "name": "primaryKeyAttribute", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.primaryKeyAttribute", "access": null, "description": null, "lineNumber": 1072, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 912, "kind": "member", "name": "primaryKeyField", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.primaryKeyField", "access": null, "description": null, "lineNumber": 1074, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 913, "kind": "member", "name": "primaryKeyCount", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model.primaryKeyCount", "access": null, "description": null, "lineNumber": 1077, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 914, "kind": "member", "name": "_hasPrimaryKeys", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._hasPrimaryKeys", "access": null, "description": null, "lineNumber": 1078, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 915, "kind": "member", "name": "_isPrimaryKey", "memberof": "lib/model.js~Model", "static": true, "longname": "lib/model.js~Model._isPrimaryKey", "access": null, "description": null, "lineNumber": 1080, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 916, "kind": "method", "name": "removeAttribute", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.removeAttribute", "access": null, "description": "Remove attribute from model definition", "lineNumber": 1088, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "attribute", "description": "" } ] }, { "__docId__": 917, "kind": "method", "name": "sync", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.sync", "access": null, "description": "Sync this Model to the DB, that is create the table. Upon success, the callback will be called with the model instance (this)", "see": [ "{@link Sequelize#sync} for options" ], "lineNumber": 1098, "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 918, "kind": "method", "name": "drop", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.drop", "access": null, "description": "Drop the table represented by this Model", "lineNumber": 1155, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.cascade", "description": "Also drop all objects depending on this table, such as views. Only works in postgres" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 919, "kind": "method", "name": "dropSchema", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.dropSchema", "access": null, "description": null, "lineNumber": 1159, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "schema", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 920, "kind": "method", "name": "schema", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.schema", "access": null, "description": "Apply a schema to this model. For postgres, this will actually place the schema in front of the table name - `\"schema\".\"tableName\"`,\nwhile the schema will be prepended to the table name for mysql and sqlite - `'schema.tablename'`.\n\nThis method is intended for use cases where the same model is needed in multiple schemas. In such a use case it is important\nto call `model.schema(schema, [options]).sync()` for each model to ensure the models are created in the correct schema.\n\nIf a single default schema per model is needed, set the `options.schema='schema'` parameter during the `define()` call\nfor the model.", "see": [ "{@link Sequelize#define} for more information about setting a default schema." ], "lineNumber": 1183, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "schema", "description": "The name of the schema" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'.'", "defaultRaw": "'.'", "name": "options.schemaDelimiter", "description": "The character(s) that separates the schema name from the table name" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." } ], "return": { "nullable": null, "types": [ "this" ], "spread": false, "description": "" } }, { "__docId__": 921, "kind": "method", "name": "getTableName", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.getTableName", "access": null, "description": "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,\nor an object with `tableName`, `schema` and `delimiter` properties.", "lineNumber": 1212, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The hash of options from any query. You can use one model to access tables with matching schemas by overriding `getTableName` and using custom key/values to alter the name of the table. (eg. subscribers_1, subscribers_2)" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." } ], "return": { "nullable": null, "types": [ "String", "Object" ], "spread": false, "description": "" } }, { "__docId__": 922, "kind": "method", "name": "unscoped", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.unscoped", "access": null, "description": "", "lineNumber": 1219, "params": [], "return": { "nullable": null, "types": [ "Model" ], "spread": false, "description": "" } }, { "__docId__": 923, "kind": "method", "name": "addScope", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.addScope", "access": null, "description": "Add a new scope to the model. This is especially useful for adding scopes with includes, when the model you want to include is not available at the time this model is defined.\n\nBy default this will throw an error if a scope with that name already exists. Pass `override: true` in the options object to silence this error.", "lineNumber": 1233, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "name", "description": "The name of the scope. Use `defaultScope` to override the default scope" }, { "nullable": null, "types": [ "Object", "Function" ], "spread": false, "optional": false, "name": "scope", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.override", "description": "" } ] }, { "__docId__": 924, "kind": "method", "name": "scope", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.scope", "access": null, "description": "Apply a scope created in `define` to the model. First let's look at how to create scopes:\n```js\nconst Model = sequelize.define('model', attributes, {\n defaultScope: {\n where: {\n username: 'dan'\n },\n limit: 12\n },\n scopes: {\n isALie: {\n where: {\n stuff: 'cake'\n }\n },\n complexFunction: function(email, accessLevel) {\n return {\n where: {\n email: {\n $like: email\n },\n accesss_level {\n $gte: accessLevel\n }\n }\n }\n }\n }\n})\n```\nNow, since you defined a default scope, every time you do Model.find, the default scope is appended to your query. Here's a couple of examples:\n```js\nModel.findAll() // WHERE username = 'dan'\nModel.findAll({ where: { age: { gt: 12 } } }) // WHERE age > 12 AND username = 'dan'\n```\n\nTo invoke scope functions you can do:\n```js\nModel.scope({ method: ['complexFunction' 'dan@sequelize.com', 42]}).findAll()\n// WHERE email like 'dan@sequelize.com%' AND access_level >= 42\n```", "lineNumber": 1297, "params": [ { "nullable": null, "types": [ "Array", "Object", "String", "null" ], "spread": false, "optional": false, "name": "options", "description": "The scope(s) to apply. Scopes can either be passed as consecutive arguments, or as an array of arguments. To apply simple scopes and scope functions with no arguments, 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." } ], "return": { "nullable": null, "types": [ "Model" ], "spread": false, "description": "A reference to the model, with the scope(s) applied. Calling scope again on the returned model will clear the previous scope." } }, { "__docId__": 925, "kind": "method", "name": "all", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.all", "access": null, "description": null, "lineNumber": 1360, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 926, "kind": "method", "name": "findAll", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.findAll", "access": null, "description": "Search for multiple instances.\n\n__Simple search using AND and =__\n```js\nModel.findAll({\n where: {\n attr1: 42,\n attr2: 'cake'\n }\n})\n```\n```sql\nWHERE attr1 = 42 AND attr2 = 'cake'\n```\n\n__Using greater than, less than etc.__\n```js\n\nModel.findAll({\n where: {\n attr1: {\n gt: 50\n },\n attr2: {\n lte: 45\n },\n attr3: {\n in: [1,2,3]\n },\n attr4: {\n ne: 5\n }\n }\n})\n```\n```sql\nWHERE attr1 > 50 AND attr2 <= 45 AND attr3 IN (1,2,3) AND attr4 != 5\n```\nPossible options are: `$ne, $in, $not, $notIn, $gte, $gt, $lte, $lt, $like, $ilike/$iLike, $notLike, $notILike, '..'/$between, '!..'/$notBetween, '&&'/$overlap, '@>'/$contains, '<@'/$contained`\n\n__Queries using OR__\n```js\nModel.findAll({\n where: {\n name: 'a project',\n $or: [\n {id: [1, 2, 3]},\n {\n $and: [\n {id: {gt: 10}},\n {id: {lt: 100}}\n ]\n }\n ]\n }\n});\n```\n```sql\nWHERE `Model`.`name` = 'a project' AND (`Model`.`id` IN (1, 2, 3) OR (`Model`.`id` > 10 AND `Model`.`id` < 100));\n```\n\nThe promise is resolved with an array of Model instances if the query succeeds.\n\n__Alias__: _all_", "lineNumber": 1465, "unknown": [ { "tagName": "@link", "tagValue": " {@link Sequelize.query}" } ], "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "A hash of options to describe the scope of the search" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.where", "description": "A hash of attributes to describe your search. See above for examples." }, { "nullable": null, "types": [ "Array", "Object" ], "spread": false, "optional": true, "name": "options.attributes", "description": "A list of the attributes that you want to select, or an object with `include` and `exclude` keys. To rename an attribute, you can pass an array, with two elements - the first is the name of the attribute in the DB (or some kind of expression such as `Sequelize.literal`, `Sequelize.fn` and so on), and the second is the name you want the attribute to have in the returned instance" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.attributes.include", "description": "Select all the attributes of the model, plus some additional ones. Useful for aggregations, e.g. `{ attributes: { include: [[sequelize.fn('COUNT', sequelize.col('id')), 'total']] }`" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.attributes.exclude", "description": "Select all the attributes of the model, except some few. Useful for security purposes e.g. `{ attributes: { exclude: ['password'] } }`" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.paranoid", "description": "If true, only non-deleted records will be returned. If false, both deleted and non-deleted records will be returned. Only applies if `options.paranoid` is true for the model." }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.include", "description": "A list of associations to eagerly load using a left join. Supported is either `{ include: [ Model1, Model2, ...]}` or `{ include: [{ model: Model1, as: 'Alias' }]}` or `{ include: ['Alias']}`. If your association are set up with an `as` (eg. `X.hasMany(Y, { as: 'Z }`, you need to specify Z in the as attribute when eager loading Y)." }, { "nullable": null, "types": [ "Model" ], "spread": false, "optional": true, "name": "options.include[].model", "description": "The model you want to eagerly load" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.include[].as", "description": "The alias of the relation, in case the model you want to eagerly load is aliased. For `hasOne` / `belongsTo`, this should be the singular name, and for `hasMany`, it should be the plural" }, { "nullable": null, "types": [ "Association" ], "spread": false, "optional": true, "name": "options.include[].association", "description": "The association you want to eagerly load. (This can be used instead of providing a model/as pair)" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.include[].where", "description": "Where clauses to apply to the child models. Note that this converts the eager load to an inner join, unless you explicitly set `required: false`" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.include[].or", "description": "Whether to bind the ON and WHERE clause together by OR instead of AND." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.include[].on", "description": "Supply your own ON condition for the join." }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.include[].attributes", "description": "A list of attributes to select from the child model" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.include[].required", "description": "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." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.include[].separate", "description": "If true, runs a separate query to fetch the associated instances, only supported for hasMany associations" }, { "nullable": null, "types": [ "Number" ], "spread": false, "optional": true, "name": "options.include[].limit", "description": "Limit the joined rows, only supported with include.separate=true" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.include[].through.where", "description": "Filter on the join model for belongsToMany relations" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.include[].through.attributes", "description": "A list of attributes to select from the join model for belongsToMany relations" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.include[].include", "description": "Load further nested related models" }, { "nullable": null, "types": [ "Array", "Sequelize.fn", "Sequelize.col", "Sequelize.literal" ], "spread": false, "optional": true, "name": "options.order", "description": "Specifies an ordering. 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." }, { "nullable": null, "types": [ "Number" ], "spread": false, "optional": true, "name": "options.limit", "description": "" }, { "nullable": null, "types": [ "Number" ], "spread": false, "optional": true, "name": "options.offset", "description": "" }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "String", "Object" ], "spread": false, "optional": true, "name": "options.lock", "description": "Lock the selected rows. Possible options are transaction.LOCK.UPDATE and transaction.LOCK.SHARE. Postgres also supports transaction.LOCK.KEY_SHARE, transaction.LOCK.NO_KEY_UPDATE and specific model locks with joins. See [transaction.LOCK for an example](transaction#lock)" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.raw", "description": "Return raw result. See sequelize.query for more information." }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.having", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" }, { "nullable": null, "types": [ "Boolean", "Error" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.rejectOnEmpty", "description": "Throws an error when no records found" } ], "return": { "nullable": null, "types": [ "Promise>" ], "spread": false, "description": "" } }, { "__docId__": 927, "kind": "method", "name": "warnOnInvalidOptions", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.warnOnInvalidOptions", "access": null, "description": null, "lineNumber": 1554, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] }, { "name": "validColumnNames", "types": [ "*" ] } ] }, { "__docId__": 928, "kind": "method", "name": "_findSeparate", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._findSeparate", "access": null, "description": null, "lineNumber": 1574, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "results", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 929, "kind": "method", "name": "findById", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.findById", "access": null, "description": "Search for a single instance by its primary key.\n\n__Alias__: _findByPrimary_", "see": [ "{@link Model.findAll} for a full explanation of options" ], "lineNumber": 1638, "params": [ { "nullable": null, "types": [ "Number", "String", "Buffer" ], "spread": false, "optional": false, "name": "id", "description": "The value of the desired instance's primary key." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 930, "kind": "method", "name": "findOne", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.findOne", "access": null, "description": "Search for a single instance. This applies LIMIT 1, so the listener will always be called with a single instance.\n\n__Alias__: _find_", "see": [ "{@link Model.findAll} for an explanation of options" ], "lineNumber": 1669, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "A hash of options to describe the scope of the search" }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 931, "kind": "method", "name": "aggregate", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.aggregate", "access": null, "description": "Run an aggregation method on the specified field", "lineNumber": 1707, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "field", "description": "The field to aggregate over. Can be a field name or *" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "aggregateFunction", "description": "The function to use for aggregation, e.g. sum, max etc." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Query options. See sequelize.query for full options" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.where", "description": "A hash of search attributes." }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "DataTypes", "String" ], "spread": false, "optional": true, "name": "options.dataType", "description": "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." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "name": "options.distinct", "description": "Applies DISTINCT to the field being aggregated over" }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.plain", "description": "When `true`, the first returned value of `aggregateFunction` is cast to `dataType` and returned. If additional attributes are specified, along with `group` clauses, set `plain` to `false` to return all values of all returned rows. Defaults to `true`" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Returns the aggregate result cast to `options.dataType`, unless `options.plain` is false, in which case the complete data result is returned." } }, { "__docId__": 932, "kind": "method", "name": "count", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.count", "access": null, "description": "Count the number of records matching the provided where clause.\n\nIf you provide an `include` option, the number of matching associations will be counted instead.", "lineNumber": 1764, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.where", "description": "A hash of search attributes." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.include", "description": "Include options. See `find` for details" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.paranoid", "description": "Set `true` to count only non-deleted records. Can be used on models with `paranoid` enabled" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.distinct", "description": "Apply COUNT(DISTINCT(col)) on primary key or on options.col." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.col", "description": "Column on which COUNT() should be applied" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.attributes", "description": "Used in conjunction with `group`" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.group", "description": "For creating complex counts. Will return multiple rows as needed." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 933, "kind": "method", "name": "findAndCount", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.findAndCount", "access": null, "description": "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 useful for paging\n\n```js\nModel.findAndCountAll({\n where: ...,\n limit: 12,\n offset: 12\n}).then(result => {\n ...\n})\n```\nIn the above example, `result.rows` will contain rows 13 through 24, while `result.count` will return the total number of rows that matched your query.\n\nWhen you add includes, only those which are required (either because they have a where clause, or because `required` is explicitly set to true on the include) will be added to the count part.\n\nSuppose you want to find all users who have a profile attached:\n```js\nUser.findAndCountAll({\n include: [\n { model: Profile, required: true}\n ],\n limit 3\n});\n```\nBecause the include for `Profile` has `required` set it will result in an inner join, and only the users who have a profile will be counted. If we remove `required` from the include, both users with and without profiles will be counted\n\n__Alias__: _findAndCountAll_", "see": [ "{@link Model.findAll} for a specification of find and query options" ], "lineNumber": 1826, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "findOptions", "description": "See findAll" } ], "return": { "nullable": null, "types": [ "Promise<{count: Integer, rows: Model[]}>" ], "spread": false, "description": "" } }, { "__docId__": 934, "kind": "method", "name": "max", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.max", "access": null, "description": "Find the maximum value of field", "see": [ "{@link Model#aggregate} for options" ], "lineNumber": 1862, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "field", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "See aggregate" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 935, "kind": "method", "name": "min", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.min", "access": null, "description": "Find the minimum value of field", "see": [ "{@link Model#aggregate} for options" ], "lineNumber": 1875, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "field", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "See aggregate" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 936, "kind": "method", "name": "sum", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.sum", "access": null, "description": "Find the sum of field", "see": [ "{@link Model#aggregate} for options" ], "lineNumber": 1888, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "field", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "See aggregate" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 937, "kind": "method", "name": "build", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.build", "access": null, "description": "Builds a new model instance.", "lineNumber": 1903, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "(values|values[])", "description": "An object of key value pairs or an array of such. If an array, the function will return an array of instances." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.raw", "description": "If set to true, values will ignore field and virtual setters." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.isNewRecord", "description": "" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.include", "description": "an array of include options - Used to build prefetched/included model instances. See `set`" } ], "return": { "nullable": null, "types": [ "Model", "Model[]" ], "spread": false, "description": "" } }, { "__docId__": 938, "kind": "method", "name": "bulkBuild", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.bulkBuild", "access": null, "description": null, "lineNumber": 1911, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "valueSets", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 939, "kind": "method", "name": "create", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.create", "access": null, "description": "Builds a new model instance and calls save on it.", "see": [ "{@link Model#build}", "{@link Model#save}" ], "lineNumber": 1956, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "values", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.raw", "description": "If set to true, values will ignore field and virtual setters." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.isNewRecord", "description": "" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.include", "description": "an array of include options - Used to build prefetched/included model instances. See `set`" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.fields", "description": "If set, only columns matching those in fields will be saved" }, { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": true, "name": "options.fields", "description": "An optional array of strings, representing database columns. If fields is provided, only those columns will be validated and saved." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.silent", "description": "If true, the updatedAt timestamp will not be updated." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.validate", "description": "If false, validations won't be run." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.hooks", "description": "Run before and after create / update + validate hooks" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.returning", "description": "Return the affected rows (only for postgres)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 940, "kind": "method", "name": "findOrBuild", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.findOrBuild", "access": null, "description": "Find a row that matches the query, or build (but don't save) the row if none is found.\nThe successful result of the promise will be (instance, initialized) - Make sure to use .spread()\n\n__Alias__: _findOrInitialize_", "lineNumber": 1983, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options.where", "description": "A hash of search attributes." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.defaults", "description": "Default values to use if building a new instance" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 941, "kind": "method", "name": "findOrCreate", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.findOrCreate", "access": null, "description": "Find a row that matches the query, or build and save the row if none is found\nThe successful result of the promise will be (instance, created) - Make sure to use .spread()\n\nIf no transaction is passed in the `options` object, a new transaction will be created internally, to prevent the race condition where a matching row is created by another connection after the find but before the insert call.\nHowever, it is not always possible to handle this case in SQLite, specifically if one transaction inserts and another tries to select before the first one has committed. In this case, an instance of sequelize. TimeoutError will be thrown instead.\nIf a transaction is created, a savepoint will be created instead, and any unique constraint violation will be handled internally.", "see": [ "{@link Model.findAll} for a full specification of find and options" ], "lineNumber": 2024, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options.where", "description": "where A hash of search attributes." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.defaults", "description": "Default values to use if creating a new instance" }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 942, "kind": "method", "name": "findCreateFind", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.findCreateFind", "access": null, "description": "A more performant findOrCreate that will not work under a transaction (at least not in postgres)\nWill execute a find call, if empty then attempt to create, if unique constraint then attempt to find again", "see": [ "{@link Model.findAll} for a full specification of find and options" ], "lineNumber": 2117, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options.where", "description": "where A hash of search attributes." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.defaults", "description": "Default values to use if creating a new instance" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 943, "kind": "method", "name": "upsert", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.upsert", "access": null, "description": "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.\n\n**Implementation details:**\n\n* MySQL - Implemented as a single query `INSERT values ON DUPLICATE KEY UPDATE values`\n* PostgreSQL - Implemented as a temporary function with exception handling: INSERT EXCEPTION WHEN unique_constraint UPDATE\n* SQLite - Implemented as two queries `INSERT; UPDATE`. This means that the update is executed regardless of whether the row already existed or not\n* MSSQL - Implemented as a single query using `MERGE` and `WHEN (NOT) MATCHED THEN`\n**Note** that SQLite returns undefined for created, no matter if the row was created or updated. This is because SQLite always runs INSERT OR IGNORE + UPDATE, in a single query, so there is no way to know whether the row was inserted or not.\n\n__Alias__: _insertOrUpdate_", "lineNumber": 2164, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "values", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.validate", "description": "Run validations before the row is inserted" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "defaultValue": "Object.keys(this.attributes)", "defaultRaw": "Object.keys(this.attributes)", "name": "options.fields", "description": "The fields to insert / update. Defaults to all fields" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.hooks", "description": "Run before / after upsert hooks?" }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Returns a boolean indicating whether the row was created or updated." } }, { "__docId__": 944, "kind": "method", "name": "bulkCreate", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.bulkCreate", "access": null, "description": "Create and insert multiple instances in bulk.\n\nThe 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\nand SQLite do not make it easy to obtain back automatically generated IDs and other default values in a way that can be mapped to multiple records.\nTo obtain Instances for the newly created values, you will need to query for them again.\n\nIf validation fails, the promise is rejected with an array-like [AggregateError](http://bluebirdjs.com/docs/api/aggregateerror.html)", "lineNumber": 2239, "params": [ { "nullable": null, "types": [ "Array" ], "spread": false, "optional": false, "name": "records", "description": "List of objects (key/value pairs) to create instances from" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.fields", "description": "Fields to insert (defaults to all fields)" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.validate", "description": "Should each row be subject to validation before it is inserted. The whole insert will fail if one row fails validation" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.hooks", "description": "Run before / after bulk create hooks?" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.individualHooks", "description": "Run before / after create hooks for each individual Instance? BulkCreate hooks will still be run if options.hooks is true." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.ignoreDuplicates", "description": "Ignore duplicate values for primary keys? (not supported by postgres)" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.updateOnDuplicate", "description": "Fields to update if row key already exists (on duplicate key update)? (only supported by mysql). By default, all fields are updated." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.returning", "description": "Append RETURNING * to get back auto generated values (Postgres only)" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise>" ], "spread": false, "description": "" } }, { "__docId__": 945, "kind": "method", "name": "truncate", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.truncate", "access": null, "description": "Truncate all instances of the model. This is a convenient method for Model.destroy({ truncate: true }).", "see": [ "{@link Model#destroy} for more information" ], "lineNumber": 2392, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": true, "name": "options", "description": "The options passed to Model.destroy in addition to truncate" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": true, "defaultValue": " false", "defaultRaw": false, "name": "options.cascade", "description": "Only used in conjunction with TRUNCATE. Truncates all tables that have foreign-key references to the named table, or to any tables added to the group due to CASCADE." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": true, "name": "options.logging", "description": "A function that logs sql queries, or false for no logging" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 946, "kind": "method", "name": "destroy", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.destroy", "access": null, "description": "Delete multiple instances, or set their deletedAt timestamp to the current time if `paranoid` is enabled.", "lineNumber": 2415, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.where", "description": "Filter the destroy" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.hooks", "description": "Run before / after bulk destroy hooks?" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.individualHooks", "description": "If set to true, destroy will SELECT all records matching the where parameter and will execute before / after destroy hooks on each row" }, { "nullable": null, "types": [ "Number" ], "spread": false, "optional": true, "name": "options.limit", "description": "How many rows to delete" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.force", "description": "Delete instead of setting deletedAt to current timestamp (only applicable if `paranoid` is enabled)" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.truncate", "description": "If set to true, dialects that support it will use TRUNCATE instead of DELETE FROM. If a table is truncated the where and limit options are ignored" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.cascade", "description": "Only used in conjunction with TRUNCATE. Truncates all tables that have foreign-key references to the named table, or to any tables added to the group due to CASCADE." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.restartIdentity", "description": "Only used in conjunction with TRUNCATE. Automatically restart sequences owned by columns of the truncated table." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "The number of destroyed rows" } }, { "__docId__": 947, "kind": "method", "name": "restore", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.restore", "access": null, "description": "Restore multiple instances if `paranoid` is enabled.", "lineNumber": 2500, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.where", "description": "Filter the restore" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.hooks", "description": "Run before / after bulk restore hooks?" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.individualHooks", "description": "If set to true, restore will find all records within the where parameter and will execute before / after bulkRestore hooks on each row" }, { "nullable": null, "types": [ "Number" ], "spread": false, "optional": true, "name": "options.limit", "description": "How many rows to undelete (only for mysql)" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 948, "kind": "method", "name": "update", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.update", "access": null, "description": "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\nof affected rows, while the second element is the actual affected rows (only supported in postgres with `options.returning` true.)", "lineNumber": 2573, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "values", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options.where", "description": "Options to describe the scope of the search." }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.fields", "description": "Fields to update (defaults to all fields)" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.validate", "description": "Should each row be subject to validation before it is inserted. The whole insert will fail if one row fails validation" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.hooks", "description": "Run before / after bulk update hooks?" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.sideEffects", "description": "Whether or not to update the side effects of any virtual setters." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.individualHooks", "description": "Run before / after update hooks?. If true, this will execute a SELECT followed by individual UPDATEs. A select is needed, because the row data needs to be passed to the hooks" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.returning", "description": "Return the affected rows (only for postgres)" }, { "nullable": null, "types": [ "Number" ], "spread": false, "optional": true, "name": "options.limit", "description": "How many rows to update (only for mysql and mariadb, implemented as TOP(n) for MSSQL)" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "Transaction to run query under" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.silent", "description": "If true, the updatedAt timestamp will not be updated." } ], "return": { "nullable": null, "types": [ "Promise>" ], "spread": false, "description": "" } }, { "__docId__": 949, "kind": "method", "name": "describe", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.describe", "access": null, "description": "Run a describe query on the table. The result will be return to the listener as a hash of attributes and their types.", "lineNumber": 2772, "params": [ { "name": "schema", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 950, "kind": "method", "name": "_getDefaultTimestamp", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._getDefaultTimestamp", "access": null, "description": null, "lineNumber": 2776, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "attr", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 951, "kind": "method", "name": "_expandAttributes", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._expandAttributes", "access": null, "description": null, "lineNumber": 2783, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 952, "kind": "method", "name": "_injectScope", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model._injectScope", "access": null, "description": null, "lineNumber": 2801, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 953, "kind": "method", "name": "inspect", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.inspect", "access": null, "description": null, "lineNumber": 2832, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 954, "kind": "method", "name": "hasAlias", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.hasAlias", "access": null, "description": null, "lineNumber": 2836, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "alias", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 955, "kind": "constructor", "name": "constructor", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#constructor", "access": null, "description": "Builds a new model instance.", "lineNumber": 2848, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "values", "description": "an object of key value pairs" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.raw", "description": "If set to true, values will ignore field and virtual setters." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.isNewRecord", "description": "" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.include", "description": "an array of include options - Used to build prefetched/included model instances. See `set`" } ] }, { "__docId__": 956, "kind": "member", "name": "dataValues", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#dataValues", "access": null, "description": null, "lineNumber": 2868, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 957, "kind": "member", "name": "_previousDataValues", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#_previousDataValues", "access": null, "description": null, "lineNumber": 2869, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 958, "kind": "member", "name": "_changed", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#_changed", "access": null, "description": null, "lineNumber": 2870, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 959, "kind": "member", "name": "_modelOptions", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#_modelOptions", "access": null, "description": null, "lineNumber": 2871, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 960, "kind": "member", "name": "_options", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#_options", "access": null, "description": null, "lineNumber": 2872, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 961, "kind": "member", "name": "hasPrimaryKeys", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#hasPrimaryKeys", "access": null, "description": null, "lineNumber": 2873, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 962, "kind": "member", "name": "__eagerlyLoadedAssociations", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#__eagerlyLoadedAssociations", "access": null, "description": null, "lineNumber": 2874, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 963, "kind": "member", "name": "isNewRecord", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#isNewRecord", "access": null, "description": "Returns true if this instance has not yet been persisted to the database", "lineNumber": 2880, "properties": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "isNewRecord", "description": "" } ], "return": { "nullable": null, "types": [ "Boolean" ], "spread": false, "description": "" }, "type": { "types": [ "*" ] } }, { "__docId__": 964, "kind": "method", "name": "_initValues", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#_initValues", "access": null, "description": null, "lineNumber": 2892, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "values", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 965, "kind": "get", "name": "sequelize", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#sequelize", "access": null, "description": "A reference to the sequelize instance", "see": [ "{@link Sequelize}" ], "lineNumber": 2949, "properties": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "sequelize", "description": "" } ], "return": { "nullable": null, "types": [ "Sequelize" ], "spread": false, "description": "" }, "type": { "types": [ "*" ] } }, { "__docId__": 966, "kind": "method", "name": "where", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#where", "access": null, "description": "Get an object representing the query for this instance, use with `options.where`", "lineNumber": 2959, "params": [ { "name": "checkVersion", "types": [ "*" ] } ], "properties": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "where", "description": "" } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "" } }, { "__docId__": 967, "kind": "method", "name": "toString", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#toString", "access": null, "description": null, "lineNumber": 2975, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 968, "kind": "method", "name": "getDataValue", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#getDataValue", "access": null, "description": "Get the value of the underlying data value", "lineNumber": 2985, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "key", "description": "" } ], "return": { "nullable": null, "types": [ "any" ], "spread": false, "description": "" } }, { "__docId__": 969, "kind": "method", "name": "setDataValue", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#setDataValue", "access": null, "description": "Update the underlying data value", "lineNumber": 2995, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "key", "description": "" }, { "nullable": null, "types": [ "any" ], "spread": false, "optional": false, "name": "value", "description": "" } ] }, { "__docId__": 970, "kind": "method", "name": "get", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#get", "access": null, "description": "If no key is given, returns all values of the instance, also invoking virtual getters.\n\nIf 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.", "lineNumber": 3015, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "key", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.plain", "description": "If set to true, included instances will be returned as plain objects" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.raw", "description": "If set to true, field and virtual setters will be ignored" } ], "return": { "nullable": null, "types": [ "Object", "any" ], "spread": false, "description": "" } }, { "__docId__": 971, "kind": "method", "name": "set", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#set", "access": null, "description": "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`).\nIn 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\nwill be called instead. To bypass the setter, you can pass `raw: true` in the options object.\n\nIf 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\nset directly to the object passed, or used to extend dataValues, if dataValues already contain values.\n\nWhen set is called, the previous value of the field is stored and sets a changed flag(see `changed`).\n\nSet can also be used to build instances for associations, if you have values for those.\nWhen using set with associations you need to make sure the property key matches the alias of the association\nwhile also making sure that the proper include options have been set (from .build() or .find())\n\nIf 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": [ "{@link Model.findAll} for more information about includes" ], "lineNumber": 3084, "params": [ { "nullable": null, "types": [ "String", "Object" ], "spread": false, "optional": false, "name": "key", "description": "" }, { "nullable": null, "types": [ "any" ], "spread": false, "optional": false, "name": "value", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.raw", "description": "If set to true, field and virtual setters will be ignored" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.reset", "description": "Clear all previously set data values" } ], "return": { "types": [ "*" ] } }, { "__docId__": 972, "kind": "member", "name": "dataValues", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#dataValues", "access": null, "description": null, "lineNumber": 3093, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 973, "kind": "member", "name": "dataValues", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#dataValues", "access": null, "description": null, "lineNumber": 3099, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 974, "kind": "member", "name": "dataValues", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#dataValues", "access": null, "description": null, "lineNumber": 3101, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 975, "kind": "member", "name": "_previousDataValues", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#_previousDataValues", "access": null, "description": null, "lineNumber": 3104, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 976, "kind": "member", "name": "_previousDataValues", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#_previousDataValues", "access": null, "description": null, "lineNumber": 3131, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 977, "kind": "method", "name": "setAttributes", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#setAttributes", "access": null, "description": null, "lineNumber": 3234, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "updates", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 978, "kind": "method", "name": "changed", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#changed", "access": null, "description": "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`.\n\nIf changed is called without an argument, it will return an array of keys that have changed.\n\nIf changed is called without an argument and no keys have changed, it will return `false`.", "lineNumber": 3248, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "key", "description": "" } ], "return": { "nullable": null, "types": [ "Boolean", "Array" ], "spread": false, "description": "" } }, { "__docId__": 979, "kind": "method", "name": "previous", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#previous", "access": null, "description": "Returns the previous value for key from `_previousDataValues`.\n\nIf called without a key, returns the previous values for all values which have changed", "lineNumber": 3270, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "key", "description": "" } ], "return": { "nullable": null, "types": [ "any", "Array" ], "spread": false, "description": "" } }, { "__docId__": 980, "kind": "method", "name": "_setInclude", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#_setInclude", "access": null, "description": null, "lineNumber": 3278, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "key", "types": [ "*" ] }, { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ] }, { "__docId__": 981, "kind": "member", "name": "[accessor]", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#[accessor]", "access": null, "description": null, "lineNumber": 3309, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 982, "kind": "member", "name": "[accessor]", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#[accessor]", "access": null, "description": null, "lineNumber": 3312, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 983, "kind": "method", "name": "save", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#save", "access": null, "description": "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.\n\nOn success, the callback will be called with this instance. On validation error, the callback will be called with an instance of `Sequelize.ValidationError`.\nThis error will have a property for each of the fields for which validation failed, with the error message for that field.", "lineNumber": 3334, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": true, "name": "options.fields", "description": "An optional array of strings, representing database columns. If fields is provided, only those columns will be validated and saved." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.silent", "description": "If true, the updatedAt timestamp will not be updated." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.validate", "description": "If false, validations won't be run." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.hooks", "description": "Run before and after create / update + validate hooks" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.returning", "description": "Append RETURNING * to get back auto generated values (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 984, "kind": "member", "name": "isNewRecord", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#isNewRecord", "access": null, "description": null, "lineNumber": 3579, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 985, "kind": "method", "name": "reload", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#reload", "access": null, "description": "Refresh the current instance in-place, i.e. update the object with current data from the DB and return the same object.\nThis is different from doing a `find(Instance.id)`, because that would create and return a new instance. With this method,\nall references to the Instance are updated with the new data and no new objects are created.", "see": [ "{@link Model.findAll}" ], "lineNumber": 3596, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options that are passed on to `Model.find`" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 986, "kind": "member", "name": "_options", "memberof": "lib/model.js~Model", "static": false, "longname": "lib/model.js~Model#_options", "access": null, "description": null, "lineNumber": 3612, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 987, "kind": "method", "name": "validate", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#validate", "access": null, "description": "Validate the attributes of this instance according to validation rules set in the model definition.\n\nEmits null if and only if validation successful; otherwise an Error instance containing { field name : [error msgs] } entries.", "lineNumber": 3634, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "Options that are passed to the validator" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.skip", "description": "An array of strings. All properties that are in this array will not be validated" }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.fields", "description": "An array of strings. Only the properties that are in this array will be validated" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.hooks", "description": "Run before and after validate hooks" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 988, "kind": "method", "name": "update", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#update", "access": null, "description": "This is the same as calling `set` and then calling `save` but it only saves the\nexact values passed to it, making it more atomic and safer.", "see": [ "{@link Model#set}", "{@link Model#save}" ], "lineNumber": 3649, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "updates", "description": "See `set`" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "See `save`" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 989, "kind": "method", "name": "destroy", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#destroy", "access": null, "description": "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.", "lineNumber": 3684, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.force", "description": "If set to true, paranoid models will actually be deleted" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 990, "kind": "method", "name": "restore", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#restore", "access": null, "description": "Restore the row corresponding to this instance. Only available for paranoid models.", "lineNumber": 3741, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 991, "kind": "method", "name": "increment", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#increment", "access": null, "description": "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\n```sql\nSET column = column + X\n```\nquery. To get the correct value after an increment into the Instance you should do a reload.\n\n```js\ninstance.increment('number') // increment number by 1\ninstance.increment(['number', 'count'], { by: 2 }) // increment number and count by 2\ninstance.increment({ answer: 42, tries: 1}, { by: 2 }) // increment answer by 42, and tries by 1.\n // `by` is ignored, since each column has its own value\n```", "see": [ "{@link Model#reload}" ], "lineNumber": 3794, "params": [ { "nullable": null, "types": [ "String", "Array", "Object" ], "spread": false, "optional": false, "name": "fields", "description": "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." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Integer" ], "spread": false, "optional": true, "defaultValue": "1", "defaultRaw": 1, "name": "options.by", "description": "The number to increment by" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.silent", "description": "If true, the updatedAt timestamp will not be updated." }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 992, "kind": "method", "name": "decrement", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#decrement", "access": null, "description": "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\n```sql\nSET column = column - X\n```\nquery. To get the correct value after an decrement into the Instance you should do a reload.\n\n```js\ninstance.decrement('number') // decrement number by 1\ninstance.decrement(['number', 'count'], { by: 2 }) // decrement number and count by 2\ninstance.decrement({ answer: 42, tries: 1}, { by: 2 }) // decrement answer by 42, and tries by 1.\n // `by` is ignored, since each column has its own value\n```", "see": [ "{@link Model#reload}" ], "lineNumber": 3867, "params": [ { "nullable": null, "types": [ "String", "Array", "Object" ], "spread": false, "optional": false, "name": "fields", "description": "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" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "Integer" ], "spread": false, "optional": true, "defaultValue": "1", "defaultRaw": 1, "name": "options.by", "description": "The number to decrement by" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.silent", "description": "If true, the updatedAt timestamp will not be updated." }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "name": "options.transaction", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 993, "kind": "method", "name": "equals", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#equals", "access": null, "description": "Check whether this and `other` Instance refer to the same row", "lineNumber": 3881, "params": [ { "nullable": null, "types": [ "Model" ], "spread": false, "optional": false, "name": "other", "description": "" } ], "return": { "nullable": null, "types": [ "Boolean" ], "spread": false, "description": "" } }, { "__docId__": 994, "kind": "method", "name": "equalsOneOf", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#equalsOneOf", "access": null, "description": "Check if this is equal to one of `others` by calling equals", "lineNumber": 3900, "params": [ { "nullable": null, "types": [ "Array" ], "spread": false, "optional": false, "name": "others", "description": "" } ], "return": { "nullable": null, "types": [ "Boolean" ], "spread": false, "description": "" } }, { "__docId__": 995, "kind": "method", "name": "setValidators", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#setValidators", "access": null, "description": null, "lineNumber": 3904, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "attribute", "types": [ "*" ] }, { "name": "validators", "types": [ "*" ] } ] }, { "__docId__": 996, "kind": "method", "name": "toJSON", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": false, "longname": "lib/model.js~Model#toJSON", "access": null, "description": "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": [ "{@link Model#get}" ], "lineNumber": 3914, "params": [], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 997, "kind": "method", "name": "hasMany", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.hasMany", "access": null, "description": "Creates a 1:m association between this (the source) and the provided target. The foreign key is added on the target.", "examples": [ "User.hasMany(Profile) // This will add userId to the profile table" ], "lineNumber": 3937, "unknown": [ { "tagName": "@returns", "tagValue": "{HasMany}" } ], "params": [ { "nullable": null, "types": [ "Model" ], "spread": false, "optional": false, "name": "target", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.hooks", "description": "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" }, { "nullable": null, "types": [ "string", "object" ], "spread": false, "optional": true, "name": "options.as", "description": "The alias of this model. If you provide a string, it should be plural, and will be singularized using node.inflection. If you want to control the singular version yourself, provide an object with `plural` and `singular` keys. See also the `name` option passed to `sequelize.define`. If you create multiple associations between the same tables, you should provide an alias to be able to distinguish between them. If you provide an alias when creating the association, you should provide the same alias when eager loading and when getting associated models. Defaults to the pluralized name of target" }, { "nullable": null, "types": [ "string", "object" ], "spread": false, "optional": true, "name": "options.foreignKey", "description": "The name of the foreign key in the target table or an object representing the type definition for the foreign column (see `Sequelize.define` for syntax). When using an object, you can add a `name` property to set the name of the column. Defaults to the name of source + primary key of source" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "name": "options.sourceKey", "description": "The name of the field to use as the key for the association in the source table. Defaults to the primary key of the source table" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": true, "name": "options.scope", "description": "A key/value set that will be used for association create and find defaults on the target. (sqlite not supported for N:M)" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "'SET NULL|CASCADE'", "defaultRaw": "'SET NULL|CASCADE'", "name": "options.onDelete", "description": "SET NULL if foreignKey allows nulls, CASCADE if otherwise" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "'CASCADE'", "defaultRaw": "'CASCADE'", "name": "options.onUpdate", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.constraints", "description": "Should on update and on delete constraints be enabled on the foreign key." } ], "return": { "nullable": null, "types": [ "HasMany" ], "spread": false, "description": "" } }, { "__docId__": 998, "kind": "method", "name": "belongsToMany", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.belongsToMany", "access": null, "description": "Create an N:M association with a join table. Defining `through` is required.", "examples": [ "// Automagically generated join model\nUser.belongsToMany(Project, { through: 'UserProjects' })\nProject.belongsToMany(User, { through: 'UserProjects' })\n\n// Join model with additional attributes\nconst UserProjects = sequelize.define('UserProjects', {\n started: Sequelize.BOOLEAN\n})\nUser.belongsToMany(Project, { through: UserProjects })\nProject.belongsToMany(User, { through: UserProjects })" ], "lineNumber": 3971, "params": [ { "nullable": null, "types": [ "Model" ], "spread": false, "optional": false, "name": "target", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.hooks", "description": "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" }, { "nullable": null, "types": [ "Model", "string", "object" ], "spread": false, "optional": false, "name": "options.through", "description": "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." }, { "nullable": null, "types": [ "Model" ], "spread": false, "optional": true, "name": "options.through.model", "description": "The model used to join both sides of the N:M association." }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": true, "name": "options.through.scope", "description": "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)" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.through.unique", "description": "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)" }, { "nullable": null, "types": [ "string", "object" ], "spread": false, "optional": true, "name": "options.as", "description": "The alias of this association. If you provide a string, it should be plural, and will be singularized using node.inflection. If you want to control the singular version yourself, provide an object with `plural` and `singular` keys. See also the `name` option passed to `sequelize.define`. If you create multiple associations between the same tables, you should provide an alias to be able to distinguish between them. If you provide an alias when creating the association, you should provide the same alias when eager loading and when getting associated models. Defaults to the pluralized name of target" }, { "nullable": null, "types": [ "string", "object" ], "spread": false, "optional": true, "name": "options.foreignKey", "description": "The name of the foreign key in the join table (representing the source model) or an object representing the type definition for the foreign column (see `Sequelize.define` for syntax). When using an object, you can add a `name` property to set the name of the column. Defaults to the name of source + primary key of source" }, { "nullable": null, "types": [ "string", "object" ], "spread": false, "optional": true, "name": "options.otherKey", "description": "The name of the foreign key in the join table (representing the target model) or an object representing the type definition for the other column (see `Sequelize.define` for syntax). When using an object, you can add a `name` property to set the name of the column. Defaults to the name of target + primary key of target" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": true, "name": "options.scope", "description": "A key/value set that will be used for association create and find defaults on the target. (sqlite not supported for N:M)" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "sequelize.options.timestamps", "defaultRaw": "sequelize.options.timestamps", "name": "options.timestamps", "description": "Should the join model have timestamps" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "'SET NULL|CASCADE'", "defaultRaw": "'SET NULL|CASCADE'", "name": "options.onDelete", "description": "Cascade if this is a n:m, and set null if it is a 1:m" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "'CASCADE'", "defaultRaw": "'CASCADE'", "name": "options.onUpdate", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.constraints", "description": "Should on update and on delete constraints be enabled on the foreign key." } ], "return": { "nullable": null, "types": [ "BelongsToMany" ], "spread": false, "description": "" } }, { "__docId__": 999, "kind": "method", "name": "hasOne", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.hasOne", "access": null, "description": "Creates an association between this (the source) and the provided target. The foreign key is added on the target.", "examples": [ "User.hasOne(Profile) // This will add userId to the profile table" ], "lineNumber": 3988, "unknown": [ { "tagName": "@returns", "tagValue": "{HasOne}" } ], "params": [ { "nullable": null, "types": [ "Model" ], "spread": false, "optional": false, "name": "target", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.hooks", "description": "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" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "name": "options.as", "description": "The alias of this model, in singular form. See also the `name` option passed to `sequelize.define`. If you create multiple associations between the same tables, you should provide an alias to be able to distinguish between them. If you provide an alias when creating the association, you should provide the same alias when eager loading and when getting associated models. Defaults to the singularized name of target" }, { "nullable": null, "types": [ "string", "object" ], "spread": false, "optional": true, "name": "options.foreignKey", "description": "The name of the foreign key in the target table or an object representing the type definition for the foreign column (see `Sequelize.define` for syntax). When using an object, you can add a `name` property to set the name of the column. Defaults to the name of source + primary key of source" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "'SET NULL|CASCADE'", "defaultRaw": "'SET NULL|CASCADE'", "name": "options.onDelete", "description": "SET NULL if foreignKey allows nulls, CASCADE if otherwise" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "'CASCADE'", "defaultRaw": "'CASCADE'", "name": "options.onUpdate", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.constraints", "description": "Should on update and on delete constraints be enabled on the foreign key." } ], "return": { "nullable": null, "types": [ "HasOne" ], "spread": false, "description": "" } }, { "__docId__": 1000, "kind": "method", "name": "belongsTo", "memberof": "lib/model.js~Model", "generator": false, "async": false, "static": true, "longname": "lib/model.js~Model.belongsTo", "access": null, "description": "Creates an association between this (the source) and the provided target. The foreign key is added on the source.", "examples": [ "Profile.belongsTo(User) // This will add userId to the profile table" ], "lineNumber": 4007, "unknown": [ { "tagName": "@returns", "tagValue": "{BelongsTo}" } ], "params": [ { "nullable": null, "types": [ "Model" ], "spread": false, "optional": false, "name": "target", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": true, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.hooks", "description": "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" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "name": "options.as", "description": "The alias of this model, in singular form. See also the `name` option passed to `sequelize.define`. If you create multiple associations between the same tables, you should provide an alias to be able to distinguish between them. If you provide an alias when creating the association, you should provide the same alias when eager loading and when getting associated models. Defaults to the singularized name of target" }, { "nullable": null, "types": [ "string", "object" ], "spread": false, "optional": true, "name": "options.foreignKey", "description": "The name of the foreign key in the source table or an object representing the type definition for the foreign column (see `Sequelize.define` for syntax). When using an object, you can add a `name` property to set the name of the column. Defaults to the name of target + primary key of target" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "name": "options.targetKey", "description": "The name of the field to use as the key for the association in the target table. Defaults to the primary key of the target table" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "'SET NULL|NO ACTION'", "defaultRaw": "'SET NULL|NO ACTION'", "name": "options.onDelete", "description": "SET NULL if foreignKey allows nulls, NO ACTION if otherwise" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "'CASCADE'", "defaultRaw": "'CASCADE'", "name": "options.onUpdate", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.constraints", "description": "Should on update and on delete constraints be enabled on the foreign key." } ], "return": { "nullable": null, "types": [ "BelongsTo" ], "spread": false, "description": "" } }, { "__docId__": 1001, "kind": "file", "name": "lib/promise.js", "content": "", "static": true, "longname": "lib/promise.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1002, "kind": "variable", "name": "Promise", "memberof": "lib/promise.js", "static": true, "longname": "lib/promise.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/promise.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1003, "kind": "file", "name": "lib/query-interface.js", "content": "", "static": true, "longname": "lib/query-interface.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1004, "kind": "variable", "name": "Utils", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1005, "kind": "variable", "name": "_", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~_", "access": null, "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1006, "kind": "variable", "name": "DataTypes", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1007, "kind": "variable", "name": "SQLiteQueryInterface", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~SQLiteQueryInterface", "access": null, "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1008, "kind": "variable", "name": "MSSSQLQueryInterface", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~MSSSQLQueryInterface", "access": null, "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1009, "kind": "variable", "name": "MySQLQueryInterface", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~MySQLQueryInterface", "access": null, "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1010, "kind": "variable", "name": "Transaction", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~Transaction", "access": null, "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1011, "kind": "variable", "name": "Promise", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1012, "kind": "variable", "name": "QueryTypes", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~QueryTypes", "access": null, "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1013, "kind": "class", "name": "QueryInterface", "memberof": "lib/query-interface.js", "static": true, "longname": "lib/query-interface.js~QueryInterface", "access": "private", "export": false, "importPath": "sequelize/lib/query-interface.js", "importStyle": null, "description": "The interface that Sequelize uses to talk to all databases", "lineNumber": 18, "unknown": [ { "tagName": "@class", "tagValue": "QueryInterface" } ], "interface": false }, { "__docId__": 1014, "kind": "constructor", "name": "constructor", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#constructor", "access": null, "description": null, "lineNumber": 19, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sequelize", "types": [ "*" ] } ] }, { "__docId__": 1015, "kind": "member", "name": "sequelize", "memberof": "lib/query-interface.js~QueryInterface", "static": false, "longname": "lib/query-interface.js~QueryInterface#sequelize", "access": null, "description": null, "lineNumber": 20, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1016, "kind": "member", "name": "QueryGenerator", "memberof": "lib/query-interface.js~QueryInterface", "static": false, "longname": "lib/query-interface.js~QueryInterface#QueryGenerator", "access": null, "description": null, "lineNumber": 21, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1017, "kind": "method", "name": "createSchema", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#createSchema", "access": null, "description": null, "lineNumber": 24, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "schema", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1018, "kind": "method", "name": "dropSchema", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#dropSchema", "access": null, "description": null, "lineNumber": 30, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "schema", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1019, "kind": "method", "name": "dropAllSchemas", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#dropAllSchemas", "access": null, "description": null, "lineNumber": 36, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1020, "kind": "method", "name": "showAllSchemas", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#showAllSchemas", "access": null, "description": null, "lineNumber": 46, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1021, "kind": "method", "name": "databaseVersion", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#databaseVersion", "access": null, "description": null, "lineNumber": 60, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1022, "kind": "method", "name": "createTable", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#createTable", "access": null, "description": null, "lineNumber": 67, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "attributes", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] }, { "name": "model", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1023, "kind": "method", "name": "dropTable", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#dropTable", "access": null, "description": null, "lineNumber": 173, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1024, "kind": "method", "name": "dropAllTables", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#dropAllTables", "access": null, "description": null, "lineNumber": 208, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1025, "kind": "method", "name": "dropAllEnums", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#dropAllEnums", "access": null, "description": null, "lineNumber": 255, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1026, "kind": "method", "name": "pgListEnums", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#pgListEnums", "access": null, "description": null, "lineNumber": 268, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1027, "kind": "method", "name": "renameTable", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#renameTable", "access": null, "description": null, "lineNumber": 274, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "before", "types": [ "*" ] }, { "name": "after", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1028, "kind": "method", "name": "showAllTables", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#showAllTables", "access": null, "description": null, "lineNumber": 280, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1029, "kind": "method", "name": "describeTable", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#describeTable", "access": null, "description": null, "lineNumber": 290, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1030, "kind": "method", "name": "addColumn", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#addColumn", "access": null, "description": null, "lineNumber": 323, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "table", "types": [ "*" ] }, { "name": "key", "types": [ "*" ] }, { "name": "attribute", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1031, "kind": "method", "name": "removeColumn", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#removeColumn", "access": null, "description": null, "lineNumber": 333, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "attributeName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1032, "kind": "method", "name": "changeColumn", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#changeColumn", "access": null, "description": null, "lineNumber": 350, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "attributeName", "types": [ "*" ] }, { "name": "dataTypeOrOptions", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1033, "kind": "method", "name": "renameColumn", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#renameColumn", "access": null, "description": null, "lineNumber": 373, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "attrNameBefore", "types": [ "*" ] }, { "name": "attrNameAfter", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1034, "kind": "method", "name": "addIndex", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#addIndex", "access": null, "description": null, "lineNumber": 406, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "attributes", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] }, { "name": "rawTablename", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1035, "kind": "method", "name": "showIndex", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#showIndex", "access": null, "description": null, "lineNumber": 426, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1036, "kind": "method", "name": "nameIndexes", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#nameIndexes", "access": null, "description": null, "lineNumber": 431, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "indexes", "types": [ "*" ] }, { "name": "rawTablename", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1037, "kind": "method", "name": "getForeignKeysForTables", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#getForeignKeysForTables", "access": null, "description": null, "lineNumber": 435, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableNames", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1038, "kind": "method", "name": "removeIndex", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#removeIndex", "access": null, "description": null, "lineNumber": 459, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "indexNameOrAttributes", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1039, "kind": "method", "name": "insert", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#insert", "access": null, "description": null, "lineNumber": 465, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "instance", "types": [ "*" ] }, { "name": "tableName", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1040, "kind": "method", "name": "upsert", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#upsert", "access": null, "description": null, "lineNumber": 479, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "valuesByField", "types": [ "*" ] }, { "name": "updateValues", "types": [ "*" ] }, { "name": "where", "types": [ "*" ] }, { "name": "model", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1041, "kind": "method", "name": "bulkInsert", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#bulkInsert", "access": null, "description": null, "lineNumber": 536, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "records", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] }, { "name": "attributes", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1042, "kind": "method", "name": "update", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#update", "access": null, "description": null, "lineNumber": 543, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "instance", "types": [ "*" ] }, { "name": "tableName", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "identifier", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1043, "kind": "method", "name": "bulkUpdate", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#bulkUpdate", "access": null, "description": null, "lineNumber": 569, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "identifier", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] }, { "name": "attributes", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1044, "kind": "method", "name": "delete", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#delete", "access": null, "description": null, "lineNumber": 581, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "instance", "types": [ "*" ] }, { "name": "tableName", "types": [ "*" ] }, { "name": "identifier", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1045, "kind": "method", "name": "bulkDelete", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#bulkDelete", "access": null, "description": null, "lineNumber": 620, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "identifier", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] }, { "name": "model", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1046, "kind": "method", "name": "select", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#select", "access": null, "description": null, "lineNumber": 629, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "model", "types": [ "*" ] }, { "name": "tableName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1047, "kind": "method", "name": "increment", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#increment", "access": null, "description": null, "lineNumber": 640, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "instance", "types": [ "*" ] }, { "name": "tableName", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "identifier", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1048, "kind": "method", "name": "decrement", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#decrement", "access": null, "description": null, "lineNumber": 650, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "instance", "types": [ "*" ] }, { "name": "tableName", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "identifier", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1049, "kind": "method", "name": "rawSelect", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#rawSelect", "access": null, "description": null, "lineNumber": 660, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] }, { "name": "attributeSelector", "types": [ "*" ] }, { "name": "Model", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1050, "kind": "method", "name": "createTrigger", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#createTrigger", "access": null, "description": null, "lineNumber": 708, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "triggerName", "types": [ "*" ] }, { "name": "timingType", "types": [ "*" ] }, { "name": "fireOnArray", "types": [ "*" ] }, { "name": "functionName", "types": [ "*" ] }, { "name": "functionParams", "types": [ "*" ] }, { "name": "optionsArray", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1051, "kind": "method", "name": "dropTrigger", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#dropTrigger", "access": null, "description": null, "lineNumber": 718, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "triggerName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1052, "kind": "method", "name": "renameTrigger", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#renameTrigger", "access": null, "description": null, "lineNumber": 729, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName", "types": [ "*" ] }, { "name": "oldTriggerName", "types": [ "*" ] }, { "name": "newTriggerName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1053, "kind": "method", "name": "createFunction", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#createFunction", "access": null, "description": null, "lineNumber": 740, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "functionName", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] }, { "name": "returnType", "types": [ "*" ] }, { "name": "language", "types": [ "*" ] }, { "name": "body", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1054, "kind": "method", "name": "dropFunction", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#dropFunction", "access": null, "description": null, "lineNumber": 751, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "functionName", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1055, "kind": "method", "name": "renameFunction", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#renameFunction", "access": null, "description": null, "lineNumber": 762, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "oldFunctionName", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] }, { "name": "newFunctionName", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1056, "kind": "method", "name": "quoteIdentifier", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#quoteIdentifier", "access": "private", "description": "Escape an identifier (e.g. a table or attribute name). If force is true,\nthe identifier will be quoted even if the `quoteIdentifiers` option is\nfalse.", "lineNumber": 781, "params": [ { "name": "identifier", "types": [ "*" ] }, { "name": "force", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1057, "kind": "method", "name": "quoteTable", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#quoteTable", "access": null, "description": null, "lineNumber": 785, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "identifier", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1058, "kind": "method", "name": "quoteIdentifiers", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#quoteIdentifiers", "access": "private", "description": "Split an identifier into .-separated tokens and quote each part.\nIf force is true, the identifier will be quoted even if the\n`quoteIdentifiers` option is false.", "lineNumber": 795, "params": [ { "name": "identifiers", "types": [ "*" ] }, { "name": "force", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1059, "kind": "method", "name": "escape", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#escape", "access": "private", "description": "Escape a value (e.g. a string, number or date)", "lineNumber": 803, "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1060, "kind": "method", "name": "setAutocommit", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#setAutocommit", "access": null, "description": null, "lineNumber": 807, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "transaction", "types": [ "*" ] }, { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1061, "kind": "method", "name": "setIsolationLevel", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#setIsolationLevel", "access": null, "description": null, "lineNumber": 829, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "transaction", "types": [ "*" ] }, { "name": "value", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1062, "kind": "method", "name": "startTransaction", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#startTransaction", "access": null, "description": null, "lineNumber": 852, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "transaction", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1063, "kind": "method", "name": "deferConstraints", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#deferConstraints", "access": null, "description": null, "lineNumber": 866, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "transaction", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1064, "kind": "method", "name": "commitTransaction", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#commitTransaction", "access": null, "description": null, "lineNumber": 880, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "transaction", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1065, "kind": "method", "name": "rollbackTransaction", "memberof": "lib/query-interface.js~QueryInterface", "generator": false, "async": false, "static": false, "longname": "lib/query-interface.js~QueryInterface#rollbackTransaction", "access": null, "description": null, "lineNumber": 902, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "transaction", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1066, "kind": "file", "name": "lib/query-types.js", "content": "", "static": true, "longname": "lib/query-types.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1067, "kind": "variable", "name": "QueryTypes", "memberof": "lib/query-types.js", "static": true, "longname": "lib/query-types.js~QueryTypes", "access": null, "export": false, "importPath": "sequelize/lib/query-types.js", "importStyle": null, "description": "An enum of query types used by `sequelize.query`", "see": [ "{@link Sequelize#query}" ], "lineNumber": 22, "properties": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "SELECT", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "INSERT", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "UPDATE", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "BULKUPDATE", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "BULKDELETE", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "DELETE", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "UPSERT", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "VERSION", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "SHOWTABLES", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "SHOWINDEXES", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "DESCRIBE", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "RAW", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "FOREIGNKEYS", "description": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1068, "kind": "file", "name": "lib/sequelize.js", "content": "", "static": true, "longname": "lib/sequelize.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1069, "kind": "variable", "name": "url", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~url", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1070, "kind": "variable", "name": "Path", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Path", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1071, "kind": "variable", "name": "retry", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~retry", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1072, "kind": "variable", "name": "clsBluebird", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~clsBluebird", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1073, "kind": "variable", "name": "Utils", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1074, "kind": "variable", "name": "Model", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Model", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1075, "kind": "variable", "name": "DataTypes", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1076, "kind": "variable", "name": "Deferrable", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Deferrable", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1077, "kind": "variable", "name": "ModelManager", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~ModelManager", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1078, "kind": "variable", "name": "QueryInterface", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~QueryInterface", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1079, "kind": "variable", "name": "Transaction", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Transaction", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1080, "kind": "variable", "name": "QueryTypes", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~QueryTypes", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 14, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1081, "kind": "variable", "name": "sequelizeErrors", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~sequelizeErrors", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 15, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1082, "kind": "variable", "name": "Promise", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1083, "kind": "variable", "name": "Hooks", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Hooks", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1084, "kind": "variable", "name": "Association", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Association", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 18, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1085, "kind": "variable", "name": "Validator", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Validator", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 19, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1086, "kind": "variable", "name": "_", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~_", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": null, "lineNumber": 20, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1087, "kind": "class", "name": "Sequelize", "memberof": "lib/sequelize.js", "static": true, "longname": "lib/sequelize.js~Sequelize", "access": null, "export": false, "importPath": "sequelize/lib/sequelize.js", "importStyle": null, "description": "This is the main class, the entry point to sequelize. To use it, you just need to import sequelize:\n\n```js\nconst Sequelize = require('sequelize');\n```\n\nIn addition to sequelize, the connection library for the dialect you want to use should also be installed in your project. You don't need to import it however, as sequelize will take care of that.", "lineNumber": 31, "interface": false }, { "__docId__": 1088, "kind": "constructor", "name": "constructor", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#constructor", "access": null, "description": "Instantiate sequelize with name of database, username and password\n\n#### Example usage\n\n```javascript\n// without password and options\nconst sequelize = new Sequelize('database', 'username')\n\n// without options\nconst sequelize = new Sequelize('database', 'username', 'password')\n\n// without password / with blank password\nconst sequelize = new Sequelize('database', 'username', null, {})\n\n// with password and options\nconst sequelize = new Sequelize('my_database', 'john', 'doe', {})\n\n// with database, username, and password in the options object\nconst sequelize = new Sequelize({ database, username, password });\n\n// with uri\nconst sequelize = new Sequelize('mysql://localhost:3306/database', {})\n```", "lineNumber": 96, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "database", "description": "The name of the database" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "username", "description": "The username which is used to authenticate against the database." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "password", "description": "The password which is used to authenticate against the database. Supports SQLCipher encryption for SQLite." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "An object with options." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'localhost'", "defaultRaw": "'localhost'", "name": "options.host", "description": "The host of the relational database." }, { "nullable": null, "types": [ "Integer" ], "spread": false, "optional": true, "defaultValue": "", "defaultRaw": "", "name": "options.port", "description": "The port of the relational database." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "options.username", "description": "The username which is used to authenticate against the database." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "options.password", "description": "The password which is used to authenticate against the database." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "options.database", "description": "The name of the database" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'mysql'", "defaultRaw": "'mysql'", "name": "options.dialect", "description": "The dialect of the database you are connecting to. One of mysql, postgres, sqlite and mssql." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "options.dialectModulePath", "description": "If specified, load the dialect library from this path. For example, if you want to use pg.js instead of pg when connecting to a pg database, you should specify 'pg.js' here" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.dialectOptions", "description": "An object of additional options, which are passed directly to the connection library" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.storage", "description": "Only used by sqlite. Defaults to ':memory:'" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'tcp'", "defaultRaw": "'tcp'", "name": "options.protocol", "description": "The protocol of the relational database." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options.define", "description": "Default options for model definitions. See sequelize.define for options" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options.query", "description": "Default options for sequelize.query" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options.set", "description": "Default options for sequelize.set" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options.sync", "description": "Default options for sequelize.sync" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'+00:00'", "defaultRaw": "'+00:00'", "name": "options.timezone", "description": "The timezone used when converting a date from the database into a JavaScript date. The timezone is also used to SET TIMEZONE when connecting to the server, to ensure that the result of NOW, CURRENT_TIMESTAMP and other time related functions have in the right timezone. For best cross platform performance use the format +/-HH:MM. Will also accept string versions of timezones used by moment.js (e.g. 'America/Los_Angeles'); this is useful to capture daylight savings time changes." }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "console.log", "defaultRaw": "console.log", "name": "options.logging", "description": "A function that gets executed every time Sequelize would log something." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.benchmark", "description": "Pass query execution time in milliseconds as second argument to logging function (options.logging)." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.omitNull", "description": "A flag that defines if null values should be passed to SQL queries or not." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.native", "description": "A flag that defines if native library shall be used or not. Currently only has an effect for postgres" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.replication", "description": "Use read / write replication. To enable replication, pass an object, with two properties, read and write. Write should be an object (a single server for handling writes), and read an array of object (several servers to handle reads). Each read/write server can have the following properties: `host`, `port`, `username`, `password`, `database`" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options.pool", "description": "Should sequelize use a connection pool. Default is true" }, { "nullable": null, "types": [ "Integer" ], "spread": false, "optional": true, "name": "options.pool.max", "description": "Maximum number of connection in pool. Default is 5" }, { "nullable": null, "types": [ "Integer" ], "spread": false, "optional": true, "name": "options.pool.min", "description": "Minimum number of connection in pool. Default is 0" }, { "nullable": null, "types": [ "Integer" ], "spread": false, "optional": true, "name": "options.pool.idle", "description": "The maximum time, in milliseconds, that a connection can be idle before being released" }, { "nullable": null, "types": [ "Integer" ], "spread": false, "optional": true, "name": "options.pool.acquire", "description": "The maximum time, in milliseconds, that pool will try to get connection before throwing error" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "name": "options.pool.validate", "description": "A function that validates a connection. Called with client. The default function checks that client is an object, and that its state is not disconnected" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.quoteIdentifiers", "description": "Set to `false` to make table names and attributes case-insensitive on Postgres and skip double quoting of them. WARNING: Setting this to false may expose vulnerabilities and is not reccomended!" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'DEFERRED'", "defaultRaw": "'DEFERRED'", "name": "options.transactionType", "description": "Set the default transaction type. See `Sequelize.Transaction.TYPES` for possible options. Sqlite only." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.isolationLevel", "description": "Set the default transaction isolation level. See `Sequelize.Transaction.ISOLATION_LEVELS` for possible options." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.retry", "description": "Set of flags that control when a query is automatically retried." }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.retry.match", "description": "Only retry a query if the error matches one of these strings." }, { "nullable": null, "types": [ "Integer" ], "spread": false, "optional": true, "name": "options.retry.max", "description": "How many times a failing query is automatically retried. Set to 0 to disable retrying on SQL_BUSY error." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.typeValidation", "description": "Run built in type validators on insert and update, e.g. validate that arguments passed to integer fields are integer-like." } ] }, { "__docId__": 1089, "kind": "member", "name": "options", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#options", "access": null, "description": null, "lineNumber": 139, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1090, "kind": "member", "name": "config", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#config", "access": null, "description": null, "lineNumber": 187, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"database\": *, \"username\": *, \"password\": *, \"host\": *, \"port\": *, \"pool\": *, \"protocol\": *, \"native\": *, \"ssl\": *, \"replication\": *, \"dialectModulePath\": *, \"keepDefaultTimezone\": *, \"dialectOptions\": *}" ] } }, { "__docId__": 1091, "kind": "member", "name": "dialect", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#dialect", "access": null, "description": null, "lineNumber": 222, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1092, "kind": "member", "name": "models", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#models", "access": null, "description": "Models are stored here under the name given to `sequelize.define`", "lineNumber": 229, "type": { "types": [ "{}" ] } }, { "__docId__": 1093, "kind": "member", "name": "modelManager", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#modelManager", "access": null, "description": null, "lineNumber": 230, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1094, "kind": "member", "name": "connectionManager", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#connectionManager", "access": null, "description": null, "lineNumber": 231, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1095, "kind": "member", "name": "importCache", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#importCache", "access": null, "description": null, "lineNumber": 233, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{}" ] } }, { "__docId__": 1096, "kind": "member", "name": "test", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#test", "access": null, "description": null, "lineNumber": 235, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"_trackRunningQueries\": *, \"_runningQueries\": *, \"trackRunningQueries\": function, \"verifyNoRunningQueries\": function}" ] } }, { "__docId__": 1097, "kind": "member", "name": "_trackRunningQueries", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#_trackRunningQueries", "access": null, "description": null, "lineNumber": 239, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "boolean" ] } }, { "__docId__": 1098, "kind": "method", "name": "refreshTypes", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#refreshTypes", "access": null, "description": null, "lineNumber": 249, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 1099, "kind": "method", "name": "getDialect", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#getDialect", "access": null, "description": "Returns the specified dialect.", "lineNumber": 258, "params": [], "return": { "nullable": null, "types": [ "String" ], "spread": false, "description": "The specified dialect." } }, { "__docId__": 1100, "kind": "method", "name": "getQueryInterface", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#getQueryInterface", "access": null, "description": "Returns an instance of QueryInterface.", "lineNumber": 269, "unknown": [ { "tagName": "@method", "tagValue": "getQueryInterface" }, { "tagName": "@memberOf", "tagValue": "Sequelize" } ], "params": [], "return": { "nullable": null, "types": [ "QueryInterface" ], "spread": false, "description": "An instance (singleton) of QueryInterface." } }, { "__docId__": 1101, "kind": "member", "name": "queryInterface", "memberof": "lib/sequelize.js~Sequelize", "static": false, "longname": "lib/sequelize.js~Sequelize#queryInterface", "access": null, "description": null, "lineNumber": 270, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1102, "kind": "method", "name": "define", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#define", "access": null, "description": "Define a new model, representing a table in the DB.\n\nThe table columns are defined by the object that is given as the second argument. Each key of the object represents a column", "examples": [ "sequelize.define('modelName', {\n columnA: {\n type: Sequelize.BOOLEAN,\n validate: {\n is: [\"[a-z]\",'i'], // will only allow letters\n max: 23, // only allow values <= 23\n isIn: {\n args: [['en', 'zh']],\n msg: \"Must be English or Chinese\"\n }\n },\n field: 'column_a'\n // Other attributes here\n },\n columnB: Sequelize.STRING,\n columnC: 'MY VERY OWN COLUMN TYPE'\n})\n\nsequelize.models.modelName // The model will now be available in models under the name given to define" ], "see": [ "{@link Model.init} for a more comprehensive specification of the `options` and `attributes` objects.", "The manual section about defining models", "{@link DataTypes} For a list of possible data types" ], "lineNumber": 310, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "modelName", "description": "The name of the model. The model will be stored in `sequelize.models` under this name" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "attributes", "description": "An object, where each attribute is a column of the table. See {@link Model.init}" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "These options are merged with the default define options provided to the Sequelize constructor and passed to Model.init()" } ], "return": { "nullable": null, "types": [ "Model" ], "spread": false, "description": "" } }, { "__docId__": 1103, "kind": "method", "name": "model", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#model", "access": null, "description": "Fetch a Model which is already defined", "lineNumber": 331, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "modelName", "description": "The name of a model defined with Sequelize.define" } ], "return": { "nullable": null, "types": [ "Model" ], "spread": false, "description": "" }, "throws": [ { "types": [ "*" ], "description": "Will throw an error if the model is not defined (that is, if sequelize#isDefined returns false)" } ] }, { "__docId__": 1104, "kind": "method", "name": "isDefined", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#isDefined", "access": null, "description": "Checks whether a model with the given name is defined", "lineNumber": 345, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "modelName", "description": "The name of a model defined with Sequelize.define" } ], "return": { "nullable": null, "types": [ "Boolean" ], "spread": false, "description": "" } }, { "__docId__": 1105, "kind": "method", "name": "import", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#import", "access": null, "description": "Imports a model defined in another file\n\nImported models are cached, so multiple calls to import with the same path will not load the file multiple times\n\nSee https://github.com/sequelize/express-example for a short example of how to define your models in separate files so that they can be imported by sequelize.import", "lineNumber": 359, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "path", "description": "The path to the file that holds the model you want to import. If the part is relative, it will be resolved relatively to the calling file" } ], "return": { "nullable": null, "types": [ "Model" ], "spread": false, "description": "" } }, { "__docId__": 1106, "kind": "method", "name": "query", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#query", "access": null, "description": "Execute a query on the DB, with the possibility to bypass all the sequelize goodness.\n\nBy 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.\n\nIf you are running a type of query where you don't need the metadata, for example a `SELECT` query, you can pass in a query type to make sequelize format the results:\n\n```js\nsequelize.query('SELECT...').spread((results, metadata) => {\n // Raw query - use spread\n});\n\nsequelize.query('SELECT...', { type: sequelize.QueryTypes.SELECT }).then(results => {\n // SELECT query - use then\n})\n```", "see": [ "{@link Model.build} for more information about instance option." ], "lineNumber": 425, "unknown": [ { "tagName": "@method", "tagValue": "query" } ], "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "sql", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "Query options." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.raw", "description": "If true, sequelize will not try to format the results of the query, or build an instance of a model from the result" }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "options.transaction", "description": "The transaction that the query should be executed under" }, { "nullable": null, "types": [ "QueryTypes" ], "spread": false, "optional": true, "defaultValue": "'RAW'", "defaultRaw": "'RAW'", "name": "options.type", "description": "The type of query you are executing. The query type affects how results are formatted before they are passed back. The type is a string, but `Sequelize.QueryTypes` is provided as convenience shortcuts." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.nest", "description": "If true, transforms objects with `.` separated property names into nested objects using [dottie.js](https://github.com/mickhansen/dottie.js). For example { 'user.username': 'john' } becomes { user: { username: 'john' }}. When `nest` is true, the query type is assumed to be `'SELECT'`, unless otherwise specified" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.plain", "description": "Sets the query type to `SELECT` and return a single row" }, { "nullable": null, "types": [ "Object", "Array" ], "spread": false, "optional": true, "name": "options.replacements", "description": "Either an object of named parameter replacements in the format `:param` or an array of unnamed replacements to replace `?` in your SQL." }, { "nullable": null, "types": [ "Object", "Array" ], "spread": false, "optional": true, "name": "options.bind", "description": "Either an object of named bind parameter in the format `_param` or an array of unnamed bind parameter to replace `$1, $2, ...` in your SQL." }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.useMaster", "description": "Force the query to use the write pool, regardless of the query type." }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "new Model()" ], "spread": false, "optional": true, "name": "options.instance", "description": "A sequelize instance used to build the return instance" }, { "nullable": null, "types": [ "Model" ], "spread": false, "optional": true, "name": "options.model", "description": "A sequelize model used to build the returned model instances (used to be called callee)" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.retry", "description": "Set of flags that control when a query is automatically retried." }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": true, "name": "options.retry.match", "description": "Only retry a query if the error matches one of these strings." }, { "nullable": null, "types": [ "Integer" ], "spread": false, "optional": true, "name": "options.retry.max", "description": "How many times a failing query is automatically retried." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.supportsSearchPath", "description": "If false do not prepend the query with the search_path (Postgres only)" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.mapToModel", "description": "Map returned fields to model's fields if `options.model` or `options.instance` is present. Mapping will occur before building the model instance." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options.fieldMap", "description": "Map returned fields to arbitrary names for `SELECT` query type." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1107, "kind": "method", "name": "set", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#set", "access": null, "description": "Execute a query which would set an environment or user variable. The variables are set per connection, so this function needs a transaction.\nOnly works for MySQL.", "lineNumber": 549, "unknown": [ { "tagName": "@method", "tagValue": "set" } ], "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "variables", "description": "Object with multiple variables." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "Query options." }, { "nullable": null, "types": [ "Transaction" ], "spread": false, "optional": false, "name": "options.transaction", "description": "The transaction that the query should be executed under" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1108, "kind": "method", "name": "escape", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#escape", "access": null, "description": "Escape value.", "lineNumber": 580, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "value", "description": "" } ], "return": { "nullable": null, "types": [ "String" ], "spread": false, "description": "" } }, { "__docId__": 1109, "kind": "method", "name": "createSchema", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#createSchema", "access": null, "description": "Create a new database schema.\n\nNote, that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html),\nnot a database table. In mysql and sqlite, this command will do nothing.", "see": [ "{@link Model.schema}" ], "lineNumber": 596, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "schema", "description": "Name of the schema" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": false, "name": "options.logging", "description": "A function that logs sql queries, or false for no logging" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1110, "kind": "method", "name": "showAllSchemas", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#showAllSchemas", "access": null, "description": "Show all defined schemas\n\nNote, that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html),\nnot a database table. In mysql and sqlite, this will show all tables.", "lineNumber": 609, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": false, "name": "options.logging", "description": "A function that logs sql queries, or false for no logging" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1111, "kind": "method", "name": "dropSchema", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#dropSchema", "access": null, "description": "Drop a single schema\n\nNote, that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html),\nnot a database table. In mysql and sqlite, this drop a table matching the schema name", "lineNumber": 623, "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "schema", "description": "Name of the schema" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": false, "name": "options.logging", "description": "A function that logs sql queries, or false for no logging" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1112, "kind": "method", "name": "dropAllSchemas", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#dropAllSchemas", "access": null, "description": "Drop all schemas\n\nNote,that this is a schema in the [postgres sense of the word](http://www.postgresql.org/docs/9.1/static/ddl-schemas.html),\nnot a database table. In mysql and sqlite, this is the equivalent of drop all tables.", "lineNumber": 636, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": false, "name": "options.logging", "description": "A function that logs sql queries, or false for no logging" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1113, "kind": "method", "name": "sync", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#sync", "access": null, "description": "Sync all defined models to the DB.", "lineNumber": 652, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.force", "description": "If force is true, each Model will run `DROP TABLE IF EXISTS`, before it tries to create its own table" }, { "nullable": null, "types": [ "RegExp" ], "spread": false, "optional": true, "name": "options.match", "description": "Match a regex against the database name before syncing, a safety check for cases where force: true is used in tests but not live code" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": true, "defaultValue": "console.log", "defaultRaw": "console.log", "name": "options.logging", "description": "A function that logs sql queries, or false for no logging" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'public'", "defaultRaw": "'public'", "name": "options.schema", "description": "The schema that the tables should be created in. This can be overriden for each table in sequelize.define" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "DEFAULT", "defaultRaw": "DEFAULT", "name": "options.searchPath", "description": "An optional parameter to specify the schema search_path (Postgres only)" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.hooks", "description": "If hooks is true then beforeSync, afterSync, beforBulkSync, afterBulkSync hooks will be called" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1114, "kind": "method", "name": "truncate", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#truncate", "access": null, "description": "Truncate all tables defined through the sequelize models. This is done\nby calling Model.truncate() on each model.", "see": [ "{@link Model.truncate} for more information" ], "lineNumber": 704, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": true, "name": "options", "description": "The options passed to Model.destroy in addition to truncate" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": true, "name": "options.transaction", "description": "" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": true, "name": "options.logging", "description": "A function that logs sql queries, or false for no logging" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1115, "kind": "method", "name": "drop", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#drop", "access": null, "description": "Drop all tables defined through this sequelize instance. This is done by calling Model.drop on each model", "see": [ "{@link Model.drop} for options" ], "lineNumber": 730, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "options", "description": "The options passed to each call to Model.drop" }, { "nullable": null, "types": [ "Boolean", "function" ], "spread": false, "optional": false, "name": "options.logging", "description": "A function that logs sql queries, or false for no logging" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1116, "kind": "method", "name": "authenticate", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#authenticate", "access": null, "description": "Test the connection by trying to authenticate", "lineNumber": 748, "unknown": [ { "tagName": "@error", "tagValue": "'Invalid credentials' if the authentication failed (even if the database did not respond at all...)" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1117, "kind": "method", "name": "databaseVersion", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#databaseVersion", "access": null, "description": null, "lineNumber": 752, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1118, "kind": "method", "name": "fn", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.fn", "access": null, "description": "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.\nIf 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.\n\nConvert a user's username to upper case\n```js\ninstance.updateAttributes({\n username: self.sequelize.fn('upper', self.sequelize.col('username'))\n})\n```", "examples": [ "Convert a user's username to upper case\ninstance.updateAttributes({\n username: self.sequelize.fn('upper', self.sequelize.col('username'))\n})" ], "see": [ "{@link Model.findAll}", "{@link Sequelize.define}", "{@link Sequelize.col}" ], "lineNumber": 783, "since": "v2.0.0-dev3", "unknown": [ { "tagName": "@method", "tagValue": "fn" } ], "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "fn", "description": "The function you want to call" }, { "nullable": null, "types": [ "any" ], "spread": false, "optional": false, "name": "args", "description": "All further arguments will be passed as arguments to the function" } ], "return": { "nullable": null, "types": [ "Sequelize.fn" ], "spread": false, "description": "" } }, { "__docId__": 1119, "kind": "method", "name": "col", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.col", "access": null, "description": "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": [ "{@link Sequelize#fn}" ], "lineNumber": 797, "since": "v2.0.0-dev3", "unknown": [ { "tagName": "@method", "tagValue": "col" } ], "params": [ { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "col", "description": "The name of the column" } ], "return": { "nullable": null, "types": [ "Sequelize.col" ], "spread": false, "description": "" } }, { "__docId__": 1120, "kind": "method", "name": "cast", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.cast", "access": null, "description": "Creates a object representing a call to the cast function.", "lineNumber": 811, "since": "v2.0.0-dev3", "unknown": [ { "tagName": "@method", "tagValue": "cast" } ], "params": [ { "nullable": null, "types": [ "any" ], "spread": false, "optional": false, "name": "val", "description": "The value to cast" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "type", "description": "The type to cast it to" } ], "return": { "nullable": null, "types": [ "Sequelize.cast" ], "spread": false, "description": "" } }, { "__docId__": 1121, "kind": "method", "name": "literal", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.literal", "access": null, "description": "Creates a object representing a literal, i.e. something that will not be escaped.", "lineNumber": 825, "since": "v2.0.0-dev3", "unknown": [ { "tagName": "@method", "tagValue": "literal" }, { "tagName": "@alias", "tagValue": "asIs" } ], "params": [ { "nullable": null, "types": [ "any" ], "spread": false, "optional": false, "name": "val", "description": "" } ], "return": { "nullable": null, "types": [ "Sequelize.literal" ], "spread": false, "description": "" } }, { "__docId__": 1122, "kind": "method", "name": "and", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.and", "access": null, "description": "An AND query", "see": [ "{@link Model.findAll}" ], "lineNumber": 839, "since": "v2.0.0-dev3", "unknown": [ { "tagName": "@method", "tagValue": "and" } ], "params": [ { "nullable": null, "types": [ "String", "Object" ], "spread": false, "optional": false, "name": "args", "description": "Each argument will be joined by AND" } ], "return": { "nullable": null, "types": [ "Sequelize.and" ], "spread": false, "description": "" } }, { "__docId__": 1123, "kind": "method", "name": "or", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.or", "access": null, "description": "An OR query", "see": [ "{@link Model.findAll}" ], "lineNumber": 853, "since": "v2.0.0-dev3", "unknown": [ { "tagName": "@method", "tagValue": "or" } ], "params": [ { "nullable": null, "types": [ "String", "Object" ], "spread": false, "optional": false, "name": "args", "description": "Each argument will be joined by OR" } ], "return": { "nullable": null, "types": [ "Sequelize.or" ], "spread": false, "description": "" } }, { "__docId__": 1124, "kind": "method", "name": "json", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.json", "access": null, "description": "Creates an object representing nested where conditions for postgres's json data-type.", "see": [ "{@link Model.findAll}" ], "lineNumber": 867, "unknown": [ { "tagName": "@method", "tagValue": "json" } ], "params": [ { "nullable": null, "types": [ "String", "Object" ], "spread": false, "optional": false, "name": "conditions", "description": "A hash containing strings/numbers or other nested hash, a string using dot notation or a string using postgres json syntax." }, { "nullable": null, "types": [ "String", "Number", "Boolean" ], "spread": false, "optional": true, "name": "value", "description": "An optional value to compare against. Produces a string of the form \" = ''\"." } ], "return": { "nullable": null, "types": [ "Sequelize.json" ], "spread": false, "description": "" } }, { "__docId__": 1125, "kind": "method", "name": "where", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.where", "access": null, "description": "A way of specifying attr = condition.\n\nThe attr can either be an object taken from `Model.rawAttributes` (for example `Model.rawAttributes.id` or `Model.rawAttributes.name`). The\nattribute should be defined in your model definition. The attribute can also be an object from one of the sequelize utility functions (`sequelize.fn`, `sequelize.col` etc.)\n\nFor string attributes, use the regular `{ where: { attr: something }}` syntax. If you don't want your string to be escaped, use `sequelize.literal`.", "see": [ "{@link Model.findAll}" ], "lineNumber": 887, "since": "v2.0.0-dev3", "unknown": [ { "tagName": "@alias", "tagValue": "condition" } ], "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "attr", "description": "The attribute, which can be either an attribute object from `Model.rawAttributes` or a sequelize object, for example an instance of `sequelize.fn`. For simple string attributes, use the POJO syntax" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "name": "comparator", "description": "" }, { "nullable": null, "types": [ "String", "Object" ], "spread": false, "optional": false, "name": "logic", "description": "The condition. Can be both a simply type, or a further condition (`$or`, `$and`, `.literal` etc.)" } ], "return": { "types": [ "*" ] } }, { "__docId__": 1126, "kind": "method", "name": "transaction", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#transaction", "access": null, "description": "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\n\n```js\nsequelize.transaction().then(transaction => {\n return User.find(..., {transaction})\n .then(user => user.updateAttributes(..., {transaction}))\n .then(() => transaction.commit())\n .catch(() => transaction.rollback());\n})\n```\n\nA syntax for automatically committing or rolling back based on the promise chain resolution is also supported:\n\n```js\nsequelize.transaction(transaction => { // Note that we use a callback rather than a promise.then()\n return User.find(..., {transaction})\n .then(user => user.updateAttributes(..., {transaction}))\n}).then(() => {\n // Committed\n}).catch(err => {\n // Rolled back\n console.error(err);\n});\n```\n\nIf you have [CLS](https://github.com/othiym23/node-continuation-local-storage) enabled, the transaction will automatically be passed to any query that runs within the callback.\nTo enable CLS, add it do your project, create a namespace and set it on the sequelize constructor:\n\n```js\nconst cls = require('continuation-local-storage');\nconst ns = cls.createNamespace('....');\nconst Sequelize = require('sequelize');\nSequelize.useCLS(ns);\n```\nNote, that CLS is enabled for all sequelize instances, and all instances will share the same namespace", "see": [ "{@link Transaction}" ], "lineNumber": 937, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": true, "name": "options.autocommit", "description": "" }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "defaultValue": "'DEFERRED'", "defaultRaw": "'DEFERRED'", "name": "options.type", "description": "See `Sequelize.Transaction.TYPES` for possible options. Sqlite only." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": true, "name": "options.isolationLevel", "description": "See `Sequelize.Transaction.ISOLATION_LEVELS` for possible options" }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.logging", "description": "A function that gets executed while running the query to log the sql." }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": true, "name": "autoCallback", "description": "The callback is called with the transaction object, and should return a promise. If the promise is resolved, the transaction commits; if the promise rejects, the transaction rolls back" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1127, "kind": "method", "name": "useCLS", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.useCLS", "access": null, "description": "Use CLS with Sequelize.\nCLS namespace provided is stored as `Sequelize._cls`\nand bluebird Promise is patched to use the namespace, using `cls-bluebird` module.", "lineNumber": 971, "unknown": [ { "tagName": "@returns", "tagValue": "{Object} Sequelize constructor" } ], "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "ns", "description": "CLS namespace" } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "Sequelize constructor" } }, { "__docId__": 1128, "kind": "member", "name": "_cls", "memberof": "lib/sequelize.js~Sequelize", "static": true, "longname": "lib/sequelize.js~Sequelize._cls", "access": null, "description": null, "lineNumber": 976, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1129, "kind": "method", "name": "_clsRun", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize._clsRun", "access": "private", "description": "Run function in CLS context.\nIf no CLS context in use, just runs the function normally", "lineNumber": 993, "unknown": [ { "tagName": "@returns", "tagValue": "{*} Return value of function" } ], "params": [ { "nullable": null, "types": [ "Function" ], "spread": false, "optional": false, "name": "fn", "description": "Function to run" } ], "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "Return value of function" } }, { "__docId__": 1130, "kind": "get", "name": "cls", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.cls", "access": null, "description": null, "lineNumber": 1007, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1131, "kind": "set", "name": "cls", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": true, "longname": "lib/sequelize.js~Sequelize.cls", "access": null, "description": null, "lineNumber": 1012, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1132, "kind": "method", "name": "log", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#log", "access": null, "description": null, "lineNumber": 1017, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 1133, "kind": "method", "name": "close", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#close", "access": null, "description": "Close all connections used by this sequelize instance, and free all references so the instance can be garbage collected.\n\nNormally this is done on process exit, so you only need to call this method if you are creating multiple instances, and want\nto garbage collect some of them.", "lineNumber": 1052, "params": [] }, { "__docId__": 1134, "kind": "method", "name": "normalizeDataType", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#normalizeDataType", "access": null, "description": null, "lineNumber": 1056, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "Type", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1135, "kind": "method", "name": "normalizeAttribute", "memberof": "lib/sequelize.js~Sequelize", "generator": false, "async": false, "static": false, "longname": "lib/sequelize.js~Sequelize#normalizeAttribute", "access": null, "description": null, "lineNumber": 1069, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "attribute", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1136, "kind": "file", "name": "lib/sql-string.js", "content": "", "static": true, "longname": "lib/sql-string.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1137, "kind": "variable", "name": "dataTypes", "memberof": "lib/sql-string.js", "static": true, "longname": "lib/sql-string.js~dataTypes", "access": null, "export": false, "importPath": "sequelize/lib/sql-string.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1138, "kind": "variable", "name": "_", "memberof": "lib/sql-string.js", "static": true, "longname": "lib/sql-string.js~_", "access": null, "export": false, "importPath": "sequelize/lib/sql-string.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1139, "kind": "function", "name": "escape", "memberof": "lib/sql-string.js", "generator": false, "async": false, "static": true, "longname": "lib/sql-string.js~escape", "access": null, "export": false, "importPath": "sequelize/lib/sql-string.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "val", "types": [ "*" ] }, { "name": "timeZone", "types": [ "*" ] }, { "name": "dialect", "types": [ "*" ] }, { "name": "format", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1140, "kind": "function", "name": "format", "memberof": "lib/sql-string.js", "generator": false, "async": false, "static": true, "longname": "lib/sql-string.js~format", "access": null, "export": false, "importPath": "sequelize/lib/sql-string.js", "importStyle": null, "description": null, "lineNumber": 75, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "timeZone", "types": [ "*" ] }, { "name": "dialect", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1141, "kind": "function", "name": "formatNamedParameters", "memberof": "lib/sql-string.js", "generator": false, "async": false, "static": true, "longname": "lib/sql-string.js~formatNamedParameters", "access": null, "export": false, "importPath": "sequelize/lib/sql-string.js", "importStyle": null, "description": null, "lineNumber": 91, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "values", "types": [ "*" ] }, { "name": "timeZone", "types": [ "*" ] }, { "name": "dialect", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1142, "kind": "file", "name": "lib/transaction.js", "content": "", "static": true, "longname": "lib/transaction.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1143, "kind": "variable", "name": "Utils", "memberof": "lib/transaction.js", "static": true, "longname": "lib/transaction.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/transaction.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1144, "kind": "class", "name": "Transaction", "memberof": "lib/transaction.js", "static": true, "longname": "lib/transaction.js~Transaction", "access": null, "export": false, "importPath": "sequelize/lib/transaction.js", "importStyle": null, "description": "The transaction object is used to identify a running transaction. It is created by calling `Sequelize.transaction()`.\n\nTo run a query under a transaction, you should pass the transaction in the options object..", "see": [ "{@link Sequelize.transaction}" ], "lineNumber": 12, "interface": false }, { "__docId__": 1145, "kind": "constructor", "name": "constructor", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#constructor", "access": null, "description": "", "lineNumber": 21, "params": [ { "nullable": null, "types": [ "Sequelize" ], "spread": false, "optional": false, "name": "sequelize", "description": "A configured sequelize Instance" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "An object with options" }, { "nullable": null, "types": [ "Boolean" ], "spread": false, "optional": false, "name": "options.autocommit", "description": "Sets the autocommit property of the transaction." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "defaultValue": "true", "defaultRaw": true, "name": "options.type", "description": "Sets the type of the transaction." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "defaultValue": "true", "defaultRaw": true, "name": "options.isolationLevel", "description": "Sets the isolation level of the transaction." }, { "nullable": null, "types": [ "String" ], "spread": false, "optional": false, "name": "options.deferrable", "description": "Sets the constraints to be deferred or immediately checked." } ] }, { "__docId__": 1146, "kind": "member", "name": "sequelize", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#sequelize", "access": null, "description": null, "lineNumber": 22, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1147, "kind": "member", "name": "savepoints", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#savepoints", "access": null, "description": null, "lineNumber": 23, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*[]" ] } }, { "__docId__": 1148, "kind": "member", "name": "options", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#options", "access": null, "description": null, "lineNumber": 29, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1149, "kind": "member", "name": "parent", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#parent", "access": null, "description": null, "lineNumber": 35, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1150, "kind": "member", "name": "id", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#id", "access": null, "description": null, "lineNumber": 36, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1151, "kind": "member", "name": "id", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#id", "access": null, "description": null, "lineNumber": 39, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1152, "kind": "member", "name": "name", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#name", "access": null, "description": null, "lineNumber": 41, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1153, "kind": "member", "name": "id", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#id", "access": null, "description": null, "lineNumber": 43, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1154, "kind": "method", "name": "commit", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#commit", "access": null, "description": "Commit the transaction", "lineNumber": 54, "params": [], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1155, "kind": "member", "name": "finished", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#finished", "access": null, "description": null, "lineNumber": 67, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 1156, "kind": "method", "name": "rollback", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#rollback", "access": null, "description": "Rollback (abort) the transaction", "lineNumber": 80, "params": [], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1157, "kind": "method", "name": "prepareEnvironment", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#prepareEnvironment", "access": null, "description": null, "lineNumber": 100, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 1158, "kind": "member", "name": "connection", "memberof": "lib/transaction.js~Transaction", "static": false, "longname": "lib/transaction.js~Transaction#connection", "access": null, "description": null, "lineNumber": 104, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1159, "kind": "method", "name": "begin", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#begin", "access": null, "description": null, "lineNumber": 122, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 1160, "kind": "method", "name": "setDeferrable", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#setDeferrable", "access": null, "description": null, "lineNumber": 129, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 1161, "kind": "method", "name": "setAutocommit", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#setAutocommit", "access": null, "description": null, "lineNumber": 138, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 1162, "kind": "method", "name": "setIsolationLevel", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#setIsolationLevel", "access": null, "description": null, "lineNumber": 145, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 1163, "kind": "method", "name": "cleanup", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#cleanup", "access": null, "description": null, "lineNumber": 152, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 1164, "kind": "method", "name": "_clearCls", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#_clearCls", "access": null, "description": null, "lineNumber": 158, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 1165, "kind": "get", "name": "TYPES", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": true, "longname": "lib/transaction.js~Transaction.TYPES", "access": null, "description": "Types can be set per-transaction by passing `options.type` to `sequelize.transaction`.\nDefault to `DEFERRED` but you can override the default type by passing `options.transactionType` in `new Sequelize`.\nSqlite only.\n\nPass in the desired level as the first argument:\n\n```js\nreturn sequelize.transaction({type: Sequelize.Transaction.TYPES.EXCLUSIVE}, transaction => {\n\n // your transactions\n\n}).then(result => {\n // transaction has been committed. Do something after the commit if required.\n}).catch(err => {\n // do something with the err.\n});\n```", "lineNumber": 190, "properties": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "DEFERRED", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "IMMEDIATE", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "EXCLUSIVE", "description": "" } ], "type": { "types": [ "{\"DEFERRED\": string, \"IMMEDIATE\": string, \"EXCLUSIVE\": string}" ] } }, { "__docId__": 1166, "kind": "get", "name": "ISOLATION_LEVELS", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": true, "longname": "lib/transaction.js~Transaction.ISOLATION_LEVELS", "access": null, "description": "Isolations levels can be set per-transaction by passing `options.isolationLevel` to `sequelize.transaction`.\nDefault to `REPEATABLE_READ` but you can override the default isolation level by passing `options.isolationLevel` in `new Sequelize`.\n\nPass in the desired level as the first argument:\n\n```js\nreturn sequelize.transaction({isolationLevel: Sequelize.Transaction.ISOLATION_LEVELS.SERIALIZABLE}, transaction => {\n\n // your transactions\n\n}).then(result => {\n // transaction has been committed. Do something after the commit if required.\n}).catch(err => {\n // do something with the err.\n});\n```", "lineNumber": 220, "properties": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "READ_UNCOMMITTED", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "READ_COMMITTED", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "REPEATABLE_READ", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "SERIALIZABLE", "description": "" } ], "type": { "types": [ "{\"READ_UNCOMMITTED\": string, \"READ_COMMITTED\": string, \"REPEATABLE_READ\": string, \"SERIALIZABLE\": string}" ] } }, { "__docId__": 1167, "kind": "get", "name": "LOCK", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": true, "longname": "lib/transaction.js~Transaction.LOCK", "access": null, "description": "Possible options for row locking. Used in conjunction with `find` calls:\n\n```js\nt1 // is a transaction\nModel.findAll({\n where: ...,\n transaction: t1,\n lock: t1.LOCK...\n});\n```\n\nPostgres also supports specific locks while eager loading by using OF:\n```js\nUserModel.findAll({\n where: ...,\n include: [TaskModel, ...],\n transaction: t1,\n lock: {\n level: t1.LOCK...,\n of: UserModel\n }\n});\n```\nUserModel will be locked but TaskModel won't!", "lineNumber": 262, "properties": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "UPDATE", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "SHARE", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "KEY_SHARE", "description": "Postgres 9.3+ only" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "NO_KEY_UPDATE", "description": "Postgres 9.3+ only" } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "" }, "type": { "types": [ "{\"UPDATE\": string, \"SHARE\": string, \"KEY_SHARE\": string, \"NO_KEY_UPDATE\": string}" ] } }, { "__docId__": 1168, "kind": "get", "name": "LOCK", "memberof": "lib/transaction.js~Transaction", "generator": false, "async": false, "static": false, "longname": "lib/transaction.js~Transaction#LOCK", "access": null, "description": "", "see": [ "{@link Transaction.LOCK}" ], "lineNumber": 274, "type": { "types": [ "*" ] } }, { "__docId__": 1169, "kind": "file", "name": "lib/utils/inherits.js", "content": "", "static": true, "longname": "lib/utils/inherits.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1170, "kind": "variable", "name": "util", "memberof": "lib/utils/inherits.js", "static": true, "longname": "lib/utils/inherits.js~util", "access": null, "export": false, "importPath": "sequelize/lib/utils/inherits.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1171, "kind": "variable", "name": "_", "memberof": "lib/utils/inherits.js", "static": true, "longname": "lib/utils/inherits.js~_", "access": null, "export": false, "importPath": "sequelize/lib/utils/inherits.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1172, "kind": "function", "name": "inherits", "memberof": "lib/utils/inherits.js", "generator": false, "async": false, "static": true, "longname": "lib/utils/inherits.js~inherits", "access": "private", "export": false, "importPath": "sequelize/lib/utils/inherits.js", "importStyle": null, "description": "like util.inherits, but also copies over static properties", "lineNumber": 10, "params": [ { "name": "constructor", "types": [ "*" ] }, { "name": "superConstructor", "types": [ "*" ] } ] }, { "__docId__": 1173, "kind": "file", "name": "lib/utils/logger.js", "content": "", "static": true, "longname": "lib/utils/logger.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1174, "kind": "variable", "name": "depd", "memberof": "lib/utils/logger.js", "static": true, "longname": "lib/utils/logger.js~depd", "access": "private", "export": false, "importPath": "sequelize/lib/utils/logger.js", "importStyle": null, "description": "Sequelize module for debug and deprecation messages.\nIt require a `context` for which messages will be printed.", "lineNumber": 12, "unknown": [ { "tagName": "@module", "tagValue": "logging" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1175, "kind": "class", "name": "Logger", "memberof": "lib/utils/logger.js", "static": true, "longname": "lib/utils/logger.js~Logger", "access": null, "export": false, "importPath": "sequelize/lib/utils/logger.js", "importStyle": null, "description": null, "lineNumber": 16, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false }, { "__docId__": 1176, "kind": "constructor", "name": "constructor", "memberof": "lib/utils/logger.js~Logger", "generator": false, "async": false, "static": false, "longname": "lib/utils/logger.js~Logger#constructor", "access": null, "description": null, "lineNumber": 17, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "config", "types": [ "*" ] } ] }, { "__docId__": 1177, "kind": "member", "name": "config", "memberof": "lib/utils/logger.js~Logger", "static": false, "longname": "lib/utils/logger.js~Logger#config", "access": null, "description": null, "lineNumber": 19, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1178, "kind": "member", "name": "depd", "memberof": "lib/utils/logger.js~Logger", "static": false, "longname": "lib/utils/logger.js~Logger#depd", "access": null, "description": null, "lineNumber": 24, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1179, "kind": "member", "name": "debug", "memberof": "lib/utils/logger.js~Logger", "static": false, "longname": "lib/utils/logger.js~Logger#debug", "access": null, "description": null, "lineNumber": 25, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1180, "kind": "method", "name": "deprecate", "memberof": "lib/utils/logger.js~Logger", "generator": false, "async": false, "static": false, "longname": "lib/utils/logger.js~Logger#deprecate", "access": null, "description": null, "lineNumber": 28, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] } ] }, { "__docId__": 1181, "kind": "method", "name": "debug", "memberof": "lib/utils/logger.js~Logger", "generator": false, "async": false, "static": false, "longname": "lib/utils/logger.js~Logger#debug", "access": null, "description": null, "lineNumber": 32, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] } ] }, { "__docId__": 1182, "kind": "method", "name": "warn", "memberof": "lib/utils/logger.js~Logger", "generator": false, "async": false, "static": false, "longname": "lib/utils/logger.js~Logger#warn", "access": null, "description": null, "lineNumber": 36, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "message", "types": [ "*" ] } ] }, { "__docId__": 1183, "kind": "method", "name": "debugContext", "memberof": "lib/utils/logger.js~Logger", "generator": false, "async": false, "static": false, "longname": "lib/utils/logger.js~Logger#debugContext", "access": null, "description": null, "lineNumber": 40, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "childContext", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1184, "kind": "file", "name": "lib/utils/parameter-validator.js", "content": "", "static": true, "longname": "lib/utils/parameter-validator.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1185, "kind": "variable", "name": "_", "memberof": "lib/utils/parameter-validator.js", "static": true, "longname": "lib/utils/parameter-validator.js~_", "access": null, "export": false, "importPath": "sequelize/lib/utils/parameter-validator.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1186, "kind": "variable", "name": "util", "memberof": "lib/utils/parameter-validator.js", "static": true, "longname": "lib/utils/parameter-validator.js~util", "access": null, "export": false, "importPath": "sequelize/lib/utils/parameter-validator.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1187, "kind": "variable", "name": "Utils", "memberof": "lib/utils/parameter-validator.js", "static": true, "longname": "lib/utils/parameter-validator.js~Utils", "access": null, "export": false, "importPath": "sequelize/lib/utils/parameter-validator.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1188, "kind": "function", "name": "validateDeprecation", "memberof": "lib/utils/parameter-validator.js", "generator": false, "async": false, "static": true, "longname": "lib/utils/parameter-validator.js~validateDeprecation", "access": null, "export": false, "importPath": "sequelize/lib/utils/parameter-validator.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "expectation", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1189, "kind": "function", "name": "validate", "memberof": "lib/utils/parameter-validator.js", "generator": false, "async": false, "static": true, "longname": "lib/utils/parameter-validator.js~validate", "access": null, "export": false, "importPath": "sequelize/lib/utils/parameter-validator.js", "importStyle": null, "description": null, "lineNumber": 22, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "expectation", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 1190, "kind": "function", "name": "check", "memberof": "lib/utils/parameter-validator.js", "generator": false, "async": false, "static": true, "longname": "lib/utils/parameter-validator.js~check", "access": null, "export": false, "importPath": "sequelize/lib/utils/parameter-validator.js", "importStyle": null, "description": null, "lineNumber": 32, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] }, { "name": "expectation", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1191, "kind": "file", "name": "lib/utils/validator-extras.js", "content": "", "static": true, "longname": "lib/utils/validator-extras.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1192, "kind": "variable", "name": "_", "memberof": "lib/utils/validator-extras.js", "static": true, "longname": "lib/utils/validator-extras.js~_", "access": null, "export": false, "importPath": "sequelize/lib/utils/validator-extras.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1193, "kind": "variable", "name": "validator", "memberof": "lib/utils/validator-extras.js", "static": true, "longname": "lib/utils/validator-extras.js~validator", "access": null, "export": false, "importPath": "sequelize/lib/utils/validator-extras.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1194, "kind": "variable", "name": "extensions", "memberof": "lib/utils/validator-extras.js", "static": true, "longname": "lib/utils/validator-extras.js~extensions", "access": null, "export": false, "importPath": "sequelize/lib/utils/validator-extras.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "{\"extend\": function, \"notEmpty\": function, \"len\": function, \"isUrl\": function, \"isIPv6\": function, \"isIPv4\": function, \"notIn\": function, \"regex\": function, \"notRegex\": function, \"isDecimal\": function, \"min\": function, \"max\": function, \"not\": function, \"contains\": function, \"notContains\": function, \"is\": function}" ] } }, { "__docId__": 1195, "kind": "function", "name": "extendModelValidations", "memberof": "lib/utils/validator-extras.js", "generator": false, "async": false, "static": true, "longname": "lib/utils/validator-extras.js~extendModelValidations", "access": null, "export": false, "importPath": "sequelize/lib/utils/validator-extras.js", "importStyle": null, "description": null, "lineNumber": 66, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "modelInstance", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1196, "kind": "function", "name": "notNull", "memberof": "lib/utils/validator-extras.js", "generator": false, "async": false, "static": true, "longname": "lib/utils/validator-extras.js~notNull", "access": null, "export": false, "importPath": "sequelize/lib/utils/validator-extras.js", "importStyle": null, "description": null, "lineNumber": 80, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [] }, { "__docId__": 1197, "kind": "file", "name": "lib/utils.js", "content": "", "static": true, "longname": "lib/utils.js", "access": null, "description": null, "lineNumber": 1 }, { "__docId__": 1198, "kind": "variable", "name": "DataTypes", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~DataTypes", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1199, "kind": "variable", "name": "SqlString", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~SqlString", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 4, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1200, "kind": "variable", "name": "_", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~_", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 5, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1201, "kind": "variable", "name": "parameterValidator", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~parameterValidator", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1202, "kind": "variable", "name": "Logger", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~Logger", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 7, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1203, "kind": "variable", "name": "uuid", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~uuid", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 8, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1204, "kind": "variable", "name": "Promise", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~Promise", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1205, "kind": "variable", "name": "primitives", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~primitives", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 10, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string[]" ] } }, { "__docId__": 1206, "kind": "variable", "name": "inflection", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~inflection", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 12, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1207, "kind": "variable", "name": "logger", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~logger", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 13, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "Logger" ] } }, { "__docId__": 1208, "kind": "function", "name": "useInflection", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~useInflection", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 22, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "_inflection", "types": [ "*" ] } ] }, { "__docId__": 1209, "kind": "function", "name": "camelizeIf", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~camelizeIf", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 27, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "str", "types": [ "*" ] }, { "name": "condition", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1210, "kind": "function", "name": "underscoredIf", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~underscoredIf", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 38, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "str", "types": [ "*" ] }, { "name": "condition", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1211, "kind": "function", "name": "isPrimitive", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~isPrimitive", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 49, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "val", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1212, "kind": "function", "name": "mergeDefaults", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~mergeDefaults", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 55, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "a", "types": [ "*" ] }, { "name": "b", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1213, "kind": "function", "name": "merge", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~merge", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 68, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 1214, "kind": "function", "name": "lowercaseFirst", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~lowercaseFirst", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 91, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "s", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1215, "kind": "function", "name": "uppercaseFirst", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~uppercaseFirst", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 96, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "s", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1216, "kind": "function", "name": "spliceStr", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~spliceStr", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 101, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "str", "types": [ "*" ] }, { "name": "index", "types": [ "*" ] }, { "name": "count", "types": [ "*" ] }, { "name": "add", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1217, "kind": "function", "name": "camelize", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~camelize", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 106, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "str", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1218, "kind": "function", "name": "underscore", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~underscore", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 111, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "str", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1219, "kind": "function", "name": "format", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~format", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 116, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "arr", "types": [ "*" ] }, { "name": "dialect", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1220, "kind": "function", "name": "formatNamedParameters", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~formatNamedParameters", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 123, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "sql", "types": [ "*" ] }, { "name": "parameters", "types": [ "*" ] }, { "name": "dialect", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1221, "kind": "function", "name": "cloneDeep", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~cloneDeep", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 129, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "obj", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1222, "kind": "function", "name": "mapFinderOptions", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~mapFinderOptions", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 151, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] }, { "name": "Model", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1223, "kind": "function", "name": "mapOptionFieldNames", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~mapOptionFieldNames", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 169, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "options", "types": [ "*" ] }, { "name": "Model", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1224, "kind": "function", "name": "mapWhereFieldNames", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~mapWhereFieldNames", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 223, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "attributes", "types": [ "*" ] }, { "name": "Model", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1225, "kind": "function", "name": "mapValueFieldNames", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~mapValueFieldNames", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 262, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dataValues", "types": [ "*" ] }, { "name": "fields", "types": [ "*" ] }, { "name": "Model", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1226, "kind": "function", "name": "isColString", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~isColString", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 280, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1227, "kind": "function", "name": "argsArePrimaryKeys", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~argsArePrimaryKeys", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 285, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "args", "types": [ "*" ] }, { "name": "primaryKeys", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1228, "kind": "function", "name": "canTreatArrayAsAnd", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~canTreatArrayAsAnd", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 302, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "arr", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1229, "kind": "function", "name": "combineTableNames", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~combineTableNames", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 313, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "tableName1", "types": [ "*" ] }, { "name": "tableName2", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1230, "kind": "function", "name": "singularize", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~singularize", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 318, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "str", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1231, "kind": "function", "name": "pluralize", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~pluralize", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 323, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "str", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1232, "kind": "function", "name": "removeCommentsFromFunctionString", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~removeCommentsFromFunctionString", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 328, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "s", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1233, "kind": "function", "name": "toDefaultValue", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~toDefaultValue", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 336, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1234, "kind": "function", "name": "defaultValueSchemable", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~defaultValueSchemable", "access": "private", "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": "Determine if the default value provided exists and can be described\nin a db schema using the DEFAULT directive.", "lineNumber": 366, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "value", "description": "Any default value." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "yes / no." } }, { "__docId__": 1235, "kind": "function", "name": "removeNullValuesFromHash", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~removeNullValuesFromHash", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 383, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "hash", "types": [ "*" ] }, { "name": "omitNull", "types": [ "*" ] }, { "name": "options", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1236, "kind": "function", "name": "stack", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~stack", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 405, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 1237, "kind": "function", "name": "sliceArgs", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~sliceArgs", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 416, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "args", "types": [ "*" ] }, { "name": "begin", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1238, "kind": "function", "name": "now", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~now", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 426, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "dialect", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1239, "kind": "variable", "name": "TICK_CHAR", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~TICK_CHAR", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 438, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "string" ] } }, { "__docId__": 1240, "kind": "function", "name": "addTicks", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~addTicks", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 441, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "s", "types": [ "*" ] }, { "name": "tickChar", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1241, "kind": "function", "name": "removeTicks", "memberof": "lib/utils.js", "generator": false, "async": false, "static": true, "longname": "lib/utils.js~removeTicks", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 447, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "s", "types": [ "*" ] }, { "name": "tickChar", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1242, "kind": "class", "name": "SequelizeMethod", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~SequelizeMethod", "access": "private", "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": "Utility functions for representing SQL functions, and columns that should be escaped.\nPlease do not use these functions directly, use Sequelize.fn and Sequelize.col instead.", "lineNumber": 458, "interface": false }, { "__docId__": 1243, "kind": "class", "name": "Fn", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~Fn", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 461, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "SequelizeMethod" ] }, { "__docId__": 1244, "kind": "constructor", "name": "constructor", "memberof": "lib/utils.js~Fn", "generator": false, "async": false, "static": false, "longname": "lib/utils.js~Fn#constructor", "access": null, "description": null, "lineNumber": 462, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "fn", "types": [ "*" ] }, { "name": "args", "types": [ "*" ] } ] }, { "__docId__": 1245, "kind": "member", "name": "fn", "memberof": "lib/utils.js~Fn", "static": false, "longname": "lib/utils.js~Fn#fn", "access": null, "description": null, "lineNumber": 464, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1246, "kind": "member", "name": "args", "memberof": "lib/utils.js~Fn", "static": false, "longname": "lib/utils.js~Fn#args", "access": null, "description": null, "lineNumber": 465, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1247, "kind": "method", "name": "clone", "memberof": "lib/utils.js~Fn", "generator": false, "async": false, "static": false, "longname": "lib/utils.js~Fn#clone", "access": null, "description": null, "lineNumber": 467, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 1248, "kind": "class", "name": "Col", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~Col", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 473, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "SequelizeMethod" ] }, { "__docId__": 1249, "kind": "constructor", "name": "constructor", "memberof": "lib/utils.js~Col", "generator": false, "async": false, "static": false, "longname": "lib/utils.js~Col#constructor", "access": null, "description": null, "lineNumber": 474, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "col", "types": [ "*" ] } ] }, { "__docId__": 1250, "kind": "member", "name": "col", "memberof": "lib/utils.js~Col", "static": false, "longname": "lib/utils.js~Col#col", "access": null, "description": null, "lineNumber": 479, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1251, "kind": "class", "name": "Cast", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~Cast", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 484, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "SequelizeMethod" ] }, { "__docId__": 1252, "kind": "constructor", "name": "constructor", "memberof": "lib/utils.js~Cast", "generator": false, "async": false, "static": false, "longname": "lib/utils.js~Cast#constructor", "access": null, "description": null, "lineNumber": 485, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "val", "types": [ "*" ] }, { "name": "type", "types": [ "*" ] } ] }, { "__docId__": 1253, "kind": "member", "name": "val", "memberof": "lib/utils.js~Cast", "static": false, "longname": "lib/utils.js~Cast#val", "access": null, "description": null, "lineNumber": 487, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1254, "kind": "member", "name": "type", "memberof": "lib/utils.js~Cast", "static": false, "longname": "lib/utils.js~Cast#type", "access": null, "description": null, "lineNumber": 488, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1255, "kind": "class", "name": "Literal", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~Literal", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 493, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "SequelizeMethod" ] }, { "__docId__": 1256, "kind": "constructor", "name": "constructor", "memberof": "lib/utils.js~Literal", "generator": false, "async": false, "static": false, "longname": "lib/utils.js~Literal#constructor", "access": null, "description": null, "lineNumber": 494, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "val", "types": [ "*" ] } ] }, { "__docId__": 1257, "kind": "member", "name": "val", "memberof": "lib/utils.js~Literal", "static": false, "longname": "lib/utils.js~Literal#val", "access": null, "description": null, "lineNumber": 496, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1258, "kind": "class", "name": "Json", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~Json", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 501, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "SequelizeMethod" ] }, { "__docId__": 1259, "kind": "constructor", "name": "constructor", "memberof": "lib/utils.js~Json", "generator": false, "async": false, "static": false, "longname": "lib/utils.js~Json#constructor", "access": null, "description": null, "lineNumber": 502, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "conditionsOrPath", "types": [ "*" ] }, { "name": "value", "types": [ "*" ] } ] }, { "__docId__": 1260, "kind": "member", "name": "conditions", "memberof": "lib/utils.js~Json", "static": false, "longname": "lib/utils.js~Json#conditions", "access": null, "description": null, "lineNumber": 505, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1261, "kind": "member", "name": "path", "memberof": "lib/utils.js~Json", "static": false, "longname": "lib/utils.js~Json#path", "access": null, "description": null, "lineNumber": 507, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1262, "kind": "member", "name": "value", "memberof": "lib/utils.js~Json", "static": false, "longname": "lib/utils.js~Json#value", "access": null, "description": null, "lineNumber": 509, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1263, "kind": "class", "name": "Where", "memberof": "lib/utils.js", "static": true, "longname": "lib/utils.js~Where", "access": null, "export": false, "importPath": "sequelize/lib/utils.js", "importStyle": null, "description": null, "lineNumber": 516, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "interface": false, "extends": [ "SequelizeMethod" ] }, { "__docId__": 1264, "kind": "constructor", "name": "constructor", "memberof": "lib/utils.js~Where", "generator": false, "async": false, "static": false, "longname": "lib/utils.js~Where#constructor", "access": null, "description": null, "lineNumber": 517, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "params": [ { "name": "attribute", "types": [ "*" ] }, { "name": "comparator", "types": [ "*" ] }, { "name": "logic", "types": [ "*" ] } ] }, { "__docId__": 1265, "kind": "member", "name": "attribute", "memberof": "lib/utils.js~Where", "static": false, "longname": "lib/utils.js~Where#attribute", "access": null, "description": null, "lineNumber": 524, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1266, "kind": "member", "name": "comparator", "memberof": "lib/utils.js~Where", "static": false, "longname": "lib/utils.js~Where#comparator", "access": null, "description": null, "lineNumber": 525, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } }, { "__docId__": 1267, "kind": "member", "name": "logic", "memberof": "lib/utils.js~Where", "static": false, "longname": "lib/utils.js~Where#logic", "access": null, "description": null, "lineNumber": 526, "undocument": true, "unknown": [ { "tagName": "@_undocument", "tagValue": "" } ], "type": { "types": [ "*" ] } } ]