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

package/driver/mysql/MysqlQueryRunner.d.ts

@@ -38,6 +38,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     release(): Promise<void>;
     /**
      * Starts transaction on the current connection.
+     *
      * @param isolationLevel
      */
     startTransaction(isolationLevel?: IsolationLevel): Promise<void>;
@@ -53,6 +54,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     rollbackTransaction(): Promise<void>;
     /**
      * Executes a raw SQL query.
+     *
      * @param query
      * @param parameters
      * @param useStructuredResult
@@ -60,6 +62,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     query(query: string, parameters?: any[], useStructuredResult?: boolean): Promise<any>;
     /**
      * Returns raw data stream.
+     *
      * @param query
      * @param parameters
      * @param onEnd
@@ -73,11 +76,13 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     /**
      * 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>;
@@ -87,6 +92,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     getCurrentDatabase(): Promise<string>;
     /**
      * Checks if schema with the given name exist.
+     *
      * @param schema
      */
     hasSchema(schema: string): Promise<boolean>;
@@ -96,41 +102,48 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     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 column
      */
     hasColumn(tableOrName: Table | string, column: TableColumn | string): Promise<boolean>;
     /**
      * Creates a new database.
+     *
      * @param database
      * @param ifNotExists
      */
     createDatabase(database: string, ifNotExists?: boolean): Promise<void>;
     /**
      * Drops database.
+     *
      * @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
      */
     dropSchema(schemaPath: string, ifExists?: boolean): Promise<void>;
     /**
      * Creates a new table.
+     *
      * @param table
      * @param ifNotExists
      * @param createForeignKeys
@@ -138,6 +151,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     createTable(table: Table, ifNotExists?: boolean, createForeignKeys?: boolean): Promise<void>;
     /**
      * Drop the table.
+     *
      * @param target
      * @param ifExists
      * @param dropForeignKeys
@@ -145,42 +159,49 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropTable(target: Table | string, ifExists?: boolean, dropForeignKeys?: 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 a table.
+     *
      * @param oldTableOrName
      * @param newTableName
      */
     renameTable(oldTableOrName: Table | string, newTableName: string): Promise<void>;
     /**
      * Change table comment.
+     *
      * @param tableOrName
      * @param newComment
      */
     changeTableComment(tableOrName: Table | string, newComment?: 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
@@ -188,6 +209,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     renameColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newTableColumnOrName: TableColumn | string): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param oldColumnOrName
      * @param newColumn
@@ -195,6 +217,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     changeColumn(tableOrName: Table | string, oldColumnOrName: TableColumn | string, newColumn: TableColumn): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param changedColumns
      */
