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

package/driver/sap/SapQueryRunner.d.ts

@@ -39,6 +39,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     release(): Promise<void>;
     /**
      * Starts transaction.
+     *
      * @param isolationLevel
      */
     startTransaction(isolationLevel?: IsolationLevel): Promise<void>;
@@ -54,6 +55,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     rollbackTransaction(): Promise<void>;
     /**
      * Switches AUTOCOMMIT mode on/off
+     *
      * @see https://help.sap.com/docs/HANA_SERVICE_CF/7c78579ce9b14a669c1f3295b0d8ca16/d538d11053bd4f3f847ec5ce817a3d4c.html?locale=en-US
      * @param options
      * @param options.status
@@ -63,6 +65,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     }): Promise<void>;
     /**
      * Executes a given SQL query.
+     *
      * @param query
      * @param parameters
      * @param useStructuredResult
@@ -70,6 +73,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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 SapQueryRunner extends BaseQueryRunner implements QueryRunn
     /**
      * 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>;
@@ -104,6 +110,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     }>;
     /**
      * Checks if schema with the given name exist.
+     *
      * @param schema
      */
     hasSchema(schema: string): Promise<boolean>;
@@ -113,35 +120,41 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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
      */
     hasColumn(tableOrName: Table | string, columnName: 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
      * @param isCascade
@@ -149,6 +162,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     dropSchema(schemaPath: string, ifExists?: boolean, isCascade?: boolean): Promise<void>;
     /**
      * Creates a new table.
+     *
      * @param table
      * @param ifNotExists
      * @param createForeignKeys
@@ -157,6 +171,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     createTable(table: Table, ifNotExists?: boolean, createForeignKeys?: boolean, createIndices?: boolean): Promise<void>;
     /**
      * Drops the table.
+     *
      * @param tableOrName
      * @param ifExists
      * @param dropForeignKeys
@@ -165,36 +180,42 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     dropTable(tableOrName: 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 a 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
@@ -202,6 +223,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     renameColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newTableColumnOrName: TableColumn | string): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param oldTableColumnOrName
      * @param newColumn
@@ -209,6 +231,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     changeColumn(tableOrName: Table | string, oldTableColumnOrName: TableColumn | string, newColumn: TableColumn): Promise<void>;
     /**
      * Changes a column in the table.
+     *
      * @param tableOrName
      * @param changedColumns
      */
@@ -218,6 +241,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     }[]): Promise<void>;
     /**
      * Drops column in the table.
+     *
      * @param tableOrName
      * @param columnOrName
      * @param ifExists
@@ -225,6 +249,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     dropColumn(tableOrName: Table | string, columnOrName: TableColumn | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops the columns in the table.
+     *
      * @param tableOrName
      * @param columns
      * @param ifExists
@@ -232,18 +257,21 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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
      * @param ifExists
@@ -251,18 +279,21 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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 unique constraint.
+     *
      * @param tableOrName
      * @param uniqueOrName
      * @param ifExists
@@ -270,6 +301,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     dropUniqueConstraint(tableOrName: Table | string, uniqueOrName: TableUnique | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops unique constraints.
+     *
      * @param tableOrName
      * @param uniqueConstraints
      * @param ifExists
@@ -277,18 +309,21 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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
@@ -296,6 +331,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     dropCheckConstraint(tableOrName: Table | string, checkOrName: TableCheck | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops check constraints.
+     *
      * @param tableOrName
      * @param checkConstraints
      * @param ifExists
@@ -303,18 +339,21 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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
@@ -322,6 +361,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     dropExclusionConstraint(tableOrName: Table | string, exclusionOrName: TableExclusion | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops exclusion constraints.
+     *
      * @param tableOrName
      * @param exclusionConstraints
      * @param ifExists
@@ -329,18 +369,21 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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
@@ -348,6 +391,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     dropForeignKey(tableOrName: Table | string, foreignKeyOrName: TableForeignKey | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops a foreign keys from the table.
+     *
      * @param tableOrName
      * @param foreignKeys
      * @param ifExists
@@ -355,18 +399,21 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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
@@ -374,6 +421,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     dropIndex(tableOrName: Table | string, indexOrName: TableIndex | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops an indices from the table.
+     *
      * @param tableOrName
      * @param indices
      * @param ifExists
@@ -382,6 +430,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     /**
      * Clears all table contents.
      * Note: this operation uses SQL's TRUNCATE query which cannot be reverted in transactions.
+     *
      * @param tablePath
      * @param options
      * @param options.cascade
@@ -396,17 +445,20 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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 and returns SQL for create table.
+     *
      * @param table
      * @param createForeignKeys
      */
     protected createTableSql(table: Table, createForeignKeys?: boolean): Query;
     /**
      * Builds drop table sql.
+     *
      * @param tableOrName
      * @param ifExists
      */
@@ -415,11 +467,13 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     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>;
@@ -427,63 +481,74 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     protected dropColumnSql(table: Table, column: TableColumn): string;
     /**
      * 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 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 tableOrName
      * @param foreignKey
      */
     protected createForeignKeySql(tableOrName: Table | string, foreignKey: TableForeignKey): Query;
     /**
      * Builds drop foreign key sql.
+     *
      * @param tableOrName
      * @param foreignKeyOrName
      */
     protected dropForeignKeySql(tableOrName: Table | string, 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 query for create column.
+     *
      * @param column
      * @param explicitDefault
      * @param explicitNullable
@@ -491,6 +556,7 @@ export declare class SapQueryRunner extends BaseQueryRunner implements QueryRunn
     protected buildCreateColumnSql(column: TableColumn, explicitDefault?: boolean, explicitNullable?: boolean): string;
     /**
      * Change table comment.
+     *
      * @param tableOrName
      * @param newComment
      */