UNPKG

drizzle-orm

Version:

Drizzle ORM package for SQL databases

51 lines (50 loc) 3.23 kB
import type { Row, RowList, Sql, TransactionSql } from 'postgres'; import { entityKind } from "../entity.cjs"; import type { Logger } from "../logger.cjs"; import type { PgDialect } from "../pg-core/dialect.cjs"; import { PgTransaction } from "../pg-core/index.cjs"; import type { SelectedFieldsOrdered } from "../pg-core/query-builders/select.types.cjs"; import type { PgQueryResultHKT, PgTransactionConfig, PreparedQueryConfig } from "../pg-core/session.cjs"; import { PgPreparedQuery, PgSession } from "../pg-core/session.cjs"; import type { RelationalSchemaConfig, TablesRelationalConfig } from "../relations.cjs"; import { type Query } from "../sql/sql.cjs"; import { type Assume } from "../utils.cjs"; export declare class PostgresJsPreparedQuery<T extends PreparedQueryConfig> extends PgPreparedQuery<T> { private client; private queryString; private params; private logger; private fields; private _isResponseInArrayMode; private customResultMapper?; static readonly [entityKind]: string; constructor(client: Sql, queryString: string, params: unknown[], logger: Logger, fields: SelectedFieldsOrdered | undefined, _isResponseInArrayMode: boolean, customResultMapper?: ((rows: unknown[][]) => T["execute"]) | undefined); execute(placeholderValues?: Record<string, unknown> | undefined): Promise<T['execute']>; all(placeholderValues?: Record<string, unknown> | undefined): Promise<T['all']>; } export interface PostgresJsSessionOptions { logger?: Logger; } export declare class PostgresJsSession<TSQL extends Sql, TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends PgSession<PostgresJsQueryResultHKT, TFullSchema, TSchema> { client: TSQL; private schema; static readonly [entityKind]: string; logger: Logger; constructor(client: TSQL, dialect: PgDialect, schema: RelationalSchemaConfig<TSchema> | undefined, /** @internal */ options?: PostgresJsSessionOptions); prepareQuery<T extends PreparedQueryConfig = PreparedQueryConfig>(query: Query, fields: SelectedFieldsOrdered | undefined, name: string | undefined, isResponseInArrayMode: boolean, customResultMapper?: (rows: unknown[][]) => T['execute']): PgPreparedQuery<T>; query(query: string, params: unknown[]): Promise<RowList<Row[]>>; queryObjects<T extends Row>(query: string, params: unknown[]): Promise<RowList<T[]>>; transaction<T>(transaction: (tx: PostgresJsTransaction<TFullSchema, TSchema>) => Promise<T>, config?: PgTransactionConfig): Promise<T>; } export declare class PostgresJsTransaction<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends PgTransaction<PostgresJsQueryResultHKT, TFullSchema, TSchema> { static readonly [entityKind]: string; constructor(dialect: PgDialect, /** @internal */ session: PostgresJsSession<TransactionSql, TFullSchema, TSchema>, schema: RelationalSchemaConfig<TSchema> | undefined, nestedIndex?: number); transaction<T>(transaction: (tx: PostgresJsTransaction<TFullSchema, TSchema>) => Promise<T>): Promise<T>; } export interface PostgresJsQueryResultHKT extends PgQueryResultHKT { type: RowList<Assume<this['row'], Row>[]>; }