@@ -204,6 +227,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     }[]): Promise<void>;
     /**
      * Drops column in the table.
+     *
      * @param tableOrName
      * @param columnOrName
      * @param ifExists
@@ -211,6 +235,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropColumn(tableOrName: Table | string, columnOrName: TableColumn | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops the columns in the table.
+     *
      * @param tableOrName
      * @param columns
      * @param ifExists
@@ -218,18 +243,21 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropColumns(tableOrName: Table | string, columns: TableColumn[] | string[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new primary key.
+     *
      * @param tableOrName
      * @param columnNames
      */
     createPrimaryKey(tableOrName: Table | string, columnNames: 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 not used in MySQL
      * @param ifExists
@@ -237,18 +265,21 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropPrimaryKey(tableOrName: Table | string, constraintName?: string, ifExists?: boolean): Promise<void>;
     /**
      * Creates a new unique constraint.
+     *
      * @param tableOrName
      * @param uniqueConstraint
      */
     createUniqueConstraint(tableOrName: Table | string, uniqueConstraint: TableUnique): Promise<void>;
     /**
      * Creates a new unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      */
     createUniqueConstraints(tableOrName: Table | string, uniqueConstraints: TableUnique[]): Promise<void>;
     /**
      * Drops a unique constraint.
+     *
      * @param tableOrName
      * @param uniqueOrName
      * @param ifExists
@@ -256,6 +287,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropUniqueConstraint(tableOrName: Table | string, uniqueOrName: TableUnique | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops a unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      * @param ifExists
@@ -263,18 +295,21 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropUniqueConstraints(tableOrName: Table | string, uniqueConstraints: TableUnique[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new check constraint.
+     *
      * @param tableOrName
      * @param checkConstraint
      */
     createCheckConstraint(tableOrName: Table | string, checkConstraint: TableCheck): Promise<void>;
     /**
      * Creates a new check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      */
     createCheckConstraints(tableOrName: Table | string, checkConstraints: TableCheck[]): Promise<void>;
     /**
      * Drops check constraint.
+     *
      * @param tableOrName
      * @param checkOrName
      * @param ifExists
@@ -282,6 +317,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropCheckConstraint(tableOrName: Table | string, checkOrName: TableCheck | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      * @param ifExists
@@ -289,18 +325,21 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropCheckConstraints(tableOrName: Table | string, checkConstraints: TableCheck[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new exclusion constraint.
+     *
      * @param tableOrName
      * @param exclusionConstraint
      */
     createExclusionConstraint(tableOrName: Table | string, exclusionConstraint: TableExclusion): Promise<void>;
     /**
      * Creates a new exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      */
     createExclusionConstraints(tableOrName: Table | string, exclusionConstraints: TableExclusion[]): Promise<void>;
     /**
      * Drops exclusion constraint.
+     *
      * @param tableOrName
      * @param exclusionOrName
      * @param ifExists
@@ -308,6 +347,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropExclusionConstraint(tableOrName: Table | string, exclusionOrName: TableExclusion | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      * @param ifExists
@@ -315,18 +355,21 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     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.
+     *
      * @param tableOrName
      * @param foreignKeyOrName
      * @param ifExists
@@ -334,6 +377,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropForeignKey(tableOrName: Table | string, foreignKeyOrName: TableForeignKey | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops a foreign keys from the table.
+     *
      * @param tableOrName
      * @param foreignKeys
      * @param ifExists
@@ -341,18 +385,21 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     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>;
     /**
      * Creates a new indices
+     *
      * @param tableOrName
      * @param indices
      */
     createIndices(tableOrName: Table | string, indices: TableIndex[]): Promise<void>;
     /**
      * Drops an index.
+     *
      * @param tableOrName
      * @param indexOrName
      * @param ifExists
@@ -360,6 +407,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     dropIndex(tableOrName: Table | string, indexOrName: TableIndex | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops an indices from the table.
+     *
      * @param tableOrName
      * @param indices
      * @param ifExists
@@ -368,6 +416,7 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     /**
      * Clears all table contents.
      * Note: this operation uses SQL's TRUNCATE query which cannot be reverted in transactions.
+     *
      * @param tableOrName
      * @param options
      * @param options.cascade
@@ -379,23 +428,27 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
      * Removes all tables from the currently connected database.
      * Be careful using this method and avoid using it in production or migrations
      * (because it can clear all your database).
+     *
      * @param database
      */
     clearDatabase(database?: string): Promise<void>;
     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
      */
     protected createTableSql(table: Table, createForeignKeys?: boolean): Query;
     /**
      * Builds drop table sql
+     *
      * @param tableOrName
      */
     protected dropTableSql(tableOrName: Table | string): Query;
@@ -403,61 +456,72 @@ export declare class MysqlQueryRunner extends BaseQueryRunner implements QueryRu
     protected insertViewDefinitionSql(view: View): Promise<Query>;
     /**
      * Builds drop view sql.
+     *
      * @param viewOrPath
      */
     protected dropViewSql(viewOrPath: View | string): Query;
     /**
      * Builds remove view sql.
+     *
      * @param viewOrPath
      */
     protected deleteViewDefinitionSql(viewOrPath: View | string): Promise<Query>;
     /**
      * Builds create index sql.
+     *
      * @param table
      * @param index
      */
     protected createIndexSql(table: Table, index: TableIndex): Query;
     /**
      * Builds drop index sql.
+     *
      * @param table
      * @param indexOrName
      */
     protected dropIndexSql(table: Table, indexOrName: TableIndex | string): Query;
     /**
      * Builds create primary key sql.
+     *
      * @param table
      * @param columnNames
      */
     protected createPrimaryKeySql(table: Table, columnNames: string[]): Query;
     /**
      * Builds drop primary key sql.
+     *
      * @param table
      */
     protected dropPrimaryKeySql(table: Table): 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
      */
     protected dropForeignKeySql(table: Table, foreignKeyOrName: TableForeignKey | string): Query;
     /**
      * 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;
     /**
      * Builds a part of query to create/change a column.
+     *
      * @param column
      * @param skipPrimary
      * @param skipName