@steroidsjs/nest 3.0.0 → 3.0.2

package/infrastructure/commands/generate/CustomPostgresQueryRunner.d.ts

@@ -18,28 +18,105 @@ export declare class TableSqlInMemory extends SqlInMemory {
     upTableQueries: TableQuery[];
     downTableQueries: TableQuery[];
 }
+/**
+ * Runs queries on a single postgres database connection.
+ */
 export declare class CustomPostgresQueryRunner extends PostgresQueryRunner implements QueryRunner {
+    /**
+     * Sql-s stored if "sql in memory" mode is enabled.
+     */
     protected sqlInMemory: TableSqlInMemory;
+    /**
+     * Creates a new table.
+     */
     createTable(table: Table, ifNotExist?: boolean, createForeignKeys?: boolean, createIndices?: boolean): Promise<void>;
+    /**
+     * Drops the table.
+     */
     dropTable(target: Table | string, ifExist?: boolean, dropForeignKeys?: boolean, dropIndices?: boolean): Promise<void>;
+    /**
+     * Creates a new column from the column in the table.
+     */
     addColumn(tableOrName: Table | string, column: TableColumn): Promise<void>;
+    /**
+     * Renames column in the given table.
+     */
     renameColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newTableColumnOrName: TableColumn | string): Promise<void>;
+    /**
+     * Changes a column in the table.
+     */
     changeColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newColumn: TableColumn): Promise<void>;
+    /**
+     * Drops column in the table.
+     */
     dropColumn(tableOrName: Table | string, columnOrName: TableColumn | string): Promise<void>;
+    /**
+     * Updates composite primary keys.
+     */
     updatePrimaryKeys(tableOrName: Table | string, columns: TableColumn[]): Promise<void>;
+    /**
+     * Creates new unique constraint.
+     */
     createUniqueConstraint(tableOrName: Table | string, uniqueConstraint: TableUnique): Promise<void>;
+    /**
+     * Drops unique constraint.
+     */
     dropUniqueConstraint(tableOrName: Table | string, uniqueOrName: TableUnique | string): Promise<void>;
+    /**
+     * Creates new check constraint.
+     */
     createCheckConstraint(tableOrName: Table | string, checkConstraint: TableCheck): Promise<void>;
+    /**
+     * Drops check constraint.
+     */
     dropCheckConstraint(tableOrName: Table | string, checkOrName: TableCheck | string): Promise<void>;
+    /**
+     * Creates new exclusion constraint.
+     */
     createExclusionConstraint(tableOrName: Table | string, exclusionConstraint: TableExclusion): Promise<void>;
+    /**
+     * Drops exclusion constraint.
+     */
     dropExclusionConstraint(tableOrName: Table | string, exclusionOrName: TableExclusion | string): Promise<void>;
+    /**
+     * Creates a new foreign key.
+     */
     createForeignKey(tableOrName: Table | string, foreignKey: TableForeignKey): Promise<void>;
+    /**
+     * Drops a foreign key from the table.
+     */
     dropForeignKey(tableOrName: Table | string, foreignKeyOrName: TableForeignKey | string): Promise<void>;
+    /**
+     * Creates a new index.
+     */
     createIndex(tableOrName: Table | string, index: TableIndex): Promise<void>;
+    /**
+     * Drops an index from the table.
+     */
     dropIndex(tableOrName: Table | string, indexOrName: TableIndex | string): Promise<void>;
+    /**
+     * Executes sql used special for schema build.
+     */
     protected executeQueries(upQueries: TableQuery | TableQuery[] | Query | Query[], downQueries: TableQuery | TableQuery[] | Query | Query[]): Promise<void>;
+    /**
+     * Enables special query runner mode in which sql queries won't be executed,
+     * instead they will be memorized into a special variable inside query runner.
+     * You can get memorized sql using getMemorySql() method.
+     */
     enableSqlMemory(): void;
+    /**
+     * Disables special query runner mode in which sql queries won't be executed
+     * started by calling enableSqlMemory() method.
+     *
+     * Previously memorized sql will be flushed.
+     */
     disableSqlMemory(): void;
+    /**
+     * Flushes all memorized sqls.
+     */
     clearSqlMemory(): void;
+    /**
+     * Gets sql stored in the memory. Parameters in the sql are already replaced.
+     */
     getMemorySql(): TableSqlInMemory;
 }