Class PostgresQueryGenerator

Readonlydialect

__TEST__getInternals

• __TEST__getInternals(): AbstractQueryGeneratorInternal<
      AbstractDialect<object, object>,
  >

  Returns AbstractQueryGeneratorInternal<AbstractDialect<object, object>>

addColumnQuery

• addColumnQuery(
      table: TableName,
      columnName: string,
      columnDefinition: DataType | AttributeOptions<Model<any, any>>,
      options?: AddColumnQueryOptions,
  ): string

  Parameters

  • table: TableName
  • columnName: string
  • columnDefinition: DataType | AttributeOptions<Model<any, any>>
  • Optionaloptions: AddColumnQueryOptions

  Returns string

addConstraintQuery

• addConstraintQuery(
      tableName: TableOrModel,
      options: AddConstraintQueryOptions,
  ): string

  Parameters

  • tableName: TableOrModel
  • options: AddConstraintQueryOptions

  Returns string

addIndexQuery

• addIndexQuery(
      tableName: TableName,
      attributes: (string | Fn | Literal | IndexField)[],
      options?: AddIndexQueryOptions,
      rawTablename?: string,
  ): string

  Parameters

  • tableName: TableName

    The table to add the index to

  • attributes: (string | Fn | Literal | IndexField)[]

    The columns to index. Can also be passed as options.fields

  • Optionaloptions: AddIndexQueryOptions
  • OptionalrawTablename: string

    The name of the table without its schema, used to generate the index name

  Returns string

• addIndexQuery(
      tableName: TableName,
      options: AddIndexQueryOptions & Required<Pick<IndexOptions, "fields">>,
  ): string

  Parameters

  • tableName: TableName

    The table to add the index to

  • options: AddIndexQueryOptions & Required<Pick<IndexOptions, "fields">>

  Returns string

arithmeticQuery

• arithmeticQuery(
      operator: string,
      tableName: TableName,
      where: WhereOptions,
      incrementAmountsByField: { [key: string]: number | Literal },
      extraAttributesToBeUpdated: { [key: string]: unknown },
      options?: ArithmeticQueryOptions,
  ): string

  Parameters

  • operator: string
  • tableName: TableName
  • where: WhereOptions
  • incrementAmountsByField: { [key: string]: number | Literal }
  • extraAttributesToBeUpdated: { [key: string]: unknown }
  • Optionaloptions: ArithmeticQueryOptions

  Returns string

assertTypeCanBeUnique

• assertTypeCanBeUnique(
      columnName: string | undefined,
      type: string | AbstractDataType<any>,
      options?: UniqueTypeOptions,
  ): void

  Throws if columns of this type cannot be unique in this dialect, to throw a clear error instead of the one of the database.

  Parameters

  • columnName: string | undefined

    The name of the column

  • type: string | AbstractDataType<any>

    The type of the column

  • Optionaloptions: UniqueTypeOptions

    The length of the prefix of the column that is part of the unique index, if any (prefixLength)

  Returns void

attributesToSql

• attributesToSql(
      columns: AttributesToSqlColumns,
      options?: AttributeToSqlOptions,
  ): Record<string, string>

  Generates the SQL fragment declaring each of the given columns, keyed by column name.

  Parameters

  • columns: AttributesToSqlColumns

    a map of column descriptions, keyed by attribute name

  • Optionaloptions: AttributeToSqlOptions

  Returns Record<string, string>

attributeToSql

• attributeToSql(
      column: AttributeToSqlInput,
      options?: AttributeToSqlOptions,
  ): string

  Generates the SQL fragment that declares a single column, without its name.

  Every dialect implements this. It lives here because attributesToSql calls it.

  Parameters

  • column: AttributeToSqlInput

    a column description, or the data type of a column

  • Optionaloptions: AttributeToSqlOptions

  Returns string

bulkDeleteQuery

• bulkDeleteQuery(
      tableOrModel: TableOrModel,
      options: BulkDeleteQueryOptions,
  ): string

  Parameters

  • tableOrModel: TableOrModel
  • options: BulkDeleteQueryOptions

  Returns string

bulkInsertQuery

