Class 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

Constructors

constructor

new QueryInterface(sequelize: Sequelize): QueryInterface
Parameters
- sequelize: Sequelize
Returns QueryInterface
- Defined in types/dialects/abstract/query-interface.d.ts:271

Properties

queryGenerator

queryGenerator: AbstractQueryGenerator

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: TableName, key: string, attribute: DataTypes.DataType | ModelAttributeColumnOptions<Model<any, any>>, options?: QiOptionsWithReplacements): Promise<void>
Adds a new column to a table
Parameters
- table: TableName
- key: string
- attribute: DataTypes.DataType | ModelAttributeColumnOptions<Model<any, any>>
- Optional options: QiOptionsWithReplacements
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:368

addConstraint

addConstraint(tableName: TableName, options?: Object): Promise<void>
Adds constraints to a table
Parameters
- tableName: TableName
- Optional options: Object
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:428

addIndex

addIndex(tableName: TableName, attributes: string[], options?: QueryInterfaceIndexOptions, rawTablename?: string): Promise<void>
Adds a new index to a table
Parameters
- tableName: TableName
- attributes: string[]
- Optional options: QueryInterfaceIndexOptions
- Optional rawTablename: string
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:407
addIndex(tableName: TableName, options: {
    benchmark?: boolean;
    bind?: BindOrReplacements;
    concurrently?: boolean;
    fieldMap?: FieldMap;
    fields: (string | Fn | Literal | IndexField)[];
    instance?: Model<any, any>;
    logging?: boolean | ((sql: string, timing?: number) => void);
    mapToModel?: boolean;
    name?: string;
    nest?: boolean;
    operator?: string;
    parser?: null | string;
    plain?: boolean;
    prefix?: string;
    raw?: boolean;
    replacements?: {
        [key: string]: unknown;
    };
    retry?: RetryOptions;
    transaction?: null | Transaction;
    type?: IndexType;
    unique?: boolean;
    useMaster?: boolean;
    using?: string;
    where?: WhereOptions<any>;
}, rawTablename?: string): Promise<void>
Parameters
- tableName: TableName
- options: {
      benchmark?: boolean;
      bind?: BindOrReplacements;
      concurrently?: boolean;
      fieldMap?: FieldMap;
      fields: (string | Fn | Literal | IndexField)[];
      instance?: Model<any, any>;
      logging?: boolean | ((sql: string, timing?: number) => void);
      mapToModel?: boolean;
      name?: string;
      nest?: boolean;
      operator?: string;
      parser?: null | string;
      plain?: boolean;
      prefix?: string;
      raw?: boolean;
      replacements?: {
          [key: string]: unknown;
      };
      retry?: RetryOptions;
      transaction?: null | Transaction;
      type?: IndexType;
      unique?: boolean;
      useMaster?: boolean;
      using?: string;
      where?: WhereOptions<any>;
  }
  - Optional benchmark?: boolean
    
    Pass query execution time in milliseconds as second argument to logging function (options.logging).
  - Optional bind?: BindOrReplacements
    
    Either an object of named parameter bindings in the format $param or an array of unnamed values to bind to $1, $2, etc in your SQL.
  - Optional concurrently?: boolean
    
    PostgreSQL will build the index without taking any write locks. Postgres only.
    
    Default
    false
  - Optional fieldMap?: FieldMap
    
    Map returned fields to arbitrary names for SELECT query type if options.fieldMaps is present.
  - fields: (string | Fn | Literal | IndexField)[]
    
    The fields to index.
  - Optional instance?: Model<any, any>
    
    A sequelize instance used to build the return instance
  - Optional logging?: boolean | ((sql: string, timing?: number) => void)
    
    A function that gets executed while running the query to log the sql.
  - Optional mapToModel?: boolean
    
    Map returned fields to model's fields if options.model or options.instance is present. Mapping will occur before building the model instance.
  - Optional name?: string
    
    The name of the index. Defaults to model name + _ + fields concatenated
  - Optional nest?: boolean
    
    If true, transforms objects with . separated property names into nested objects using 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
    
    Default
    false
  - Optional operator?: string
    
    Index operator type. Postgres only
  - Optional parser?: null | string
    
    For FULLTEXT columns set your parser
  - Optional plain?: boolean
    
    Sets the query type to SELECT and return a single row
  - Optional prefix?: string
    
    Prefix to append to the index name.
  - Optional raw?: boolean
    
    If true, sequelize will not try to format the results of the query, or build an instance of a model from the result
  - Optional replacements?: {
    [key: string]: unknown;
    }
    
    Only named replacements are allowed in query interface methods.
    - [key: string]: unknown
  - Optional retry?: RetryOptions
  - Optional transaction?: null | Transaction
    
    The transaction in which this query must be run.
    
    If CLS is enabled and a transaction is running in the current CLS context, that transaction will be used, unless null or a Transaction is manually specified here.
  - Optional type?: IndexType
    
    Index type. Only used by mysql. One of UNIQUE, FULLTEXT and SPATIAL
  - Optional unique?: boolean
    
    Should the index by unique? Can also be triggered by setting type to UNIQUE
    
    Default
    false
  - Optional useMaster?: boolean
    
    Force the query to use the write pool, regardless of the query type.
    
    Default
    false
  - Optional using?: string
    
    The method to create the index by (USING statement in SQL). BTREE and HASH are supported by mysql and postgres. Postgres additionally supports GIST, SPGIST, BRIN and GIN.
  - Optional where?: WhereOptions<any>
    
    Optional where parameter for index. Can be used to limit the index to certain rows.
