typeorm
Version:
Data-Mapper ORM for TypeScript, ES7, ES6, ES5. Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, MongoDB databases.
668 lines (666 loc) • 27.2 kB
JavaScript
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = y[op[0] & 2 ? "return" : op[0] ? "throw" : "next"]) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [0, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
import { ConnectionIsNotSetError } from "../../error/ConnectionIsNotSetError";
import { DriverPackageNotInstalledError } from "../../error/DriverPackageNotInstalledError";
import { OracleQueryRunner } from "./OracleQueryRunner";
import { DateUtils } from "../../util/DateUtils";
import { PlatformTools } from "../../platform/PlatformTools";
import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
import { DriverUtils } from "../DriverUtils";
import { OrmUtils } from "../../util/OrmUtils";
/**
* Organizes communication with Oracle RDBMS.
*/
var OracleDriver = /** @class */ (function () {
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
function OracleDriver(connection) {
/**
* Pool for slave databases.
* Used in replication.
*/
this.slaves = [];
/**
* Indicates if replication is enabled.
*/
this.isReplicated = false;
/**
* Indicates if tree tables are supported by this driver.
*/
this.treeSupport = true;
/**
* Gets list of supported column data types by a driver.
*
* @see https://www.techonthenet.com/oracle/datatypes.php
* @see https://docs.oracle.com/cd/B28359_01/server.111/b28318/datatype.htm#CNCPT012
*/
this.supportedDataTypes = [
"char",
"nchar",
"nvarchar2",
"varchar2",
"long",
"raw",
"long raw",
"number",
"numeric",
"float",
"dec",
"decimal",
"integer",
"int",
"smallint",
"real",
"double precision",
"date",
"timestamp",
"timestamp with time zone",
"timestamp with local time zone",
"interval year to month",
"interval day to second",
"bfile",
"blob",
"clob",
"nclob",
"rowid",
"urowid"
];
/**
* Gets list of spatial column data types.
*/
this.spatialTypes = [];
/**
* Gets list of column data types that support length by a driver.
*/
this.withLengthColumnTypes = [
"char",
"nchar",
"nvarchar2",
"varchar2",
"varchar",
"raw"
];
/**
* Gets list of column data types that support precision by a driver.
*/
this.withPrecisionColumnTypes = [
"number",
"float",
"timestamp",
"timestamp with time zone",
"timestamp with local time zone"
];
/**
* Gets list of column data types that support scale by a driver.
*/
this.withScaleColumnTypes = [
"number"
];
/**
* Orm has special columns and we need to know what database column types should be for those types.
* Column types are driver dependant.
*/
this.mappedDataTypes = {
createDate: "timestamp",
createDateDefault: "CURRENT_TIMESTAMP",
updateDate: "timestamp",
updateDateDefault: "CURRENT_TIMESTAMP",
version: "number",
treeLevel: "number",
migrationId: "number",
migrationName: "varchar2",
migrationTimestamp: "number",
cacheId: "number",
cacheIdentifier: "varchar2",
cacheTime: "number",
cacheDuration: "number",
cacheQuery: "clob",
cacheResult: "clob",
};
/**
* 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.
*/
this.dataTypeDefaults = {
"char": { length: 1 },
"nchar": { length: 1 },
"varchar": { length: 255 },
"varchar2": { length: 255 },
"nvarchar2": { length: 255 },
"raw": { length: 2000 },
"float": { precision: 126 },
"timestamp": { precision: 6 },
"timestamp with time zone": { precision: 6 },
"timestamp with local time zone": { precision: 6 }
};
this.connection = connection;
this.options = connection.options;
// load oracle package
this.loadDependencies();
// extra oracle setup
this.oracle.outFormat = this.oracle.OBJECT;
// Object.assign(connection.options, DriverUtils.buildDriverOptions(connection.options)); // todo: do it better way
// validate options to make sure everything is set
// if (!this.options.host)
// throw new DriverOptionNotSetError("host");
// if (!this.options.username)
// throw new DriverOptionNotSetError("username");
// if (!this.options.sid)
// throw new DriverOptionNotSetError("sid");
//
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Performs connection to the database.
* Based on pooling options, it can either create connection immediately,
* either create a pool and create connection when needed.
*/
OracleDriver.prototype.connect = function () {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
var _a, _b, _c;
return __generator(this, function (_d) {
switch (_d.label) {
case 0:
this.oracle.fetchAsString = [this.oracle.CLOB];
this.oracle.fetchAsBuffer = [this.oracle.BLOB];
if (!this.options.replication) return [3 /*break*/, 3];
_a = this;
return [4 /*yield*/, Promise.all(this.options.replication.slaves.map(function (slave) {
return _this.createPool(_this.options, slave);
}))];
case 1:
_a.slaves = _d.sent();
_b = this;
return [4 /*yield*/, this.createPool(this.options, this.options.replication.master)];
case 2:
_b.master = _d.sent();
this.database = this.options.replication.master.database;
return [3 /*break*/, 5];
case 3:
_c = this;
return [4 /*yield*/, this.createPool(this.options, this.options)];
case 4:
_c.master = _d.sent();
this.database = this.options.database;
_d.label = 5;
case 5: return [2 /*return*/];
}
});
});
};
/**
* Makes any action after connection (e.g. create extensions in Postgres driver).
*/
OracleDriver.prototype.afterConnect = function () {
return Promise.resolve();
};
/**
* Closes connection with the database.
*/
OracleDriver.prototype.disconnect = function () {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!this.master)
return [2 /*return*/, Promise.reject(new ConnectionIsNotSetError("oracle"))];
return [4 /*yield*/, this.closePool(this.master)];
case 1:
_a.sent();
return [4 /*yield*/, Promise.all(this.slaves.map(function (slave) { return _this.closePool(slave); }))];
case 2:
_a.sent();
this.master = undefined;
this.slaves = [];
return [2 /*return*/];
}
});
});
};
/**
* Creates a schema builder used to build and sync a schema.
*/
OracleDriver.prototype.createSchemaBuilder = function () {
return new RdbmsSchemaBuilder(this.connection);
};
/**
* Creates a query runner used to execute database queries.
*/
OracleDriver.prototype.createQueryRunner = function (mode) {
if (mode === void 0) { mode = "master"; }
return new OracleQueryRunner(this, mode);
};
/**
* Replaces parameters in the given sql with special escaping character
* and an array of parameter names to be passed to a query.
*/
OracleDriver.prototype.escapeQueryWithParameters = function (sql, parameters, nativeParameters) {
var escapedParameters = Object.keys(nativeParameters).map(function (key) {
if (typeof nativeParameters[key] === "boolean")
return nativeParameters[key] ? 1 : 0;
return nativeParameters[key];
});
if (!parameters || !Object.keys(parameters).length)
return [sql, escapedParameters];
var keys = Object.keys(parameters).map(function (parameter) { return "(:(\\.\\.\\.)?" + parameter + "\\b)"; }).join("|");
sql = sql.replace(new RegExp(keys, "g"), function (key) {
var value;
var isArray = false;
if (key.substr(0, 4) === ":...") {
isArray = true;
value = parameters[key.substr(4)];
}
else {
value = parameters[key.substr(1)];
}
if (isArray) {
return value.map(function (v, index) {
escapedParameters.push(v);
return ":" + key.substr(4) + index;
}).join(", ");
}
else if (value instanceof Function) {
return value();
}
else if (typeof value === "boolean") {
return value ? 1 : 0;
}
else {
escapedParameters.push(value);
return key;
}
}); // todo: make replace only in value statements, otherwise problems
return [sql, escapedParameters];
};
/**
* Escapes a column name.
*/
OracleDriver.prototype.escape = function (columnName) {
return "\"" + columnName + "\"";
};
/**
* Build full table name with database name, schema name and table name.
* Oracle does not support table schemas. One user can have only one schema.
*/
OracleDriver.prototype.buildTableName = function (tableName, schema, database) {
return tableName;
};
/**
* Prepares given value to a value to be persisted, based on its column type and metadata.
*/
OracleDriver.prototype.preparePersistentValue = function (value, columnMetadata) {
if (columnMetadata.transformer)
value = columnMetadata.transformer.to(value);
if (value === null || value === undefined)
return value;
if (columnMetadata.type === Boolean) {
return value ? 1 : 0;
}
else if (columnMetadata.type === "date") {
if (typeof value === "string")
value = value.replace(/[^0-9-]/g, "");
return function () { return "TO_DATE('" + DateUtils.mixedDateToDateString(value) + "', 'YYYY-MM-DD')"; };
}
else if (columnMetadata.type === Date
|| columnMetadata.type === "timestamp"
|| columnMetadata.type === "timestamp with time zone"
|| columnMetadata.type === "timestamp with local time zone") {
return DateUtils.mixedDateToDate(value);
}
else if (columnMetadata.type === "simple-array") {
return DateUtils.simpleArrayToString(value);
}
else if (columnMetadata.type === "simple-json") {
return DateUtils.simpleJsonToString(value);
}
return value;
};
/**
* Prepares given value to a value to be persisted, based on its column type or metadata.
*/
OracleDriver.prototype.prepareHydratedValue = function (value, columnMetadata) {
if (value === null || value === undefined)
return value;
if (columnMetadata.type === Boolean) {
value = value === 1 ? true : false;
}
else if (columnMetadata.type === "date") {
value = DateUtils.mixedDateToDateString(value);
}
else if (columnMetadata.type === "time") {
value = DateUtils.mixedTimeToString(value);
}
else if (columnMetadata.type === Date
|| columnMetadata.type === "timestamp"
|| columnMetadata.type === "timestamp with time zone"
|| columnMetadata.type === "timestamp with local time zone") {
value = DateUtils.normalizeHydratedDate(value);
}
else if (columnMetadata.type === "json") {
value = JSON.parse(value);
}
else if (columnMetadata.type === "simple-array") {
value = DateUtils.stringToSimpleArray(value);
}
else if (columnMetadata.type === "simple-json") {
value = DateUtils.stringToSimpleJson(value);
}
if (columnMetadata.transformer)
value = columnMetadata.transformer.from(value);
return value;
};
/**
* Creates a database type from a given column metadata.
*/
OracleDriver.prototype.normalizeType = function (column) {
if (column.type === Number || column.type === Boolean || column.type === "numeric"
|| column.type === "dec" || column.type === "decimal" || column.type === "int"
|| column.type === "integer" || column.type === "smallint") {
return "number";
}
else if (column.type === "real" || column.type === "double precision") {
return "float";
}
else if (column.type === String || column.type === "varchar") {
return "varchar2";
}
else if (column.type === Date) {
return "timestamp";
}
else if (column.type === Buffer) {
return "blob";
}
else if (column.type === "uuid") {
return "varchar2";
}
else if (column.type === "simple-array") {
return "clob";
}
else if (column.type === "simple-json") {
return "clob";
}
else {
return column.type || "";
}
};
/**
* Normalizes "default" value of the column.
*/
OracleDriver.prototype.normalizeDefault = function (columnMetadata) {
var defaultValue = columnMetadata.default;
if (typeof defaultValue === "number") {
return "" + defaultValue;
}
else if (typeof defaultValue === "boolean") {
return defaultValue === true ? "1" : "0";
}
else if (typeof defaultValue === "function") {
return defaultValue();
}
else if (typeof defaultValue === "string") {
return "'" + defaultValue + "'";
}
else {
return defaultValue;
}
};
/**
* Normalizes "isUnique" value of the column.
*/
OracleDriver.prototype.normalizeIsUnique = function (column) {
return column.entityMetadata.uniques.some(function (uq) { return uq.columns.length === 1 && uq.columns[0] === column; });
};
/**
* Calculates column length taking into account the default length values.
*/
OracleDriver.prototype.getColumnLength = function (column) {
if (column.length)
return column.length.toString();
switch (column.type) {
case String:
case "varchar":
case "varchar2":
case "nvarchar2":
return "255";
case "raw":
return "2000";
case "uuid":
return "36";
default:
return "";
}
};
OracleDriver.prototype.createFullType = function (column) {
var type = column.type;
// used 'getColumnLength()' method, because in Oracle column length is required for some data types.
if (this.getColumnLength(column)) {
type += "(" + this.getColumnLength(column) + ")";
}
else if (column.precision !== null && column.precision !== undefined && column.scale !== null && column.scale !== undefined) {
type += "(" + column.precision + "," + column.scale + ")";
}
else if (column.precision !== null && column.precision !== undefined) {
type += "(" + column.precision + ")";
}
if (column.type === "timestamp with time zone") {
type = "TIMESTAMP" + (column.precision !== null && column.precision !== undefined ? "(" + column.precision + ")" : "") + " WITH TIME ZONE";
}
else if (column.type === "timestamp with local time zone") {
type = "TIMESTAMP" + (column.precision !== null && column.precision !== undefined ? "(" + column.precision + ")" : "") + " WITH LOCAL TIME ZONE";
}
if (column.isArray)
type += " array";
return type;
};
/**
* Obtains a new database connection to a master server.
* Used for replication.
* If replication is not setup then returns default connection's database connection.
*/
OracleDriver.prototype.obtainMasterConnection = function () {
var _this = this;
return new Promise(function (ok, fail) {
_this.master.getConnection(function (err, connection, release) {
if (err)
return fail(err);
ok(connection);
});
});
};
/**
* 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.
*/
OracleDriver.prototype.obtainSlaveConnection = function () {
var _this = this;
if (!this.slaves.length)
return this.obtainMasterConnection();
return new Promise(function (ok, fail) {
var random = Math.floor(Math.random() * _this.slaves.length);
_this.slaves[random].getConnection(function (err, connection) {
if (err)
return fail(err);
ok(connection);
});
});
};
/**
* Creates generated map of values generated or returned by database after INSERT query.
*/
OracleDriver.prototype.createGeneratedMap = function (metadata, insertResult) {
if (!insertResult)
return undefined;
return Object.keys(insertResult).reduce(function (map, key) {
var column = metadata.findColumnWithDatabaseName(key);
if (column) {
OrmUtils.mergeDeep(map, column.createValueMap(insertResult[key]));
}
return map;
}, {});
};
/**
* Differentiate columns of this table and columns from the given column metadatas columns
* and returns only changed.
*/
OracleDriver.prototype.findChangedColumns = function (tableColumns, columnMetadatas) {
var _this = this;
return columnMetadatas.filter(function (columnMetadata) {
var tableColumn = tableColumns.find(function (c) { return c.name === columnMetadata.databaseName; });
if (!tableColumn)
return false; // we don't need new columns, we only need exist and changed
return tableColumn.name !== columnMetadata.databaseName
|| tableColumn.type !== _this.normalizeType(columnMetadata)
|| tableColumn.length !== columnMetadata.length
|| tableColumn.precision !== columnMetadata.precision
|| tableColumn.scale !== columnMetadata.scale
// || tableColumn.comment !== columnMetadata.comment || // todo
|| _this.normalizeDefault(columnMetadata) !== tableColumn.default
|| tableColumn.isPrimary !== columnMetadata.isPrimary
|| tableColumn.isNullable !== columnMetadata.isNullable
|| tableColumn.isUnique !== _this.normalizeIsUnique(columnMetadata)
|| (columnMetadata.generationStrategy !== "uuid" && tableColumn.isGenerated !== columnMetadata.isGenerated);
});
};
/**
* Returns true if driver supports RETURNING / OUTPUT statement.
*/
OracleDriver.prototype.isReturningSqlSupported = function () {
return true;
};
/**
* Returns true if driver supports uuid values generation on its own.
*/
OracleDriver.prototype.isUUIDGenerationSupported = function () {
return false;
};
/**
* Creates an escaped parameter.
*/
OracleDriver.prototype.createParameter = function (parameterName, index) {
return ":" + parameterName;
};
/**
* Converts column type in to native oracle type.
*/
OracleDriver.prototype.columnTypeToNativeParameter = function (type) {
switch (this.normalizeType({ type: type })) {
case "number":
case "numeric":
case "int":
case "integer":
case "smallint":
case "dec":
case "decimal":
return this.oracle.NUMBER;
case "char":
case "nchar":
case "nvarchar2":
case "varchar2":
return this.oracle.STRING;
case "blob":
return this.oracle.BLOB;
case "clob":
return this.oracle.CLOB;
case "date":
case "timestamp":
case "timestamp with time zone":
case "timestamp with local time zone":
return this.oracle.DATE;
}
};
// -------------------------------------------------------------------------
// Protected Methods
// -------------------------------------------------------------------------
/**
* Loads all driver dependencies.
*/
OracleDriver.prototype.loadDependencies = function () {
try {
this.oracle = PlatformTools.load("oracledb");
}
catch (e) {
throw new DriverPackageNotInstalledError("Oracle", "oracledb");
}
};
/**
* Creates a new connection pool for a given database credentials.
*/
OracleDriver.prototype.createPool = function (options, credentials) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
var connectionOptions;
return __generator(this, function (_a) {
credentials = Object.assign(credentials, DriverUtils.buildDriverOptions(credentials)); // todo: do it better way
connectionOptions = Object.assign({}, {
user: credentials.username,
password: credentials.password,
connectString: credentials.host + ":" + credentials.port + "/" + credentials.sid,
}, options.extra || {});
// pooling is enabled either when its set explicitly to true,
// either when its not defined at all (e.g. enabled by default)
return [2 /*return*/, new Promise(function (ok, fail) {
_this.oracle.createPool(connectionOptions, function (err, pool) {
if (err)
return fail(err);
ok(pool);
});
})];
});
});
};
/**
* Closes connection pool.
*/
OracleDriver.prototype.closePool = function (pool) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, new Promise(function (ok, fail) {
pool.close(function (err) { return err ? fail(err) : ok(); });
pool = undefined;
})];
});
});
};
return OracleDriver;
}());
export { OracleDriver };
//# sourceMappingURL=OracleDriver.js.map