admindb 1.2.1 → 2.1.0

package/dist/db/postgres.d.ts

@@ -0,0 +1,85 @@
+import type { Logger } from '../utils/logger';
+import { type ColumnDef, type IndexDef } from '../sql/generator';
+import type { DatabaseDialect, IDatabase, MutationResult, PostgresOptions, QueryOptions, ReferencingTableInfo, Result, RowFilters, SavedQuery, SchemaInfo, SQLInputValue, TableInfoData, TableListItem, WhereClause } from './types';
+export declare class PostgresDatabase implements IDatabase {
+    private pool;
+    private logger;
+    readonly path: string;
+    readonly isReadOnly: boolean;
+    readonly dialect: DatabaseDialect;
+    readonly schema: string;
+    constructor(connection: string | PostgresOptions, logger: Logger, options?: PostgresOptions);
+    private sanitizeConnectionString;
+    private readonlyBlocked;
+    close(): Promise<void>;
+    private tryRun;
+    /** Run a callback inside an atomic transaction on a dedicated client. */
+    private transaction;
+    private initSchema;
+    hasMultipleStatements(sql: string): boolean;
+    all(sql: string, params?: SQLInputValue[]): Promise<Result<unknown[]>>;
+    run(sql: string, params?: SQLInputValue[]): Promise<Result<MutationResult>>;
+    execResult(sql: string): Promise<Result<{
+        changes?: number;
+    }>>;
+    runWrite(sql: string): Promise<Result<{
+        changes?: number;
+    }>>;
+    listTables(): Promise<Result<TableListItem[]>>;
+    getTableInfo(table: string): Promise<Result<TableInfoData>>;
+    getRowCount(table: string, filters?: RowFilters): Promise<Result<number>>;
+    getRows(table: string, opts?: QueryOptions): Promise<Result<Record<string, unknown>[]>>;
+    getAllRows(table: string): Promise<Result<Record<string, unknown>[]>>;
+    getRow(table: string, where: WhereClause[]): Promise<Result<Record<string, unknown> | null>>;
+    insertRow(table: string, fields: WhereClause[]): Promise<Result<MutationResult>>;
+    insertRows(table: string, rows: WhereClause[][]): Promise<Result<{
+        inserted: number;
+        skipped: number;
+    }>>;
+    updateRow(table: string, fields: WhereClause[], where: WhereClause[]): Promise<Result<MutationResult>>;
+    updateRows(table: string, rows: {
+        fields: WhereClause[];
+        where: WhereClause[];
+    }[]): Promise<Result<{
+        updated: number;
+    }>>;
+    deleteRow(table: string, where: WhereClause[]): Promise<Result<MutationResult>>;
+    deleteRows(table: string, rows: WhereClause[][]): Promise<Result<{
+        deleted: number;
+    }>>;
+    getRowsByPks(table: string, pks: WhereClause[][]): Promise<Result<Record<string, unknown>[]>>;
+    getRowsByFk(table: string, column: string, value: unknown, limit?: number): Promise<Result<{
+        rows: Record<string, unknown>[];
+        total: number;
+    }>>;
+    getCreateStatement(table: string): Promise<Result<string | null>>;
+    listSavedQueries(): Promise<Result<SavedQuery[]>>;
+    saveQuery(name: string, sql: string): Promise<Result<MutationResult>>;
+    deleteSavedQuery(id: string | number): Promise<Result<MutationResult>>;
+    getSchema(table: string): Promise<Result<SchemaInfo>>;
+    getReferencingTables(table: string): Promise<Result<ReferencingTableInfo[]>>;
+    renameTable(oldName: string, newName: string): Promise<Result<{
+        changes?: number;
+    }>>;
+    addColumn(table: string, col: ColumnDef): Promise<Result<{
+        changes?: number;
+    }>>;
+    modifyColumn(table: string, oldColName: string, newColDef: ColumnDef): Promise<Result<{
+        changes?: number;
+    }>>;
+    renameColumn(table: string, oldName: string, newName: string): Promise<Result<{
+        changes?: number;
+    }>>;
+    dropColumn(table: string, column: string): Promise<Result<{
+        changes?: number;
+    }>>;
+    dropTable(table: string): Promise<Result<{
+        changes?: number;
+    }>>;
+    createIndex(table: string, index: IndexDef): Promise<Result<{
+        changes?: number;
+    }>>;
+    dropIndex(indexName: string): Promise<Result<{
+        changes?: number;
+    }>>;
+}