- Optional rawTablename: string
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:413

bulkDelete

bulkDelete(tableName: TableName, identifier: WhereOptions<any>, options?: QiOptionsWithReplacements, model?: ModelStatic<Model<any, any>>): Promise<object>
Deletes multiple rows at once
Parameters
- tableName: TableName
- identifier: WhereOptions<any>
- Optional options: QiOptionsWithReplacements
- Optional model: ModelStatic<Model<any, any>>
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:519

bulkInsert

bulkInsert(tableName: TableName, records: object[], options?: QiOptionsWithReplacements, attributes?: Record<string, ModelAttributeColumnOptions<Model<any, any>>>): Promise<number | object>
Inserts multiple records at once
Parameters
- tableName: TableName
- records: object[]
- Optional options: QiOptionsWithReplacements
- Optional attributes: Record<string, ModelAttributeColumnOptions<Model<any, any>>>
Returns Promise<number | object>
- Defined in types/dialects/abstract/query-interface.d.ts:477

bulkUpdate

bulkUpdate(tableName: TableName, values: object, where: WhereOptions<any>, options?: QiOptionsWithReplacements, columnDefinitions?: {
[columnName: string]: BuiltModelAttributeColumOptions;
}): Promise<object>
Updates multiple rows at once
Parameters
- tableName: TableName
- values: object
- where: WhereOptions<any>
- Optional options: QiOptionsWithReplacements
- Optional columnDefinitions: {
  [columnName: string]: BuiltModelAttributeColumOptions;
  }
  - [columnName: string]: BuiltModelAttributeColumOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:498

changeColumn

changeColumn(tableName: TableName, attributeName: string, dataTypeOrOptions?: DataTypes.DataType | ModelAttributeColumnOptions<Model<any, any>>, options?: QiOptionsWithReplacements): Promise<void>
Changes a column
Parameters
- tableName: TableName
- attributeName: string
- Optional dataTypeOrOptions: DataTypes.DataType | ModelAttributeColumnOptions<Model<any, any>>
- Optional options: QiOptionsWithReplacements
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:387

commitTransaction

commitTransaction(transaction: Transaction, options?: QueryRawOptions): Promise<void>
Commit an already started transaction
Parameters
- transaction: Transaction
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:659

createDatabase

createDatabase(name: string, options?: CreateDatabaseOptions): Promise<void>
Creates a database
Parameters
- name: string
- Optional options: CreateDatabaseOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:669

createFunction

createFunction(functionName: string, params: FunctionParam[], returnType: string, language: string, body: string, optionsArray?: string[], options?: CreateFunctionOptions): Promise<void>
Postgres only. Create a function
Parameters
- functionName: string
- params: FunctionParam[]
- returnType: string
- language: string
- body: string
- Optional optionsArray: string[]
- Optional options: CreateFunctionOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:600

createSchema

