@nymphjs/driver-postgresql 1.0.0-beta.11 → 1.0.0-beta.110

package/dist/PostgreSQLDriver.d.ts

@@ -1,6 +1,6 @@
-import { Pool, PoolClient } from 'pg';
-import { NymphDriver, EntityConstructor, EntityInterface, FormattedSelector, Options, Selector } from '@nymphjs/nymph';
-import { PostgreSQLDriverConfig } from './conf';
+import type { Pool, PoolClient } from 'pg';
+import { NymphDriver, type EntityConstructor, type EntityObjectType, type EntityInterface, type EntityInstanceType, type SerializedEntityData, type FormattedSelector, type Options, type Selector } from '@nymphjs/nymph';
+import { PostgreSQLDriverConfig } from './conf/index.js';
 type PostgreSQLDriverConnection = {
     client: PoolClient;
     done: () => void;
@@ -9,6 +9,9 @@ type PostgreSQLDriverTransaction = {
     connection: PostgreSQLDriverConnection | null;
     count: number;
 };
+/**
+ * The PostgreSQL Nymph database driver.
+ */
 export default class PostgreSQLDriver extends NymphDriver {
     config: PostgreSQLDriverConfig;
     private postgresqlConfig;
@@ -18,55 +21,139 @@ export default class PostgreSQLDriver extends NymphDriver {
     protected transaction: PostgreSQLDriverTransaction | null;
     static escape(input: string): string;
     static escapeValue(input: string): string;
+    static escapeNullSequences(input: string): string;
+    static unescapeNullSequences(input: string): string;
+    static escapeNulls(input: string): string;
+    static unescapeNulls(input: string): string;
     constructor(config: Partial<PostgreSQLDriverConfig>, link?: Pool, transaction?: PostgreSQLDriverTransaction);
+    /**
+     * This is used internally by Nymph. Don't call it yourself.
+     *
+     * @returns A clone of this instance.
+     */
     clone(): PostgreSQLDriver;
     private getConnection;
+    /**
+     * Connect to the PostgreSQL database.
+     *
+     * @returns Whether this instance is connected to a PostgreSQL database.
+     */
     connect(): Promise<true>;
+    /**
+     * Disconnect from the PostgreSQL database.
+     *
+     * @returns Whether this instance is connected to a PostgreSQL database.
+     */
     disconnect(): Promise<false>;
     inTransaction(): Promise<boolean>;
+    /**
+     * Check connection status.
+     *
+     * @returns Whether this instance is connected to a PostgreSQL database.
+     */
     isConnected(): boolean;
+    private createEntitiesTable;
+    private addTilmeldColumnsAndIndexes;
+    private createEntitiesTilmeldIndexes;
+    private createDataTable;
+    private createReferencesTable;
+    private createTokensTable;
+    private createUniquesTable;
+    /**
+     * Create entity tables in the database.
+     *
+     * @param etype The entity type to create a table for. If this is blank, the default tables are created.
+     * @returns True on success, false on failure.
+     */
     private createTables;
     private translateQuery;
     private query;
-    private querySync;
+    private queryArray;
     private queryIter;
-    private queryIterSync;
     private queryGet;
     private queryRun;
-    private queryRunSync;
     commit(name: string): Promise<boolean>;
     deleteEntityByID(guid: string, className?: EntityConstructor | string | null): Promise<boolean>;
     deleteUID(name: string): Promise<boolean>;
-    protected exportEntities(writeLine: (line: string) => void): Promise<void>;
+    getIndexes(etype: string): Promise<{
+        scope: "data" | "references" | "tokens";
+        name: string;
+        property: string;
+    }[]>;
+    addIndex(etype: string, definition: {
+        scope: 'data' | 'references' | 'tokens';
+        name: string;
+        property: string;
+    }): Promise<boolean>;
+    deleteIndex(etype: string, scope: 'data' | 'references' | 'tokens', name: string): Promise<boolean>;
+    getEtypes(): Promise<string[]>;
+    exportDataIterator(): AsyncGenerator<{
+        type: 'comment' | 'uid' | 'entity';
+        content: string;
+    }, void, false | undefined>;
+    /**
+     * Generate the PostgreSQL query.
+     * @param options The options array.
+     * @param formattedSelectors The formatted selector array.
+     * @param etype
+     * @param count Used to track internal params.
+     * @param params Used to store internal params.
+     * @param subquery Whether only a subquery should be returned.
+     * @returns The SQL query.
+     */
     private makeEntityQuery;
     protected performQuery(options: Options, formattedSelectors: FormattedSelector[], etype: string): {
         result: any;
     };
-    protected performQuerySync(options: Options, formattedSelectors: FormattedSelector[], etype: string): {
-        result: any;
-    };
     getEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
         return: 'count';
     }, ...selectors: Selector[]): Promise<number>;
     getEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
         return: 'guid';
     }, ...selectors: Selector[]): Promise<string[]>;
-    getEntities<T extends EntityConstructor = EntityConstructor>(options?: Options<T>, ...selectors: Selector[]): Promise<ReturnType<T['factorySync']>[]>;
-    protected getEntitiesSync<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
-        return: 'count';
-    }, ...selectors: Selector[]): number;
-    protected getEntitiesSync<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
-        return: 'guid';
-    }, ...selectors: Selector[]): string[];
-    protected getEntitiesSync<T extends EntityConstructor = EntityConstructor>(options?: Options<T>, ...selectors: Selector[]): ReturnType<T['factorySync']>[];
+    getEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
+        return: 'object';
+    }, ...selectors: Selector[]): Promise<EntityObjectType<T>[]>;
+    getEntities<T extends EntityConstructor = EntityConstructor>(options?: Options<T>, ...selectors: Selector[]): Promise<EntityInstanceType<T>[]>;
     getUID(name: string): Promise<number | null>;
-    import(filename: string): Promise<boolean>;
+    importEntity(entity: {
+        guid: string;
+        cdate: number;
+        mdate: number;
+        tags: string[];
+        sdata: SerializedEntityData;
+        etype: string;
+    }): Promise<void>;
+    importEntityTokens(entity: {
+        guid: string;
+        cdate: number;
+        mdate: number;
+        tags: string[];
+        sdata: SerializedEntityData;
+        etype: string;
+    }): Promise<void>;
+    importEntityTilmeldAC(entity: {
+        guid: string;
+        cdate: number;
+        mdate: number;
+        tags: string[];
+        sdata: SerializedEntityData;
+        etype: string;
+    }): Promise<void>;
+    private importEntityInternal;
+    importUID({ name, value }: {
+        name: string;
+        value: number;
+    }): Promise<void>;
     newUID(name: string): Promise<number>;
     renameUID(oldName: string, newName: string): Promise<boolean>;
     rollback(name: string): Promise<boolean>;
     saveEntity(entity: EntityInterface): Promise<boolean>;
     setUID(name: string, curUid: number): Promise<boolean>;
-    private internalTransaction;
+    protected internalTransaction(name: string): Promise<PostgreSQLDriverTransaction>;
     startTransaction(name: string): Promise<import("@nymphjs/nymph").Nymph>;
+    private removeTilmeldOldRows;
+    needsMigration(): Promise<'json' | 'tokens' | 'tilmeldColumns' | false>;
+    liveMigration(migrationType: 'tokenTables' | 'tilmeldColumns' | 'tilmeldRemoveOldRows'): Promise<void>;
 }
 export {};