@proteinjs/db-driver-spanner 1.0.2

package/dist/test/dropTable.js

@@ -0,0 +1,115 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    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) : adopt(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 (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, 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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDropTable = void 0;
+var db_1 = require("@proteinjs/db");
+var getDropTable = function (spannerDriver) {
+    return function (table) { return __awaiter(void 0, void 0, void 0, function () {
+        var tableManager, foreignKeys, _a, _b, _c, _i, columnName, foreignKey, indexes, _d, _e, _f, _g, indexName, error_1;
+        return __generator(this, function (_h) {
+            switch (_h.label) {
+                case 0:
+                    tableManager = spannerDriver.getTableManager();
+                    return [4 /*yield*/, tableManager.schemaMetadata.tableExists(table)];
+                case 1:
+                    if (!_h.sent()) return [3 /*break*/, 15];
+                    return [4 /*yield*/, tableManager.schemaMetadata.getForeignKeys(table)];
+                case 2:
+                    foreignKeys = _h.sent();
+                    _a = foreignKeys;
+                    _b = [];
+                    for (_c in _a)
+                        _b.push(_c);
+                    _i = 0;
+                    _h.label = 3;
+                case 3:
+                    if (!(_i < _b.length)) return [3 /*break*/, 6];
+                    _c = _b[_i];
+                    if (!(_c in _a)) return [3 /*break*/, 5];
+                    columnName = _c;
+                    foreignKey = foreignKeys[columnName];
+                    return [4 /*yield*/, spannerDriver.runUpdateSchema(new db_1.StatementFactory().dropForeignKey(table.name, { table: foreignKey.referencedTableName, column: foreignKey.referencedColumnName, referencedByColumn: columnName }).sql)];
+                case 4:
+                    _h.sent();
+                    _h.label = 5;
+                case 5:
+                    _i++;
+                    return [3 /*break*/, 3];
+                case 6: return [4 /*yield*/, tableManager.schemaMetadata.getIndexes(table)];
+                case 7:
+                    indexes = _h.sent();
+                    _d = indexes;
+                    _e = [];
+                    for (_f in _d)
+                        _e.push(_f);
+                    _g = 0;
+                    _h.label = 8;
+                case 8:
+                    if (!(_g < _e.length)) return [3 /*break*/, 13];
+                    _f = _e[_g];
+                    if (!(_f in _d)) return [3 /*break*/, 12];
+                    indexName = _f;
+                    if (indexName == 'PRIMARY_KEY')
+                        return [3 /*break*/, 12];
+                    _h.label = 9;
+                case 9:
+                    _h.trys.push([9, 11, , 12]);
+                    // console.info(`Dropping index: ${indexName}`);
+                    return [4 /*yield*/, spannerDriver.runUpdateSchema(new db_1.StatementFactory().dropIndex({ name: indexName, columns: indexes[indexName] }, table.name).sql)];
+                case 10:
+                    // console.info(`Dropping index: ${indexName}`);
+                    _h.sent();
+                    return [3 /*break*/, 12];
+                case 11:
+                    error_1 = _h.sent();
+                    console.error("Failed to drop index: ".concat(indexName, "\nreason: ").concat(error_1.details));
+                    return [3 /*break*/, 12];
+                case 12:
+                    _g++;
+                    return [3 /*break*/, 8];
+                case 13: return [4 /*yield*/, spannerDriver.runUpdateSchema("DROP TABLE ".concat(table.name))];
+                case 14:
+                    _h.sent();
+                    _h.label = 15;
+                case 15: return [2 /*return*/];
+            }
+        });
+    }); };
+};
+exports.getDropTable = getDropTable;
+//# sourceMappingURL=dropTable.js.map

package/dist/test/dropTable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dropTable.js","sourceRoot":"","sources":["../../test/dropTable.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oCAAwD;AAGjD,IAAM,YAAY,GAAG,UAAC,aAA4B;IACvD,OAAO,UAAO,KAAiB;;;;;oBAEvB,YAAY,GAAG,aAAa,CAAC,eAAe,EAAE,CAAC;oBACjD,qBAAM,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,CAAC,EAAA;;yBAApD,SAAoD,EAApD,yBAAoD;oBAClC,qBAAM,YAAY,CAAC,cAAc,CAAC,cAAc,CAAC,KAAK,CAAC,EAAA;;oBAArE,WAAW,GAAG,SAAuD;yBACpD,WAAW;;;;;;;;;;;oBAC1B,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;oBAC3C,qBAAM,aAAa,CAAC,eAAe,CAAC,IAAI,qBAAgB,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,mBAAmB,EAAE,MAAM,EAAE,UAAU,CAAC,oBAAoB,EAAE,kBAAkB,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,EAAA;;oBAA9M,SAA8M,CAAC;;;;;wBAGjM,qBAAM,YAAY,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;yBAE7C,OAAO;;;;;;;;;;;oBAC3B,IAAI,SAAS,IAAI,aAAa;wBAC5B,yBAAS;;;;oBAGT,gDAAgD;oBAChD,qBAAM,aAAa,CAAC,eAAe,CAAC,IAAI,qBAAgB,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAA;;oBADvI,gDAAgD;oBAChD,SAAuI,CAAC;;;;oBAExI,OAAO,CAAC,KAAK,CAAC,gCAAyB,SAAS,uBAAa,OAAK,CAAC,OAAO,CAAE,CAAC,CAAC;;;;;yBAGlF,qBAAM,aAAa,CAAC,eAAe,CAAC,qBAAc,KAAK,CAAC,IAAI,CAAE,CAAC,EAAA;;oBAA/D,SAA+D,CAAC;;;;;SAGnE,CAAA;AACH,CAAC,CAAA;AA5BY,QAAA,YAAY,gBA4BxB"}

package/generated/index.ts

@@ -0,0 +1,34 @@
+/** Load Dependency Source Graphs */
+
+import '@google-cloud/spanner';
+import '@proteinjs/db';
+import '@proteinjs/db-query';
+import '@proteinjs/reflection';
+import '@proteinjs/util';
+
+
+/** Generate Source Graph */
+
+const sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/db-driver-spanner/SpannerConfig\",\"value\":{\"packageName\":\"@proteinjs/db-driver-spanner\",\"name\":\"SpannerConfig\",\"filePath\":\"/home/runner/work/db/db/packages/drivers/spanner/src/SpannerConfig.ts\",\"qualifiedName\":\"@proteinjs/db-driver-spanner/SpannerConfig\",\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"typeParameters\":[],\"directParents\":null},{\"packageName\":\"@proteinjs/db-driver-spanner\",\"name\":\"{\\n  projectId: string,\\n  instanceName: string,\\n  databaseName: string,\\n}\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/db-driver-spanner/{\\n  projectId: string,\\n  instanceName: string,\\n  databaseName: string,\\n}\",\"typeParameters\":[],\"directParents\":null}],\"sourceType\":1}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"@proteinjs/db-driver-spanner/SpannerDriver\",\"value\":{\"packageName\":\"@proteinjs/db-driver-spanner\",\"name\":\"SpannerDriver\",\"filePath\":\"/home/runner/work/db/db/packages/drivers/spanner/src/SpannerDriver.ts\",\"qualifiedName\":\"@proteinjs/db-driver-spanner/SpannerDriver\",\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"properties\":[{\"name\":\"SPANNER\",\"type\":{\"packageName\":\"@google-cloud/spanner\",\"name\":\"Spanner\",\"filePath\":null,\"qualifiedName\":\"@google-cloud/spanner/Spanner\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":true,\"visibility\":\"private\"},{\"name\":\"SPANNER_INSTANCE\",\"type\":{\"packageName\":\"@google-cloud/spanner\",\"name\":\"Instance\",\"filePath\":null,\"qualifiedName\":\"@google-cloud/spanner/Instance\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":true,\"visibility\":\"private\"},{\"name\":\"SPANNER_DB\",\"type\":{\"packageName\":\"@google-cloud/spanner\",\"name\":\"Database\",\"filePath\":null,\"qualifiedName\":\"@google-cloud/spanner/Database\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":true,\"visibility\":\"private\"},{\"name\":\"logger\",\"type\":null,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\"},{\"name\":\"config\",\"type\":{\"packageName\":\"@proteinjs/db-driver-spanner\",\"name\":\"SpannerConfig\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/db-driver-spanner/SpannerConfig\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\"}],\"methods\":[{\"name\":\"getSpanner\",\"returnType\":{\"packageName\":\"@google-cloud/spanner\",\"name\":\"Spanner\",\"filePath\":null,\"qualifiedName\":\"@google-cloud/spanner/Spanner\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\",\"parameters\":[]},{\"name\":\"getSpannerInstance\",\"returnType\":{\"packageName\":\"@google-cloud/spanner\",\"name\":\"Instance\",\"filePath\":null,\"qualifiedName\":\"@google-cloud/spanner/Instance\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\",\"parameters\":[]},{\"name\":\"getSpannerDb\",\"returnType\":{\"packageName\":\"@google-cloud/spanner\",\"name\":\"Database\",\"filePath\":null,\"qualifiedName\":\"@google-cloud/spanner/Database\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\",\"parameters\":[]},{\"name\":\"getDbName\",\"returnType\":null,\"isAsync\":false,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]},{\"name\":\"getTableManager\",\"returnType\":{\"packageName\":\"@proteinjs/db\",\"name\":\"TableManager\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/db/TableManager\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]},{\"name\":\"createDbIfNotExists\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<void>\",\"filePath\":null,\"qualifiedName\":\"/Promise<void>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[]},{\"name\":\"dbExists\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<boolean>\",\"filePath\":null,\"qualifiedName\":\"/Promise<boolean>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\",\"parameters\":[{\"name\":\"databaseName\",\"type\":{\"packageName\":\"\",\"name\":\"string\",\"filePath\":null,\"qualifiedName\":\"/string\",\"typeParameters\":null,\"directParents\":null}}]},{\"name\":\"runQuery\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<any[]>\",\"filePath\":null,\"qualifiedName\":\"/Promise<any[]>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"generateStatement\",\"type\":{\"packageName\":\"\",\"name\":\"(config: DbDriverStatementConfig) => Statement\",\"filePath\":null,\"qualifiedName\":\"/(config: DbDriverStatementConfig) => Statement\",\"typeParameters\":null,\"directParents\":null}}]},{\"name\":\"runDml\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<number>\",\"filePath\":null,\"qualifiedName\":\"/Promise<number>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"generateStatement\",\"type\":{\"packageName\":\"\",\"name\":\"(config: DbDriverStatementConfig) => Statement\",\"filePath\":null,\"qualifiedName\":\"/(config: DbDriverStatementConfig) => Statement\",\"typeParameters\":null,\"directParents\":null}}]},{\"name\":\"runUpdateSchema\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<void>\",\"filePath\":null,\"qualifiedName\":\"/Promise<void>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"sql\",\"type\":{\"packageName\":\"\",\"name\":\"string\",\"filePath\":null,\"qualifiedName\":\"/string\",\"typeParameters\":null,\"directParents\":null}}]}],\"typeParameters\":[],\"directParentInterfaces\":[{\"packageName\":\"@proteinjs/db\",\"name\":\"DbDriver\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/db/DbDriver\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"directParentClasses\":[],\"sourceType\":2}},{\"v\":\"@proteinjs/db/DbDriver\"},{\"v\":\"@proteinjs/db-driver-spanner/SpannerSchemaMetadata\",\"value\":{\"packageName\":\"@proteinjs/db-driver-spanner\",\"name\":\"SpannerSchemaMetadata\",\"filePath\":\"/home/runner/work/db/db/packages/drivers/spanner/src/SpannerSchemaMetadata.ts\",\"qualifiedName\":\"@proteinjs/db-driver-spanner/SpannerSchemaMetadata\",\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"properties\":[],\"methods\":[{\"name\":\"getColumnMetadata\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<{[columnName: string]: { type: string, isNullable: boolean }}>\",\"filePath\":null,\"qualifiedName\":\"/Promise<{[columnName: string]: { type: string, isNullable: boolean }}>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"table\",\"type\":{\"packageName\":\"\",\"name\":\"Table<any>\",\"filePath\":null,\"qualifiedName\":\"/Table<any>\",\"typeParameters\":null,\"directParents\":null}}]},{\"name\":\"getPrimaryKey\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<string[]>\",\"filePath\":null,\"qualifiedName\":\"/Promise<string[]>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"table\",\"type\":{\"packageName\":\"\",\"name\":\"Table<any>\",\"filePath\":null,\"qualifiedName\":\"/Table<any>\",\"typeParameters\":null,\"directParents\":null}}]},{\"name\":\"getForeignKeys\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<{[columnName: string]: { referencedTableName: string, referencedColumnName: string }}>\",\"filePath\":null,\"qualifiedName\":\"/Promise<{[columnName: string]: { referencedTableName: string, referencedColumnName: string }}>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"table\",\"type\":{\"packageName\":\"\",\"name\":\"Table<any>\",\"filePath\":null,\"qualifiedName\":\"/Table<any>\",\"typeParameters\":null,\"directParents\":null}}]},{\"name\":\"getUniqueColumns\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<string[]>\",\"filePath\":null,\"qualifiedName\":\"/Promise<string[]>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"table\",\"type\":{\"packageName\":\"\",\"name\":\"Table<any>\",\"filePath\":null,\"qualifiedName\":\"/Table<any>\",\"typeParameters\":null,\"directParents\":null}}]},{\"name\":\"getIndexes\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<{[keyName: string]: string[]}>\",\"filePath\":null,\"qualifiedName\":\"/Promise<{[keyName: string]: string[]}>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"table\",\"type\":{\"packageName\":\"\",\"name\":\"Table<any>\",\"filePath\":null,\"qualifiedName\":\"/Table<any>\",\"typeParameters\":null,\"directParents\":null}}]}],\"typeParameters\":[],\"directParentInterfaces\":[],\"directParentClasses\":[{\"packageName\":\"@proteinjs/db\",\"name\":\"SchemaMetadata\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/db/SchemaMetadata\",\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParentInterfaces\":[],\"directParentClasses\":[]}],\"sourceType\":2}},{\"v\":\"@proteinjs/db/SchemaMetadata\"},{\"v\":\"@proteinjs/db-driver-spanner/SpannerSchemaOperations\",\"value\":{\"packageName\":\"@proteinjs/db-driver-spanner\",\"name\":\"SpannerSchemaOperations\",\"filePath\":\"/home/runner/work/db/db/packages/drivers/spanner/src/SpannerSchemaOperations.ts\",\"qualifiedName\":\"@proteinjs/db-driver-spanner/SpannerSchemaOperations\",\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"properties\":[{\"name\":\"logger\",\"type\":null,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\"},{\"name\":\"spannerDriver\",\"type\":{\"packageName\":\"@proteinjs/db-driver-spanner\",\"name\":\"SpannerDriver\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/db-driver-spanner/SpannerDriver\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\"}],\"methods\":[{\"name\":\"createTable\",\"returnType\":null,\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"table\",\"type\":{\"packageName\":\"\",\"name\":\"Table<any>\",\"filePath\":null,\"qualifiedName\":\"/Table<any>\",\"typeParameters\":null,\"directParents\":null}}]},{\"name\":\"alterTable\",\"returnType\":null,\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"table\",\"type\":{\"packageName\":\"\",\"name\":\"Table<any>\",\"filePath\":null,\"qualifiedName\":\"/Table<any>\",\"typeParameters\":null,\"directParents\":null}},{\"name\":\"tableChanges\",\"type\":{\"packageName\":\"@proteinjs/db\",\"name\":\"TableChanges\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/db/TableChanges\",\"typeParameters\":null,\"directParents\":null}}]}],\"typeParameters\":[],\"directParentInterfaces\":[{\"packageName\":\"@proteinjs/db\",\"name\":\"SchemaOperations\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/db/SchemaOperations\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"directParentClasses\":[],\"sourceType\":2}},{\"v\":\"@proteinjs/db/SchemaOperations\"}],\"edges\":[{\"v\":\"@proteinjs/db-driver-spanner/SpannerConfig\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends type\"},{\"v\":\"@proteinjs/db-driver-spanner/SpannerDriver\",\"w\":\"@proteinjs/db/DbDriver\",\"value\":\"implements interface\"},{\"v\":\"@proteinjs/db-driver-spanner/SpannerSchemaMetadata\",\"w\":\"@proteinjs/db/SchemaMetadata\",\"value\":\"extends class\"},{\"v\":\"@proteinjs/db-driver-spanner/SpannerSchemaOperations\",\"w\":\"@proteinjs/db/SchemaOperations\",\"value\":\"implements interface\"}]}";
+
+
+/** Generate Source Links */
+
+import { SpannerDriver } from '../src/SpannerDriver';
+import { SpannerSchemaMetadata } from '../src/SpannerSchemaMetadata';
+import { SpannerSchemaOperations } from '../src/SpannerSchemaOperations';
+
+const sourceLinks = {
+	'@proteinjs/db-driver-spanner/SpannerDriver': SpannerDriver,
+	'@proteinjs/db-driver-spanner/SpannerSchemaMetadata': SpannerSchemaMetadata,
+	'@proteinjs/db-driver-spanner/SpannerSchemaOperations': SpannerSchemaOperations,
+};
+
+
+/** Load Source Graph and Links */
+
+import { SourceRepository } from '@proteinjs/reflection';
+SourceRepository.merge(sourceGraph, sourceLinks);
+
+
+export * from '../index';

package/index.ts

@@ -0,0 +1,2 @@
+export * from './src/SpannerDriver';
+export * from './src/SpannerConfig';

package/jest.config.js

@@ -0,0 +1,19 @@
+module.exports = {
+	"roots": [
+	  	"<rootDir>/test"
+	],
+	"transform": {
+	  	"^.+\\.tsx?$": "ts-jest"
+	},
+	"testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+	"moduleFileExtensions": [
+		"ts",
+		"tsx",
+		"js",
+		"jsx",
+		"json",
+		"node"
+	],
+	"testEnvironment": "node",
+	"setupFiles": ['./test/setup']
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+    "name": "@proteinjs/db-driver-spanner",
+    "version": "1.0.2",
+    "description": "Db driver for Google Spanner",
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/brentbahry/db.git"
+    },
+    "bugs": {
+        "url": "https://github.com/brentbahry/db/issues"
+    },
+    "homepage": "https://github.com/brentbahry/db#readme",
+    "author": "Brent Bahry",
+    "license": "ISC",
+    "scripts": {
+        "clean": "rm -rf dist/ node_modules/ generated/ package-lock.json",
+        "build": "reflection-build && tsc",
+        "watch": "reflection-watch",
+        "test": "jest --runInBand"
+    },
+    "dependencies": {
+        "@google-cloud/spanner": "7.5.0",
+        "@proteinjs/db": "^1.0.3",
+        "@proteinjs/db-query": "^1.0.2",
+        "@proteinjs/reflection": "1.0.2",
+        "@proteinjs/util": "1.0.18"
+    },
+    "devDependencies": {
+        "@proteinjs/reflection-build": "1.0.5",
+        "@types/jest": "29.5.5",
+        "@types/node": "14.0.27",
+        "jest": "29.7.0",
+        "ts-jest": "29.1.1",
+        "typescript": "5.2.2"
+    },
+    "main": "./dist/generated/index.js",
+    "types": "./dist/generated/index.d.ts",
+    "gitHead": "05f576fa1cbd32912a08f7242b009d73103de30f"
+}