createSchema(schema?: string, options?: QueryRawOptions): Promise<void>
Queries the schema (table list).
Parameters
- Optional schema: string
  
  The schema to query. Applies only to Postgres.
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:278

createTable

createTable<M>(tableName: TableName, attributes: ModelAttributes<M, CreationAttributes<M>>, options?: QueryInterfaceCreateTableOptions): Promise<void>
Creates a table with specified attributes.
Type Parameters
- M extends Model<any, any, M>
Parameters
- tableName: TableName
  
  Name of table to create
- attributes: ModelAttributes<M, CreationAttributes<M>>
  
  Hash of attributes, key is attribute name, value is data type
- Optional options: QueryInterfaceCreateTableOptions
  
  Table options.
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:311

createTrigger

createTrigger(tableName: TableName, triggerName: string, timingType: string, fireOnArray: {
[key: string]: unknown;
}[], functionName: string, functionParams: FunctionParam[], optionsArray: string[], options?: QiOptionsWithReplacements): Promise<void>
Postgres only. Creates a trigger on specified table to call the specified function with supplied parameters.
Parameters
- tableName: TableName
- triggerName: string
- timingType: string
- fireOnArray: {
  [key: string]: unknown;
  }[]
- functionName: string
- functionParams: FunctionParam[]
- optionsArray: string[]
- Optional options: QiOptionsWithReplacements
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:569

databaseVersion

databaseVersion(options?: QueryRawOptions): Promise<string>
Return database version
Parameters
- Optional options: QueryRawOptions
Returns Promise<string>
- Defined in types/dialects/abstract/query-interface.d.ts:302

decrement

decrement<M>(model: ModelStatic<M>, tableName: TableName, incrementAmountsByField: object, extraAttributesToBeUpdated?: object, where?: WhereOptions<Attributes<M>>, options?: QiArithmeticOptions): Promise<object>
Decrements a row value
Type Parameters
- M extends Model<any, any, M>
Parameters
- model: ModelStatic<M>
- tableName: TableName
- incrementAmountsByField: object
- Optional extraAttributesToBeUpdated: object
- Optional where: WhereOptions<Attributes<M>>
- Optional options: QiArithmeticOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:546

deferConstraints

deferConstraints(transaction: Transaction, options?: QueryRawOptions): Promise<void>
Defer constraints
Parameters
- transaction: Transaction
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:654

delete

delete(instance: null | Model<any, any>, tableName: TableName, identifier: WhereOptions<any>, options?: QiDeleteOptions): Promise<object>
Deletes a row
Parameters
- instance: null | Model<any, any>
- tableName: TableName
- identifier: WhereOptions<any>
- Optional options: QiDeleteOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:509

describeTable

describeTable(tableName: TableName, options?: string | {
schema?: string;
schemaDelimiter?: string;
} & Logging): Promise<ColumnsDescription>
Describe a table
Parameters
- tableName: TableName
- Optional options: string | {
  schema?: string;
  schemaDelimiter?: string;
  } & Logging
Returns Promise<ColumnsDescription>
- Defined in types/dialects/abstract/query-interface.d.ts:360

dropAllEnums

dropAllEnums(options?: QueryRawOptions): Promise<void>
Drops all defined enums
Parameters
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:337

dropAllSchemas

dropAllSchemas(options?: QueryInterfaceDropAllTablesOptions): Promise<void>
Drops all tables.
Parameters
- Optional options: QueryInterfaceDropAllTablesOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:290

dropAllTables

dropAllTables(options?: QueryInterfaceDropAllTablesOptions): Promise<void>
Drops all tables.
Parameters
- Optional options: QueryInterfaceDropAllTablesOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:330

dropDatabase

dropDatabase(name: string, options?: QueryRawOptions): Promise<void>
Creates a database
Parameters
- name: string
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:674

dropFunction

dropFunction(functionName: string, params: FunctionParam[], options?: QiOptionsWithReplacements): Promise<void>
Postgres only. Drops a function
Parameters
- functionName: string
- params: FunctionParam[]
- Optional options: QiOptionsWithReplacements
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:613

dropSchema

dropSchema(schema?: string, options?: QueryRawOptions): Promise<void>
Drops the specified schema (table).
Parameters
- Optional schema: string
  
  The schema to query. Applies only to Postgres.
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:285

