Adds the ability to fetch schemas

kiwicopple · kiwicopple · commit eb6282d7deca · 2020-05-27T13:28:42.000+08:00
diff --git a/dist/api.js b/dist/api.js
@@ -9,6 +9,7 @@ router.use(cors());
 router.use('/config', connectionMiddleware_1.addConnectionToRequest, require('./api/config'));
 router.use('/plugins', connectionMiddleware_1.addConnectionToRequest, require('./api/plugins'));
 router.use('/query', connectionMiddleware_1.addConnectionToRequest, require('./api/query'));
+router.use('/schemas', connectionMiddleware_1.addConnectionToRequest, require('./api/schemas'));
 router.use('/tables', connectionMiddleware_1.addConnectionToRequest, require('./api/tables'));
 router.use('/users', connectionMiddleware_1.addConnectionToRequest, require('./api/users'));
 module.exports = router;
diff --git a/dist/api/schemas.js b/dist/api/schemas.js
@@ -0,0 +1,70 @@
+"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 (_) 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 });
+var Router = require('express').Router;
+var router = new Router();
+var schemas = require('../lib/sql').schemas;
+var RunQuery = require('../lib/connectionPool');
+var schemas_1 = require("../lib/constants/schemas");
+router.get('/', function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
+    var data, query, payload, error_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                _a.trys.push([0, 2, , 3]);
+                return [4 /*yield*/, RunQuery(req.headers.pg, schemas.list)];
+            case 1:
+                data = (_a.sent()).data;
+                query = req.query;
+                payload = data;
+                if (!(query === null || query === void 0 ? void 0 : query.includeSystemSchemas))
+                    payload = removeSystemSchemas(data);
+                return [2 /*return*/, res.status(200).json(payload)];
+            case 2:
+                error_1 = _a.sent();
+                console.log('throwing error');
+                res.status(500).json({ error: 'Database error', status: 500 });
+                return [3 /*break*/, 3];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); });
+var removeSystemSchemas = function (data) {
+    return data.filter(function (x) { return !schemas_1.DEFAULT_SYSTEM_SCHEMAS.includes(x.schema_name); });
+};
+module.exports = router;
diff --git a/dist/lib/constants/schemas.js b/dist/lib/constants/schemas.js
@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SYSTEM_SCHEMAS = void 0;
+exports.DEFAULT_SYSTEM_SCHEMAS = [
+    'information_schema',
+    'pg_catalog',
+    'pg_toast_temp_1',
+    'pg_temp_1',
+    'pg_toast',
+];
diff --git a/dist/lib/interfaces/schemas.js b/dist/lib/interfaces/schemas.js
@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
diff --git a/dist/lib/sql/index.js b/dist/lib/sql/index.js
@@ -27,6 +27,9 @@ module.exports = {
   sequences: {
     list: fs.readFileSync(path.join(__dirname, '/sequences/list.sql')).toString(),
   },
+  schemas: {
+    list: fs.readFileSync(path.join(__dirname, '/schemas/list.sql')).toString(),
+  },
   types: {
     list: fs.readFileSync(path.join(__dirname, '/types/list.sql')).toString(),
   },
diff --git a/dist/lib/sql/schemas/list.sql b/dist/lib/sql/schemas/list.sql
@@ -0,0 +1,10 @@
+SELECT
+    catalog_name,
+    schema_name,
+    schema_owner,
+    default_character_set_catalog,
+    default_character_set_schema,
+    default_character_set_name,
+    sql_path
+FROM
+    information_schema.schemata
diff --git a/package.json b/package.json
@@ -44,14 +44,6 @@
     "url": "https://github.com/supabase/pg-api/issues"
   },
   "homepage": "https://github.com/supabase/pg-api#readme",