package/src/SpannerColumnTypeFactory.ts

@@ -0,0 +1,25 @@
+import { BinaryColumn, BooleanColumn, Column, DateColumn, DateTimeColumn, DecimalColumn, FloatColumn, IntegerColumn, StringColumn } from '@proteinjs/db';
+
+// max size of a row in spanner is 10mb
+export class SpannerColumnTypeFactory {
+  getType(column: Column<any, any>): string {
+    if (column instanceof IntegerColumn)
+      return 'INT64';
+    else if (column instanceof StringColumn)
+      return `STRING(${column.maxLength})`;
+    else if (column instanceof FloatColumn)
+      return 'FLOAT64';
+    else if (column instanceof DecimalColumn)
+      return column.large ? 'BIGNUMERIC' : 'NUMERIC';
+    else if (column instanceof BooleanColumn)
+      return 'BOOL';
+    else if (column instanceof DateColumn)
+      return 'DATE';
+    else if (column instanceof DateTimeColumn)
+      return 'TIMESTAMP';
+    else if (column instanceof BinaryColumn)
+      return `BYTES(${!(column as BinaryColumn).maxLength ? 'MAX' : (column as BinaryColumn).maxLength})`;
+    
+    throw new Error(`Invalid column type: ${column.constructor.name}, must extend a base column`);
+  }
+}

