typeorm 1.0.0-beta.1 → 1.0.0-beta.2

package/browser/driver/postgres/PostgresQueryRunner.d.ts

@@ -38,6 +38,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     /**
      * Release a connection back to the pool, optionally specifying an Error to release with.
      * Per pg-pool documentation this will prevent the pool from re-using the broken connection.
+     *
      * @param err
      */
     private releasePostgresConnection;
@@ -48,6 +49,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     release(): Promise<void>;
     /**
      * Starts transaction.
+     *
      * @param isolationLevel
      */
     startTransaction(isolationLevel?: IsolationLevel): Promise<void>;
@@ -63,6 +65,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     rollbackTransaction(): Promise<void>;
     /**
      * Executes a given SQL query.
+     *
      * @param query
      * @param parameters
      * @param useStructuredResult
@@ -70,6 +73,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     query(query: string, parameters?: any[], useStructuredResult?: boolean): Promise<any>;
     /**
      * Returns raw data stream.
+     *
      * @param query
      * @param parameters
      * @param onEnd
@@ -83,11 +87,13 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     /**
      * Returns all available schema names including system schemas.
      * If database parameter specified, returns schemas of that database.
+     *
      * @param database
      */
     getSchemas(database?: string): Promise<string[]>;
     /**
      * Checks if database with the given name exist.
+     *
      * @param database
      */
     hasDatabase(database: string): Promise<boolean>;
@@ -97,6 +103,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     getCurrentDatabase(): Promise<string>;
     /**
      * Checks if schema with the given name exist.
+     *
      * @param schema
      */
     hasSchema(schema: string): Promise<boolean>;
@@ -106,11 +113,13 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     getCurrentSchema(): Promise<string>;
     /**
      * Checks if table with the given name exist in the database.
+     *
      * @param tableOrName
      */
     hasTable(tableOrName: Table | string): Promise<boolean>;
     /**
      * Checks if column with the given name exist in the given table.
+     *
      * @param tableOrName
      * @param columnName
      */
@@ -118,6 +127,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     /**
      * Creates a new database.
      * Note: Postgres does not support database creation inside a transaction block.
+     *
      * @param database
      * @param ifNotExists
      */
@@ -125,18 +135,21 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     /**
      * Drops database.
      * Note: Postgres does not support database dropping inside a transaction block.
+     *
      * @param database
      * @param ifExists
      */
     dropDatabase(database: string, ifExists?: boolean): Promise<void>;
     /**
      * Creates a new table schema.
+     *
      * @param schemaPath
      * @param ifNotExists
      */
     createSchema(schemaPath: string, ifNotExists?: boolean): Promise<void>;
     /**
      * Drops table schema.
+     *
      * @param schemaPath
      * @param ifExists
      * @param isCascade
@@ -144,6 +157,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropSchema(schemaPath: string, ifExists?: boolean, isCascade?: boolean): Promise<void>;
     /**
      * Creates a new table.
+     *
      * @param table
      * @param ifNotExists
      * @param createForeignKeys
@@ -152,6 +166,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     createTable(table: Table, ifNotExists?: boolean, createForeignKeys?: boolean, createIndices?: boolean): Promise<void>;
     /**
      * Drops the table.
+     *
      * @param target
      * @param ifExists
      * @param dropForeignKeys
@@ -160,36 +175,42 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropTable(target: Table | string, ifExists?: boolean, dropForeignKeys?: boolean, dropIndices?: boolean): Promise<void>;
     /**
      * Creates a new view.
+     *
      * @param view
      * @param syncWithMetadata
      */
     createView(view: View, syncWithMetadata?: boolean): Promise<void>;
     /**
      * Drops the view.
+     *
      * @param target
      * @param ifExists
      */
     dropView(target: View | string, ifExists?: boolean): Promise<void>;
     /**
      * Renames the given table.
+     *
      * @param oldTableOrName
      * @param newTableName
      */
     renameTable(oldTableOrName: Table | string, newTableName: string): Promise<void>;
     /**
      * Creates a new column from the column in the table.
+     *
      * @param tableOrName
      * @param column
      */
     addColumn(tableOrName: Table | string, column: TableColumn): Promise<void>;
     /**
      * Creates a new columns from the column in the table.
+     *
      * @param tableOrName
      * @param columns
      */
     addColumns(tableOrName: Table | string, columns: TableColumn[]): Promise<void>;
     /**
      * Renames column in the given table.
+     *
      * @param tableOrName
      * @param oldTableColumnOrName
      * @param newTableColumnOrName
@@ -197,6 +218,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     renameColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newTableColumnOrName: TableColumn | string): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param oldTableColumnOrName
      * @param newColumn
@@ -204,6 +226,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     changeColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newColumn: TableColumn): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param changedColumns
      */
