????
Your IP : 18.191.37.17
import { ColumnType, DataSource, EntityMetadata, ObjectLiteral, Table, TableColumn, TableForeignKey } from "../..";
import { ColumnMetadata } from "../../metadata/ColumnMetadata";
import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
import { Driver } from "../Driver";
import { CteCapabilities } from "../types/CteCapabilities";
import { DataTypeDefaults } from "../types/DataTypeDefaults";
import { MappedColumnTypes } from "../types/MappedColumnTypes";
import { SapConnectionOptions } from "./SapConnectionOptions";
import { SapQueryRunner } from "./SapQueryRunner";
import { ReplicationMode } from "../types/ReplicationMode";
import { View } from "../../schema-builder/view/View";
import { UpsertType } from "../types/UpsertType";
/**
* Organizes communication with SAP Hana DBMS.
*
* todo: looks like there is no built in support for connection pooling, we need to figure out something
*/
export declare class SapDriver implements Driver {
/**
* Connection used by driver.
*/
connection: DataSource;
/**
* Hana Pool instance.
*/
client: any;
/**
* Hana Client streaming extension.
*/
streamClient: any;
/**
* Pool for master database.
*/
master: any;
/**
* Pool for slave databases.
* Used in replication.
*/
slaves: any[];
/**
* Connection options.
*/
options: SapConnectionOptions;
/**
* Database name used to perform all write queries.
*/
database?: string;
/**
* Schema name used to perform all write queries.
*/
schema?: string;
/**
* 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: "simple";
/**
* Gets list of supported column data types by a driver.
*
* @see https://help.sap.com/viewer/4fe29514fd584807ac9f2a04f6754767/2.0.03/en-US/20a1569875191014b507cf392724b7eb.html
*/
supportedDataTypes: ColumnType[];
/**
* Returns type of upsert supported by driver if any
*/
supportedUpsertTypes: UpsertType[];
/**
* 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;
/**
* Max length allowed by SAP HANA for aliases (identifiers).
* @see https://help.sap.com/viewer/4fe29514fd584807ac9f2a04f6754767/2.0.03/en-US/20a760537519101497e3cfe07b348f3c.html
*/
maxAliasLength: number;
cteCapabilities: CteCapabilities;
dummyTableName: string;
constructor(connection: DataSource);
/**
* 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 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): SapQueryRunner;
/**
* 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. myDB.mySchema.myTable
*/
buildTableName(tableName: string, schema?: 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.
*/
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: ObjectLiteral): 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(): 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;
/**
* If driver dependency is not given explicitly, then try to load it via "require".
*/
protected loadDependencies(): void;
/**
* Escapes a given comment.
*/
protected escapeComment(comment?: string): string | undefined;
}