import { Driver } from "../Driver";
|
import { ObjectLiteral } from "../../common/ObjectLiteral";
|
import { ColumnMetadata } from "../../metadata/ColumnMetadata";
|
import { CockroachConnectionCredentialsOptions } from "./CockroachConnectionCredentialsOptions";
|
import { CockroachConnectionOptions } from "./CockroachConnectionOptions";
|
import { Connection } from "../../connection/Connection";
|
import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
|
import { MappedColumnTypes } from "../types/MappedColumnTypes";
|
import { ColumnType } from "../types/ColumnTypes";
|
import { QueryRunner } from "../../query-runner/QueryRunner";
|
import { DataTypeDefaults } from "../types/DataTypeDefaults";
|
import { TableColumn } from "../../schema-builder/table/TableColumn";
|
import { EntityMetadata } from "../../metadata/EntityMetadata";
|
import { CockroachQueryRunner } from "./CockroachQueryRunner";
|
/**
|
* Organizes communication with Cockroach DBMS.
|
*/
|
export declare class CockroachDriver implements Driver {
|
/**
|
* Connection used by driver.
|
*/
|
connection: Connection;
|
/**
|
* Cockroach underlying library.
|
*/
|
postgres: any;
|
/**
|
* Pool for master database.
|
*/
|
master: any;
|
/**
|
* Pool for slave databases.
|
* Used in replication.
|
*/
|
slaves: any[];
|
/**
|
* We store all created query runners because we need to release them.
|
*/
|
connectedQueryRunners: QueryRunner[];
|
/**
|
* Connection options.
|
*/
|
options: CockroachConnectionOptions;
|
/**
|
* Master database used to perform all write queries.
|
*/
|
database?: string;
|
/**
|
* Indicates if replication is enabled.
|
*/
|
isReplicated: boolean;
|
/**
|
* Indicates if tree tables are supported by this driver.
|
*/
|
treeSupport: boolean;
|
/**
|
* Gets list of supported column data types by a driver.
|
*
|
* @see https://www.cockroachlabs.com/docs/stable/data-types.html
|
*/
|
supportedDataTypes: ColumnType[];
|
/**
|
* 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 precision by a driver.
|
*/
|
withPrecisionColumnTypes: ColumnType[];
|
/**
|
* Gets list of column data types that support scale by a driver.
|
*/
|
withScaleColumnTypes: ColumnType[];
|
/**
|
* Orm has special columns and we need to know what database column types should be for those types.
|
* 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;
|
/**
|
* No documentation specifying a maximum length for identifiers could be found
|
* for CockroarchDb.
|
*/
|
maxAliasLength?: number;
|
constructor(connection: Connection);
|
/**
|
* Performs connection to the database.
|
* Based on pooling options, it can either create connection immediately,
|
* either create a pool and create connection when needed.
|
*/
|
connect(): Promise<void>;
|
/**
|
* Makes any action after connection (e.g. create extensions in Postgres driver).
|
*/
|
afterConnect(): Promise<void>;
|
/**
|
* Closes connection with 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?: "master" | "slave"): CockroachQueryRunner;
|
/**
|
* 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;
|
/**
|
* 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 schema name and table name.
|
* E.g. "mySchema"."myTable"
|
*/
|
buildTableName(tableName: string, schema?: string): string;
|
/**
|
* Creates a database type from a given column metadata.
|
*/
|
normalizeType(column: {
|
type?: ColumnType;
|
length?: number | string;
|
precision?: number | null;
|
scale?: number;
|
isArray?: boolean;
|
isGenerated?: boolean;
|
generationStrategy?: "increment" | "uuid" | "rowid";
|
}): string;
|
/**
|
* Normalizes "default" value of the column.
|
*/
|
normalizeDefault(columnMetadata: ColumnMetadata): string;
|
/**
|
* Normalizes "isUnique" value of the column.
|
*/
|
normalizeIsUnique(column: ColumnMetadata): boolean;
|
/**
|
* Returns default column lengths, which is required on column creation.
|
*/
|
getColumnLength(column: ColumnMetadata): 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.
|
*
|
* todo: slow. optimize Object.keys(), OrmUtils.mergeDeep and column.createValueMap parts
|
*/
|
createGeneratedMap(metadata: EntityMetadata, insertResult: ObjectLiteral): ObjectLiteral | undefined;
|
/**
|
* Differentiate columns of this table and columns from the given column metadatas columns
|
* and returns only changed.
|
*/
|
findChangedColumns(tableColumns: TableColumn[], columnMetadatas: ColumnMetadata[]): ColumnMetadata[];
|
private lowerDefaultValueIfNecessary;
|
/**
|
* Returns true if driver supports RETURNING / OUTPUT statement.
|
*/
|
isReturningSqlSupported(): boolean;
|
/**
|
* Returns true if driver supports uuid values generation on its own.
|
*/
|
isUUIDGenerationSupported(): boolean;
|
/**
|
* Creates an escaped parameter.
|
*/
|
createParameter(parameterName: string, index: number): string;
|
/**
|
* Loads postgres query stream package.
|
*/
|
loadStreamDependency(): any;
|
/**
|
* If driver dependency is not given explicitly, then try to load it via "require".
|
*/
|
protected loadDependencies(): void;
|
/**
|
* Creates a new connection pool for a given database credentials.
|
*/
|
protected createPool(options: CockroachConnectionOptions, credentials: CockroachConnectionCredentialsOptions): Promise<any>;
|
/**
|
* Closes connection pool.
|
*/
|
protected closePool(pool: any): Promise<void>;
|
/**
|
* Executes given query.
|
*/
|
protected executeQuery(connection: any, query: string): Promise<{}>;
|
}
|