dropTable

dropTable(tableName: TableName, options?: QueryInterfaceDropTableOptions): Promise<void>
Drops the specified table.
Parameters
- tableName: TableName
  
  Table name.
- Optional options: QueryInterfaceDropTableOptions
  
  Query options, particularly "force".
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:323

dropTrigger

dropTrigger(tableName: TableName, triggerName: string, options?: QiOptionsWithReplacements): Promise<void>
Postgres only. Drops the specified trigger.
Parameters
- tableName: TableName
- triggerName: string
- Optional options: QiOptionsWithReplacements
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:585

getForeignKeyReferencesForTable

getForeignKeyReferencesForTable(tableName: TableName, options?: QueryRawOptions): Promise<object>
Get foreign key references details for the table
Parameters
- tableName: TableName
- Optional options: QueryRawOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:456

getForeignKeysForTables

getForeignKeysForTables(tableNames: string[], options?: QueryRawOptions): Promise<object>
Returns all foreign key constraints of requested tables
Parameters
- tableNames: string[]
- Optional options: QueryRawOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:451

increment

increment<M>(model: ModelStatic<M>, tableName: TableName, incrementAmountsByField: object, extraAttributesToBeUpdated?: object, where?: WhereOptions<Attributes<M>>, options?: QiArithmeticOptions): Promise<object>
Increments a row value
Type Parameters
- M extends Model<any, any, M>
Parameters
- model: ModelStatic<M>
- tableName: TableName
- incrementAmountsByField: object
- Optional extraAttributesToBeUpdated: object
- Optional where: WhereOptions<Attributes<M>>
- Optional options: QiArithmeticOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:534

insert

insert(instance: null | Model<any, any>, tableName: string, values: object, options?: QiInsertOptions): Promise<object>
Inserts a new record
Parameters
- instance: null | Model<any, any>
- tableName: string
- values: object
- Optional options: QiInsertOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:461

listDatabases

listDatabases(options?: QueryRawOptions): Promise<DatabaseDescription[]>
Lists all available databases
Parameters
- Optional options: QueryRawOptions
Returns Promise<DatabaseDescription[]>
- Defined in types/dialects/abstract/query-interface.d.ts:679

nameIndexes

nameIndexes(indexes: string[], rawTablename: string): Promise<void>
Put a name to an index
Parameters
- indexes: string[]
- rawTablename: string
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:446

quoteIdentifier

quoteIdentifier(identifier: string, force?: boolean): string
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
- Optional force: boolean
Returns string
- Defined in types/dialects/abstract/query-interface.d.ts:629

quoteIdentifiers

quoteIdentifiers(identifiers: string): string
Split an identifier into .-separated tokens and quote each part.
Parameters
- identifiers: string
Returns string
- Defined in types/dialects/abstract/query-interface.d.ts:634

rawSelect

rawSelect(tableName: TableName, options: QiSelectOptions, attributeSelector: string, model?: ModelStatic<Model<any, any>>): Promise<string[]>
Selects raw without parsing the string into an object
Parameters
- tableName: TableName
- options: QiSelectOptions
- attributeSelector: string
- Optional model: ModelStatic<Model<any, any>>
Returns Promise<string[]>
- Defined in types/dialects/abstract/query-interface.d.ts:558

removeColumn

removeColumn(table: TableName, attribute: string, options?: QiOptionsWithReplacements): Promise<void>
Removes a column from a table
Parameters
- table: TableName
- attribute: string
- Optional options: QiOptionsWithReplacements
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:378

removeConstraint

removeConstraint(tableName: TableName, constraintName: string, options?: QueryRawOptions): Promise<void>
Removes constraints from a table
Parameters
- tableName: TableName
- constraintName: string
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:436

removeIndex

removeIndex(tableName: TableName, indexName: string, options?: QueryInterfaceIndexOptions): Promise<void>
Removes an index of a table
Parameters
- tableName: TableName
- indexName: string
- Optional options: QueryInterfaceIndexOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:422
removeIndex(tableName: TableName, attributes: string[], options?: QueryInterfaceIndexOptions): Promise<void>
Parameters
- tableName: TableName
- attributes: string[]
- Optional options: QueryInterfaceIndexOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:423