@@ -213,6 +236,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     }[]): Promise<void>;
     /**
      * Drops column in the table.
+     *
      * @param tableOrName
      * @param columnOrName
      * @param ifExists
@@ -220,6 +244,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropColumn(tableOrName: Table | string, columnOrName: TableColumn | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops the columns in the table.
+     *
      * @param tableOrName
      * @param columns
      * @param ifExists
@@ -227,6 +252,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropColumns(tableOrName: Table | string, columns: TableColumn[] | string[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new primary key.
+     *
      * @param tableOrName
      * @param columnNames
      * @param constraintName
@@ -234,12 +260,14 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     createPrimaryKey(tableOrName: Table | string, columnNames: string[], constraintName?: string): Promise<void>;
     /**
      * Updates composite primary keys.
+     *
      * @param tableOrName
      * @param columns
      */
     updatePrimaryKeys(tableOrName: Table | string, columns: TableColumn[]): Promise<void>;
     /**
      * Drops a primary key.
+     *
      * @param tableOrName
      * @param constraintName
      * @param ifExists
@@ -247,18 +275,21 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropPrimaryKey(tableOrName: Table | string, constraintName?: string, ifExists?: boolean): Promise<void>;
     /**
      * Creates new unique constraint.
+     *
      * @param tableOrName
      * @param uniqueConstraint
      */
     createUniqueConstraint(tableOrName: Table | string, uniqueConstraint: TableUnique): Promise<void>;
     /**
      * Creates new unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      */
     createUniqueConstraints(tableOrName: Table | string, uniqueConstraints: TableUnique[]): Promise<void>;
     /**
      * Drops unique constraint.
+     *
      * @param tableOrName
      * @param uniqueOrName
      * @param ifExists
@@ -266,6 +297,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropUniqueConstraint(tableOrName: Table | string, uniqueOrName: TableUnique | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      * @param ifExists
@@ -273,18 +305,21 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropUniqueConstraints(tableOrName: Table | string, uniqueConstraints: TableUnique[], ifExists?: boolean): Promise<void>;
     /**
      * Creates new check constraint.
+     *
      * @param tableOrName
      * @param checkConstraint
      */
     createCheckConstraint(tableOrName: Table | string, checkConstraint: TableCheck): Promise<void>;
     /**
      * Creates new check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      */
     createCheckConstraints(tableOrName: Table | string, checkConstraints: TableCheck[]): Promise<void>;
     /**
      * Drops check constraint.
+     *
      * @param tableOrName
      * @param checkOrName
      * @param ifExists
@@ -292,6 +327,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropCheckConstraint(tableOrName: Table | string, checkOrName: TableCheck | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      * @param ifExists
@@ -299,18 +335,21 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropCheckConstraints(tableOrName: Table | string, checkConstraints: TableCheck[], ifExists?: boolean): Promise<void>;
     /**
      * Creates new exclusion constraint.
+     *
      * @param tableOrName
      * @param exclusionConstraint
      */
     createExclusionConstraint(tableOrName: Table | string, exclusionConstraint: TableExclusion): Promise<void>;
     /**
      * Creates new exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      */
     createExclusionConstraints(tableOrName: Table | string, exclusionConstraints: TableExclusion[]): Promise<void>;
     /**
      * Drops exclusion constraint.
+     *
      * @param tableOrName
      * @param exclusionOrName
      * @param ifExists
@@ -318,6 +357,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropExclusionConstraint(tableOrName: Table | string, exclusionOrName: TableExclusion | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      * @param ifExists
@@ -325,18 +365,21 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropExclusionConstraints(tableOrName: Table | string, exclusionConstraints: TableExclusion[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new foreign key.
+     *
      * @param tableOrName
      * @param foreignKey
      */
     createForeignKey(tableOrName: Table | string, foreignKey: TableForeignKey): Promise<void>;
     /**
      * Creates a new foreign keys.
+     *
      * @param tableOrName
      * @param foreignKeys
      */
     createForeignKeys(tableOrName: Table | string, foreignKeys: TableForeignKey[]): Promise<void>;
     /**
      * Drops a foreign key from the table.
+     *
      * @param tableOrName
      * @param foreignKeyOrName
      * @param ifExists
@@ -344,6 +387,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropForeignKey(tableOrName: Table | string, foreignKeyOrName: TableForeignKey | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops a foreign keys from the table.
+     *
      * @param tableOrName
      * @param foreignKeys
      * @param ifExists
@@ -351,30 +395,35 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropForeignKeys(tableOrName: Table | string, foreignKeys: TableForeignKey[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new index.
+     *
      * @param tableOrName
      * @param index
      */
     createIndex(tableOrName: Table | string, index: TableIndex): Promise<void>;
     /**
      * Create a new view index.
+     *
      * @param viewOrName
      * @param index
      */
     createViewIndex(viewOrName: View | string, index: TableIndex): Promise<void>;
     /**
      * Creates a new indices
+     *
      * @param tableOrName
      * @param indices
      */
     createIndices(tableOrName: Table | string, indices: TableIndex[]): Promise<void>;
     /**
      * Creates new view indices
+     *
      * @param viewOrName
      * @param indices
      */
     createViewIndices(viewOrName: View | string, indices: TableIndex[]): Promise<void>;
     /**
      * Drops an index from the table.
+     *
      * @param tableOrName
      * @param indexOrName
      * @param ifExists
@@ -382,12 +431,14 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     dropIndex(tableOrName: Table | string, indexOrName: TableIndex | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops an index from a view.
+     *
      * @param viewOrName
      * @param indexOrName
      */
     dropViewIndex(viewOrName: View | string, indexOrName: TableIndex | string): Promise<void>;
     /**
      * Drops an indices from the table.
+     *
      * @param tableOrName
      * @param indices
      * @param ifExists
@@ -396,6 +447,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     /**
      * Clears all table contents.
      * Note: this operation uses SQL's TRUNCATE query which cannot be reverted in transactions.
+     *
      * @param tableName
      * @param options
      * @param options.cascade
@@ -410,11 +462,13 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected loadViews(viewNames?: string[]): Promise<View[]>;
     /**
      * Loads all tables (with given names) from the database and creates a Table from them.
+     *
      * @param tableNames
      */
     protected loadTables(tableNames?: string[]): Promise<Table[]>;
     /**
      * Builds create table sql.
+     *
      * @param table
      * @param createForeignKeys
      */
