typeorm 0.3.6-dev.9d331b1 → 0.3.6-dev.bbdc20f

package/driver/spanner/SpannerConnectionCredentialsOptions.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Spanner specific connection credential options.
+ */
+export interface SpannerConnectionCredentialsOptions {
+    /**
+     * Connection url where perform connection to.
+     */
+    readonly instanceId?: string;
+    /**
+     * Database host.
+     */
+    readonly projectId?: string;
+    /**
+     * Database host port.
+     */
+    readonly databaseId?: string;
+}

package/driver/spanner/SpannerConnectionCredentialsOptions.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+
+//# sourceMappingURL=SpannerConnectionCredentialsOptions.js.map

package/driver/spanner/SpannerConnectionCredentialsOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/driver/spanner/SpannerConnectionCredentialsOptions.ts"],"names":[],"mappings":"","file":"SpannerConnectionCredentialsOptions.js","sourcesContent":["/**\n * Spanner specific connection credential options.\n */\nexport interface SpannerConnectionCredentialsOptions {\n    /**\n     * Connection url where perform connection to.\n     */\n    readonly instanceId?: string\n\n    /**\n     * Database host.\n     */\n    readonly projectId?: string\n\n    /**\n     * Database host port.\n     */\n    readonly databaseId?: string\n}\n"],"sourceRoot":"../.."}

package/driver/spanner/SpannerConnectionOptions.d.ts

@@ -0,0 +1,120 @@
+import { BaseConnectionOptions } from "../../connection/BaseConnectionOptions";
+import { SpannerConnectionCredentialsOptions } from "./SpannerConnectionCredentialsOptions";
+/**
+ * Spanner specific connection options.
+ */
+export interface SpannerConnectionOptions extends BaseConnectionOptions, SpannerConnectionCredentialsOptions {
+    /**
+     * Database type.
+     */
+    readonly type: "spanner";
+    /**
+     * The driver object
+     * This defaults to require("@google-cloud/spanner").
+     */
+    readonly driver?: any;
+    readonly database?: string;
+    readonly schema?: string;
+    /**
+     * The charset for the connection. This is called "collation" in the SQL-level of MySQL (like utf8_general_ci).
+     * If a SQL-level charset is specified (like utf8mb4) then the default collation for that charset is used.
+     * Default: 'UTF8_GENERAL_CI'
+     */
+    readonly charset?: string;
+    /**
+     * The timezone configured on the MySQL server.
+     * This is used to type cast server date/time values to JavaScript Date object and vice versa.
+     * This can be 'local', 'Z', or an offset in the form +HH:MM or -HH:MM. (Default: 'local')
+     */
+    readonly timezone?: string;
+    /**
+     * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10000)
+     */
+    readonly connectTimeout?: number;
+    /**
+     * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10000)
+     * This difference between connectTimeout and acquireTimeout is subtle and is described in the mysqljs/mysql docs
+     * https://github.com/mysqljs/mysql/tree/master#pool-options
+     */
+    readonly acquireTimeout?: number;
+    /**
+     * Allow connecting to MySQL instances that ask for the old (insecure) authentication method. (Default: false)
+     */
+    readonly insecureAuth?: boolean;
+    /**
+     * When dealing with big numbers (BIGINT and DECIMAL columns) in the database, you should enable this option (Default: false)
+     */
+    readonly supportBigNumbers?: boolean;
+    /**
+     * Enabling both supportBigNumbers and bigNumberStrings forces big numbers (BIGINT and DECIMAL columns) to be always
+     * returned as JavaScript String objects (Default: false). Enabling supportBigNumbers but leaving bigNumberStrings
+     * disabled will return big numbers as String objects only when they cannot be accurately represented with
+     * [JavaScript Number objects](http://ecma262-5.com/ELS5_HTML.htm#Section_8.5) (which happens when they exceed the [-2^53, +2^53] range),
+     * otherwise they will be returned as Number objects. This option is ignored if supportBigNumbers is disabled.
+     */
+    readonly bigNumberStrings?: boolean;
+    /**
+     * Force date types (TIMESTAMP, DATETIME, DATE) to be returned as strings rather then inflated into JavaScript Date objects.
+     * Can be true/false or an array of type names to keep as strings.
+     */
+    readonly dateStrings?: boolean | string[];
+    /**
+     * Prints protocol details to stdout. Can be true/false or an array of packet type names that should be printed.
+     * (Default: false)
+     */
+    readonly debug?: boolean | string[];
+    /**
+     * Generates stack traces on Error to include call site of library entrance ("long stack traces").
+     * Slight performance penalty for most calls. (Default: true)
+     */
+    readonly trace?: boolean;
+    /**
+     * Allow multiple mysql statements per query. Be careful with this, it could increase the scope of SQL injection attacks.
+     * (Default: false)
+     */
+    readonly multipleStatements?: boolean;
+    /**
+     * Use spatial functions like GeomFromText and AsText which are removed in MySQL 8.
+     * (Default: true)
+     */
+    readonly legacySpatialSupport?: boolean;
+    /**
+     * List of connection flags to use other than the default ones. It is also possible to blacklist default ones.
+     * For more information, check https://github.com/mysqljs/mysql#connection-flags.
+     */
+    readonly flags?: string[];
+    /**
+     * Replication setup.
+     */
+    readonly replication?: {
+        /**
+         * Master server used by orm to perform writes.
+         */
+        readonly master: SpannerConnectionCredentialsOptions;
+        /**
+         * List of read-from severs (slaves).
+         */
+        readonly slaves: SpannerConnectionCredentialsOptions[];
+        /**
+         * If true, PoolCluster will attempt to reconnect when connection fails. (Default: true)
+         */
+        readonly canRetry?: boolean;
+        /**
+         * If connection fails, node's errorCount increases.
+         * When errorCount is greater than removeNodeErrorCount, remove a node in the PoolCluster. (Default: 5)
+         */
+        readonly removeNodeErrorCount?: number;
+        /**
+         * If connection fails, specifies the number of milliseconds before another connection attempt will be made.
+         * If set to 0, then node will be removed instead and never re-used. (Default: 0)
+         */
+        readonly restoreNodeTimeout?: number;
+        /**
+         * Determines how slaves are selected:
+         * RR: Select one alternately (Round-Robin).
+         * RANDOM: Select the node by random function.
+         * ORDER: Select the first node available unconditionally.
+         */
+        readonly selector?: "RR" | "RANDOM" | "ORDER";
+    };
+}