package/src/SpannerConfig.ts

@@ -0,0 +1,9 @@
+import { Loadable, SourceRepository } from '@proteinjs/reflection';
+
+export const getSpannerConfig = () => SourceRepository.get().object<SpannerConfig>('@proteinjs/db-driver-spanner/SpannerConfig');
+
+export type SpannerConfig = Loadable & {
+  projectId: string,
+  instanceName: string,
+  databaseName: string,
+}

package/src/SpannerDriver.ts

@@ -0,0 +1,115 @@
+import { Database, Instance, Spanner } from '@google-cloud/spanner';
+import { DbDriver, DbDriverStatementConfig, TableManager } from '@proteinjs/db';
+import { SpannerConfig, getSpannerConfig } from './SpannerConfig';
+import { Logger } from '@proteinjs/util';
+import { Statement } from '@proteinjs/db-query';
+import { SpannerSchemaOperations } from './SpannerSchemaOperations';
+import { SpannerColumnTypeFactory } from './SpannerColumnTypeFactory';
+import { SpannerSchemaMetadata } from './SpannerSchemaMetadata';
+
+export class SpannerDriver implements DbDriver {
+	private static SPANNER: Spanner;
+	private static SPANNER_INSTANCE: Instance;
+	private static SPANNER_DB: Database;
+	private logger = new Logger(this.constructor.name);
+	private config: SpannerConfig;
+
+	constructor(config?: SpannerConfig) {
+		this.config = config ? config : getSpannerConfig();
+	}
+
+	private getSpanner(): Spanner {
+		if (!SpannerDriver.SPANNER)
+			SpannerDriver.SPANNER = new Spanner({ projectId: this.config.projectId });
+
+
+		return SpannerDriver.SPANNER;
+	}
+
+	private getSpannerInstance(): Instance {
+		if (!SpannerDriver.SPANNER_INSTANCE)
+			SpannerDriver.SPANNER_INSTANCE = this.getSpanner().instance(this.config.instanceName);
+
+		return SpannerDriver.SPANNER_INSTANCE;
+	}
+
+	private getSpannerDb(): Database {
+		if (!SpannerDriver.SPANNER_DB)
+			SpannerDriver.SPANNER_DB = this.getSpannerInstance().database(this.config.databaseName);
+
+		return SpannerDriver.SPANNER_DB;
+	}
+
+	getDbName() {
+		return this.config.databaseName;
+	}
+
+	getTableManager(): TableManager {
+		const columnTypeFactory = new SpannerColumnTypeFactory();
+		const schemaOperations = new SpannerSchemaOperations(this);
+		const schemaMetadata = new SpannerSchemaMetadata(this, false);
+		return new TableManager(this, columnTypeFactory, schemaOperations, schemaMetadata);
+	}
+
+	async createDbIfNotExists(): Promise<void> {
+		if (await this.dbExists(this.getDbName()))
+			return;
+
+		await this.getSpannerInstance().createDatabase(this.getDbName());
+	}
+
+	private async dbExists(databaseName: string): Promise<boolean> {
+		const [exists] = await this.getSpannerInstance().database(databaseName).exists();
+		return exists;
+	}
+
+	async runQuery(generateStatement: (config: DbDriverStatementConfig) => Statement): Promise<any[]> {
+		const { sql, namedParams } = generateStatement({ useParams: true, useNamedParams: true, prefixTablesWithDb: false });
+		try {
+			this.logger.debug(`Executing query: ${sql}`);
+			const [rows] = await this.getSpannerDb().run({ sql, params: namedParams?.params });
+			return rows.map(row => row.toJSON());
+			// return JSON.parse(JSON.stringify((await this.getSpannerDb().run({ sql, params: namedParams?.params }))[0]));
+		} catch(error: any) {
+			this.logger.error(`Failed when executing query: ${sql}\nreason: ${error.details}`);
+			throw error;
+		}
+	}
+
+	/**
+	 * Execute a write operation.
+	 * 
+	 * @returns number of affected rows
+	 */
+	async runDml(generateStatement: (config: DbDriverStatementConfig) => Statement): Promise<number> {
+		const { sql, namedParams } = generateStatement({ useParams: true, useNamedParams: true, prefixTablesWithDb: false });
+		try {
+			return await this.getSpannerDb().runTransactionAsync(async (transaction) => {
+				this.logger.debug(`Executing dml: ${sql}`);
+				const [rowCount] = await transaction.runUpdate({
+					sql,
+					params: namedParams?.params,
+				});
+				await transaction.commit();
+				return rowCount;
+			});
+		} catch(error: any) {
+			this.logger.error(`Failed when executing dml: ${sql}\nreason: ${error.details}`);
+			throw error;
+		}
+	}
+
+	/**
+	 * Execute a schema write operation.
+	 */
+	async runUpdateSchema(sql: string): Promise<void> {
+		try {
+			this.logger.debug(`Executing schema update: ${sql}`)
+			const [operation] = await this.getSpannerDb().updateSchema(sql);
+      await operation.promise();
+		} catch(error: any) {
+			this.logger.error(`Failed when executing schema update: ${sql}\nreason: ${error.details}`);
+			throw error;
+		}
+	}
+}

