@sequelize/core/lib/expression-builders/identifier.d.ts

Sequelize is a promise-based Node.js ORM tool for Postgres, MySQL, MariaDB, SQLite, Microsoft SQL Server, Amazon Redshift, Snowflake’s Data Cloud, Db2, and IBM i. It features solid transaction support, relations, eager and lazy loading, read replication a

import type { TableOrModel } from '../abstract-dialect/query-generator.types';
import { BaseSqlExpression, SQL_IDENTIFIER } from './base-sql-expression.js';
/**
 * Use {@link sql.identifier} instead.
 */
export declare class Identifier extends BaseSqlExpression {
    readonly values: Array<string | TableOrModel>;
    protected readonly [SQL_IDENTIFIER]: 'identifier';
    constructor(values: Array<string | TableOrModel>);
}
/**
 * Used to represent a value that will either be escaped to a literal, or a bind parameter.
 * Unlike {@link sql.attribute} and {@link sql.col}, this identifier will be escaped as-is,
 * without mapping to a column name or any other transformation.
 *
 * This method supports strings, table structures, model classes (in which case the identifiers will be the model schema & table name), and model definitions (same behavior as model classes)
 *
 * @param values The identifiers to escape. Automatically joins them with a period (`.`).
 * @example
 * ```ts
 * sequelize.query(sql`SELECT * FROM users WHERE ${identifier('firstName')} = 'John'`);
 * ```
 *
 * Will generate (identifier quoting depending on the dialect):
 *
 * ```sql
 * SELECT * FROM users WHERE "firstName" = 'John'
 * ```
 */
export declare function identifier(...values: Array<string | TableOrModel>): Identifier;