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

package/browser/driver/spanner/SpannerQueryRunner.d.ts

@@ -42,6 +42,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     release(): Promise<void>;
     /**
      * Starts transaction.
+     *
      * @param isolationLevel
      */
     startTransaction(isolationLevel?: IsolationLevel): Promise<void>;
@@ -57,6 +58,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     rollbackTransaction(): Promise<void>;
     /**
      * Executes a given SQL query.
+     *
      * @param query
      * @param parameters
      * @param useStructuredResult
@@ -67,12 +69,14 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
      * Used for creating/altering/dropping tables, columns, indexes, etc.
      *
      * DDL changing queries should be executed by `updateSchema()` method.
+     *
      * @param query
      * @param parameters
      */
     updateDDL(query: string, parameters?: any[]): Promise<void>;
     /**
      * Returns raw data stream.
+     *
      * @param query
      * @param parameters
      * @param onEnd
@@ -86,11 +90,13 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     /**
      * 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>;
@@ -100,6 +106,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     getCurrentDatabase(): Promise<string>;
     /**
      * Checks if schema with the given name exist.
+     *
      * @param schema
      */
     hasSchema(schema: string): Promise<boolean>;
@@ -109,11 +116,13 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     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
      */
@@ -121,6 +130,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     /**
      * Creates a new database.
      * Note: Spanner does not support database creation inside a transaction block.
+     *
      * @param database
      * @param ifNotExists
      */
@@ -128,18 +138,21 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     /**
      * Drops database.
      * Note: Spanner 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
@@ -147,6 +160,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     dropSchema(schemaPath: string, ifExists?: boolean, isCascade?: boolean): Promise<void>;
     /**
      * Creates a new table.
+     *
      * @param table
      * @param ifNotExists
      * @param createForeignKeys
@@ -155,6 +169,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     createTable(table: Table, ifNotExists?: boolean, createForeignKeys?: boolean, createIndices?: boolean): Promise<void>;
     /**
      * Drops the table.
+     *
      * @param target
      * @param ifExists
      * @param dropForeignKeys
@@ -163,35 +178,41 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     dropTable(target: Table | string, ifExists?: boolean, dropForeignKeys?: boolean, dropIndices?: boolean): Promise<void>;
     /**
      * Creates a new view.
+     *
      * @param view
      */
     createView(view: View): 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
@@ -199,6 +220,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     renameColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newTableColumnOrName: TableColumn | string): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param oldTableColumnOrName
      * @param newColumn
@@ -206,6 +228,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     changeColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newColumn: TableColumn): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param changedColumns
      */
@@ -215,6 +238,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     }[]): Promise<void>;
     /**
      * Drops column in the table.
+     *
      * @param tableOrName
      * @param columnOrName
      * @param ifExists
@@ -222,6 +246,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     dropColumn(tableOrName: Table | string, columnOrName: TableColumn | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops the columns in the table.
+     *
      * @param tableOrName
      * @param columns
      * @param ifExists
@@ -231,6 +256,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
      * Creates a new primary key.
      *
      * Not supported in Spanner.
+     *
      * @param tableOrName
      * @param columnNames
      * @see https://cloud.google.com/spanner/docs/schema-and-data-model#notes_about_key_columns
@@ -238,6 +264,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     createPrimaryKey(tableOrName: Table | string, columnNames: string[]): Promise<void>;
     /**
      * Updates composite primary keys.
+     *
      * @param tableOrName
      * @param columns
      */
@@ -246,6 +273,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
      * Drops a primary key.
      *
      * Not supported in Spanner.
+     *
      * @param tableOrName
      * @param constraintName
      * @param ifExists
@@ -254,18 +282,21 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     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
@@ -273,6 +304,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     dropUniqueConstraint(tableOrName: Table | string, uniqueOrName: TableUnique | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      * @param ifExists
@@ -280,18 +312,21 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     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 new check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      */
     createCheckConstraints(tableOrName: Table | string, checkConstraints: TableCheck[]): Promise<void>;
     /**
      * Drops check constraint.
+     *
      * @param tableOrName
      * @param checkOrName
      * @param ifExists
@@ -299,6 +334,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     dropCheckConstraint(tableOrName: Table | string, checkOrName: TableCheck | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      * @param ifExists
@@ -306,18 +342,21 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     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
@@ -325,6 +364,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     dropExclusionConstraint(tableOrName: Table | string, exclusionOrName: TableExclusion | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      * @param ifExists
@@ -332,18 +372,21 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     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
@@ -351,6 +394,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     dropForeignKey(tableOrName: Table | string, foreignKeyOrName: TableForeignKey | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops a foreign keys from the table.
+     *
      * @param tableOrName
      * @param foreignKeys
      * @param ifExists
@@ -358,18 +402,21 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     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 from the table.
+     *
      * @param tableOrName
      * @param indexOrName
      * @param ifExists
@@ -377,6 +424,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     dropIndex(tableOrName: Table | string, indexOrName: TableIndex | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops an indices from the table.
+     *
      * @param tableOrName
      * @param indices
      * @param ifExists
@@ -385,6 +433,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     /**
      * Clears all table contents.
      * Spanner does not support TRUNCATE TABLE statement, so we use DELETE FROM.
+     *
      * @param tableName
      * @param options
      * @param options.cascade
@@ -407,17 +456,20 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     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 tableOrPath
      */
     protected dropTableSql(tableOrPath: Table | string): Query;
@@ -425,62 +477,73 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     protected insertViewDefinitionSql(view: View): Promise<Query>;
     /**
      * Builds drop view sql.
+     *
      * @param view
      */
     protected dropViewSql(view: View): Query;
     /**
      * Builds remove view sql.
+     *
      * @param view
      */
     protected deleteViewDefinitionSql(view: View): 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 check constraint sql.
+     *
      * @param table
      * @param checkConstraint
      */
     protected createCheckConstraintSql(table: Table, checkConstraint: TableCheck): Query;
     /**
      * Builds drop check constraint sql.
+     *
      * @param table
      * @param checkOrName
      */
     protected dropCheckConstraintSql(table: Table, checkOrName: TableCheck | string): 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 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
      */
     protected buildCreateColumnSql(column: TableColumn): string;
     /**
      * Executes sql used special for schema build.
+     *
      * @param upQueries
      * @param downQueries
      */
@@ -488,6 +551,7 @@ export declare class SpannerQueryRunner extends BaseQueryRunner implements Query
     protected isDMLQuery(query: string): boolean;
     /**
      * Change table comment.
+     *
      * @param tableOrName
      * @param comment
      */