package/src/SpannerSchemaMetadata.ts

@@ -0,0 +1,96 @@
+import { ParameterizationConfig, QueryBuilder, SchemaMetadata, Table } from '@proteinjs/db';
+
+export class SpannerSchemaMetadata extends SchemaMetadata {
+  async getColumnMetadata(table: Table<any>): Promise<{[columnName: string]: { type: string, isNullable: boolean }}> {
+    const qb = QueryBuilder.fromObject({
+      'TABLE_NAME': table.name
+    }, 'COLUMNS');
+    const generateStatement = (config: ParameterizationConfig) => qb.toSql({ dbName: 'INFORMATION_SCHEMA', ...config });
+		const results = await this.dbDriver.runQuery(generateStatement);
+    const columnMetadata: {[columnName: string]: { type: string, isNullable: boolean }} = {};
+    for (const row of results)
+      columnMetadata[row['COLUMN_NAME']] = { type: row['SPANNER_TYPE'], isNullable: row['IS_NULLABLE'] === 'YES' };
+  
+    return columnMetadata;
+  }
+
+  async getPrimaryKey(table: Table<any>): Promise<string[]> {
+		const indexes = await this.getIndexes(table);
+    return indexes['PRIMARY_KEY'];
+  }
+
+  async getForeignKeys(table: Table<any>): Promise<{[columnName: string]: { referencedTableName: string, referencedColumnName: string }}> {
+    const tableConstraintsQb = QueryBuilder.fromObject({
+      'TABLE_NAME': table.name,
+      'CONSTRAINT_TYPE': 'FOREIGN KEY'
+    }, 'TABLE_CONSTRAINTS');
+    const generateTableConstraintsStatement = (config: ParameterizationConfig) => tableConstraintsQb.toSql({ dbName: 'INFORMATION_SCHEMA', ...config });
+		const tableConstraints = await this.dbDriver.runQuery(generateTableConstraintsStatement);
+    const foreignKeys: {[columnName: string]: { referencedTableName: string, referencedColumnName: string }} = {};
+    for (const tableConstraint of tableConstraints) {
+      const referentialConstraintsQb = QueryBuilder.fromObject({
+        'CONSTRAINT_NAME': tableConstraint['CONSTRAINT_NAME']
+      }, 'REFERENTIAL_CONSTRAINTS');
+      const generateReferentialConstraintsStatement = (config: ParameterizationConfig) => referentialConstraintsQb.toSql({ dbName: 'INFORMATION_SCHEMA', ...config });
+      const referentialConstraints = await this.dbDriver.runQuery(generateReferentialConstraintsStatement);
+      const referencedTableConstraintName = referentialConstraints[0]['UNIQUE_CONSTRAINT_NAME'];
+      
+      const referenceTableConstraintsQb = QueryBuilder.fromObject({
+        'CONSTRAINT_NAME': referencedTableConstraintName
+      }, 'TABLE_CONSTRAINTS');
+      const generateReferenceTableConstraintsStatement = (config: ParameterizationConfig) => referenceTableConstraintsQb.toSql({ dbName: 'INFORMATION_SCHEMA', ...config });
+      const referenceTableConstraints = await this.dbDriver.runQuery(generateReferenceTableConstraintsStatement);
+      const referencedTableName = referenceTableConstraints[0]['TABLE_NAME'];
+
+      const keyColumnUsageQb = QueryBuilder.fromObject({
+        'TABLE_NAME': table.name,
+        'CONSTRAINT_NAME': tableConstraint['CONSTRAINT_NAME']
+      }, 'KEY_COLUMN_USAGE');
+      const generateKeyColumnUsageStatement = (config: ParameterizationConfig) => keyColumnUsageQb.toSql({ dbName: 'INFORMATION_SCHEMA', ...config });
+      const keyColumnUsages = await this.dbDriver.runQuery(generateKeyColumnUsageStatement);
+      const referencingColumnName = keyColumnUsages[0]['COLUMN_NAME'];
+
+      foreignKeys[referencingColumnName] = {
+        referencedTableName,
+        referencedColumnName: 'id',
+      };
+    }
+  
+    return foreignKeys;
+  }
+
+  async getUniqueColumns(table: Table<any>): Promise<string[]> {
+    const indexes = await this.getIndexes(table);
+    const uniqueColumns: string[] = [];
+    for (const indexName in indexes) {
+      if (!indexName.endsWith('_unique'))
+        continue;
+  
+      const indexedColumns = indexes[indexName];
+      uniqueColumns.push(...indexedColumns);
+    }
+  
+    return uniqueColumns;
+  }
+
+  async getIndexes(table: Table<any>): Promise<{[keyName: string]: string[]}> {
+    const qb = new QueryBuilder('INDEX_COLUMNS')
+      .condition({ field: 'TABLE_NAME', operator: '=', value: table.name })
+      .sort([{ field: 'ORDINAL_POSITION', desc: false }])
+    ;
+    const generateStatement = (config: ParameterizationConfig) => qb.toSql({ dbName: 'INFORMATION_SCHEMA', ...config });
+		const results: any[] = await this.dbDriver.runQuery(generateStatement);
+    const indexes: { [keyName: string]: string[] } = {};
+    for (const row of results) {
+      if (!row['INDEX_NAME'])
+        continue;
+
+      if (!indexes[row['INDEX_NAME']])
+        indexes[row['INDEX_NAME']] = [];
+  
+      indexes[row['INDEX_NAME']].push(row['COLUMN_NAME']);
+    }
+  
+    return indexes;
+  }
+}

