指南 参考 源代码
public class | source

PostgresQueryInterface

扩展

QueryInterface → PostgresQueryInterface

Sequelize 用于与 Postgres 数据库交互的接口

方法摘要

公共方法
public

async dropAllEnums(options: object): Promise

从数据库中删除所有枚举(仅限 Postgres)

public

异步 dropEnum(enumName: 字符串, options: 对象): Promise

从数据库中删除指定的枚举类型 (仅限 Postgres)

public

异步 dropTable(tableName: *, options: *)

由于 Postgres 对枚举类型有特殊处理,因此应该在表和属性中删除相关的枚举类型

public

异步 getForeignKeyReferencesForTable(table: *, options: *): *

public

异步 pgListEnums(tableName: 字符串, options: 对象): Promise

列出所有枚举类型 (仅限 Postgres)

继承摘要

从类 QueryInterface
public

异步 addColumn(table: 字符串, key: 字符串, attribute: 对象, options: 对象): Promise

向表格添加新列

public

异步 addConstraint(tableName: 字符串, options: 对象): Promise

向表格添加约束

public

异步 addIndex(tableName: 字符串 | 对象, attributes: 数组, options: 对象, rawTablename: 字符串): Promise

向列添加索引

public

异步 bulkDelete(tableName: 字符串, where: 对象, options: 对象, model: Model): Promise

从表格中删除多条记录

public

异步 bulkInsert(tableName: 字符串, records: 数组, options: 对象, attributes: 对象): Promise

向表格中插入多条记录

public

异步 bulkUpdate(tableName: 字符串, values: 对象, identifier: 对象, options: 对象, attributes: 对象): Promise

更新表格中的多条记录

public

异步 changeColumn(tableName: 字符串, attributeName: 字符串, dataTypeOrOptions: 对象, options: 对象): *

更改列定义

public

异步 createDatabase(database: 字符串, options: 对象): Promise

创建数据库

public

异步 createFunction(functionName: 字符串, params: 数组, returnType: 字符串, language: 字符串, body: 字符串, optionsArray: 数组, options: 对象): Promise

创建 SQL 函数

public

异步 createSchema(schema: 字符串, options: 对象): Promise

创建模式

public

异步 createTable(tableName: 字符串, attributes: 对象, options: 对象, model: Model): Promise

使用给定的属性集创建表格

public

异步 describeTable(tableName: 字符串, options: 对象): Promise<对象>

描述表格结构

public

异步 dropAllSchemas(options: 对象): Promise

删除所有模式

public

异步 dropAllTables(options: 对象): Promise

从数据库中删除所有表格

public

异步 dropDatabase(database: 字符串, options: 对象): Promise

删除数据库

public

异步 dropFunction(functionName: 字符串, params: 数组, options: 对象): Promise

删除 SQL 函数

public

异步 dropSchema(schema: 字符串, options: 对象): Promise

删除模式

public

异步 dropTable(tableName: 字符串, options: 对象): Promise

从数据库中删除表格

public

异步 getForeignKeyReferencesForTable(tableName: 字符串, options: 对象): *

获取表的外键引用详细信息

public

异步 getForeignKeysForTables(tableNames: 字符串[], options: 对象): Promise

返回请求表的全部外键约束

public

通过 "." 拆分标识符列表并引用每个部分

public

通过 "." 拆分标识符列表并引用每个部分。

public

异步 removeColumn(tableName: 字符串, attributeName: 字符串, options: 对象): *

从表中删除列

public

异步 removeConstraint(tableName: 字符串, constraintName: 字符串, options: 对象): *

从表中删除约束

public

异步 removeIndex(tableName: 字符串, indexNameOrAttributes: 字符串 | 字符串[], options: 对象): Promise

从表中删除已存在的索引

public

异步 renameColumn(tableName: 字符串, attrNameBefore: 字符串, attrNameAfter: 字符串, options: 对象): Promise

重命名列

public

异步 renameFunction(oldFunctionName: 字符串, params: 数组, newFunctionName: 字符串, options: 对象): Promise

重命名 SQL 函数

public

异步 renameTable(before: 字符串, after: 字符串, options: 对象): Promise

重命名表

public

异步 showAllSchemas(options: 对象): Promise<数组>

显示所有模式

public

异步 tableExists(tableName: TableName, options: QueryOptions): Promise<布尔值>

返回一个 Promise,如果表存在于数据库中,则解析为 true,否则解析为 false。

public

异步 upsert(tableName: 字符串, insertValues: 对象, updateValues: 对象, where: 对象, options: 对象): Promise<布尔值, ?数字>

Upsert

公共方法

公开 异步 dropAllEnums(options: 对象): Promise 来源

从数据库中删除所有枚举(仅限 Postgres)

参数

名称类型属性描述
options 对象

查询选项

返回

Promise

公开 异步 dropEnum(enumName: 字符串, options: 对象): Promise 来源

从数据库中删除指定的枚举类型 (仅限 Postgres)

参数

名称类型属性描述
enumName 字符串
  • 可选

要删除的枚举名称

options 对象

查询选项

返回

Promise

公开 异步 dropTable(tableName: *, options: *) 来源

由于 Postgres 对枚举类型有特殊处理,因此应该在表和属性中删除相关的枚举类型

覆盖

QueryInterface#dropTable

参数

名称类型属性描述
tableName *
options *

公开 异步 getForeignKeyReferencesForTable(table: *, options: *): * 来源

获取表的外键引用详细信息

这些详细信息包含 constraintSchema、constraintName、constraintCatalog tableCatalog、tableSchema、tableName、columnName、referencedTableCatalog、referencedTableCatalog、referencedTableSchema、referencedTableName、referencedColumnName。提醒:如果它是 sqlite,则不会返回约束信息。

覆盖

QueryInterface#getForeignKeyReferencesForTable

参数

名称类型属性描述
table *
options *

返回

*

公开 异步 pgListEnums(tableName: 字符串, options: 对象): Promise 来源

列出所有枚举类型 (仅限 Postgres)

参数

名称类型属性描述
tableName 字符串
  • 可选

要列出其枚举的表

options 对象
  • 可选

查询选项

返回

Promise