CINXE.COM
<!DOCTYPE html><html><head> <meta charset="utf-8"> <base data-ice="baseUrl"> <title data-ice="title">Reference | Sequelize</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> <link rel="stylesheet" href="./inject/css/0-style.css"><link rel="stylesheet" href="./inject/css/0-theme.css"><meta name="description" content="An easy-to-use multi SQL dialect ORM for Node.js"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="Sequelize"><meta property="twitter:description" content="An easy-to-use multi SQL dialect ORM for Node.js"><meta name="viewport" content="width=device-width, initial-scale=1.0"></head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./" style="display: flex; align-items: center;"><img src="./image/brand_logo.png" style="width:34px;"></a> <a href="/docs/v6/intro/" data-ice="manualHeaderLink" class="api-reference-link">Guides</a> <a href='/api/v6/identifiers'>Reference</a> <a href="source.html">Source</a> <div class="search-box"> <span> <img src="./image/search.png"> <span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span> </span> <ul class="search-result"></ul> </div> <a style="position:relative; top:3px;" href="https://github.com/sequelize/sequelize"><img width="30px" src="./image/github.png" style="width: 30px;"></a></header> <nav class="navigation" data-ice="nav"><button id="navigationHamburger" class="hamburger" type="button"><span class="line"></span><span class="line"></span><span class="line"></span></button><div> <ul> <li data-ice="doc" style="margin-top: 15px;"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/model.js~model'>Model</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/sequelize.js~sequelize'>Sequelize</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/transaction.js~transaction'>Transaction</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href='/api/v6/function/#static-function-format'>format</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href='/api/v6/function/#static-function-formatNamedParameters'>formatNamedParameters</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href='/api/v6/function/#static-function-safeStringifyJson'>safeStringifyJson</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href='/api/v6/variable/#static-variable-DataTypes'>DataTypes</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href='/api/v6/variable/#static-variable-Deferrable'>Deferrable</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href='/api/v6/variable/#static-variable-IndexHints'>IndexHints</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href='/api/v6/variable/#static-variable-QueryTypes'>QueryTypes</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href='/api/v6/variable/#static-variable-TableHints'>TableHints</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#associations'>associations</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/associations/base.js~association'>Association</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/associations/belongs-to-many.js~belongstomany'>BelongsToMany</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/associations/belongs-to.js~belongsto'>BelongsTo</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/associations/has-many.js~hasmany'>HasMany</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/associations/has-one.js~hasone'>HasOne</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#dialects-abstract'>dialects/abstract</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/dialects/abstract/query-interface.js~queryinterface'>QueryInterface</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#dialects-db2'>dialects/db2</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/dialects/db2/query-interface.js~db2queryinterface'>Db2QueryInterface</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#dialects-mssql'>dialects/mssql</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/dialects/mssql/async-queue.ts~asyncqueueerror'>AsyncQueueError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/dialects/mssql/query-interface.js~mssqlqueryinterface'>MSSqlQueryInterface</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#dialects-mysql'>dialects/mysql</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/dialects/mysql/query-interface.js~mysqlqueryinterface'>MySQLQueryInterface</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#dialects-oracle'>dialects/oracle</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/dialects/oracle/query-interface.js~oraclequeryinterface'>OracleQueryInterface</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#dialects-postgres'>dialects/postgres</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/dialects/postgres/query-interface.js~postgresqueryinterface'>PostgresQueryInterface</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#dialects-snowflake'>dialects/snowflake</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/dialects/snowflake/query-interface.js~snowflakequeryinterface'>SnowflakeQueryInterface</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#dialects-sqlite'>dialects/sqlite</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/dialects/sqlite/query-interface.js~sqlitequeryinterface'>SQLiteQueryInterface</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#errors'>errors</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/aggregate-error.ts~aggregateerror'>AggregateError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/association-error.ts~associationerror'>AssociationError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/base-error.ts~baseerror'>BaseError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/bulk-record-error.ts~bulkrecorderror'>BulkRecordError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/connection-error.ts~connectionerror'>ConnectionError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/database-error.ts~databaseerror'>DatabaseError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/eager-loading-error.ts~eagerloadingerror'>EagerLoadingError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/empty-result-error.ts~emptyresulterror'>EmptyResultError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/instance-error.ts~instanceerror'>InstanceError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/optimistic-lock-error.ts~optimisticlockerror'>OptimisticLockError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/query-error.ts~queryerror'>QueryError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/sequelize-scope-error.ts~sequelizescopeerror'>SequelizeScopeError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/validation-error.ts~validationerror'>ValidationError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/validation-error.ts~validationerroritem'>ValidationErrorItem</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href='/api/v6/variable/#static-variable-ValidationErrorItemOrigin'>ValidationErrorItemOrigin</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href='/api/v6/variable/#static-variable-ValidationErrorItemType'>ValidationErrorItemType</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#errors-connection'>errors/connection</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/connection/access-denied-error.ts~accessdeniederror'>AccessDeniedError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/connection/connection-acquire-timeout-error.ts~connectionacquiretimeouterror'>ConnectionAcquireTimeoutError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/connection/connection-refused-error.ts~connectionrefusederror'>ConnectionRefusedError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/connection/connection-timed-out-error.ts~connectiontimedouterror'>ConnectionTimedOutError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/connection/host-not-found-error.ts~hostnotfounderror'>HostNotFoundError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/connection/host-not-reachable-error.ts~hostnotreachableerror'>HostNotReachableError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/connection/invalid-connection-error.ts~invalidconnectionerror'>InvalidConnectionError</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#errors-database'>errors/database</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/database/exclusion-constraint-error.ts~exclusionconstrainterror'>ExclusionConstraintError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/database/foreign-key-constraint-error.ts~foreignkeyconstrainterror'>ForeignKeyConstraintError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/database/timeout-error.ts~timeouterror'>TimeoutError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/database/unknown-constraint-error.ts~unknownconstrainterror'>UnknownConstraintError</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#errors-validation'>errors/validation</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/errors/validation/unique-constraint-error.ts~uniqueconstrainterror'>UniqueConstraintError</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/identifiers#utils'>utils</a><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href='/api/v6/function/#static-function-injectReplacements'>injectReplacements</a></span></span></li> <li data-ice="doc"><a class='nav-dir-path' data-ice='dirPath' href='/api/v6/variable/#static-variable-DataTypes'>datatypes</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~array'>ARRAY</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~virtual'>VIRTUAL</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~uuidv4'>UUIDV4</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~uuidv1'>UUIDV1</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~uuid'>UUID</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~tsvector'>TSVECTOR</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~tinyint'>TINYINT</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~time'>TIME</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~text'>TEXT</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~string'>STRING</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~smallint'>SMALLINT</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~real'>REAL</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~range'>RANGE</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~number'>NUMBER</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~now'>NOW</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~mediumint'>MEDIUMINT</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~macaddr'>MACADDR</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~jsontype'>JSONTYPE</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~jsonb'>JSONB</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~integer'>INTEGER</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~inet'>INET</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~hstore'>HSTORE</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~geometry'>GEOMETRY</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~geography'>GEOGRAPHY</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~float'>FLOAT</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~enum'>ENUM</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~double'>DOUBLE</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~decimal'>DECIMAL</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~dateonly'>DATEONLY</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~date'>DATE</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~citext'>CITEXT</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~cidr'>CIDR</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~char'>CHAR</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~boolean'>BOOLEAN</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~blob'>BLOB</a></span></span></li><li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href='/api/v6/class/src/data-types.js~bigint'>BIGINT</a></span></span></li></ul> </div> </nav> <div class="content" data-ice="content"><h1>References</h1> <div class="identifiers-wrap"> <div> <div data-ice="dirSummaryWrap"> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/model.js~model'>Model</a></span></span> </p> </div> <div> <div data-ice="description"><p>A Model represents a table in the database.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/sequelize.js~sequelize'>Sequelize</a></span></span> </p> </div> <div> <div data-ice="description"><p>This is the main class, the entry point to sequelize.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/transaction.js~transaction'>Transaction</a></span></span> </p> </div> <div> <div data-ice="description"><p>The transaction object is used to identify a running transaction.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-function">F</span> <span class="code" data-ice="name"><span><a href='/api/v6/function/#static-function-format'>format</a></span></span><span class="code" data-ice="signature">(arr: <span><span>unknown</span><span>[]</span></span>, dialect: <span>AbstractDialect</span>): <span>*</span></span> </p> </div> <div> <div class="deprecated" data-ice="deprecated">this function was deprecated. use {@link injectReplacements} instead. This method has been removed in v7.</div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-function">F</span> <span class="code" data-ice="name"><span><a href='/api/v6/function/#static-function-formatNamedParameters'>formatNamedParameters</a></span></span><span class="code" data-ice="signature">(sql: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, parameters: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>, dialect: <span>AbstractDialect</span>): <span>*</span></span> </p> </div> <div> <div class="deprecated" data-ice="deprecated">this function was deprecated. use {@link injectReplacements} instead. This method has been removed in v7.</div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-function">F</span> <span class="code" data-ice="name"><span><a href='/api/v6/function/#static-function-safeStringifyJson'>safeStringifyJson</a></span></span><span class="code" data-ice="signature">(value: <span>any</span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></span> </p> </div> <div> <div data-ice="description"><p>Stringify a value as JSON with some differences:</p> <ul> <li>bigints are stringified as a json string.</li> </ul> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-variable">V</span> <span class="code" data-ice="name"><span><a href='/api/v6/variable/#static-variable-DataTypes'>DataTypes</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> <div data-ice="description"><p>A convenience class holding commonly used data types.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-variable">V</span> <span class="code" data-ice="name"><span><a href='/api/v6/variable/#static-variable-Deferrable'>Deferrable</a></span></span><span class="code" data-ice="signature">: {"INITIALLY_DEFERRED": <span>*</span>, "INITIALLY_IMMEDIATE": <span>*</span>, "NOT": <span>*</span>, "SET_DEFERRED": <span>*</span>, "SET_IMMEDIATE": <span>*</span>}</span> </p> </div> <div> <div data-ice="description"><p>A collection of properties related to deferrable constraints.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-variable">V</span> <span class="code" data-ice="name"><span><a href='/api/v6/variable/#static-variable-IndexHints'>IndexHints</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> <div data-ice="description"><p>An enum of index hints to be used in mysql for querying with index hints</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-variable">V</span> <span class="code" data-ice="name"><span><a href='/api/v6/variable/#static-variable-QueryTypes'>QueryTypes</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> <div data-ice="description"><p>An enum of query types used by <code>sequelize.query</code></p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-variable">V</span> <span class="code" data-ice="name"><span><a href='/api/v6/variable/#static-variable-TableHints'>TableHints</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> <div data-ice="description"><p>An enum of table hints to be used in mssql for querying with table hints</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="associations">associations</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/associations/base.js~association'>Association</a></span></span> </p> </div> <div> <div data-ice="description"><p>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).</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/associations/belongs-to-many.js~belongstomany'>BelongsToMany</a></span></span> </p> </div> <div> <div data-ice="description"><p>Many-to-many association with a join table.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/associations/belongs-to.js~belongsto'>BelongsTo</a></span></span> </p> </div> <div> <div data-ice="description"><p>One-to-one association</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/associations/has-many.js~hasmany'>HasMany</a></span></span> </p> </div> <div> <div data-ice="description"><p>One-to-many association</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/associations/has-one.js~hasone'>HasOne</a></span></span> </p> </div> <div> <div data-ice="description"><p>One-to-one association</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="dialects-abstract">dialects/abstract</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/dialects/abstract/query-interface.js~queryinterface'>QueryInterface</a></span></span> </p> </div> <div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="dialects-db2">dialects/db2</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/dialects/db2/query-interface.js~db2queryinterface'>Db2QueryInterface</a></span></span> </p> </div> <div> <div data-ice="description"><p>The interface that Sequelize uses to talk with Db2 database</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="dialects-mssql">dialects/mssql</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/dialects/mssql/async-queue.ts~asyncqueueerror'>AsyncQueueError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a connection to a database is closed while an operation is in progress</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/dialects/mssql/query-interface.js~mssqlqueryinterface'>MSSqlQueryInterface</a></span></span> </p> </div> <div> <div data-ice="description"><p>The interface that Sequelize uses to talk with MSSQL database</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="dialects-mysql">dialects/mysql</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/dialects/mysql/query-interface.js~mysqlqueryinterface'>MySQLQueryInterface</a></span></span> </p> </div> <div> <div data-ice="description"><p>The interface that Sequelize uses to talk with MySQL/MariaDB database</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="dialects-oracle">dialects/oracle</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/dialects/oracle/query-interface.js~oraclequeryinterface'>OracleQueryInterface</a></span></span> </p> </div> <div> <div data-ice="description"><p>The interface that Sequelize uses to talk with Oracle database</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="dialects-postgres">dialects/postgres</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/dialects/postgres/query-interface.js~postgresqueryinterface'>PostgresQueryInterface</a></span></span> </p> </div> <div> <div data-ice="description"><p>The interface that Sequelize uses to talk with Postgres database</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="dialects-snowflake">dialects/snowflake</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/dialects/snowflake/query-interface.js~snowflakequeryinterface'>SnowflakeQueryInterface</a></span></span> </p> </div> <div> <div data-ice="description"><p>The interface that Sequelize uses to talk with Snowflake database</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="dialects-sqlite">dialects/sqlite</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/dialects/sqlite/query-interface.js~sqlitequeryinterface'>SQLiteQueryInterface</a></span></span> </p> </div> <div> <div data-ice="description"><p>The interface that Sequelize uses to talk with SQLite database</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="errors">errors</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/aggregate-error.ts~aggregateerror'>AggregateError</a></span></span><span class="code" data-ice="signature">(errors: <span>*</span>)</span> </p> </div> <div> <div data-ice="description"><p>A wrapper for multiple Errors</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/association-error.ts~associationerror'>AssociationError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when an association is improperly constructed (see message for details)</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/base-error.ts~baseerror'>BaseError</a></span></span> </p> </div> <div> <div data-ice="description"><p>The Base Error all Sequelize Errors inherit from.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/bulk-record-error.ts~bulkrecorderror'>BulkRecordError</a></span></span><span class="code" data-ice="signature">(error: <span>*</span>, record: <span>*</span>)</span> </p> </div> <div> <div data-ice="description"><p>Thrown when bulk operation fails, it represent per record level error.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/connection-error.ts~connectionerror'>ConnectionError</a></span></span> </p> </div> <div> <div data-ice="description"><p>A base class for all connection related errors.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/database-error.ts~databaseerror'>DatabaseError</a></span></span> </p> </div> <div> <div data-ice="description"><p>A base class for all database related errors.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/eager-loading-error.ts~eagerloadingerror'>EagerLoadingError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when an include statement is improperly constructed (see message for details)</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/empty-result-error.ts~emptyresulterror'>EmptyResultError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a record was not found, Usually used with rejectOnEmpty mode (see message for details)</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/instance-error.ts~instanceerror'>InstanceError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a some problem occurred with Instance methods (see message for details)</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/optimistic-lock-error.ts~optimisticlockerror'>OptimisticLockError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when attempting to update a stale model instance</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/query-error.ts~queryerror'>QueryError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a query is passed invalid options (see message for details)</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/sequelize-scope-error.ts~sequelizescopeerror'>SequelizeScopeError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Scope Error.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/validation-error.ts~validationerror'>ValidationError</a></span></span><span class="code" data-ice="signature">(message: <span>*</span>, errors: <span>*</span>)</span> </p> </div> <div> <div data-ice="description"><p>Validation Error.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/validation-error.ts~validationerroritem'>ValidationErrorItem</a></span></span> </p> </div> <div> <div data-ice="description"><p>Validation Error Item Instances of this class are included in the <code>ValidationError.errors</code> property.</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-variable">V</span> <span class="code" data-ice="name"><span><a href='/api/v6/variable/#static-variable-ValidationErrorItemOrigin'>ValidationErrorItemOrigin</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> <div data-ice="description"><p>An enum that defines valid ValidationErrorItem <code>origin</code> values</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-variable">V</span> <span class="code" data-ice="name"><span><a href='/api/v6/variable/#static-variable-ValidationErrorItemType'>ValidationErrorItemType</a></span></span><span class="code" data-ice="signature">: <span>*</span></span> </p> </div> <div> <div data-ice="description"><p>An enum that is used internally by the <code>ValidationErrorItem</code> class that maps current <code>type</code> strings (as given to ValidationErrorItem.constructor()) to our new <code>origin</code> values.</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="errors-connection">errors/connection</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/connection/access-denied-error.ts~accessdeniederror'>AccessDeniedError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a connection to a database is refused due to insufficient privileges</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/connection/connection-acquire-timeout-error.ts~connectionacquiretimeouterror'>ConnectionAcquireTimeoutError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when connection is not acquired due to timeout</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/connection/connection-refused-error.ts~connectionrefusederror'>ConnectionRefusedError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a connection to a database is refused</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/connection/connection-timed-out-error.ts~connectiontimedouterror'>ConnectionTimedOutError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a connection to a database times out</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/connection/host-not-found-error.ts~hostnotfounderror'>HostNotFoundError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a connection to a database has a hostname that was not found</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/connection/host-not-reachable-error.ts~hostnotreachableerror'>HostNotReachableError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a connection to a database has a hostname that was not reachable</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/connection/invalid-connection-error.ts~invalidconnectionerror'>InvalidConnectionError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a connection to a database has invalid values for any of the connection parameters</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="errors-database">errors/database</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/database/exclusion-constraint-error.ts~exclusionconstrainterror'>ExclusionConstraintError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when an exclusion constraint is violated in the database</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/database/foreign-key-constraint-error.ts~foreignkeyconstrainterror'>ForeignKeyConstraintError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a foreign key constraint is violated in the database</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/database/timeout-error.ts~timeouterror'>TimeoutError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a database query times out because of a deadlock</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/database/unknown-constraint-error.ts~unknownconstrainterror'>UnknownConstraintError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when constraint name is not found in the database</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="errors-validation">errors/validation</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href='/api/v6/class/src/errors/validation/unique-constraint-error.ts~uniqueconstrainterror'>UniqueConstraintError</a></span></span> </p> </div> <div> <div data-ice="description"><p>Thrown when a unique constraint is violated in the database</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="utils">utils</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-function">F</span> <span class="code" data-ice="name"><span><a href='/api/v6/function/#static-function-injectReplacements'>injectReplacements</a></span></span><span class="code" data-ice="signature">(sqlString: <span>*</span>, dialect: <span>*</span>, replacements: <span>*</span>): <span>*</span></span> </p> </div> <div> <div data-ice="description"><p>Inlines replacements in places where they would be valid SQL values.</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> </div> <div class="identifier-dir-tree" data-ice="dirTreeWrap"> <div class="identifier-dir-tree-header">Directories</div> <div class="identifier-dir-tree-content" data-ice="dirTree"><div style="padding-left: 0em"><a href="#associations">associations</a></div> <div style="padding-left: 1em"><a href="#dialects-abstract">abstract</a></div> <div style="padding-left: 1em"><a href="#dialects-db2">db2</a></div> <div style="padding-left: 1em"><a href="#dialects-mssql">mssql</a></div> <div style="padding-left: 1em"><a href="#dialects-mysql">mysql</a></div> <div style="padding-left: 1em"><a href="#dialects-oracle">oracle</a></div> <div style="padding-left: 1em"><a href="#dialects-postgres">postgres</a></div> <div style="padding-left: 1em"><a href="#dialects-snowflake">snowflake</a></div> <div style="padding-left: 1em"><a href="#dialects-sqlite">sqlite</a></div> <div style="padding-left: 0em"><a href="#errors">errors</a></div> <div style="padding-left: 1em"><a href="#errors-connection">connection</a></div> <div style="padding-left: 1em"><a href="#errors-database">database</a></div> <div style="padding-left: 1em"><a href="#errors-validation">validation</a></div> <div style="padding-left: 0em"><a href="#utils">utils</a></div></div> </div> </div> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.1.0)</span><img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> <script>'use strict'; (() => { function toggleNavigationBar() { const navigationElements = document.getElementsByClassName('navigation'); for (let i = 0; i < navigationElements.length; ++i) { const navigationElement = navigationElements[i]; navigationElement.classList.toggle('open'); } } // Hamburger button - toggles the navigation bar const hamburger = document.getElementById('navigationHamburger'); hamburger.addEventListener('click', () => { toggleNavigationBar(); }); // Each link in the navigation bar - closes the navigation bar const navigationLinks = document.querySelectorAll('.navigation a'); for (let i = 0; i < navigationLinks.length; ++i) { const linkElement = navigationLinks[i]; linkElement.addEventListener('click', () => { toggleNavigationBar(); }); } })(); </script></body></html>