package/driver/spanner/SpannerConnectionOptions.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+
+//# sourceMappingURL=SpannerConnectionOptions.js.map

package/driver/spanner/SpannerConnectionOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/driver/spanner/SpannerConnectionOptions.ts"],"names":[],"mappings":"","file":"SpannerConnectionOptions.js","sourcesContent":["import { BaseConnectionOptions } from \"../../connection/BaseConnectionOptions\"\nimport { SpannerConnectionCredentialsOptions } from \"./SpannerConnectionCredentialsOptions\"\n\n/**\n * Spanner specific connection options.\n */\nexport interface SpannerConnectionOptions\n    extends BaseConnectionOptions,\n        SpannerConnectionCredentialsOptions {\n    /**\n     * Database type.\n     */\n    readonly type: \"spanner\"\n\n    /**\n     * The driver object\n     * This defaults to require(\"@google-cloud/spanner\").\n     */\n    readonly driver?: any\n\n    // todo\n    readonly database?: string\n\n    // todo\n    readonly schema?: string\n\n    /**\n     * The charset for the connection. This is called \"collation\" in the SQL-level of MySQL (like utf8_general_ci).\n     * If a SQL-level charset is specified (like utf8mb4) then the default collation for that charset is used.\n     * Default: 'UTF8_GENERAL_CI'\n     */\n    readonly charset?: string\n\n    /**\n     * The timezone configured on the MySQL server.\n     * This is used to type cast server date/time values to JavaScript Date object and vice versa.\n     * This can be 'local', 'Z', or an offset in the form +HH:MM or -HH:MM. (Default: 'local')\n     */\n    readonly timezone?: string\n\n    /**\n     * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10000)\n     */\n    readonly connectTimeout?: number\n\n    /**\n     * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10000)\n     * This difference between connectTimeout and acquireTimeout is subtle and is described in the mysqljs/mysql docs\n     * https://github.com/mysqljs/mysql/tree/master#pool-options\n     */\n    readonly acquireTimeout?: number\n\n    /**\n     * Allow connecting to MySQL instances that ask for the old (insecure) authentication method. (Default: false)\n     */\n    readonly insecureAuth?: boolean\n\n    /**\n     * When dealing with big numbers (BIGINT and DECIMAL columns) in the database, you should enable this option (Default: false)\n     */\n    readonly supportBigNumbers?: boolean\n\n    /**\n     * Enabling both supportBigNumbers and bigNumberStrings forces big numbers (BIGINT and DECIMAL columns) to be always\n     * returned as JavaScript String objects (Default: false). Enabling supportBigNumbers but leaving bigNumberStrings\n     * disabled will return big numbers as String objects only when they cannot be accurately represented with\n     * [JavaScript Number objects](http://ecma262-5.com/ELS5_HTML.htm#Section_8.5) (which happens when they exceed the [-2^53, +2^53] range),\n     * otherwise they will be returned as Number objects. This option is ignored if supportBigNumbers is disabled.\n     */\n    readonly bigNumberStrings?: boolean\n\n    /**\n     * Force date types (TIMESTAMP, DATETIME, DATE) to be returned as strings rather then inflated into JavaScript Date objects.\n     * Can be true/false or an array of type names to keep as strings.\n     */\n    readonly dateStrings?: boolean | string[]\n\n    /**\n     * Prints protocol details to stdout. Can be true/false or an array of packet type names that should be printed.\n     * (Default: false)\n     */\n    readonly debug?: boolean | string[]\n\n    /**\n     * Generates stack traces on Error to include call site of library entrance (\"long stack traces\").\n     * Slight performance penalty for most calls. (Default: true)\n     */\n    readonly trace?: boolean\n\n    /**\n     * Allow multiple mysql statements per query. Be careful with this, it could increase the scope of SQL injection attacks.\n     * (Default: false)\n     */\n    readonly multipleStatements?: boolean\n\n    /**\n     * Use spatial functions like GeomFromText and AsText which are removed in MySQL 8.\n     * (Default: true)\n     */\n    readonly legacySpatialSupport?: boolean\n\n    /**\n     * List of connection flags to use other than the default ones. It is also possible to blacklist default ones.\n     * For more information, check https://github.com/mysqljs/mysql#connection-flags.\n     */\n    readonly flags?: string[]\n\n    /**\n     * Replication setup.\n     */\n    readonly replication?: {\n        /**\n         * Master server used by orm to perform writes.\n         */\n        readonly master: SpannerConnectionCredentialsOptions\n\n        /**\n         * List of read-from severs (slaves).\n         */\n        readonly slaves: SpannerConnectionCredentialsOptions[]\n\n        /**\n         * If true, PoolCluster will attempt to reconnect when connection fails. (Default: true)\n         */\n        readonly canRetry?: boolean\n\n        /**\n         * If connection fails, node's errorCount increases.\n         * When errorCount is greater than removeNodeErrorCount, remove a node in the PoolCluster. (Default: 5)\n         */\n        readonly removeNodeErrorCount?: number\n\n        /**\n         * If connection fails, specifies the number of milliseconds before another connection attempt will be made.\n         * If set to 0, then node will be removed instead and never re-used. (Default: 0)\n         */\n        readonly restoreNodeTimeout?: number\n\n        /**\n         * Determines how slaves are selected:\n         * RR: Select one alternately (Round-Robin).\n         * RANDOM: Select the node by random function.\n         * ORDER: Select the first node available unconditionally.\n         */\n        readonly selector?: \"RR\" | \"RANDOM\" | \"ORDER\"\n    }\n}\n"],"sourceRoot":"../.."}