• bulkInsertQuery(
      tableName: TableName,
      newEntries: object[],
      options?: BulkInsertOptions,
      columnDefinitions?: {
          [columnName: string]: NormalizedAttributeOptions<Model<any, any>>;
      },
  ): string

  Parameters

  • tableName: TableName
  • newEntries: object[]
  • Optionaloptions: BulkInsertOptions
  • OptionalcolumnDefinitions: { [columnName: string]: NormalizedAttributeOptions<Model<any, any>> }

  Returns string

commitTransactionQuery

• commitTransactionQuery(): string

  Returns a query that commits a transaction.

  Returns string

createDatabaseQuery

• createDatabaseQuery(
      database: string,
      options?: CreateDatabaseQueryOptions,
  ): string

  Parameters

  • database: string
  • Optionaloptions: CreateDatabaseQueryOptions

  Returns string

createSavepointQuery

• createSavepointQuery(savepointName: string): string

  Returns a query that creates a savepoint.

  Parameters

  • savepointName: string

  Returns string

createSchemaQuery

• createSchemaQuery(
      schemaName: string,
      options?: CreateSchemaQueryOptions,
  ): string

  Parameters

  • schemaName: string
  • Optionaloptions: CreateSchemaQueryOptions

  Returns string

createTableQuery

• createTableQuery(
      tableName: TableOrModel,
      columns: { [columnName: string]: string },
      options?: CreateTableQueryOptions,
  ): string

  Parameters

  • tableName: TableOrModel
  • columns: { [columnName: string]: string }
  • Optionaloptions: CreateTableQueryOptions

  Returns string

describeTableQuery

• describeTableQuery(tableName: TableOrModel): string

  Parameters

  • tableName: TableOrModel

  Returns string

dropDatabaseQuery

• dropDatabaseQuery(database: string): string

  Parameters

  • database: string

  Returns string

dropForeignKeyQuery

• dropForeignKeyQuery(_tableName: TableOrModel, _foreignKey: string): Error

  Generates an SQL query that drops a foreign key constraint.

  Parameters

  • _tableName: TableOrModel

    The table or associated model.

  • _foreignKey: string

    The name of the foreign key constraint.

  Returns Error

  Deprecated

  Use removeConstraintQuery instead.

dropSchemaQuery

• dropSchemaQuery(schemaName: string, options?: DropSchemaQueryOptions): string

  Parameters

  • schemaName: string
  • Optionaloptions: DropSchemaQueryOptions

  Returns string

dropTableQuery

• dropTableQuery(tableName: TableOrModel, options?: DropTableQueryOptions): string

  Parameters

  • tableName: TableOrModel
  • Optionaloptions: DropTableQueryOptions

  Returns string

escape

• escape(value: unknown, options?: EscapeOptions): string

  Escapes a value (e.g. a string, number or date) as an SQL value (as opposed to an identifier).

  Parameters

  • value: unknown

    The value to escape

  • Optionaloptions: EscapeOptions

    The options to use when escaping the value

  Returns string

escapeList

• escapeList(values: unknown[], options?: EscapeOptions): string

  Escapes an array of values (e.g. strings, numbers or dates) as an SQL List of values.

  Parameters

  • values: unknown[]

    The list of values to escape

  • Optionaloptions: EscapeOptions

  Returns string

  Example

  const values = [1, 2, 3];
  queryGenerator.escapeList([1, 2, 3]); 
  Copy

extractTableDetails

• extractTableDetails(
      tableOrModel: TableOrModel,
      options?: { delimiter?: string; schema?: string },
  ): RequiredBy<TableNameWithSchema, "schema">

  Parameters

  • tableOrModel: TableOrModel
  • Optionaloptions: { delimiter?: string; schema?: string }

  Returns RequiredBy<TableNameWithSchema, "schema">

formatSqlExpression

• formatSqlExpression(piece: BaseSqlExpression, options?: EscapeOptions): string

  Parameters

  • piece: BaseSqlExpression
  • Optionaloptions: EscapeOptions

  Returns string

formatUnquoteJson

• formatUnquoteJson(arg: unknown, options?: EscapeOptions): string

  The goal of this method is to execute the equivalent of json_unquote for the current dialect.

  Parameters

  • arg: unknown
  • Optionaloptions: EscapeOptions

  Returns string

