QueryInterface

The interface that Sequelize uses to talk to all databases.

This interface is available through sequelize.QueryInterface. It should not be commonly used, but it's referenced anyway, so it can be used.

Hierarchy

QueryInterface

Index

Properties

Methods

Properties

QueryGenerator

QueryGenerator: any

Returns the dialect-specific sql generator.

We don't have a definition for the QueryGenerator, because I doubt it is commonly in use separately.

sequelize

sequelize: Sequelize

Returns the current sequelize instance.

Methods

addColumn

addColumn(table: string, key: string, attribute: DefineAttributeColumnOptions | DataTypeAbstract, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4043
Adds a new column to a table

Parameters
- table: string
- key: string
- attribute: DefineAttributeColumnOptions | DataTypeAbstract
- Optional options: QueryInterfaceOptions
Returns Promise<void>

addIndex

addIndex(tableName: string | Object, attributes: string[], options?: QueryOptions, rawTablename?: string): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4068
Adds a new index to a table

Parameters
- tableName: string | Object
- attributes: string[]
- Optional options: QueryOptions
- Optional rawTablename: string
Returns Promise<void>

bulkDelete

bulkDelete(tableName: string, identifier: Object, options?: QueryOptions, model?: Model<any, any>): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4131
Deletes multiple rows at once

Parameters
- tableName: string
- identifier: Object
- Optional options: QueryOptions
- Optional model: Model<any, any>
Returns Promise<Object>

bulkInsert

bulkInsert(tableName: string, records: Object[], options?: QueryOptions, attributes?: string[] | string): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4107
Inserts multiple records at once

Parameters
- tableName: string
- records: Object[]
- Optional options: QueryOptions
- Optional attributes: string[] | string
Returns Promise<Object>

bulkUpdate

bulkUpdate(tableName: string, values: Object, identifier: Object, options?: QueryOptions, attributes?: string[] | string): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4119
Updates multiple rows at once

Parameters
- tableName: string
- values: Object
- identifier: Object
- Optional options: QueryOptions
- Optional attributes: string[] | string
Returns Promise<Object>

changeColumn

changeColumn(tableName: string | object, attributeName: string, dataTypeOrOptions?: string | DataTypeAbstract | DefineAttributeColumnOptions, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4054
Changes a column

Parameters
- tableName: string | object
- attributeName: string
- Optional dataTypeOrOptions: string | DataTypeAbstract | DefineAttributeColumnOptions
- Optional options: QueryInterfaceOptions
Returns Promise<void>

commitTransaction

commitTransaction(transaction: Transaction, options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4233
Commit an already started transaction

Parameters
- transaction: Transaction
- Optional options: QueryOptions
Returns Promise<void>

createFunction

createFunction(functionName: string, params: any[], returnType: string, language: string, body: string, options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4173
Postgres only. Create a function

Parameters
- functionName: string
- params: any[]
- returnType: string
- language: string
- body: string
- Optional options: QueryOptions
Returns Promise<void>

createSchema

createSchema(schema?: string, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:3966
Queries the schema (table list).

Parameters
- Optional schema: string
  
  The schema to query. Applies only to Postgres.
- Optional options: QueryInterfaceOptions
Returns Promise<void>

createTable

createTable(tableName: string | object, attributes: DefineAttributes, options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:3999
Creates a table with specified attributes.

Parameters
- tableName: string | object
  
  Name of table to create
- attributes: DefineAttributes
  
  Hash of attributes, key is attribute name, value is data type
- Optional options: QueryOptions
  
  Query options.
Returns Promise<void>

createTrigger

createTrigger(tableName: string, triggerName: string, timingType: string, fireOnArray: any[], functionName: string, functionParams: any[], optionsArray: string[], options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4155
Postgres only. Creates a trigger on specified table to call the specified function with supplied parameters.

Parameters
- tableName: string
- triggerName: string
- timingType: string
- fireOnArray: any[]
- functionName: string
- functionParams: any[]
- optionsArray: string[]
- Optional options: QueryInterfaceOptions
Returns Promise<void>

databaseVersion

databaseVersion(options?: QueryInterfaceOptions): Promise<string>

- Defined in node_modules/@types/sequelize/index.d.ts:3990
Return database version

Parameters
- Optional options: QueryInterfaceOptions
Returns Promise<string>

deferConstraints

deferConstraints(transaction: Transaction, options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4228
Defer constraints

Parameters
- transaction: Transaction
- Optional options: QueryOptions
Returns Promise<void>

delete

delete(instance: Instance<any>, tableName: string, identifier: Object, options?: QueryOptions): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4125
Deletes a row

Parameters
- instance: Instance<any>
- tableName: string
- identifier: Object
- Optional options: QueryOptions
Returns Promise<Object>

describeTable

describeTable(tableName: string | object, options?: string | object): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4037
Describe a table

Parameters
- tableName: string | object
- Optional options: string | object
Returns Promise<Object>

dropAllEnums

dropAllEnums(options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4022
Drops all defined enums

Parameters
- Optional options: QueryOptions
Returns Promise<void>

dropAllSchemas

dropAllSchemas(options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:3978
Drops all tables.

Parameters
- Optional options: QueryInterfaceOptions
Returns Promise<void>

dropAllTables

dropAllTables(options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4015
Drops all tables.

Parameters
- Optional options: QueryOptions
Returns Promise<void>

dropFunction

dropFunction(functionName: string, params: any[], options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4179
Postgres only. Drops a function

Parameters
- functionName: string
- params: any[]
- Optional options: QueryInterfaceOptions
Returns Promise<void>

dropSchema

dropSchema(schema?: string, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:3973
Drops the specified schema (table).

Parameters
- Optional schema: string
  
  The schema to query. Applies only to Postgres.
- Optional options: QueryInterfaceOptions
Returns Promise<void>

dropTable

dropTable(tableName: string, options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4008
Drops the specified table.

Parameters
- tableName: string
  
  Table name.
- Optional options: QueryOptions
  
  Query options, particularly "force".
Returns Promise<void>

dropTrigger

dropTrigger(tableName: string, triggerName: string, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4162
Postgres only. Drops the specified trigger.

Parameters
- tableName: string
- triggerName: string
- Optional options: QueryInterfaceOptions
Returns Promise<void>

escape

escape(value?: string | number | Date): string

- Defined in node_modules/@types/sequelize/index.d.ts:4208
Escape a value (e.g. a string, number or date)

Parameters
- Optional value: string | number | Date
Returns string

getForeignKeysForTables

getForeignKeysForTables(tableNames: string, options?: QueryInterfaceOptions): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4084
Returns all foreign key constraints of a table

Parameters
- tableNames: string
- Optional options: QueryInterfaceOptions
Returns Promise<Object>

increment

increment(instance: Instance<any>, tableName: string, values: Object, identifier: Object, options?: QueryOptions): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4142
Increments a row value

Parameters
- instance: Instance<any>
- tableName: string
- values: Object
- identifier: Object
- Optional options: QueryOptions
Returns Promise<Object>

insert

insert(instance: Instance<any>, tableName: string, values: Object, options?: QueryOptions): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4095
Inserts a new record

Parameters
- instance: Instance<any>
- tableName: string
- values: Object
- Optional options: QueryOptions
Returns Promise<Object>

nameIndexes

nameIndexes(indexes: string[], rawTablename: string): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4079
Put a name to an index

Parameters
- indexes: string[]
- rawTablename: string
Returns Promise<void>

quoteIdentifier

quoteIdentifier(identifier: string, force: boolean): string

- Defined in node_modules/@types/sequelize/index.d.ts:4192
Escape an identifier (e.g. a table or attribute name). If force is true, the identifier will be quoted even if the quoteIdentifiers option is false.

Parameters
- identifier: string
- force: boolean
Returns string

quoteIdentifiers

quoteIdentifiers(identifiers: string, force: boolean): string

- Defined in node_modules/@types/sequelize/index.d.ts:4203
Split an identifier into .-separated tokens and quote each part. If force is true, the identifier will be quoted even if the quoteIdentifiers option is false.

Parameters
- identifiers: string
- force: boolean
Returns string

quoteTable

quoteTable(identifier: string): string

- Defined in node_modules/@types/sequelize/index.d.ts:4197
Escape a table name

Parameters
- identifier: string
Returns string

rawSelect

rawSelect(tableName: string, options: QueryOptions, attributeSelector: string | string[], model?: Model<any, any>): Promise<string[]>

- Defined in node_modules/@types/sequelize/index.d.ts:4148
Selects raw without parsing the string into an object

Parameters
- tableName: string
- options: QueryOptions
- attributeSelector: string | string[]
- Optional model: Model<any, any>
Returns Promise<string[]>

removeColumn

removeColumn(table: string, attribute: string, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4049
Removes a column from a table

Parameters
- table: string
- attribute: string
- Optional options: QueryInterfaceOptions
Returns Promise<void>

removeIndex

removeIndex(tableName: string, indexNameOrAttributes: string[] | string, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4089
Removes an index of a table

Parameters
- tableName: string
- indexNameOrAttributes: string[] | string
- Optional options: QueryInterfaceOptions
Returns Promise<void>

renameColumn

renameColumn(tableName: string | object, attrNameBefore: string, attrNameAfter: string, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4061
Renames a column

Parameters
- tableName: string | object
- attrNameBefore: string
- attrNameAfter: string
- Optional options: QueryInterfaceOptions
Returns Promise<void>

renameFunction

renameFunction(oldFunctionName: string, params: any[], newFunctionName: string, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4185
Postgres only. Rename a function

Parameters
- oldFunctionName: string
- params: any[]
- newFunctionName: string
- Optional options: QueryInterfaceOptions
Returns Promise<void>

renameTable

renameTable(before: string, after: string, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4027
Renames a table

Parameters
- before: string
- after: string
- Optional options: QueryInterfaceOptions
Returns Promise<void>

renameTrigger

renameTrigger(tableName: string, oldTriggerName: string, newTriggerName: string, options?: QueryInterfaceOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4167
Postgres only. Renames a trigger

Parameters
- tableName: string
- oldTriggerName: string
- newTriggerName: string
- Optional options: QueryInterfaceOptions
Returns Promise<void>

rollbackTransaction

rollbackTransaction(transaction: Transaction, options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4238
Rollback ( revert ) a transaction that has'nt been commited

Parameters
- transaction: Transaction
- Optional options: QueryOptions
Returns Promise<void>

select

select(model: Model<any, any>, tableName: string, options?: QueryOptions): Promise<Object[]>

- Defined in node_modules/@types/sequelize/index.d.ts:4137
Returns selected rows

Parameters
- model: Model<any, any>
- tableName: string
- Optional options: QueryOptions
Returns Promise<Object[]>

setAutocommit

setAutocommit(transaction: Transaction, value: boolean, options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4213
Set option for autocommit of a transaction

Parameters
- transaction: Transaction
- value: boolean
- Optional options: QueryOptions
Returns Promise<void>

setIsolationLevel

setIsolationLevel(transaction: Transaction, value: string, options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4218
Set the isolation level of a transaction

Parameters
- transaction: Transaction
- value: string
- Optional options: QueryOptions
Returns Promise<void>

showAllSchemas

showAllSchemas(options?: QueryOptions): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:3985
Queries all table names in the database.

Parameters
- Optional options: QueryOptions
Returns Promise<Object>

showAllTables

showAllTables(options?: QueryOptions): Promise<string[]>

- Defined in node_modules/@types/sequelize/index.d.ts:4032
Returns all tables

Parameters
- Optional options: QueryOptions
Returns Promise<string[]>

showIndex

showIndex(tableName: string | Object, options?: QueryOptions): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4074
Shows the index of a table

Parameters
- tableName: string | Object
- Optional options: QueryOptions
Returns Promise<Object>

startTransaction

startTransaction(transaction: Transaction, options?: QueryOptions): Promise<void>

- Defined in node_modules/@types/sequelize/index.d.ts:4223
Begin a new transaction

Parameters
- transaction: Transaction
- Optional options: QueryOptions
Returns Promise<void>

update

update(instance: Instance<any>, tableName: string, values: Object, identifier: Object, options?: QueryOptions): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4113
Updates a row

Parameters
- instance: Instance<any>
- tableName: string
- values: Object
- identifier: Object
- Optional options: QueryOptions
Returns Promise<Object>

upsert

upsert(tableName: string, values: Object, updateValues: Object, model: Model<any, any>, options?: QueryOptions): Promise<Object>

- Defined in node_modules/@types/sequelize/index.d.ts:4101
Inserts or Updates a record in the database

Parameters
- tableName: string
- values: Object
- updateValues: Object
- model: Model<any, any>
- Optional options: QueryOptions
Returns Promise<Object>

Hierarchy

Index

Properties

Methods

Properties

QueryGenerator

sequelize

Methods

addColumn

Parameters

table: string

key: string

attribute: DefineAttributeColumnOptions | DataTypeAbstract

Optional options: QueryInterfaceOptions

Returns Promise<void>

addIndex

Parameters

tableName: string | Object

attributes: string[]

Optional options: QueryOptions

Optional rawTablename: string

Returns Promise<void>

bulkDelete

Parameters

tableName: string

identifier: Object

Optional options: QueryOptions

Optional model: Model<any, any>

Returns Promise<Object>

bulkInsert

Parameters

tableName: string

records: Object[]

Optional options: QueryOptions

Optional attributes: string[] | string

Returns Promise<Object>

bulkUpdate

Parameters

tableName: string

values: Object

identifier: Object

Optional options: QueryOptions

Optional attributes: string[] | string

Returns Promise<Object>

changeColumn

Parameters

tableName: string | object

attributeName: string

Optional dataTypeOrOptions: string | DataTypeAbstract | DefineAttributeColumnOptions

Optional options: QueryInterfaceOptions

Returns Promise<void>

commitTransaction

Parameters

transaction: Transaction

Optional options: QueryOptions

Returns Promise<void>

createFunction

Parameters

functionName: string

params: any[]

returnType: string

language: string

body: string

Optional options: QueryOptions

Returns Promise<void>

createSchema

Parameters

Optional schema: string

Optional options: QueryInterfaceOptions

Returns Promise<void>

createTable

Parameters

tableName: string | object

attributes: DefineAttributes

Optional options: QueryOptions

Returns Promise<void>

createTrigger

Parameters

tableName: string

triggerName: string