Back to Sequelize

References

static/v5/identifiers.html

latest8.4 KB
Original Source

References

| summary | | public |

CModel

A Model represents a table in the database.

| | | public |

CQueryInterface

The interface that Sequelize uses to talk to all databases

| | | public |

CSequelize

This is the main class, the entry point to sequelize.

| | | public |

CTransaction

The transaction object is used to identify a running transaction.

| | | public |

VDataTypes: *

A convenience class holding commonly used data types.

| | | public |

VDeferrable: *

A collection of properties related to deferrable constraints.

| | | public |

VIndexHints: *

An enum of index hints to be used in mysql for querying with index hints

| | | public |

VOp: {"eq": *, "ne": *, "gte": *, "gt": *, "lte": *, "lt": *, "not": *, "is": *, "in": *, "notIn": *, "like": *, "notLike": *, "iLike": *, "notILike": *, "startsWith": *, "endsWith": *, "substring": *, "regexp": *, "notRegexp": *, "iRegexp": *, "notIRegexp": *, "between": *, "notBetween": *, "overlap": *, "contains": *, "contained": *, "adjacent": *, "strictLeft": *, "strictRight": *, "noExtendRight": *, "noExtendLeft": *, "and": *, "or": *, "any": *, "all": *, "values": *, "col": *, "placeholder": *, "join": *}

Operator symbols to be used when querying data

| | | public |

VQueryTypes: *

An enum of query types used by sequelize.query

| | | public |

VTableHints: *

An enum of table hints to be used in mssql for querying with table hints

| |

associations

| summary | | public |

CAssociation

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).

| | | public |

CBelongsToMany

Many-to-many association with a join table.

| | | public |

CBelongsTo

One-to-one association

| | | public |

CHasMany

One-to-many association

| | | public |

CHasOne

One-to-one association

| |

dialects/sqlite

| summary | | public |

FdescribeTable(qi: QueryInterface, tableName: string, options: Object): Promise<Object>

Describe a table structure

| |

errors

| summary | | public |

CAssociationError

Thrown when an association is improperly constructed (see message for details)

| | | public |

CBaseError

Sequelize provides a host of custom error classes, to allow you to do easier debugging.

| | | public |

CBulkRecordError(error: Error, record: Object)

Thrown when bulk operation fails, it represent per record level error.

| | | public |

CConnectionError

A base class for all connection related errors.

| | | public |

CDatabaseError

A base class for all database related errors.

| | | public |

CEagerLoadingError

Thrown when an include statement is improperly constructed (see message for details)

| | | public |

CEmptyResultError

Thrown when a record was not found, Usually used with rejectOnEmpty mode (see message for details)

| | | public |

CInstanceError

Thrown when a some problem occurred with Instance methods (see message for details)

| | | public |

COptimisticLockError

Thrown when attempting to update a stale model instance

| | | public |

CQueryError

Thrown when a query is passed invalid options (see message for details)

| | | public |

CSequelizeScopeError

Scope Error.

| | | public |

CValidationError(message: string, errors: Array)

Validation Error.

| | | public |

CValidationErrorItem

Validation Error Item Instances of this class are included in the ValidationError.errors property.

| |

errors/connection

| summary | | public |

CAccessDeniedError

Thrown when a connection to a database is refused due to insufficient privileges

| | | public |

CConnectionAcquireTimeoutError

Thrown when connection is not acquired due to timeout

| | | public |

CConnectionRefusedError

Thrown when a connection to a database is refused

| | | public |

CConnectionTimedOutError

Thrown when a connection to a database times out

| | | public |

CHostNotFoundError

Thrown when a connection to a database has a hostname that was not found

| | | public |

CHostNotReachableError

Thrown when a connection to a database has a hostname that was not reachable

| | | public |

CInvalidConnectionError

Thrown when a connection to a database has invalid values for any of the connection parameters

| |

errors/database

| summary | | public |

CExclusionConstraintError

Thrown when an exclusion constraint is violated in the database

| | | public |

CForeignKeyConstraintError

Thrown when a foreign key constraint is violated in the database

| | | public |

CTimeoutError

Thrown when a database query times out because of a deadlock

| | | public |

CUnknownConstraintError

Thrown when constraint name is not found in the database

| |

errors/validation

| summary | | public |

CUniqueConstraintError

Thrown when a unique constraint is violated in the database

| |

Directories

associations

sqlite

errors

connection

database

validation