generateCountAllQuery

• generateCountAllQuery(query: string): string

  Parameters

  • query: string

  Returns string

generateTransactionId

• generateTransactionId(): string

  Generates a unique identifier for the current transaction.

  Returns string

getForeignKeyQuery

• getForeignKeyQuery(_tableName: TableOrModel, _columnName?: string): Error

  Generates an SQL query that returns all foreign keys of a table or the foreign key constraint of a given column.

  Parameters

  • _tableName: TableOrModel

    The table or associated model.

  • Optional_columnName: string

    The name of the column. Not supported by SQLite.

  Returns Error

  The generated SQL query.

  Deprecated

  Use showConstraintsQuery instead.

getRandomFloatFunctionCall

• getRandomFloatFunctionCall(): string

  Returns string

getToggleForeignKeyChecksQuery

• getToggleForeignKeyChecksQuery(_enable: boolean): string

  Parameters

  • _enable: boolean

  Returns string

getUuidV1FunctionCall

• getUuidV1FunctionCall(): string

  Returns string

getUuidV4FunctionCall

• getUuidV4FunctionCall(): string

  Returns string

getUuidV7FunctionCall

• getUuidV7FunctionCall(): string

  Returns string

insertQuery

• insertQuery(
      table: TableName,
      valueHash: object,
      columnDefinitions?: {
          [columnName: string]: NormalizedAttributeOptions<Model<any, any>>;
      },
      options?: InsertOptions,
  ): BoundQuery

  Parameters

  • table: TableName
  • valueHash: object
  • OptionalcolumnDefinitions: { [columnName: string]: NormalizedAttributeOptions<Model<any, any>> }
  • Optionaloptions: InsertOptions

  Returns BoundQuery

isSameTable

• isSameTable(tableA: TableOrModel, tableB: TableOrModel): boolean

  Parameters

  • tableA: TableOrModel
  • tableB: TableOrModel

  Returns boolean

jsonPathExtractionQuery

• jsonPathExtractionQuery(
      sqlExpression: string,
      path: readonly (string | number)[],
      unquote: boolean,
  ): string

  Parameters

  • sqlExpression: string
  • path: readonly (string | number)[]
  • unquote: boolean

  Returns string

listDatabasesQuery

• listDatabasesQuery(options?: ListDatabasesQueryOptions): string

  Parameters

  • Optionaloptions: ListDatabasesQueryOptions

  Returns string

listSchemasQuery

• listSchemasQuery(options?: ListSchemasQueryOptions): string

  Parameters

  • Optionaloptions: ListSchemasQueryOptions

  Returns string

listTablesQuery

• listTablesQuery(options?: ListTablesQueryOptions): string

  Parameters

  • Optionaloptions: ListTablesQueryOptions

  Returns string

quoteIdentifier

• quoteIdentifier(identifier: string, _force?: boolean): string

  Adds quotes to identifier

  Parameters

  • identifier: string
  • Optional_force: boolean

  Returns string

quoteIdentifiers

• quoteIdentifiers(identifiers: string): string

  Parameters

  • identifiers: string

  Returns string

quoteTable

• quoteTable(param: TableOrModel, options?: QuoteTableOptions): string

  Quote table name with optional alias and schema attribution

  Parameters

  • param: TableOrModel

    table string or object

  • Optionaloptions: QuoteTableOptions

    options

  Returns string

removeColumnQuery

• removeColumnQuery(
      tableName: TableOrModel,
      columnName: string,
      options?: RemoveColumnQueryOptions,
  ): string

  Parameters

  • tableName: TableOrModel
  • columnName: string
  • Optionaloptions: RemoveColumnQueryOptions

  Returns string

removeConstraintQuery

• removeConstraintQuery(
      tableName: TableOrModel,
      constraintName: string,
      options?: RemoveConstraintQueryOptions,
  ): string

  Parameters

  • tableName: TableOrModel
  • constraintName: string
  • Optionaloptions: RemoveConstraintQueryOptions

  Returns string

removeIndexQuery

• removeIndexQuery(
      tableName: TableOrModel,
      indexNameOrAttributes: string | string[],
      options?: RemoveIndexQueryOptions,
  ): string

  Parameters

  • tableName: TableOrModel
  • indexNameOrAttributes: string | string[]
  • Optionaloptions: RemoveIndexQueryOptions

  Returns string