renameColumn

renameColumn(tableName: TableName, attrNameBefore: string, attrNameAfter: string, options?: QiOptionsWithReplacements): Promise<void>
Renames a column
Parameters
- tableName: TableName
- attrNameBefore: string
- attrNameAfter: string
- Optional options: QiOptionsWithReplacements
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:397

renameFunction

renameFunction(oldFunctionName: string, params: FunctionParam[], newFunctionName: string, options?: QiOptionsWithReplacements): Promise<void>
Postgres only. Rename a function
Parameters
- oldFunctionName: string
- params: FunctionParam[]
- newFunctionName: string
- Optional options: QiOptionsWithReplacements
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:618

renameTable

renameTable(before: TableName, after: TableName, options?: QueryRawOptions): Promise<void>
Renames a table
Parameters
- before: TableName
- after: TableName
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:342

renameTrigger

renameTrigger(tableName: TableName, oldTriggerName: string, newTriggerName: string, options?: QiOptionsWithReplacements): Promise<void>
Postgres only. Renames a trigger
Parameters
- tableName: TableName
- oldTriggerName: string
- newTriggerName: string
- Optional options: QiOptionsWithReplacements
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:590

rollbackTransaction

rollbackTransaction(transaction: Transaction, options?: QueryRawOptions): Promise<void>
Rollback ( revert ) a transaction that has'nt been commited
Parameters
- transaction: Transaction
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:664

select

select(model: null | ModelStatic<Model<any, any>>, tableName: TableName, options?: QiSelectOptions): Promise<object[]>
Returns selected rows
Parameters
- model: null | ModelStatic<Model<any, any>>
- tableName: TableName
- Optional options: QiSelectOptions
Returns Promise<object[]>
- Defined in types/dialects/abstract/query-interface.d.ts:529

setAutocommit

setAutocommit(transaction: Transaction, value: boolean, options?: QueryRawOptions): Promise<void>
Set option for autocommit of a transaction
Parameters
- transaction: Transaction
- value: boolean
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:639

setIsolationLevel

setIsolationLevel(transaction: Transaction, value: string, options?: QueryRawOptions): Promise<void>
Set the isolation level of a transaction
Parameters
- transaction: Transaction
- value: string
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:644

showAllSchemas

showAllSchemas(options?: QueryRawOptions): Promise<object>
Queries all table names in the database.
Parameters
- Optional options: QueryRawOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:297

showAllTables

showAllTables(options?: QueryRawOptions): Promise<string[]>
Returns all tables
Parameters
- Optional options: QueryRawOptions
Returns Promise<string[]>
- Defined in types/dialects/abstract/query-interface.d.ts:347

showIndex

showIndex(tableName: string | object, options?: QueryRawOptions): Promise<object>
Shows the index of a table
Parameters
- tableName: string | object
- Optional options: QueryRawOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:441

startTransaction

startTransaction(transaction: Transaction, options?: QueryRawOptions): Promise<void>
Begin a new transaction
Parameters
- transaction: Transaction
- Optional options: QueryRawOptions
Returns Promise<void>
- Defined in types/dialects/abstract/query-interface.d.ts:649

tableExists

tableExists(tableName: TableName, options?: QueryRawOptions): Promise<boolean>
Returns a promise that resolves to true if the table exists in the database, false otherwise.
Parameters
- tableName: TableName
  
  The name of the table
- Optional options: QueryRawOptions
  
  Options passed to query
Returns Promise<boolean>
- Defined in types/dialects/abstract/query-interface.d.ts:355

update

update<M>(instance: M, tableName: TableName, values: object, where: WhereOptions<Attributes<M>>, options?: QiUpdateOptions): Promise<object>
Updates a row
Type Parameters
- M extends Model<any, any, M>
Parameters
- instance: M
- tableName: TableName
- values: object
- where: WhereOptions<Attributes<M>>
- Optional options: QiUpdateOptions
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:487

upsert

upsert<M>(tableName: TableName, insertValues: object, updateValues: object, where: object, options?: QiUpsertOptions<M>): Promise<object>
Inserts or Updates a record in the database
Type Parameters
- M extends Model<any, any, M>
Parameters
- tableName: TableName
- insertValues: object
- updateValues: object
- where: object
- Optional options: QiUpsertOptions<M>
Returns Promise<object>
- Defined in types/dialects/abstract/query-interface.d.ts:466