-  "babel": {
-    "presets": [
-      "@babel/preset-env"
-    ],
-    "plugins": [
-      "@babel/plugin-transform-runtime"
-    ]
-  },
   "nodemonConfig": {
     "exec": "npm run dev",
     "watch": [
diff --git a/src/api.js b/src/api.js
@@ -8,6 +8,7 @@ router.use(cors())
 router.use('/config', addConnectionToRequest, require('./api/config'))
 router.use('/plugins', addConnectionToRequest, require('./api/plugins'))
 router.use('/query', addConnectionToRequest, require('./api/query'))
+router.use('/schemas', addConnectionToRequest, require('./api/schemas'))
 router.use('/tables', addConnectionToRequest, require('./api/tables'))
 router.use('/users', addConnectionToRequest, require('./api/users'))
 
diff --git a/src/api/schemas.ts b/src/api/schemas.ts
@@ -0,0 +1,35 @@
+const { Router } = require('express')
+const router = new Router()
+const { schemas } = require('../lib/sql')
+const RunQuery = require('../lib/connectionPool')
+import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
+import { Schema } from '../lib/interfaces/schemas'
+
+/**
+ * @param {boolean} [includeSystemSchemas=false] - Return system schemas as well as user schemas
+ */
+interface GetSchemasQueryParams {
+  includeSystemSchemas: boolean
+}
+router.get('/', async (req, res) => {
+  try {
+    const { data } = await RunQuery(req.headers.pg, schemas.list)
+    const query: GetSchemasQueryParams = req.query
+    let payload: Schema[] = data
+    if (!query?.includeSystemSchemas) payload = removeSystemSchemas(data)
+
+    return res.status(200).json(payload)
+  } catch (error) {
+    console.log('throwing error')
+    res.status(500).json({ error: 'Database error', status: 500 })
+  }
+})
+
+
+const removeSystemSchemas = (data: Schema[]) => {
+  return data.filter((x) => !DEFAULT_SYSTEM_SCHEMAS.includes(x.schema_name))
+}
+
+
+
+module.exports = router
diff --git a/src/lib/constants/schemas.ts b/src/lib/constants/schemas.ts
@@ -0,0 +1,7 @@
+export const DEFAULT_SYSTEM_SCHEMAS: string[] = [
+  'information_schema',
+  'pg_catalog',
+  'pg_toast_temp_1',
+  'pg_temp_1',
+  'pg_toast',
+]
diff --git a/src/lib/interfaces/schemas.ts b/src/lib/interfaces/schemas.ts
@@ -0,0 +1,15 @@
+export interface Schema {
+  catalog_name: string
+  schema_name: string
+  schema_owner: string
+  default_character_set_catalog: string
+  default_character_set_schema: string
+  default_character_set_name: string
+  sql_path: string
+}
+/**
+ * @param {string} schema_name The name of the schema which which should be created
+ */
+export interface CreateSchema {
+  schema_name: string
+}
diff --git a/src/lib/sql/index.js b/src/lib/sql/index.js
@@ -27,6 +27,9 @@ module.exports = {
   sequences: {
     list: fs.readFileSync(path.join(__dirname, '/sequences/list.sql')).toString(),
   },
+  schemas: {
+    list: fs.readFileSync(path.join(__dirname, '/schemas/list.sql')).toString(),
+  },
   types: {
     list: fs.readFileSync(path.join(__dirname, '/types/list.sql')).toString(),
   },
diff --git a/src/lib/sql/schemas/list.sql b/src/lib/sql/schemas/list.sql
@@ -0,0 +1,10 @@
+SELECT
+    catalog_name,
+    schema_name,
+    schema_owner,
+    default_character_set_catalog,
+    default_character_set_schema,
+    default_character_set_name,
+    sql_path
+FROM
+    information_schema.schemata
diff --git a/test/integration/index.spec.js b/test/integration/index.spec.js
@@ -49,6 +49,26 @@ describe('/config/version', () => {
     assert.equal(true, res.data.version_number == '120003')
   })
 })
+describe('/schemas', () => {
+  it('GET', async () => {
+    const res = await axios.get(`${URL}/schemas`)
+    // console.log('res.data', res.data)
+    const datum = res.data.find((x) => x.schema_name == 'public')
+    const notIncluded = res.data.find((x) => x.schema_name == 'pg_toast')
+    assert.equal(res.status, STATUS.SUCCESS)
+    assert.equal(true, !!datum)
+    assert.equal(true, !notIncluded)
+  })
+  it('GET with system schemas', async () => {
+    const res = await axios.get(`${URL}/schemas?includeSystemSchemas=true`)
+    // console.log('res.data', res.data)
+    const datum = res.data.find((x) => x.schema_name == 'public')
+    const included = res.data.find((x) => x.schema_name == 'pg_toast')
+    assert.equal(res.status, STATUS.SUCCESS)
+    assert.equal(true, !!datum)
+    assert.equal(true, !!included)
+  })
+})
 describe('/tables', () => {
   it('GET', async () => {
     const res = await axios.get(`${URL}/tables`)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+"use strict";`
	`2`	`+Object.defineProperty(exports, "__esModule", { value: true });`