@@ -425,6 +479,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     getVersion(): Promise<string>;
     /**
      * Builds drop table sql.
+     *
      * @param tableOrPath
      */
     protected dropTableSql(tableOrPath: Table | string): Query;
@@ -432,28 +487,33 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected insertViewDefinitionSql(view: View): Promise<Query>;
     /**
      * Builds drop view sql.
+     *
      * @param view
      * @param ifExists
      */
     protected dropViewSql(view: View, ifExists?: boolean): Query;
     /**
      * Builds remove view sql.
+     *
      * @param view
      */
     protected deleteViewDefinitionSql(view: View): Promise<Query>;
     /**
      * Drops ENUM type from given schemas.
+     *
      * @param schemaNames
      */
     protected dropEnumTypes(schemaNames: string[]): Promise<void>;
     /**
      * Checks if enum with the given name exist in the database.
+     *
      * @param table
      * @param column
      */
     protected hasEnumType(table: Table, column: TableColumn): Promise<boolean>;
     /**
      * Builds create ENUM type sql.
+     *
      * @param table
      * @param column
      * @param enumName
@@ -461,6 +521,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected createEnumTypeSql(table: Table, column: TableColumn, enumName?: string): Query;
     /**
      * Builds create ENUM type sql.
+     *
      * @param table
      * @param column
      * @param enumName
@@ -472,18 +533,21 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     private buildIndexTypeClause;
     /**
      * Builds create index sql.
+     *
      * @param table
      * @param index
      */
     protected createIndexSql(table: Table, index: TableIndex): Query;
     /**
      * Builds create view index sql.
+     *
      * @param view
      * @param index
      */
     protected createViewIndexSql(view: View, index: TableIndex): Query;
     /**
      * Builds drop index sql.
+     *
      * @param table
      * @param indexOrName
      * @param ifExists
@@ -491,6 +555,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected dropIndexSql(table: Table | View, indexOrName: TableIndex | string, ifExists?: boolean): Query;
     /**
      * Builds create primary key sql.
+     *
      * @param table
      * @param columnNames
      * @param constraintName
@@ -498,18 +563,21 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected createPrimaryKeySql(table: Table, columnNames: string[], constraintName?: string): Query;
     /**
      * Builds drop primary key sql.
+     *
      * @param table
      * @param ifExists
      */
     protected dropPrimaryKeySql(table: Table, ifExists?: boolean): Query;
     /**
      * Builds create unique constraint sql.
+     *
      * @param table
      * @param uniqueConstraint
      */
     protected createUniqueConstraintSql(table: Table, uniqueConstraint: TableUnique): Query;
     /**
      * Builds drop unique constraint sql.
+     *
      * @param table
      * @param uniqueOrName
      * @param ifExists
@@ -517,12 +585,14 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected dropUniqueConstraintSql(table: Table, uniqueOrName: TableUnique | string, ifExists?: boolean): Query;
     /**
      * Builds create check constraint sql.
+     *
      * @param table
      * @param checkConstraint
      */
     protected createCheckConstraintSql(table: Table, checkConstraint: TableCheck): Query;
     /**
      * Builds drop check constraint sql.
+     *
      * @param table
      * @param checkOrName
      * @param ifExists
@@ -530,12 +600,14 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected dropCheckConstraintSql(table: Table, checkOrName: TableCheck | string, ifExists?: boolean): Query;
     /**
      * Builds create exclusion constraint sql.
+     *
      * @param table
      * @param exclusionConstraint
      */
     protected createExclusionConstraintSql(table: Table, exclusionConstraint: TableExclusion): Query;
     /**
      * Builds drop exclusion constraint sql.
+     *
      * @param table
      * @param exclusionOrName
      * @param ifExists
@@ -543,12 +615,14 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected dropExclusionConstraintSql(table: Table, exclusionOrName: TableExclusion | string, ifExists?: boolean): Query;
     /**
      * Builds create foreign key sql.
+     *
      * @param table
      * @param foreignKey
      */
     protected createForeignKeySql(table: Table, foreignKey: TableForeignKey): Query;
     /**
      * Builds drop foreign key sql.
+     *
      * @param table
      * @param foreignKeyOrName
      * @param ifExists
@@ -556,6 +630,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected dropForeignKeySql(table: Table, foreignKeyOrName: TableForeignKey | string, ifExists?: boolean): Query;
     /**
      * Builds sequence name from given table and column.
+     *
      * @param table
      * @param columnOrName
      */
@@ -563,6 +638,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected buildSequencePath(table: Table, columnOrName: TableColumn | string): string;
     /**
      * Builds ENUM type name from given table and column.
+     *
      * @param table
      * @param column
      * @param withSchema
@@ -576,22 +652,26 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     }>;
     /**
      * Escapes a given comment so it's safe to include in a query.
+     *
      * @param comment
      */
     protected escapeComment(comment?: string): string;
     /**
      * Escapes given table or view path.
+     *
      * @param target
      */
     protected escapePath(target: Table | View | string): string;
     /**
      * Get the table name with table schema
      * Note: Without ' or "
+     *
      * @param target
      */
     protected getTableNameWithSchema(target: Table | string): Promise<string>;
     /**
      * Builds a query for create column.
+     *
      * @param table
      * @param column
      */
@@ -602,6 +682,7 @@ export declare class PostgresQueryRunner extends BaseQueryRunner implements Quer
     protected hasSupportForPartitionedTables(): Promise<boolean>;
     /**
      * Change table comment.
+     *
      * @param tableOrName
      * @param newComment
      */