Readonly dialectProtected Readonly sequelizeProtected Readonly whereProtected optionsProtected _addReturns an SQL fragment for adding result constraints.
Protected _getProtected _getProtected _getOptional options: AddColumnQueryOptionsOptional options: ArithmeticQueryOptionsOptional options: AttributeToSqlOptionsCreates a function that can be used to collect bind parameters.
A mutable object to which bind parameters will be added.
Creates a function that can be used to collect bind parameters.
Optional options: BulkInsertOptionsOptional columnDefinitions: { Optional _options: CreateDatabaseQueryOptionsOptional options: CreateSchemaQueryOptionsOptional options: CreateTableQueryOptionsOptional where: WhereOptionsOptional options: DeleteOptionsOptional model: ModelStatic<Model<any, any>>Generates an SQL query that drops a foreign key constraint.
The table or associated model.
The name of the foreign key constraint.
Use removeConstraintQuery instead.
Optional options: DropTableQueryOptionsEscapes a value (e.g. a string, number or date) as an SQL value (as opposed to an identifier).
The value to escape
The options to use when escaping the value
Escapes an array of values (e.g. strings, numbers or dates) as an SQL List of values.
The list of values to escape
Optional options: EscapeOptionsconst values = [1, 2, 3];
queryGenerator.escapeList([1, 2, 3]); // '(1, 2, 3)'
Optional options: { Optional delimiter?: stringOptional schema?: stringProtected formatProtected formatOptional options: EscapeOptionsProtected formatOptional options: EscapeOptionsProtected formatOptional options: EscapeOptionsProtected formatOptional options: EscapeOptionsProtected formatOptional options: EscapeOptionsProtected formatOptional options: EscapeOptionsProtected formatOptional options: EscapeOptionsOptional options: EscapeOptionsThe goal of this method is to execute the equivalent of json_unquote for the current dialect.
Generates an SQL query that returns all foreign keys of a table or the foreign key constraint of a given column.
The table or associated model.
Optional _columnName: stringThe name of the column. Not supported by SQLite.
The generated SQL query.
Use showConstraintsQuery instead.
Optional columnDefinitions: { Optional options: InsertOptionsOptional bind?: unknown[]⚠️ This is not an identifier, it's a raw SQL expression. It will be inlined in the query.
The JSON path, where each item is one level of the path
Whether the result should be unquoted (depending on dialect: ->> and #>> operators, json_unquote function). Defaults to false.
Optional _options: ListDatabasesQueryOptionsOptional _options: ListSchemasQueryOptionsOptional _options: ListTablesQueryOptionsQuote table name with optional alias and schema attribution
table string or object
Optional options: QuoteTableOptionsoptions
Optional options: RemoveColumnQueryOptionsOptional options: RemoveConstraintQueryOptionsOptional _options: RemoveIndexQueryOptionsOptional options: RenameTableQueryOptionsOptional options: SelectOptions<M>Optional model: ModelStatic<M>Optional constraints: readonly string[]Optional _options: ShowConstraintsQueryOptionsOptional options: UpdateOptionsOptional columnDefinitions: { Optional bind?: unknown[]Validate a value against a field specification
The value to validate
The DataType to validate against
Optional options: FormatWhereOptionsOptional options: FormatWhereOptionsGenerated using TypeDoc
The base class for all query generators, used to generate all SQL queries.
The implementation varies between SQL dialects, and is overridden by subclasses. You can access your dialect's version through Sequelize#queryGenerator.