package/driver/spanner/SpannerDriver.d.ts

@@ -0,0 +1,241 @@
+import { Driver, ReturningType } from "../Driver";
+import { SpannerQueryRunner } from "./SpannerQueryRunner";
+import { ObjectLiteral } from "../../common/ObjectLiteral";
+import { ColumnMetadata } from "../../metadata/ColumnMetadata";
+import { Connection } from "../../connection/Connection";
+import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
+import { SpannerConnectionOptions } from "./SpannerConnectionOptions";
+import { MappedColumnTypes } from "../types/MappedColumnTypes";
+import { ColumnType } from "../types/ColumnTypes";
+import { DataTypeDefaults } from "../types/DataTypeDefaults";
+import { TableColumn } from "../../schema-builder/table/TableColumn";
+import { EntityMetadata } from "../../metadata/EntityMetadata";
+import { ReplicationMode } from "../types/ReplicationMode";
+import { Table } from "../../schema-builder/table/Table";
+import { View } from "../../schema-builder/view/View";
+import { TableForeignKey } from "../../schema-builder/table/TableForeignKey";
+import { CteCapabilities } from "../types/CteCapabilities";
+/**
+ * Organizes communication with Spanner DBMS.
+ */
+export declare class SpannerDriver implements Driver {
+    /**
+     * Connection used by driver.
+     */
+    connection: Connection;
+    /**
+     * Cloud Spanner underlying library.
+     */
+    spanner: any;
+    /**
+     * Cloud Spanner instance.
+     */
+    instance: any;
+    /**
+     * Cloud Spanner database.
+     */
+    instanceDatabase: any;
+    /**
+     * Database name.
+     */
+    database?: string;
+    /**
+     * Connection options.
+     */
+    options: SpannerConnectionOptions;
+    /**
+     * Indicates if replication is enabled.
+     */
+    isReplicated: boolean;
+    /**
+     * Indicates if tree tables are supported by this driver.
+     */
+    treeSupport: boolean;
+    /**
+     * Represent transaction support by this driver
+     */
+    transactionSupport: "none";
+    /**
+     * Gets list of supported column data types by a driver.
+     *
+     * @see https://cloud.google.com/spanner/docs/reference/standard-sql/data-types
+     */
+    supportedDataTypes: ColumnType[];
+    /**
+     * Returns type of upsert supported by driver if any
+     */
+    readonly supportedUpsertType: undefined;
+    /**
+     * Gets list of spatial column data types.
+     */
+    spatialTypes: ColumnType[];
+    /**
+     * Gets list of column data types that support length by a driver.
+     */
+    withLengthColumnTypes: ColumnType[];
+    /**
+     * Gets list of column data types that support length by a driver.
+     */
+    withWidthColumnTypes: ColumnType[];
+    /**
+     * Gets list of column data types that support precision by a driver.
+     */
+    withPrecisionColumnTypes: ColumnType[];
+    /**
+     * Gets list of column data types that supports scale by a driver.
+     */
+    withScaleColumnTypes: ColumnType[];
+    /**
+     * ORM has special columns and we need to know what database column types should be for those columns.
+     * Column types are driver dependant.
+     */
+    mappedDataTypes: MappedColumnTypes;
+    /**
+     * Default values of length, precision and scale depends on column data type.
+     * Used in the cases when length/precision/scale is not specified by user.
+     */
+    dataTypeDefaults: DataTypeDefaults;
+    /**
+     * Max length allowed by MySQL for aliases.
+     * @see https://dev.mysql.com/doc/refman/5.5/en/identifiers.html
+     */
+    maxAliasLength: number;
+    cteCapabilities: CteCapabilities;
+    /**
+     * Supported returning types
+     */
+    private readonly _isReturningSqlSupported;
+    constructor(connection: Connection);
+    /**
+     * Performs connection to the database.
+     */
+    connect(): Promise<void>;
+    /**
+     * Makes any action after connection (e.g. create extensions in Postgres driver).
+     */
+    afterConnect(): Promise<void>;
+    /**
+     * Closes connection with the database.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Creates a schema builder used to build and sync a schema.
+     */
+    createSchemaBuilder(): RdbmsSchemaBuilder;
+    /**
+     * Creates a query runner used to execute database queries.
+     */
+    createQueryRunner(mode: ReplicationMode): SpannerQueryRunner;
+    /**
+     * Replaces parameters in the given sql with special escaping character
+     * and an array of parameter names to be passed to a query.
+     */
+    escapeQueryWithParameters(sql: string, parameters: ObjectLiteral, nativeParameters: ObjectLiteral): [string, any[]];
+    /**
+     * Escapes a column name.
+     */
+    escape(columnName: string): string;
+    /**
+     * Build full table name with database name, schema name and table name.
+     * E.g. myDB.mySchema.myTable
+     */
+    buildTableName(tableName: string, schema?: string, database?: string): string;
+    /**
+     * Parse a target table name or other types and return a normalized table definition.
+     */
+    parseTableName(target: EntityMetadata | Table | View | TableForeignKey | string): {
+        database?: string;
+        schema?: string;
+        tableName: string;
+    };
+    /**
+     * Prepares given value to a value to be persisted, based on its column type and metadata.
+     */
+    preparePersistentValue(value: any, columnMetadata: ColumnMetadata): any;
+    /**
+     * Prepares given value to a value to be persisted, based on its column type or metadata.
+     */
+    prepareHydratedValue(value: any, columnMetadata: ColumnMetadata): any;
+    /**
+     * Creates a database type from a given column metadata.
+     */
+    normalizeType(column: {
+        type: ColumnType;
+        length?: number | string;
+        precision?: number | null;
+        scale?: number;
+    }): string;
+    /**
+     * Normalizes "default" value of the column.
+     *
+     * Spanner does not support default values.
+     */
+    normalizeDefault(columnMetadata: ColumnMetadata): string | undefined;
+    /**
+     * Normalizes "isUnique" value of the column.
+     */
+    normalizeIsUnique(column: ColumnMetadata): boolean;
+    /**
+     * Returns default column lengths, which is required on column creation.
+     */
+    getColumnLength(column: ColumnMetadata | TableColumn): string;
+    /**
+     * Creates column type definition including length, precision and scale
+     */
+    createFullType(column: TableColumn): string;
+    /**
+     * Obtains a new database connection to a master server.
+     * Used for replication.
+     * If replication is not setup then returns default connection's database connection.
+     */
+    obtainMasterConnection(): Promise<any>;
+    /**
+     * Obtains a new database connection to a slave server.
+     * Used for replication.
+     * If replication is not setup then returns master (default) connection's database connection.
+     */
+    obtainSlaveConnection(): Promise<any>;
+    /**
+     * Creates generated map of values generated or returned by database after INSERT query.
+     */
+    createGeneratedMap(metadata: EntityMetadata, insertResult: any, entityIndex: number): any;
+    /**
+     * Differentiate columns of this table and columns from the given column metadatas columns
+     * and returns only changed.
+     */
+    findChangedColumns(tableColumns: TableColumn[], columnMetadatas: ColumnMetadata[]): ColumnMetadata[];
+    /**
+     * Returns true if driver supports RETURNING / OUTPUT statement.
+     */
+    isReturningSqlSupported(returningType: ReturningType): boolean;
+    /**
+     * Returns true if driver supports uuid values generation on its own.
+     */
+    isUUIDGenerationSupported(): boolean;
+    /**
+     * Returns true if driver supports fulltext indices.
+     */
+    isFullTextColumnTypeSupported(): boolean;
+    /**
+     * Creates an escaped parameter.
+     */
+    createParameter(parameterName: string, index: number): string;
+    /**
+     * Loads all driver dependencies.
+     */
+    protected loadDependencies(): void;
+    compareNullableValues(columnMetadata: ColumnMetadata, tableColumn: TableColumn): boolean;
+    /**
+     * Checks if "DEFAULT" values in the column metadata and in the database are equal.
+     */
+    protected compareDefaultValues(columnMetadataValue: string | undefined, databaseValue: string | undefined): boolean;
+    /**
+     * If parameter is a datetime function, e.g. "CURRENT_TIMESTAMP", normalizes it.
+     * Otherwise returns original input.
+     */
+    protected normalizeDatetimeFunction(value?: string): string | undefined;
+    /**
+     * Escapes a given comment.
+     */
+    protected escapeComment(comment?: string): string | undefined;
+}