renameTableQuery

• renameTableQuery(
      beforeTableName: TableOrModel,
      afterTableName: TableOrModel,
      options?: RenameTableQueryOptions,
  ): string

  Parameters

  • beforeTableName: TableOrModel
  • afterTableName: TableOrModel
  • Optionaloptions: RenameTableQueryOptions

  Returns string

rollbackSavepointQuery

• rollbackSavepointQuery(savepointName: string): string

  Returns a query that rollbacks a savepoint.

  Parameters

  • savepointName: string

  Returns string

rollbackTransactionQuery

• rollbackTransactionQuery(): string

  Returns a query that rollbacks a transaction.

  Returns string

selectQuery

• selectQuery<M extends Model<any, any>>(
      tableName: TableName,
      options?: SelectOptions<M>,
      model?: ModelStatic<M>,
  ): string

  Type Parameters

  • M extends Model<any, any>

  Parameters

  • tableName: TableName
  • Optionaloptions: SelectOptions<M>
  • Optionalmodel: ModelStatic<M>

  Returns string

setConstraintCheckingQuery

• setConstraintCheckingQuery(type: ConstraintChecking): string

  Parameters

  • type: ConstraintChecking

  Returns string

• setConstraintCheckingQuery(
      type: Class<ConstraintChecking>,
      constraints?: readonly string[],
  ): string

  Parameters

  • type: Class<ConstraintChecking>
  • Optionalconstraints: readonly string[]

  Returns string

setIsolationLevelQuery

• setIsolationLevelQuery(isolationLevel: IsolationLevel): string

  Returns a query that sets the transaction isolation level.

  Parameters

  • isolationLevel: IsolationLevel

  Returns string

showConstraintsQuery

• showConstraintsQuery(
      tableName: TableOrModel,
      options?: ShowConstraintsQueryOptions,
  ): string

  Parameters

  • tableName: TableOrModel
  • Optionaloptions: ShowConstraintsQueryOptions

  Returns string

showIndexesQuery

• showIndexesQuery(tableName: TableOrModel): string

  Parameters

  • tableName: TableOrModel

  Returns string

startTransactionQuery

• startTransactionQuery(options?: StartTransactionQueryOptions): string

  Returns a query that starts a transaction.

  Parameters

  • Optionaloptions: StartTransactionQueryOptions

  Returns string

tableExistsQuery

• tableExistsQuery(tableName: TableOrModel): string

  Parameters

  • tableName: TableOrModel

  Returns string

truncateTableQuery

• truncateTableQuery(
      tableName: TableOrModel,
      options?: TruncateTableQueryOptions,
  ): string

  Parameters

  • tableName: TableOrModel
  • Optionaloptions: TruncateTableQueryOptions

  Returns string

updateQuery

• updateQuery(
      tableName: TableName,
      attrValueHash: object,
      where: WhereOptions,
      options?: UpdateOptions,
      columnDefinitions?: {
          [columnName: string]: NormalizedAttributeOptions<Model<any, any>>;
      },
  ): BoundQuery

  Parameters

  • tableName: TableName
  • attrValueHash: object
  • where: WhereOptions
  • Optionaloptions: UpdateOptions
  • OptionalcolumnDefinitions: { [columnName: string]: NormalizedAttributeOptions<Model<any, any>> }

  Returns BoundQuery

versionQuery

• versionQuery(): string

  Returns string

whereItemsQuery

• whereItemsQuery<M extends Model<any, any>>(
      where: WhereOptions<Attributes<M>>,
      options?: FormatWhereOptions,
  ): string

  Type Parameters

  • M extends Model<any, any>

  Parameters

  • where: WhereOptions<Attributes<M>>
  • Optionaloptions: FormatWhereOptions

  Returns string

whereQuery

• whereQuery<M extends Model<any, any>>(
      where: WhereOptions<Attributes<M>>,
      options?: FormatWhereOptions,
  ): string

  Type Parameters

  • M extends Model<any, any>

  Parameters

  • where: WhereOptions<Attributes<M>>
  • Optionaloptions: FormatWhereOptions

  Returns string