package/src/SpannerSchemaOperations.ts

@@ -0,0 +1,122 @@
+import { Logger } from '@proteinjs/util';
+import { Table, SchemaOperations, TableChanges, StatementFactory, AlterTableParams, StatementUtil, getColumnByName } from '@proteinjs/db';
+import { SpannerDriver } from './SpannerDriver';
+import { SpannerColumnTypeFactory } from './SpannerColumnTypeFactory';
+
+export class SpannerSchemaOperations implements SchemaOperations {
+  private logger = new Logger(this.constructor.name);
+
+  constructor(
+    private spannerDriver: SpannerDriver
+  ){}
+
+  async createTable(table: Table<any>) {
+    const indexes: { name?: string, columns: string|string[], unique?: boolean }[] = [];
+    for (let index of table.indexes) {
+      indexes.push({ name: index.name, columns: index.columns as string[] });
+    }
+
+    const serializedColumns: { name: string, type: string, nullable?: boolean }[] = [];
+    const foreignKeys: { table: string, column: string, referencedByColumn: string }[] = [];
+    for (const columnPropertyName in table.columns) {
+      const column = table.columns[columnPropertyName];
+      const columnType = new SpannerColumnTypeFactory().getType(column);
+      serializedColumns.push({ name: column.name, type: columnType, nullable: column.options?.nullable });
+      this.logger.info(`[${table.name}] Creating column: ${column.name} (${column.constructor.name})`)
+      if (column.options?.unique?.unique) {
+        indexes.push({ name: column.options.unique.indexName, columns: column.name, unique: true });
+        this.logger.info(`[${table.name}.${column.name}] Adding unique constraint`);
+      }
+  
+      if (column.options?.references) {
+        foreignKeys.push({ table: column.options.references.table, column: 'id', referencedByColumn: column.name });
+        this.logger.info(`[${table.name}.${column.name}] Adding foreign key -> ${column.options.references.table}.id`);
+      }
+    }
+    const createTableSql = new StatementFactory().createTable(table.name, serializedColumns, 'id', foreignKeys).sql;
+    await this.spannerDriver.runUpdateSchema(createTableSql);
+
+    for (let index of indexes) {
+      const createIndexSql = new StatementFactory().createIndex(index, table.name).sql;
+      const indexName = StatementUtil.getIndexName(table.name, index);
+      this.logger.info(`[${table.name}] Creating index: ${indexName} (${typeof index.columns === 'string' ? index.columns : index.columns.join(', ')})`);
+      await this.spannerDriver.runUpdateSchema(createIndexSql);
+      this.logger.info(`[${table.name}] Created index: ${indexName} (${typeof index.columns === 'string' ? index.columns : index.columns.join(', ')})`);
+    }
+  }
+
+  async alterTable(table: Table<any>, tableChanges: TableChanges) {
+    const alterParams: AlterTableParams = {
+      tableName: table.name,
+      columnsToAdd: [],
+      foreignKeysToDrop: [],
+      foreignKeysToAdd: [],
+      columnRenames: [],
+    };
+    const indexesToDrop = tableChanges.indexesToDrop;
+    const indexesToAdd = tableChanges.indexesToCreate;
+		for (const columnPropertyName of tableChanges.columnsToCreate) {
+      const column = table.columns[columnPropertyName];
+      const columnType = new SpannerColumnTypeFactory().getType(column);
+      alterParams.columnsToAdd?.push({ name: column.name, type: columnType, nullable: column.options?.nullable });
+      this.logger.info(`[${table.name}] Creating column: ${column.name} (${column.constructor.name})`);
+      if (column.options?.unique?.unique && tableChanges.columnsWithUniqueConstraintsToCreate.includes(column.name)) {
+        indexesToAdd.push({ name: column.options.unique.indexName, columns: column.name, unique: true });
+        this.logger.info(`[${table.name}.${column.name}] Adding unique constraint`);
+      }
+  
+      if (column.options?.references && tableChanges.columnsWithForeignKeysToCreate.includes(column.name)) {
+        alterParams.foreignKeysToAdd?.push({ table: column.options.references.table, column: 'id', referencedByColumn: column.name });
+        this.logger.info(`[${table.name}.${column.name}] Adding foreign key -> ${column.options.references.table}.id`);
+      }
+    }
+
+    for (const columnName of tableChanges.columnsWithUniqueConstraintsToDrop) {
+      indexesToDrop.push({ columns: columnName, unique: true });
+      this.logger.info(`[${table.name}.${columnName}] Dropping unique constraint`);
+    }
+
+    for (const foreignKey of tableChanges.foreignKeysToDrop) {
+      alterParams.foreignKeysToDrop?.push(foreignKey);
+      this.logger.info(`[${table.name}.${foreignKey.referencedByColumn}] Dropping foreign key -> ${foreignKey.table}.${foreignKey.column}`);
+    }
+
+    for (const columnTypeChange of tableChanges.columnTypeChanges) {
+      const errorMessage = `[${table.name}.${columnTypeChange.name}] Unable to change column types in Spanner. Attempted to change type to: ${columnTypeChange.newType}`;
+      this.logger.error(errorMessage);
+      throw new Error(errorMessage);
+    }
+
+    for (const columnNullableChange of tableChanges.columnNullableChanges) {
+      const errorMessage = `[${table.name}.${columnNullableChange.name}] Unable to update nullable constraint on existing column in Spanner. Attempted to update nullable constraint to: ${columnNullableChange.nullable === true}`;
+      this.logger.error(errorMessage);
+      throw new Error(errorMessage);
+    }
+
+    for (const columnPropertyName of tableChanges.columnsToRename) {
+      const column = table.columns[columnPropertyName];
+      const errorMessage = `[${table.name}.${column.oldName}] Unable to rename columns in Spanner. Attempted to perform rename: ${column.oldName} -> ${column.name}`;
+      this.logger.error(errorMessage);
+      throw new Error(errorMessage);
+    }
+
+    const alterStatements = new StatementFactory().alterTable(alterParams);
+    for (let alterStatement of alterStatements)
+      await this.spannerDriver.runUpdateSchema(alterStatement.sql);
+
+    for (let index of tableChanges.indexesToDrop) {
+      const dropIndexSql = new StatementFactory().dropIndex(index, table.name).sql;
+      this.logger.info(`[${table.name}] Dropping index: ${index.name} (${typeof index.columns === 'string' ? index.columns : index.columns.join(', ')})`);
+      await this.spannerDriver.runUpdateSchema(dropIndexSql);
+      this.logger.info(`[${table.name}] Dropped index: ${index.name} (${typeof index.columns === 'string' ? index.columns : index.columns.join(', ')})`);
+    }
+
+    for (let index of tableChanges.indexesToCreate) {
+      const createIndexSql = new StatementFactory().createIndex(index, table.name).sql;
+      const indexName = StatementUtil.getIndexName(table.name, index);
+      this.logger.info(`[${table.name}] Creating index: ${indexName} (${typeof index.columns === 'string' ? index.columns : index.columns.join(', ')})`);
+      await this.spannerDriver.runUpdateSchema(createIndexSql);
+      this.logger.info(`[${table.name}] Created index: ${indexName} (${typeof index.columns === 'string' ? index.columns : index.columns.join(', ')})`);
+    }
+	}
+}

package/test/Crud.test.ts

@@ -0,0 +1,17 @@
+import { crudTests } from '@proteinjs/db'
+import { SpannerDriver } from '../src/SpannerDriver'
+import { getDropTable } from './dropTable'
+
+const spannerDriver = new SpannerDriver({
+	projectId: 'proteinjs-test',
+	instanceName: 'proteinjs-test',
+	databaseName: 'test',
+});
+
+describe(
+	'CRUD Tests',
+	crudTests(
+		spannerDriver,
+		getDropTable(spannerDriver)
+	)
+);