typeorm 0.3.29-dev.cc07c90 → 1.0.0-beta.1

package/browser/driver/aurora-mysql/AuroraMysqlDriver.d.ts

@@ -1,27 +1,35 @@
-import { ObjectLiteral } from "../../common/ObjectLiteral";
-import { DataSource } from "../../data-source";
-import { ColumnMetadata } from "../../metadata/ColumnMetadata";
-import { EntityMetadata } from "../../metadata/EntityMetadata";
+import type { ObjectLiteral } from "../../common/ObjectLiteral";
+import type { DataSource } from "../../data-source";
+import type { ColumnMetadata } from "../../metadata/ColumnMetadata";
+import type { EntityMetadata } from "../../metadata/EntityMetadata";
 import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
-import { Table } from "../../schema-builder/table/Table";
-import { TableColumn } from "../../schema-builder/table/TableColumn";
-import { TableForeignKey } from "../../schema-builder/table/TableForeignKey";
-import { View } from "../../schema-builder/view/View";
-import { Driver } from "../Driver";
-import { ColumnType, UnsignedColumnType } from "../types/ColumnTypes";
-import { CteCapabilities } from "../types/CteCapabilities";
-import { DataTypeDefaults } from "../types/DataTypeDefaults";
-import { MappedColumnTypes } from "../types/MappedColumnTypes";
-import { ReplicationMode } from "../types/ReplicationMode";
-import { UpsertType } from "../types/UpsertType";
-import { AuroraMysqlConnectionCredentialsOptions } from "./AuroraMysqlConnectionCredentialsOptions";
-import { AuroraMysqlConnectionOptions } from "./AuroraMysqlConnectionOptions";
+import type { Table } from "../../schema-builder/table/Table";
+import type { TableColumn } from "../../schema-builder/table/TableColumn";
+import type { TableForeignKey } from "../../schema-builder/table/TableForeignKey";
+import type { View } from "../../schema-builder/view/View";
+import type { Driver } from "../Driver";
+import type { ColumnType } from "../types/ColumnTypes";
+import type { CteCapabilities } from "../types/CteCapabilities";
+import type { DataTypeDefaults } from "../types/DataTypeDefaults";
+import type { MappedColumnTypes } from "../types/MappedColumnTypes";
+import type { ReplicationMode } from "../types/ReplicationMode";
+import type { UpsertType } from "../types/UpsertType";
+import type { AuroraMysqlConnectionCredentialsOptions } from "./AuroraMysqlConnectionCredentialsOptions";
+import type { AuroraMysqlDataSourceOptions } from "./AuroraMysqlDataSourceOptions";
 import { AuroraMysqlQueryRunner } from "./AuroraMysqlQueryRunner";
 /**
  * Organizes communication with MySQL DBMS.
  */
 export declare class AuroraMysqlDriver implements Driver {
-    connection: DataSource;
+    /**
+     * DataSource used by the driver.
+     */
+    dataSource: DataSource;
+    /**
+     * DataSource used by the driver.
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
+     */
+    get connection(): DataSource;
     /**
      * Aurora Data API underlying library.
      */
@@ -37,9 +45,9 @@ export declare class AuroraMysqlDriver implements Driver {
      */
     poolCluster: any;
     /**
-     * Connection options.
+     * DataSource options.
      */
-    options: AuroraMysqlConnectionOptions;
+    options: AuroraMysqlDataSourceOptions;
     /**
      * Database name used to perform all write queries.
      */
@@ -62,7 +70,6 @@ export declare class AuroraMysqlDriver implements Driver {
     transactionSupport: "nested";
     /**
      * Gets list of supported column data types by a driver.
-     *
      * @see https://www.tutorialspoint.com/mysql/mysql-data-types.htm
      * @see https://dev.mysql.com/doc/refman/8.0/en/data-types.html
      */
@@ -79,10 +86,6 @@ export declare class AuroraMysqlDriver implements Driver {
      * Gets list of column data types that support length by a driver.
      */
     withLengthColumnTypes: ColumnType[];
-    /**
-     * Gets list of column data types that support unsigned by a driver.
-     */
-    unsignedColumnTypes: UnsignedColumnType[];
     /**
      * Gets list of column data types that support precision by a driver.
      */
@@ -107,7 +110,7 @@ export declare class AuroraMysqlDriver implements Driver {
      */
     maxAliasLength: number;
     cteCapabilities: CteCapabilities;
-    constructor(connection: DataSource);
+    constructor(dataSource: DataSource);
     /**
      * Performs connection to the database.
      */
@@ -126,24 +129,32 @@ export declare class AuroraMysqlDriver implements Driver {
     createSchemaBuilder(): RdbmsSchemaBuilder;
     /**
      * Creates a query runner used to execute database queries.
+     * @param mode
      */
     createQueryRunner(mode: ReplicationMode): AuroraMysqlQueryRunner;
     /**
      * Replaces parameters in the given sql with special escaping character
      * and an array of parameter names to be passed to a query.
+     * @param sql
+     * @param parameters
      */
-    escapeQueryWithParameters(sql: string, parameters: ObjectLiteral, nativeParameters: ObjectLiteral): [string, any[]];
+    escapeQueryWithParameters(sql: string, parameters: ObjectLiteral): [string, any[]];
     /**
      * Escapes a column name.
+     * @param columnName
      */
     escape(columnName: string): string;
     /**
      * Build full table name with database name, schema name and table name.
      * E.g. myDB.mySchema.myTable
+     * @param tableName
+     * @param schema
+     * @param database
      */
     buildTableName(tableName: string, schema?: string, database?: string): string;
     /**
      * Parse a target table name or other types and return a normalized table definition.
+     * @param target
      */
     parseTableName(target: EntityMetadata | Table | View | TableForeignKey | string): {
         database?: string;
@@ -152,14 +163,23 @@ export declare class AuroraMysqlDriver implements Driver {
     };
     /**
      * Prepares given value to a value to be persisted, based on its column type and metadata.
+     * @param value
+     * @param columnMetadata
      */
     preparePersistentValue(value: any, columnMetadata: ColumnMetadata): any;
     /**
      * Prepares given value to a value to be persisted, based on its column type or metadata.
+     * @param value
+     * @param columnMetadata
      */
     prepareHydratedValue(value: any, columnMetadata: ColumnMetadata): any;
     /**
      * Creates a database type from a given column metadata.
+     * @param column
+     * @param column.type
+     * @param column.length
+     * @param column.precision
+     * @param column.scale
      */
     normalizeType(column: {
         type: ColumnType;
@@ -169,18 +189,22 @@ export declare class AuroraMysqlDriver implements Driver {
     }): string;
     /**
      * Normalizes "default" value of the column.
+     * @param columnMetadata
      */
     normalizeDefault(columnMetadata: ColumnMetadata): string | undefined;
     /**
      * Normalizes "isUnique" value of the column.
+     * @param column
      */
     normalizeIsUnique(column: ColumnMetadata): boolean;
     /**
      * Returns default column lengths, which is required on column creation.
+     * @param column
      */
     getColumnLength(column: ColumnMetadata | TableColumn): string;
     /**
      * Creates column type definition including length, precision and scale
+     * @param column
      */
     createFullType(column: TableColumn): string;
     /**
@@ -197,11 +221,16 @@ export declare class AuroraMysqlDriver implements Driver {
     obtainSlaveConnection(): Promise<any>;
     /**
      * Creates generated map of values generated or returned by database after INSERT query.
+     * @param metadata
+     * @param insertResult
+     * @param entityIndex
      */
     createGeneratedMap(metadata: EntityMetadata, insertResult: any, entityIndex: number): ObjectLiteral | undefined;
     /**
      * Differentiate columns of this table and columns from the given column metadatas columns
      * and returns only changed.
+     * @param tableColumns
+     * @param columnMetadatas
      */
     findChangedColumns(tableColumns: TableColumn[], columnMetadatas: ColumnMetadata[]): ColumnMetadata[];
     /**
@@ -218,6 +247,8 @@ export declare class AuroraMysqlDriver implements Driver {
     isFullTextColumnTypeSupported(): boolean;
     /**
      * Creates an escaped parameter.
+     * @param parameterName
+     * @param index
      */
     createParameter(parameterName: string, index: number): string;
     /**
@@ -226,22 +257,29 @@ export declare class AuroraMysqlDriver implements Driver {
     protected loadDependencies(): void;
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param options
+     * @param credentials
      */
-    protected createConnectionOptions(options: AuroraMysqlConnectionOptions, credentials: AuroraMysqlConnectionCredentialsOptions): Promise<any>;
+    protected createConnectionOptions(options: AuroraMysqlDataSourceOptions, credentials: AuroraMysqlConnectionCredentialsOptions): Promise<any>;
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param connectionOptions
      */
     protected createPool(connectionOptions: any): Promise<any>;
     /**
      * Attaches all required base handlers to a database connection, such as the unhandled error handler.
+     * @param connection
      */
     private prepareDbConnection;
     /**
      * Checks if "DEFAULT" values in the column metadata and in the database are equal.
+     * @param columnMetadataValue
+     * @param databaseValue
      */
     protected compareDefaultValues(columnMetadataValue: string | undefined, databaseValue: string | undefined): boolean;
     /**
      * Escapes a given comment.
+     * @param comment
      */
     protected escapeComment(comment?: string): string | undefined;
 }