Class QueryInterface

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sequelize: Sequelize

Returns QueryInterface

Properties

queryGenerator

sequelize

Methods

addColumn

Parameters

table: TableName

key: string

attribute: DataTypes.DataType | ModelAttributeColumnOptions<Model<any, any>>

Optional options: QiOptionsWithReplacements

Returns Promise<void>

addConstraint

Parameters

tableName: TableName

Optional options: Object

Returns Promise<void>

addIndex

Parameters

tableName: TableName

attributes: string[]

Optional options: QueryInterfaceIndexOptions

Optional rawTablename: string

Returns Promise<void>

Parameters

tableName: TableName

Optional benchmark?: boolean

Optional bind?: BindOrReplacements

Optional concurrently?: boolean

Default

Optional fieldMap?: FieldMap

fields: (string | Fn | Literal | IndexField)[]

Optional instance?: Model<any, any>

Optional logging?: boolean | ((sql: string, timing?: number) => void)

Optional mapToModel?: boolean

Optional name?: string

Optional nest?: boolean

Default

Optional operator?: string

Optional parser?: null | string

Optional plain?: boolean

Optional prefix?: string

Optional raw?: boolean

Optional replacements?: { [key: string]: unknown; }

[key: string]: unknown

Optional retry?: RetryOptions

Optional transaction?: null | Transaction

Optional type?: IndexType

Optional unique?: boolean

Default

Optional useMaster?: boolean

Default

Optional using?: string

Optional where?: WhereOptions<any>

Optional rawTablename: string

Returns Promise<void>

bulkDelete

Parameters

tableName: TableName

identifier: WhereOptions<any>

Optional options: QiOptionsWithReplacements

Optional model: ModelStatic<Model<any, any>>

Returns Promise<object>

bulkInsert

Parameters

tableName: TableName

records: object[]

Optional options: QiOptionsWithReplacements

Optional attributes: Record<string, ModelAttributeColumnOptions<Model<any, any>>>

Returns Promise<number | object>

`Optional` options: QiOptionsWithReplacements

`Optional` options: Object

`Optional` options: QueryInterfaceIndexOptions

`Optional` rawTablename: string

`Optional` benchmark?: boolean

`Optional` bind?: BindOrReplacements

`Optional` concurrently?: boolean

`Optional` fieldMap?: FieldMap

`Optional` instance?: Model<any, any>

`Optional` logging?: boolean | ((sql: string, timing?: number) => void)

`Optional` mapToModel?: boolean

`Optional` name?: string

`Optional` nest?: boolean

`Optional` operator?: string

`Optional` parser?: null | string

`Optional` plain?: boolean

`Optional` prefix?: string

`Optional` raw?: boolean

`Optional` replacements?: {
[key: string]: unknown;
}

`Optional` retry?: RetryOptions

`Optional` transaction?: null | Transaction

`Optional` type?: IndexType

`Optional` unique?: boolean

`Optional` useMaster?: boolean

`Optional` using?: string

`Optional` where?: WhereOptions<any>

`Optional` rawTablename: string

`Optional` options: QiOptionsWithReplacements

`Optional` model: ModelStatic<Model<any, any>>

`Optional` options: QiOptionsWithReplacements

`Optional` attributes: Record<string, ModelAttributeColumnOptions<Model<any, any>>>

`Optional` options: QiOptionsWithReplacements

`Optional` columnDefinitions: {
[columnName: string]: BuiltModelAttributeColumOptions;
}

`Optional` dataTypeOrOptions: DataTypes.DataType | ModelAttributeColumnOptions<Model<any, any>>

`Optional` options: QiOptionsWithReplacements

`Optional` options: QueryRawOptions

`Optional` options: CreateDatabaseOptions

`Optional` optionsArray: string[]

`Optional` options: CreateFunctionOptions

`Optional` schema: string

`Optional` options: QueryRawOptions

`Optional` options: QueryInterfaceCreateTableOptions

fireOnArray: {
[key: string]: unknown;
}[]

`Optional` options: QiOptionsWithReplacements

`Optional` options: QueryRawOptions