Merge branch 'BUDI-8064/doc-writethrough' into BUDI-8046/scim-logger

lerna.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.20.14",
+  "version": "2.21.2",
   "npmClient": "yarn",
   "packages": [
     "packages/*",

packages/account-portal

@@ -1 +1 @@
-Subproject commit 19f7a5829f4d23cbc694136e45d94482a59a475a
+Subproject commit 0c050591c21d3b67dc0c9225d60cc9e2324c8dac

packages/backend-core/src/cache/docWritethrough.ts

@@ -3,6 +3,10 @@ import { getDocWritethroughClient } from "../redis/init"
 import { AnyDocument, Database, LockName, LockType } from "@budibase/types"
 import * as locks from "../redis/redlockImpl"
 
+import { JobQueue, createQueue } from "../queue"
+import * as context from "../context"
+import * as dbUtils from "../db"
+
 const DEFAULT_WRITE_RATE_MS = 10000
 
 let CACHE: BaseCache | null = null
@@ -14,16 +18,84 @@ async function getCache() {
   return CACHE
 }
 
-interface CacheItem {
+interface ProcessDocMessage {
-  nextWrite: number
+  tenantId: string
+  dbName: string
+  docId: string
+  cacheKeyPrefix: string
+}
+
+export const docWritethroughProcessorQueue = createQueue<ProcessDocMessage>(
+  JobQueue.DOC_WRITETHROUGH_QUEUE
+)
+
+let _init = false
+export const init = () => {
+  if (_init) {
+    return
+  }
+  docWritethroughProcessorQueue.process(async message => {
+    const { tenantId, cacheKeyPrefix } = message.data
+    await context.doInTenant(tenantId, async () => {
+      const lockResponse = await locks.doWithLock(
+        {
+          type: LockType.TRY_ONCE,
+          name: LockName.PERSIST_WRITETHROUGH,
+          resource: cacheKeyPrefix,
+          ttl: 15000,
+        },
+        async () => {
+          await persistToDb(message.data)
+        }
+      )
+
+      if (!lockResponse.executed) {
+        console.log(`Ignoring redlock conflict in write-through cache`)
+      }
+    })
+  })
+  _init = true
+}
+
+export async function persistToDb({
+  dbName,
+  docId,
+  cacheKeyPrefix,
+}: {
+  dbName: string
+  docId: string
+  cacheKeyPrefix: string
+}) {
+  const cache = await getCache()
+
+  const db = dbUtils.getDB(dbName)
+  let doc: AnyDocument | undefined
+  try {
+    doc = await db.get(docId)
+  } catch {
+    doc = { _id: docId }
+  }
+
+  const keysToPersist = await cache.keys(`${cacheKeyPrefix}:data:*`)
+  for (const key of keysToPersist) {
+    const data = await cache.get(key, { useTenancy: false })
+    doc[data.key] = data.value
+  }
+
+  await db.put(doc)
+
+  for (const key of keysToPersist) {
+    await cache.delete(key, { useTenancy: false })
+  }
 }
 
 export class DocWritethrough {
   private db: Database
   private _docId: string
   private writeRateMs: number
+  private tenantId: string
 
-  private docInfoCacheKey: string
+  private cacheKeyPrefix: string
 
   constructor(
     db: Database,
@@ -33,81 +105,39 @@ export class DocWritethrough {
     this.db = db
     this._docId = docId
     this.writeRateMs = writeRateMs
-    this.docInfoCacheKey = `${this.docId}:info`
+    this.cacheKeyPrefix = `${this.db.name}:${this.docId}`
+    this.tenantId = context.getTenantId()
   }
 
   get docId() {
     return this._docId
   }
 
-  private makeNextWriteInfoItem(): CacheItem {
-    return { nextWrite: Date.now() + this.writeRateMs }
-  }
-
   async patch(data: Record<string, any>) {
     const cache = await getCache()
 
     await this.storeToCache(cache, data)
 
-    const updateDb = await this.shouldUpdateDb(cache)
+    docWritethroughProcessorQueue.add(
-
+      {
-    if (updateDb) {
+        tenantId: this.tenantId,
-      const lockResponse = await locks.doWithLock(
+        dbName: this.db.name,
-        {
+        docId: this.docId,
-          type: LockType.TRY_ONCE,
+        cacheKeyPrefix: this.cacheKeyPrefix,
-          name: LockName.PERSIST_WRITETHROUGH,
+      },
-          resource: this.docInfoCacheKey,
+      {
-          ttl: 15000,
+        delay: this.writeRateMs,
-        },
+        jobId: this.cacheKeyPrefix,
-        async () => {
+        removeOnFail: true,
-          if (await this.shouldUpdateDb(cache)) {
+        removeOnComplete: true,
-            await this.persistToDb(cache)
-            await cache.store(
-              this.docInfoCacheKey,
-              this.makeNextWriteInfoItem()
-            )
-          }
-        }
-      )
-
-      if (!lockResponse.executed) {
-        console.log(`Ignoring redlock conflict in write-through cache`)
       }
-    }
-  }
-
-  private async shouldUpdateDb(cache: BaseCache) {
-    const cacheItem = await cache.withCache(this.docInfoCacheKey, null, () =>
-      this.makeNextWriteInfoItem()
     )
-    return Date.now() >= cacheItem.nextWrite
   }
 
   private async storeToCache(cache: BaseCache, data: Record<string, any>) {
     for (const [key, value] of Object.entries(data)) {
-      const cacheKey = this.docId + ":data:" + key
+      const cacheKey = this.cacheKeyPrefix + ":data:" + key
       await cache.store(cacheKey, { key, value }, undefined)
     }
   }
-
-  private async persistToDb(cache: BaseCache) {
-    let doc: AnyDocument | undefined
-    try {
-      doc = await this.db.get(this.docId)
-    } catch {
-      doc = { _id: this.docId }
-    }
-
-    const keysToPersist = await cache.keys(`${this.docId}:data:*`)
-    for (const key of keysToPersist) {
-      const data = await cache.get(key, { useTenancy: false })
-      doc[data.key] = data.value
-    }
-
-    await this.db.put(doc)
-
-    for (const key of keysToPersist) {
-      await cache.delete(key, { useTenancy: false })
-    }
-  }
 }

packages/backend-core/src/cache/tests/docWritethrough.spec.ts

@@ -1,20 +1,32 @@
-import tk from "timekeeper"
-
 import { DBTestConfiguration, generator, structures } from "../../../tests"
 import { getDB } from "../../db"
-import { DocWritethrough } from "../docWritethrough"
 import _ from "lodash"
 
-const WRITE_RATE_MS = 500
+import {
+  DocWritethrough,
+  docWritethroughProcessorQueue,
+  init,
+} from "../docWritethrough"
+import InMemoryQueue from "../../queue/inMemoryQueue"
+
+const WRITE_RATE_MS = 1000
 
 const initialTime = Date.now()
 
+jest.useFakeTimers({
+  now: initialTime,
+})
+
 function resetTime() {
-  tk.travel(initialTime)
+  jest.setSystemTime(initialTime)
 }
-function travelForward(ms: number) {
+async function travelForward(ms: number) {
-  const updatedTime = Date.now() + ms
+  await jest.advanceTimersByTimeAsync(ms)
-  tk.travel(updatedTime)
+
+  const queue: InMemoryQueue = docWritethroughProcessorQueue as never
+  while (queue.hasRunningJobs()) {
+    await jest.runOnlyPendingTimersAsync()
+  }
 }
 
 describe("docWritethrough", () => {
@@ -33,33 +45,37 @@ describe("docWritethrough", () => {
       }, {} as Record<string, any>)
     }
 
-    beforeEach(() => {
+    beforeAll(() => init())
+
+    beforeEach(async () => {
       resetTime()
-      documentId = structures.db.id()
+      documentId = structures.uuid()
-      docWritethrough = new DocWritethrough(db, documentId, WRITE_RATE_MS)
-    })
-
-    it("patching will not persist if timeout from the creation does not hit", async () => {
       await config.doInTenant(async () => {
-        travelForward(WRITE_RATE_MS)
+        docWritethrough = new DocWritethrough(db, documentId, WRITE_RATE_MS)
-        await docWritethrough.patch(generatePatchObject(2))
-        await docWritethrough.patch(generatePatchObject(2))
-        travelForward(WRITE_RATE_MS - 1)
-        await docWritethrough.patch(generatePatchObject(2))
-
-        expect(await db.docExists(documentId)).toBe(false)
       })
     })
 
-    it("patching will persist if timeout hits and next patch is called", async () => {
+    it("patching will not persist if timeout does not hit", async () => {
+      await config.doInTenant(async () => {
+        await travelForward(WRITE_RATE_MS)
+        await docWritethrough.patch(generatePatchObject(2))
+        await docWritethrough.patch(generatePatchObject(2))
+        await travelForward(WRITE_RATE_MS - 1)
+
+        expect(await db.exists(documentId)).toBe(false)
+      })
+    })
+
+    it("patching will persist if timeout hits", async () => {
       await config.doInTenant(async () => {
         const patch1 = generatePatchObject(2)
         const patch2 = generatePatchObject(2)
         await docWritethrough.patch(patch1)
         await docWritethrough.patch(patch2)
 
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
 
+        // This will not be persisted
         const patch3 = generatePatchObject(3)
         await docWritethrough.patch(patch3)
 
@@ -67,7 +83,6 @@ describe("docWritethrough", () => {
           _id: documentId,
           ...patch1,
           ...patch2,
-          ...patch3,
           _rev: expect.stringMatching(/1-.+/),
           createdAt: new Date(initialTime + WRITE_RATE_MS).toISOString(),
           updatedAt: new Date(initialTime + WRITE_RATE_MS).toISOString(),
@@ -82,15 +97,12 @@ describe("docWritethrough", () => {
         await docWritethrough.patch(patch1)
         await docWritethrough.patch(patch2)
 
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
 
         const patch3 = generatePatchObject(3)
         await docWritethrough.patch(patch3)
 
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
-
-        const patch4 = generatePatchObject(3)
-        await docWritethrough.patch(patch4)
 
         expect(await db.get(documentId)).toEqual(
           expect.objectContaining({
@@ -98,7 +110,6 @@ describe("docWritethrough", () => {
             ...patch1,
             ...patch2,
             ...patch3,
-            ...patch4,
           })
         )
       })
@@ -109,16 +120,13 @@ describe("docWritethrough", () => {
         const patch1 = generatePatchObject(2)
         const patch2 = generatePatchObject(2)
         await docWritethrough.patch(patch1)
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
         const date1 = new Date()
         await docWritethrough.patch(patch2)
 
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
         const date2 = new Date()
 
-        const patch3 = generatePatchObject(3)
-        await docWritethrough.patch(patch3)
-
         expect(date1).not.toEqual(date2)
         expect(await db.get(documentId)).toEqual(
           expect.objectContaining({
@@ -129,22 +137,11 @@ describe("docWritethrough", () => {
       })
     })
 
-    it("patching will not persist even if timeout hits but next patch is not callec", async () => {
-      await config.doInTenant(async () => {
-        await docWritethrough.patch(generatePatchObject(2))
-        await docWritethrough.patch(generatePatchObject(2))
-
-        travelForward(WRITE_RATE_MS)
-
-        expect(await db.docExists(documentId)).toBe(false)
-      })
-    })
-
     it("concurrent patches will override keys", async () => {
       await config.doInTenant(async () => {
         const patch1 = generatePatchObject(2)
         await docWritethrough.patch(patch1)
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
         const patch2 = generatePatchObject(1)
         await docWritethrough.patch(patch2)
 
@@ -155,13 +152,14 @@ describe("docWritethrough", () => {
           })
         )
 
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
 
         const patch3 = {
           ...generatePatchObject(3),
           [keyToOverride]: generator.word(),
         }
         await docWritethrough.patch(patch3)
+        await travelForward(WRITE_RATE_MS)
 
         expect(await db.get(documentId)).toEqual(
           expect.objectContaining({
@@ -173,7 +171,7 @@ describe("docWritethrough", () => {
       })
     })
 
-    it("concurrent patches to multiple DocWritethrough will not contaminate each other", async () => {
+    it("concurrent patches to different docWritethrough will not pollute each other", async () => {
       await config.doInTenant(async () => {
         const secondDocWritethrough = new DocWritethrough(
           db,
@@ -186,12 +184,13 @@ describe("docWritethrough", () => {
         const doc2Patch = generatePatchObject(1)
         await secondDocWritethrough.patch(doc2Patch)
 
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
 
         const doc1Patch2 = generatePatchObject(3)
         await docWritethrough.patch(doc1Patch2)
         const doc2Patch2 = generatePatchObject(3)
         await secondDocWritethrough.patch(doc2Patch2)
+        await travelForward(WRITE_RATE_MS)
 
         expect(await db.get(docWritethrough.docId)).toEqual(
           expect.objectContaining({
@@ -214,7 +213,7 @@ describe("docWritethrough", () => {
         const initialPatch = generatePatchObject(5)
 
         await docWritethrough.patch(initialPatch)
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
 
         await docWritethrough.patch({})
 
@@ -224,9 +223,10 @@ describe("docWritethrough", () => {
 
         await db.remove(await db.get(documentId))
 
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
         const extraPatch = generatePatchObject(5)
         await docWritethrough.patch(extraPatch)
+        await travelForward(WRITE_RATE_MS)
 
         expect(await db.get(documentId)).toEqual(
           expect.objectContaining(extraPatch)
@@ -246,30 +246,46 @@ describe("docWritethrough", () => {
         )
       }
 
-      const persistToDbSpy = jest.spyOn(docWritethrough as any, "persistToDb")
       const storeToCacheSpy = jest.spyOn(docWritethrough as any, "storeToCache")
 
       await config.doInTenant(async () => {
         await parallelPatch(5)
-        expect(persistToDbSpy).not.toBeCalled()
         expect(storeToCacheSpy).toBeCalledTimes(5)
+        expect(await db.exists(documentId)).toBe(false)
 
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
 
         await parallelPatch(40)
 
-        expect(persistToDbSpy).toBeCalledTimes(1)
         expect(storeToCacheSpy).toBeCalledTimes(45)
 
+        expect(await db.get(documentId)).toEqual(
+          expect.objectContaining({
+            _id: documentId,
+            _rev: expect.stringMatching(/1-.+/),
+          })
+        )
+
         await parallelPatch(10)
 
-        expect(persistToDbSpy).toBeCalledTimes(1)
         expect(storeToCacheSpy).toBeCalledTimes(55)
+        expect(await db.get(documentId)).toEqual(
+          expect.objectContaining({
+            _id: documentId,
+            _rev: expect.stringMatching(/1-.+/),
+          })
+        )
 
-        travelForward(WRITE_RATE_MS)
+        await travelForward(WRITE_RATE_MS)
 
         await parallelPatch(5)
-        expect(persistToDbSpy).toBeCalledTimes(2)
+        await travelForward(WRITE_RATE_MS)
+        expect(await db.get(documentId)).toEqual(
+          expect.objectContaining({
+            _id: documentId,
+            _rev: expect.stringMatching(/3-.+/),
+          })
+        )
         expect(storeToCacheSpy).toBeCalledTimes(60)
       })
     })

packages/backend-core/src/db/couch/DatabaseImpl.ts

@@ -70,7 +70,15 @@ export class DatabaseImpl implements Database {
     DatabaseImpl.nano = buildNano(couchInfo)
   }
 
-  async exists() {
+  exists(docId?: string) {
+    if (docId === undefined) {
+      return this.dbExists()
+    }
+
+    return this.docExists(docId)
+  }
+
+  private async dbExists() {
     const response = await directCouchUrlCall({
       url: `${this.couchInfo.url}/${this.name}`,
       method: "HEAD",
@@ -79,6 +87,15 @@ export class DatabaseImpl implements Database {
     return response.status === 200
   }
 
+  private async docExists(id: string): Promise<boolean> {
+    try {
+      await this.performCall(db => () => db.head(id))
+      return true
+    } catch {
+      return false
+    }
+  }
+
   private nano() {
     return this.instanceNano || DatabaseImpl.nano
   }
@@ -135,15 +152,6 @@ export class DatabaseImpl implements Database {
     })
   }
 
-  async docExists(id: string): Promise<boolean> {
-    try {
-      await this.performCall(db => () => db.head(id))
-      return true
-    } catch {
-      return false
-    }
-  }
-
   async getMultiple<T extends Document>(
     ids: string[],
     opts?: { allowMissing?: boolean }

packages/backend-core/src/db/instrumentation.ts

@@ -24,9 +24,12 @@ export class DDInstrumentedDatabase implements Database {
     return this.db.name
   }
 
-  exists(): Promise<boolean> {
+  exists(docId?: string): Promise<boolean> {
     return tracer.trace("db.exists", span => {
-      span?.addTags({ db_name: this.name })
+      span?.addTags({ db_name: this.name, doc_id: docId })
+      if (docId) {
+        return this.db.exists(docId)
+      }
       return this.db.exists()
     })
   }
@@ -38,13 +41,6 @@ export class DDInstrumentedDatabase implements Database {
     })
   }
 
-  docExists(id: string): Promise<boolean> {
-    return tracer.trace("db.docExists", span => {
-      span?.addTags({ db_name: this.name, doc_id: id })
-      return this.db.docExists(id)
-    })
-  }
-
   getMultiple<T extends Document>(
     ids: string[],
     opts?: { allowMissing?: boolean | undefined } | undefined

packages/backend-core/src/db/tests/DatabaseImpl.spec.ts

@@ -17,16 +17,16 @@ describe("DatabaseImpl", () => {
     documents.push(...createdDocs.map((x: any) => ({ _id: x.id, _rev: x.rev })))
   })
 
-  describe("docExists", () => {
+  describe("document exists", () => {
     it("can check existing docs by id", async () => {
       const existingDoc = _.sample(documents)
-      const result = await database.docExists(existingDoc!._id!)
+      const result = await database.exists(existingDoc!._id!)
 
       expect(result).toBe(true)
     })
 
     it("can check non existing docs by id", async () => {
-      const result = await database.docExists(newid())
+      const result = await database.exists(newid())
 
       expect(result).toBe(false)
     })
@@ -36,9 +36,9 @@ describe("DatabaseImpl", () => {
       const id = existingDoc!._id!
 
       const results = []
-      results.push(await database.docExists(id))
+      results.push(await database.exists(id))
-      results.push(await database.docExists(id))
+      results.push(await database.exists(id))
-      results.push(await database.docExists(id))
+      results.push(await database.exists(id))
 
       expect(results).toEqual([true, true, true])
     })
@@ -46,10 +46,10 @@ describe("DatabaseImpl", () => {
     it("returns false after the doc is deleted", async () => {
       const existingDoc = _.sample(documents)
       const id = existingDoc!._id!
-      expect(await database.docExists(id)).toBe(true)
+      expect(await database.exists(id)).toBe(true)
 
       await database.remove(existingDoc!)
-      expect(await database.docExists(id)).toBe(false)
+      expect(await database.exists(id)).toBe(false)
     })
   })
 })

packages/backend-core/src/middleware/errorHandling.ts

@@ -1,5 +1,6 @@
 import { APIError } from "@budibase/types"
 import * as errors from "../errors"
+import environment from "../environment"
 
 export async function errorHandling(ctx: any, next: any) {
   try {
@@ -14,15 +15,19 @@ export async function errorHandling(ctx: any, next: any) {
       console.error(err)
     }
 
-    const error = errors.getPublicError(err)
+    let error: APIError = {
-    const body: APIError = {
       message: err.message,
       status: status,
       validationErrors: err.validation,
-      error,
+      error: errors.getPublicError(err),
     }
 
-    ctx.body = body
+    if (environment.isTest() && ctx.headers["x-budibase-include-stacktrace"]) {
+      // @ts-ignore
+      error.stack = err.stack
+    }
+
+    ctx.body = error
   }
 }
 

packages/backend-core/src/queue/constants.ts

@@ -4,4 +4,5 @@ export enum JobQueue {
   AUDIT_LOG = "auditLogQueue",
   SYSTEM_EVENT_QUEUE = "systemEventQueue",
   APP_MIGRATION = "appMigration",
+  DOC_WRITETHROUGH_QUEUE = "docWritethroughQueue",
 }

packages/backend-core/src/queue/inMemoryQueue.ts

@@ -1,5 +1,13 @@
 import events from "events"
 import { timeout } from "../utils"
+import { Queue, QueueOptions, JobOptions } from "./queue"
+
+interface JobMessage {
+  timestamp: number
+  queue: string
+  data: any
+  opts?: JobOptions
+}
 
 /**
  * Bull works with a Job wrapper around all messages that contains a lot more information about
@@ -10,12 +18,12 @@ import { timeout } from "../utils"
  * @returns A new job which can now be put onto the queue, this is mostly an
  * internal structure so that an in memory queue can be easily swapped for a Bull queue.
  */
-function newJob(queue: string, message: any) {
+function newJob(queue: string, message: any, opts?: JobOptions): JobMessage {
   return {
     timestamp: Date.now(),
     queue: queue,
     data: message,
-    opts: {},
+    opts,
   }
 }
 
@@ -24,26 +32,29 @@ function newJob(queue: string, message: any) {
  * It is relatively simple, using an event emitter internally to register when messages are available
  * to the consumers - in can support many inputs and many consumers.
  */
-class InMemoryQueue {
+class InMemoryQueue implements Partial<Queue> {
   _name: string
-  _opts?: any
+  _opts?: QueueOptions
-  _messages: any[]
+  _messages: JobMessage[]
+  _queuedJobIds: Set<string>
   _emitter: EventEmitter
   _runCount: number
   _addCount: number
+
   /**
    * The constructor the queue, exactly the same as that of Bulls.
    * @param name The name of the queue which is being configured.
    * @param opts This is not used by the in memory queue as there is no real use
    * case when in memory, but is the same API as Bull
    */
-  constructor(name: string, opts?: any) {
+  constructor(name: string, opts?: QueueOptions) {
     this._name = name
     this._opts = opts
     this._messages = []
     this._emitter = new events.EventEmitter()
     this._runCount = 0
     this._addCount = 0
+    this._queuedJobIds = new Set<string>()
   }
 
   /**
@@ -55,22 +66,27 @@ class InMemoryQueue {
    * note this is incredibly limited compared to Bull as in reality the Job would contain
    * a lot more information about the queue and current status of Bull cluster.
    */
-  process(func: any) {
+  async process(func: any) {
     this._emitter.on("message", async () => {
       if (this._messages.length <= 0) {
         return
       }
       let msg = this._messages.shift()
+
       let resp = func(msg)
       if (resp.then != null) {
         await resp
       }
       this._runCount++
+      const jobId = msg?.opts?.jobId?.toString()
+      if (jobId && msg?.opts?.removeOnComplete) {
+        this._queuedJobIds.delete(jobId)
+      }
     })
   }
 
   async isReady() {
-    return true
+    return this as any
   }
 
   // simply puts a message to the queue and emits to the queue for processing
@@ -83,27 +99,45 @@ class InMemoryQueue {
    * @param repeat serves no purpose for the import queue.
    */
   // eslint-disable-next-line no-unused-vars
-  add(msg: any, repeat: boolean) {
+  async add(data: any, opts?: JobOptions) {
-    if (typeof msg !== "object") {
+    const jobId = opts?.jobId?.toString()
+    if (jobId && this._queuedJobIds.has(jobId)) {
+      console.log(`Ignoring already queued job ${jobId}`)
+      return
+    }
+
+    if (typeof data !== "object") {
       throw "Queue only supports carrying JSON."
     }
-    this._messages.push(newJob(this._name, msg))
+    if (jobId) {
-    this._addCount++
+      this._queuedJobIds.add(jobId)
-    this._emitter.emit("message")
+    }
+
+    const pushMessage = () => {
+      this._messages.push(newJob(this._name, data, opts))
+      this._addCount++
+      this._emitter.emit("message")
+    }
+
+    const delay = opts?.delay
+    if (delay) {
+      setTimeout(pushMessage, delay)
+    } else {
+      pushMessage()
+    }
+    return {} as any
   }
 
   /**
    * replicating the close function from bull, which waits for jobs to finish.
    */
-  async close() {
+  async close() {}
-    return []
-  }
 
   /**
    * This removes a cron which has been implemented, this is part of Bull API.
    * @param cronJobId The cron which is to be removed.
    */
-  removeRepeatableByKey(cronJobId: string) {
+  async removeRepeatableByKey(cronJobId: string) {
     // TODO: implement for testing
     console.log(cronJobId)
   }
@@ -111,12 +145,12 @@ class InMemoryQueue {
   /**
    * Implemented for tests
    */
-  getRepeatableJobs() {
+  async getRepeatableJobs() {
     return []
   }
 
   // eslint-disable-next-line no-unused-vars
-  removeJobs(pattern: string) {
+  async removeJobs(pattern: string) {
     // no-op
   }
 
@@ -128,18 +162,22 @@ class InMemoryQueue {
   }
 
   async getJob() {
-    return {}
+    return null
   }
 
   on() {
     // do nothing
-    return this
+    return this as any
   }
 
   async waitForCompletion() {
     do {
       await timeout(50)
-    } while (this._addCount < this._runCount)
+    } while (this.hasRunningJobs)
+  }
+
+  hasRunningJobs() {
+    return this._addCount > this._runCount
   }
 }
 

packages/backend-core/src/queue/listeners.ts

@@ -88,6 +88,7 @@ enum QueueEventType {
   AUDIT_LOG_EVENT = "audit-log-event",
   SYSTEM_EVENT = "system-event",
   APP_MIGRATION = "app-migration",
+  DOC_WRITETHROUGH = "doc-writethrough",
 }
 
 const EventTypeMap: { [key in JobQueue]: QueueEventType } = {
@@ -96,6 +97,7 @@ const EventTypeMap: { [key in JobQueue]: QueueEventType } = {
   [JobQueue.AUDIT_LOG]: QueueEventType.AUDIT_LOG_EVENT,
   [JobQueue.SYSTEM_EVENT_QUEUE]: QueueEventType.SYSTEM_EVENT,
   [JobQueue.APP_MIGRATION]: QueueEventType.APP_MIGRATION,
+  [JobQueue.DOC_WRITETHROUGH_QUEUE]: QueueEventType.DOC_WRITETHROUGH,
 }
 
 function logging(queue: Queue, jobQueue: JobQueue) {

packages/backend-core/src/queue/queue.ts

@@ -7,6 +7,8 @@ import { addListeners, StalledFn } from "./listeners"
 import { Duration } from "../utils"
 import * as timers from "../timers"
 
+export { QueueOptions, Queue, JobOptions } from "bull"
+
 // the queue lock is held for 5 minutes
 const QUEUE_LOCK_MS = Duration.fromMinutes(5).toMs()
 // queue lock is refreshed every 30 seconds

packages/builder/src/stores/builder/tables.js

@@ -147,6 +147,12 @@ export function createTablesStore() {
     if (indexes) {
       draft.indexes = indexes
     }
+    // Add object to indicate if column is being added
+    if (draft.schema[field.name] === undefined) {
+      draft._add = {
+        name: field.name,
+      }
+    }
     draft.schema = {
       ...draft.schema,
       [field.name]: cloneDeep(field),

packages/client/src/components/app/forms/RelationshipField.svelte

@@ -1,7 +1,7 @@
 <script>
   import { CoreSelect, CoreMultiselect } from "@budibase/bbui"
   import { fetchData, Utils } from "@budibase/frontend-core"
-  import { getContext } from "svelte"
+  import { getContext, onMount } from "svelte"
   import Field from "./Field.svelte"
   import { FieldTypes } from "../../../constants"
 
@@ -28,6 +28,7 @@
   let tableDefinition
   let searchTerm
   let open
+  let initialValue
 
   $: type =
     datasourceType === "table" ? FieldTypes.LINK : FieldTypes.BB_REFERENCE
@@ -109,7 +110,11 @@
   }
 
   $: forceFetchRows(filter)
-  $: debouncedFetchRows(searchTerm, primaryDisplay, defaultValue)
+  $: debouncedFetchRows(
+    searchTerm,
+    primaryDisplay,
+    initialValue || defaultValue
+  )
 
   const forceFetchRows = async () => {
     // if the filter has changed, then we need to reset the options, clear the selection, and re-fetch
@@ -127,9 +132,13 @@
     if (allRowsFetched || !primaryDisplay) {
       return
     }
-    if (defaultVal && !optionsObj[defaultVal]) {
+    // must be an array
+    if (defaultVal && !Array.isArray(defaultVal)) {
+      defaultVal = defaultVal.split(",")
+    }
+    if (defaultVal && defaultVal.some(val => !optionsObj[val])) {
       await fetch.update({
-        query: { equal: { _id: defaultVal } },
+        query: { oneOf: { _id: defaultVal } },
       })
     }
 
@@ -202,6 +211,16 @@
       fetch.nextPage()
     }
   }
+
+  onMount(() => {
+    // if the form is in 'Update' mode, then we need to fetch the matching row so that the value is correctly set
+    if (fieldState?.value) {
+      initialValue =
+        fieldSchema?.relationshipType !== "one-to-many"
+          ? flatten(fieldState?.value) ?? []
+          : flatten(fieldState?.value)?.[0]
+    }
+  })
 </script>
 
 <Field

packages/frontend-core/src/components/grid/cells/DataCell.svelte

@@ -59,13 +59,13 @@
     isReadonly: () => readonly,
     getType: () => column.schema.type,
     getValue: () => row[column.name],
-    setValue: (value, options = { save: true }) => {
+    setValue: (value, options = { apply: true }) => {
       validation.actions.setError(cellId, null)
       updateValue({
         rowId: row._id,
         column: column.name,
         value,
-        save: options?.save,
+        apply: options?.apply,
       })
     },
   }

packages/frontend-core/src/components/grid/overlays/KeyboardManager.svelte

@@ -217,14 +217,14 @@
       const type = $focusedCellAPI.getType()
       if (type === "number" && keyCodeIsNumber(keyCode)) {
         // Update the value locally but don't save it yet
-        $focusedCellAPI.setValue(parseInt(key), { save: false })
+        $focusedCellAPI.setValue(parseInt(key), { apply: false })
         $focusedCellAPI.focus()
       } else if (
         ["string", "barcodeqr", "longform"].includes(type) &&
         (keyCodeIsLetter(keyCode) || keyCodeIsNumber(keyCode))
       ) {
         // Update the value locally but don't save it yet
-        $focusedCellAPI.setValue(key, { save: false })
+        $focusedCellAPI.setValue(key, { apply: false })
         $focusedCellAPI.focus()
       }
     }

packages/frontend-core/src/components/grid/stores/rows.js

@@ -327,29 +327,31 @@ export const createActions = context => {
     get(fetch)?.getInitialData()
   }
 
-  // Patches a row with some changes
+  // Checks if a changeset for a row actually mutates the row or not
-  const updateRow = async (rowId, changes, options = { save: true }) => {
+  const changesAreValid = (row, changes) => {
+    const columns = Object.keys(changes || {})
+    if (!row || !columns.length) {
+      return false
+    }
+
+    // Ensure there is at least 1 column that creates a difference
+    return columns.some(column => row[column] !== changes[column])
+  }
+
+  // Patches a row with some changes in local state, and returns whether a
+  // valid pending change was made or not
+  const stashRowChanges = (rowId, changes) => {
     const $rows = get(rows)
     const $rowLookupMap = get(rowLookupMap)
     const index = $rowLookupMap[rowId]
     const row = $rows[index]
-    if (index == null || !Object.keys(changes || {}).length) {
+
-      return
+    // Check this is a valid change
+    if (!row || !changesAreValid(row, changes)) {
+      return false
     }
 
-    // Abandon if no changes
+    // Add change to cache
-    let same = true
-    for (let column of Object.keys(changes)) {
-      if (row[column] !== changes[column]) {
-        same = false
-        break
-      }
-    }
-    if (same) {
-      return
-    }
-
-    // Immediately update state so that the change is reflected
     rowChangeCache.update(state => ({
       ...state,
       [rowId]: {
@@ -357,26 +359,30 @@ export const createActions = context => {
         ...changes,
       },
     }))
+    return true
+  }
 
-    // Stop here if we don't want to persist the change
+  // Saves any pending changes to a row
-    if (!options?.save) {
+  const applyRowChanges = async rowId => {
+    const $rows = get(rows)
+    const $rowLookupMap = get(rowLookupMap)
+    const index = $rowLookupMap[rowId]
+    const row = $rows[index]
+    if (row == null) {
       return
     }
 
     // Save change
     try {
-      inProgressChanges.update(state => ({
+      // Mark as in progress
-        ...state,
+      inProgressChanges.update(state => ({ ...state, [rowId]: true }))
-        [rowId]: true,
-      }))
 
       // Update row
-      const saved = await datasource.actions.updateRow({
+      const changes = get(rowChangeCache)[rowId]
-        ...cleanRow(row),
+      const newRow = { ...cleanRow(row), ...changes }
-        ...get(rowChangeCache)[rowId],
+      const saved = await datasource.actions.updateRow(newRow)
-      })
 
-      // Update state after a successful change
+      // Update row state after a successful change
       if (saved?._id) {
         rows.update(state => {
           state[index] = saved
@@ -386,6 +392,8 @@ export const createActions = context => {
         // Handle users table edge case
         await refreshRow(saved.id)
       }
+
+      // Wipe row change cache now that we've saved the row
       rowChangeCache.update(state => {
         delete state[rowId]
         return state
@@ -393,15 +401,17 @@ export const createActions = context => {
     } catch (error) {
       handleValidationError(rowId, error)
     }
-    inProgressChanges.update(state => ({
+
-      ...state,
+    // Mark as completed
-      [rowId]: false,
+    inProgressChanges.update(state => ({ ...state, [rowId]: false }))
-    }))
   }
 
   // Updates a value of a row
-  const updateValue = async ({ rowId, column, value, save = true }) => {
+  const updateValue = async ({ rowId, column, value, apply = true }) => {
-    return await updateRow(rowId, { [column]: value }, { save })
+    const success = stashRowChanges(rowId, { [column]: value })
+    if (success && apply) {
+      await applyRowChanges(rowId)
+    }
   }
 
   // Deletes an array of rows
@@ -411,9 +421,7 @@ export const createActions = context => {
     }
 
     // Actually delete rows
-    rowsToDelete.forEach(row => {
+    rowsToDelete.forEach(row => delete row.__idx)
-      delete row.__idx
-    })
     await datasource.actions.deleteRows(rowsToDelete)
 
     // Update state
@@ -433,7 +441,7 @@ export const createActions = context => {
       newRow = newRows[i]
 
       // Ensure we have a unique _id.
-      // This means generating one for non DS+, overriting any that may already
+      // This means generating one for non DS+, overwriting any that may already
       // exist as we cannot allow duplicates.
       if (!$isDatasourcePlus) {
         newRow._id = Helpers.uuid()
@@ -494,7 +502,7 @@ export const createActions = context => {
         duplicateRow,
         getRow,
         updateValue,
-        updateRow,
+        applyRowChanges,
         deleteRows,
         hasRow,
         loadNextPage,
@@ -508,7 +516,14 @@ export const createActions = context => {
 }
 
 export const initialise = context => {
-  const { rowChangeCache, inProgressChanges, previousFocusedRowId } = context
+  const {
+    rowChangeCache,
+    inProgressChanges,
+    previousFocusedRowId,
+    previousFocusedCellId,
+    rows,
+    validation,
+  } = context
 
   // Wipe the row change cache when changing row
   previousFocusedRowId.subscribe(id => {
@@ -519,4 +534,15 @@ export const initialise = context => {
       })
     }
   })
+
+  // Ensure any unsaved changes are saved when changing cell
+  previousFocusedCellId.subscribe(async id => {
+    const rowId = id?.split("-")[0]
+    const hasErrors = validation.actions.rowHasErrors(rowId)
+    const hasChanges = Object.keys(get(rowChangeCache)[rowId] || {}).length > 0
+    const isSavingChanges = get(inProgressChanges)[rowId]
+    if (rowId && !hasErrors && hasChanges && !isSavingChanges) {
+      await rows.actions.applyRowChanges(rowId)
+    }
+  })
 }

packages/frontend-core/src/components/grid/stores/ui.js

@@ -16,6 +16,7 @@ export const createStores = context => {
   const hoveredRowId = writable(null)
   const rowHeight = writable(get(props).fixedRowHeight || DefaultRowHeight)
   const previousFocusedRowId = writable(null)
+  const previousFocusedCellId = writable(null)
   const gridFocused = writable(false)
   const isDragging = writable(false)
   const buttonColumnWidth = writable(0)
@@ -48,6 +49,7 @@ export const createStores = context => {
     focusedCellAPI,
     focusedRowId,
     previousFocusedRowId,
+    previousFocusedCellId,
     hoveredRowId,
     rowHeight,
     gridFocused,
@@ -129,6 +131,7 @@ export const initialise = context => {
   const {
     focusedRowId,
     previousFocusedRowId,
+    previousFocusedCellId,
     rows,
     focusedCellId,
     selectedRows,
@@ -181,6 +184,13 @@ export const initialise = context => {
     lastFocusedRowId = id
   })
 
+  // Remember the last focused cell ID so that we can store the previous one
+  let lastFocusedCellId = null
+  focusedCellId.subscribe(id => {
+    previousFocusedCellId.set(lastFocusedCellId)
+    lastFocusedCellId = id
+  })
+
   // Remove hovered row when a cell is selected
   focusedCellId.subscribe(cell => {
     if (cell && get(hoveredRowId)) {

packages/frontend-core/src/components/grid/stores/validation.js

@@ -1,8 +1,23 @@
-import { writable, get } from "svelte/store"
+import { writable, get, derived } from "svelte/store"
 
+// Normally we would break out actions into the explicit "createActions"
+// function, but for validation all these actions are pure so can go into
+// "createStores" instead to make dependency ordering simpler
 export const createStores = () => {
   const validation = writable({})
 
+  // Derive which rows have errors so that we can use that info later
+  const rowErrorMap = derived(validation, $validation => {
+    let map = {}
+    Object.entries($validation).forEach(([key, error]) => {
+      // Extract row ID from all errored cell IDs
+      if (error) {
+        map[key.split("-")[0]] = true
+      }
+    })
+    return map
+  })
+
   const setError = (cellId, error) => {
     if (!cellId) {
       return
@@ -13,11 +28,16 @@ export const createStores = () => {
     }))
   }
 
+  const rowHasErrors = rowId => {
+    return get(rowErrorMap)[rowId]
+  }
+
   return {
     validation: {
       ...validation,
       actions: {
         setError,
+        rowHasErrors,
       },
     },
   }

packages/pro

@@ -1 +1 @@
-Subproject commit 4f8998c4be4642a0fe55011514462235edbac7b8
+Subproject commit 217e0a93a12f6ed56f122729366a3068c6bd957e

packages/server/scripts/integrations/mysql/init.sql

@@ -10,6 +10,11 @@ CREATE TABLE Persons (
     City varchar(255),
     PRIMARY KEY (PersonID)
 );
+CREATE TABLE Person (
+    PersonID int NOT NULL AUTO_INCREMENT,
+    Name varchar(255),
+    PRIMARY KEY (PersonID)
+);
 CREATE TABLE Tasks (
     TaskID int NOT NULL AUTO_INCREMENT,
     PersonID INT,
@@ -27,6 +32,7 @@ CREATE TABLE Products (
 );
 INSERT INTO Persons (FirstName, LastName, Age, Address, City, CreatedAt) VALUES ('Mike', 'Hughes', 28.2, '123 Fake Street', 'Belfast', '2021-01-19 03:14:07');
 INSERT INTO Persons (FirstName, LastName, Age, Address, City, CreatedAt) VALUES ('Dave', 'Johnson', 29, '124 Fake Street', 'Belfast', '2022-04-01 00:11:11');
+INSERT INTO Person (Name) VALUES ('Elf');
 INSERT INTO Tasks (PersonID, TaskName, CreatedAt) VALUES (1, 'assembling', '2020-01-01');
 INSERT INTO Tasks (PersonID, TaskName, CreatedAt) VALUES (2, 'processing', '2019-12-31');
 INSERT INTO Products (name, updated) VALUES ('Meat', '11:00:22'), ('Fruit', '10:00:00');

packages/server/scripts/integrations/postgres/reset.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
-docker-compose down
+docker-compose down -v
 docker volume prune -f

packages/server/src/api/controllers/permission.ts

@@ -7,6 +7,10 @@ import {
   GetResourcePermsResponse,
   ResourcePermissionInfo,
   GetDependantResourcesResponse,
+  AddPermissionResponse,
+  AddPermissionRequest,
+  RemovePermissionRequest,
+  RemovePermissionResponse,
 } from "@budibase/types"
 import { getRoleParams } from "../../db/utils"
 import {
@@ -16,9 +20,9 @@ import {
 import { removeFromArray } from "../../utilities"
 import sdk from "../../sdk"
 
-const PermissionUpdateType = {
+const enum PermissionUpdateType {
-  REMOVE: "remove",
+  REMOVE = "remove",
-  ADD: "add",
+  ADD = "add",
 }
 
 const SUPPORTED_LEVELS = CURRENTLY_SUPPORTED_LEVELS
@@ -39,7 +43,7 @@ async function updatePermissionOnRole(
     resourceId,
     level,
   }: { roleId: string; resourceId: string; level: PermissionLevel },
-  updateType: string
+  updateType: PermissionUpdateType
 ) {
   const allowedAction = await sdk.permissions.resourceActionAllowed({
     resourceId,
@@ -107,11 +111,15 @@ async function updatePermissionOnRole(
   }
 
   const response = await db.bulkDocs(docUpdates)
-  return response.map((resp: any) => {
+  return response.map(resp => {
     const version = docUpdates.find(role => role._id === resp.id)?.version
-    resp._id = roles.getExternalRoleID(resp.id, version)
+    const _id = roles.getExternalRoleID(resp.id, version)
-    delete resp.id
+    return {
-    return resp
+      _id,
+      rev: resp.rev,
+      error: resp.error,
+      reason: resp.reason,
+    }
   })
 }
 
@@ -189,13 +197,14 @@ export async function getDependantResources(
   }
 }
 
-export async function addPermission(ctx: UserCtx) {
+export async function addPermission(ctx: UserCtx<void, AddPermissionResponse>) {
-  ctx.body = await updatePermissionOnRole(ctx.params, PermissionUpdateType.ADD)
+  const params: AddPermissionRequest = ctx.params
+  ctx.body = await updatePermissionOnRole(params, PermissionUpdateType.ADD)
 }
 
-export async function removePermission(ctx: UserCtx) {
+export async function removePermission(
-  ctx.body = await updatePermissionOnRole(
+  ctx: UserCtx<void, RemovePermissionResponse>
-    ctx.params,
+) {
-    PermissionUpdateType.REMOVE
+  const params: RemovePermissionRequest = ctx.params
-  )
+  ctx.body = await updatePermissionOnRole(params, PermissionUpdateType.REMOVE)
 }

packages/server/src/api/controllers/query/index.ts

@@ -17,10 +17,12 @@ import {
   QueryPreview,
   QuerySchema,
   FieldType,
-  type ExecuteQueryRequest,
+  ExecuteQueryRequest,
-  type ExecuteQueryResponse,
+  ExecuteQueryResponse,
-  type Row,
+  Row,
   QueryParameter,
+  PreviewQueryRequest,
+  PreviewQueryResponse,
 } from "@budibase/types"
 import { ValidQueryNameRegex, utils as JsonUtils } from "@budibase/shared-core"
 
@@ -134,14 +136,16 @@ function enrichParameters(
   return requestParameters
 }
 
-export async function preview(ctx: UserCtx) {
+export async function preview(
+  ctx: UserCtx<PreviewQueryRequest, PreviewQueryResponse>
+) {
   const { datasource, envVars } = await sdk.datasources.getWithEnvVars(
     ctx.request.body.datasourceId
   )
-  const query: QueryPreview = ctx.request.body
   // preview may not have a queryId as it hasn't been saved, but if it does
   // this stops dynamic variables from calling the same query
-  const { fields, parameters, queryVerb, transformer, queryId, schema } = query
+  const { fields, parameters, queryVerb, transformer, queryId, schema } =
+    ctx.request.body
 
   let existingSchema = schema
   if (queryId && !existingSchema) {
@@ -266,9 +270,7 @@ export async function preview(ctx: UserCtx) {
       },
     }
 
-    const { rows, keys, info, extra } = (await Runner.run(
+    const { rows, keys, info, extra } = await Runner.run<QueryResponse>(inputs)
-      inputs
-    )) as QueryResponse
     const { previewSchema, nestedSchemaFields } = getSchemaFields(rows, keys)
 
     // if existing schema, update to include any previous schema keys
@@ -281,7 +283,7 @@ export async function preview(ctx: UserCtx) {
     }
     // remove configuration before sending event
     delete datasource.config
-    await events.query.previewed(datasource, query)
+    await events.query.previewed(datasource, ctx.request.body)
     ctx.body = {
       rows,
       nestedSchemaFields,
@@ -295,7 +297,10 @@ export async function preview(ctx: UserCtx) {
 }
 
 async function execute(
-  ctx: UserCtx<ExecuteQueryRequest, ExecuteQueryResponse | Row[]>,
+  ctx: UserCtx<
+    ExecuteQueryRequest,
+    ExecuteQueryResponse | Record<string, any>[]
+  >,
   opts: any = { rowsOnly: false, isAutomation: false }
 ) {
   const db = context.getAppDB()
@@ -350,18 +355,23 @@ async function execute(
   }
 }
 
-export async function executeV1(ctx: UserCtx) {
+export async function executeV1(
+  ctx: UserCtx<ExecuteQueryRequest, Record<string, any>[]>
+) {
   return execute(ctx, { rowsOnly: true, isAutomation: false })
 }
 
 export async function executeV2(
-  ctx: UserCtx,
+  ctx: UserCtx<
+    ExecuteQueryRequest,
+    ExecuteQueryResponse | Record<string, any>[]
+  >,
   { isAutomation }: { isAutomation?: boolean } = {}
 ) {
   return execute(ctx, { rowsOnly: false, isAutomation })
 }
 
-const removeDynamicVariables = async (queryId: any) => {
+const removeDynamicVariables = async (queryId: string) => {
   const db = context.getAppDB()
   const query = await db.get<Query>(queryId)
   const datasource = await sdk.datasources.get(query.datasourceId)
@@ -384,7 +394,7 @@ const removeDynamicVariables = async (queryId: any) => {
 
 export async function destroy(ctx: UserCtx) {
   const db = context.getAppDB()
-  const queryId = ctx.params.queryId
+  const queryId = ctx.params.queryId as string
   await removeDynamicVariables(queryId)
   const query = await db.get<Query>(queryId)
   const datasource = await sdk.datasources.get(query.datasourceId)

packages/server/src/api/controllers/row/ExternalRequest.ts

@@ -7,6 +7,7 @@ import {
   FilterType,
   IncludeRelationship,
   ManyToManyRelationshipFieldMetadata,
+  ManyToOneRelationshipFieldMetadata,
   OneToManyRelationshipFieldMetadata,
   Operation,
   PaginationJson,
@@ -18,6 +19,7 @@ import {
   SortJson,
   SortType,
   Table,
+  isManyToOne,
 } from "@budibase/types"
 import {
   breakExternalTableId,
@@ -32,7 +34,9 @@ import { processObjectSync } from "@budibase/string-templates"
 import { cloneDeep } from "lodash/fp"
 import { processDates, processFormulas } from "../../../utilities/rowProcessor"
 import { db as dbCore } from "@budibase/backend-core"
+import AliasTables from "./alias"
 import sdk from "../../../sdk"
+import env from "../../../environment"
 
 export interface ManyRelationship {
   tableId?: string
@@ -101,6 +105,39 @@ function buildFilters(
   }
 }
 
+async function removeManyToManyRelationships(
+  rowId: string,
+  table: Table,
+  colName: string
+) {
+  const tableId = table._id!
+  const filters = buildFilters(rowId, {}, table)
+  // safety check, if there are no filters on deletion bad things happen
+  if (Object.keys(filters).length !== 0) {
+    return getDatasourceAndQuery({
+      endpoint: getEndpoint(tableId, Operation.DELETE),
+      body: { [colName]: null },
+      filters,
+    })
+  } else {
+    return []
+  }
+}
+
+async function removeOneToManyRelationships(rowId: string, table: Table) {
+  const tableId = table._id!
+  const filters = buildFilters(rowId, {}, table)
+  // safety check, if there are no filters on deletion bad things happen
+  if (Object.keys(filters).length !== 0) {
+    return getDatasourceAndQuery({
+      endpoint: getEndpoint(tableId, Operation.UPDATE),
+      filters,
+    })
+  } else {
+    return []
+  }
+}
+
 /**
  * This function checks the incoming parameters to make sure all the inputs are
  * valid based on on the table schema. The main thing this is looking for is when a
@@ -178,13 +215,13 @@ function generateIdForRow(
 
 function getEndpoint(tableId: string | undefined, operation: string) {
   if (!tableId) {
-    return {}
+    throw new Error("Cannot get endpoint information - no table ID specified")
   }
   const { datasourceId, tableName } = breakExternalTableId(tableId)
   return {
-    datasourceId,
+    datasourceId: datasourceId!,
-    entityId: tableName,
+    entityId: tableName!,
-    operation,
+    operation: operation as Operation,
   }
 }
 
@@ -304,6 +341,18 @@ export class ExternalRequest<T extends Operation> {
     }
   }
 
+  async getRow(table: Table, rowId: string): Promise<Row> {
+    const response = await getDatasourceAndQuery({
+      endpoint: getEndpoint(table._id!, Operation.READ),
+      filters: buildFilters(rowId, {}, table),
+    })
+    if (Array.isArray(response) && response.length > 0) {
+      return response[0]
+    } else {
+      throw new Error(`Cannot fetch row by ID "${rowId}"`)
+    }
+  }
+
   inputProcessing(row: Row | undefined, table: Table) {
     if (!row) {
       return { row, manyRelationships: [] }
@@ -571,7 +620,9 @@ export class ExternalRequest<T extends Operation> {
    * information.
    */
   async lookupRelations(tableId: string, row: Row) {
-    const related: { [key: string]: any } = {}
+    const related: {
+      [key: string]: { rows: Row[]; isMany: boolean; tableId: string }
+    } = {}
     const { tableName } = breakExternalTableId(tableId)
     if (!tableName) {
       return related
@@ -589,14 +640,26 @@ export class ExternalRequest<T extends Operation> {
       ) {
         continue
       }
-      const isMany = field.relationshipType === RelationshipType.MANY_TO_MANY
+      let tableId: string | undefined,
-      const tableId = isMany ? field.through : field.tableId
+        lookupField: string | undefined,
+        fieldName: string | undefined
+      if (isManyToMany(field)) {
+        tableId = field.through
+        lookupField = primaryKey
+        fieldName = field.throughTo || primaryKey
+      } else if (isManyToOne(field)) {
+        tableId = field.tableId
+        lookupField = field.foreignKey
+        fieldName = field.fieldName
+      }
+      if (!tableId || !lookupField || !fieldName) {
+        throw new Error(
+          "Unable to lookup relationships - undefined column properties."
+        )
+      }
       const { tableName: relatedTableName } = breakExternalTableId(tableId)
       // @ts-ignore
       const linkPrimaryKey = this.tables[relatedTableName].primary[0]
-
-      const lookupField = isMany ? primaryKey : field.foreignKey
-      const fieldName = isMany ? field.throughTo || primaryKey : field.fieldName
       if (!lookupField || !row[lookupField]) {
         continue
       }
@@ -609,9 +672,12 @@ export class ExternalRequest<T extends Operation> {
         },
       })
       // this is the response from knex if no rows found
-      const rows = !response[0].read ? response : []
+      const rows: Row[] =
-      const storeTo = isMany ? field.throughFrom || linkPrimaryKey : fieldName
+        !Array.isArray(response) || response?.[0].read ? [] : response
-      related[storeTo] = { rows, isMany, tableId }
+      const storeTo = isManyToMany(field)
+        ? field.throughFrom || linkPrimaryKey
+        : fieldName
+      related[storeTo] = { rows, isMany: isManyToMany(field), tableId }
     }
     return related
   }
@@ -697,24 +763,43 @@ export class ExternalRequest<T extends Operation> {
         continue
       }
       for (let row of rows) {
-        const filters = buildFilters(generateIdForRow(row, table), {}, table)
+        const rowId = generateIdForRow(row, table)
-        // safety check, if there are no filters on deletion bad things happen
+        const promise: Promise<any> = isMany
-        if (Object.keys(filters).length !== 0) {
+          ? removeManyToManyRelationships(rowId, table, colName)
-          const op = isMany ? Operation.DELETE : Operation.UPDATE
+          : removeOneToManyRelationships(rowId, table)
-          const body = isMany ? null : { [colName]: null }
+        if (promise) {
-          promises.push(
+          promises.push(promise)
-            getDatasourceAndQuery({
-              endpoint: getEndpoint(tableId, op),
-              body,
-              filters,
-            })
-          )
         }
       }
     }
     await Promise.all(promises)
   }
 
+  async removeRelationshipsToRow(table: Table, rowId: string) {
+    const row = await this.getRow(table, rowId)
+    const related = await this.lookupRelations(table._id!, row)
+    for (let column of Object.values(table.schema)) {
+      const relationshipColumn = column as RelationshipFieldMetadata
+      if (!isManyToOne(relationshipColumn)) {
+        continue
+      }
+      const { rows, isMany, tableId } = related[relationshipColumn.fieldName]
+      const table = this.getTable(tableId)!
+      await Promise.all(
+        rows.map(row => {
+          const rowId = generateIdForRow(row, table)
+          return isMany
+            ? removeManyToManyRelationships(
+                rowId,
+                table,
+                relationshipColumn.fieldName
+              )
+            : removeOneToManyRelationships(rowId, table)
+        })
+      )
+    }
+  }
+
   /**
    * This function is a bit crazy, but the exact purpose of it is to protect against the scenario in which
    * you have column overlap in relationships, e.g. we join a few different tables and they all have the
@@ -804,7 +889,7 @@ export class ExternalRequest<T extends Operation> {
     }
     let json = {
       endpoint: {
-        datasourceId,
+        datasourceId: datasourceId!,
         entityId: tableName,
         operation,
       },
@@ -826,17 +911,30 @@ export class ExternalRequest<T extends Operation> {
       },
     }
 
-    // can't really use response right now
+    // remove any relationships that could block deletion
-    const response = await getDatasourceAndQuery(json)
+    if (operation === Operation.DELETE && id) {
-    // handle many to many relationships now if we know the ID (could be auto increment)
+      await this.removeRelationshipsToRow(table, generateRowIdField(id))
+    }
+
+    // aliasing can be disabled fully if desired
+    let response
+    if (env.SQL_ALIASING_DISABLE) {
+      response = await getDatasourceAndQuery(json)
+    } else {
+      const aliasing = new AliasTables(Object.keys(this.tables))
+      response = await aliasing.queryWithAliasing(json)
+    }
+
+    const responseRows = Array.isArray(response) ? response : []
+    // handle many-to-many relationships now if we know the ID (could be auto increment)
     if (operation !== Operation.READ) {
       await this.handleManyRelationships(
         table._id || "",
-        response[0],
+        responseRows[0],
         processed.manyRelationships
       )
     }
-    const output = this.outputProcessing(response, table, relationships)
+    const output = this.outputProcessing(responseRows, table, relationships)
     // if reading it'll just be an array of rows, return whole thing
     if (operation === Operation.READ) {
       return (

packages/server/src/api/controllers/row/alias.ts

@@ -0,0 +1,168 @@
+import {
+  QueryJson,
+  SearchFilters,
+  Table,
+  Row,
+  DatasourcePlusQueryResponse,
+} from "@budibase/types"
+import { getDatasourceAndQuery } from "../../../sdk/app/rows/utils"
+import { cloneDeep } from "lodash"
+
+class CharSequence {
+  static alphabet = "abcdefghijklmnopqrstuvwxyz"
+  counters: number[]
+
+  constructor() {
+    this.counters = [0]
+  }
+
+  getCharacter(): string {
+    const char = this.counters.map(i => CharSequence.alphabet[i]).join("")
+    for (let i = this.counters.length - 1; i >= 0; i--) {
+      if (this.counters[i] < CharSequence.alphabet.length - 1) {
+        this.counters[i]++
+        return char
+      }
+      this.counters[i] = 0
+    }
+    this.counters.unshift(0)
+    return char
+  }
+}
+
+export default class AliasTables {
+  aliases: Record<string, string>
+  tableAliases: Record<string, string>
+  tableNames: string[]
+  charSeq: CharSequence
+
+  constructor(tableNames: string[]) {
+    this.tableNames = tableNames
+    this.aliases = {}
+    this.tableAliases = {}
+    this.charSeq = new CharSequence()
+  }
+
+  getAlias(tableName: string) {
+    if (this.aliases[tableName]) {
+      return this.aliases[tableName]
+    }
+    const char = this.charSeq.getCharacter()
+    this.aliases[tableName] = char
+    this.tableAliases[char] = tableName
+    return char
+  }
+
+  aliasField(field: string) {
+    const tableNames = this.tableNames
+    if (field.includes(".")) {
+      const [tableName, column] = field.split(".")
+      const foundTableName = tableNames.find(name => {
+        const idx = tableName.indexOf(name)
+        if (idx === -1 || idx > 1) {
+          return
+        }
+        // this might look a bit mad, but the idea is if the field is wrapped, say in "", `` or []
+        // then the idx of the table name will be 1, and we should allow for it ending in a closing
+        // character - otherwise it should be the full length if the index is zero
+        const allowedCharacterDiff = idx * 2
+        return Math.abs(tableName.length - name.length) <= allowedCharacterDiff
+      })
+      if (foundTableName) {
+        const aliasedTableName = tableName.replace(
+          foundTableName,
+          this.getAlias(foundTableName)
+        )
+        field = `${aliasedTableName}.${column}`
+      }
+    }
+    return field
+  }
+
+  reverse<T extends Row | Row[]>(rows: T): T {
+    const process = (row: Row) => {
+      const final: Row = {}
+      for (let [key, value] of Object.entries(row)) {
+        if (!key.includes(".")) {
+          final[key] = value
+        } else {
+          const [alias, column] = key.split(".")
+          const tableName = this.tableAliases[alias] || alias
+          final[`${tableName}.${column}`] = value
+        }
+      }
+      return final
+    }
+    if (Array.isArray(rows)) {
+      return rows.map(row => process(row)) as T
+    } else {
+      return process(rows) as T
+    }
+  }
+
+  aliasMap(tableNames: (string | undefined)[]) {
+    const map: Record<string, string> = {}
+    for (let tableName of tableNames) {
+      if (tableName) {
+        map[tableName] = this.getAlias(tableName)
+      }
+    }
+    return map
+  }
+
+  async queryWithAliasing(json: QueryJson): DatasourcePlusQueryResponse {
+    const fieldLength = json.resource?.fields?.length
+    const aliasingEnabled = fieldLength && fieldLength > 0
+    if (aliasingEnabled) {
+      json = cloneDeep(json)
+      // run through the query json to update anywhere a table may be used
+      if (json.resource?.fields) {
+        json.resource.fields = json.resource.fields.map(field =>
+          this.aliasField(field)
+        )
+      }
+      if (json.filters) {
+        for (let [filterKey, filter] of Object.entries(json.filters)) {
+          if (typeof filter !== "object") {
+            continue
+          }
+          const aliasedFilters: typeof filter = {}
+          for (let key of Object.keys(filter)) {
+            aliasedFilters[this.aliasField(key)] = filter[key]
+          }
+          json.filters[filterKey as keyof SearchFilters] = aliasedFilters
+        }
+      }
+      if (json.meta?.table) {
+        this.getAlias(json.meta.table.name)
+      }
+      if (json.meta?.tables) {
+        Object.keys(json.meta.tables).forEach(tableName =>
+          this.getAlias(tableName)
+        )
+      }
+      if (json.relationships) {
+        json.relationships = json.relationships.map(relationship => ({
+          ...relationship,
+          aliases: this.aliasMap([
+            relationship.through,
+            relationship.tableName,
+            json.endpoint.entityId,
+          ]),
+        }))
+      }
+      // invert and return
+      const invertedTableAliases: Record<string, string> = {}
+      for (let [key, value] of Object.entries(this.tableAliases)) {
+        invertedTableAliases[value] = key
+      }
+      json.tableAliases = invertedTableAliases
+    }
+    const response = await getDatasourceAndQuery(json)
+    if (Array.isArray(response) && aliasingEnabled) {
+      return this.reverse(response)
+    } else {
+      return response
+    }
+  }
+}

packages/server/src/api/controllers/row/index.ts

@@ -211,7 +211,7 @@ export async function validate(ctx: Ctx<Row, ValidateResponse>) {
   }
 }
 
-export async function fetchEnrichedRow(ctx: any) {
+export async function fetchEnrichedRow(ctx: UserCtx<void, Row>) {
   const tableId = utils.getTableId(ctx)
   ctx.body = await pickApi(tableId).fetchEnrichedRow(ctx)
 }

packages/server/src/api/controllers/static/index.ts

@@ -170,6 +170,7 @@ export const serveApp = async function (ctx: Ctx) {
     if (!env.isJest()) {
       const plugins = objectStore.enrichPluginURLs(appInfo.usedPlugins)
       const { head, html, css } = AppComponent.render({
+        title: branding?.platformTitle || `${appInfo.name}`,
         metaImage:
           branding?.metaImageUrl ||
           "https://res.cloudinary.com/daog6scxm/image/upload/v1698759482/meta-images/plain-branded-meta-image-coral_ocxmgu.png",

packages/server/src/api/controllers/table/external.ts

@@ -6,6 +6,7 @@ import {
   BulkImportRequest,
   BulkImportResponse,
   Operation,
+  RenameColumn,
   SaveTableRequest,
   SaveTableResponse,
   Table,
@@ -25,9 +26,12 @@ function getDatasourceId(table: Table) {
   return breakExternalTableId(table._id).datasourceId
 }
 
-export async function save(ctx: UserCtx<SaveTableRequest, SaveTableResponse>) {
+export async function save(
+  ctx: UserCtx<SaveTableRequest, SaveTableResponse>,
+  renaming?: RenameColumn
+) {
   const inputs = ctx.request.body
-  const renaming = inputs?._rename
+  const adding = inputs?._add
   // can't do this right now
   delete inputs.rows
   const tableId = ctx.request.body._id
@@ -40,7 +44,7 @@ export async function save(ctx: UserCtx<SaveTableRequest, SaveTableResponse>) {
     const { datasource, table } = await sdk.tables.external.save(
       datasourceId!,
       inputs,
-      { tableId, renaming }
+      { tableId, renaming, adding }
     )
     builderSocket?.emitDatasourceUpdate(ctx, datasource)
     return table

packages/server/src/api/controllers/table/index.ts

@@ -74,8 +74,15 @@ export async function save(ctx: UserCtx<SaveTableRequest, SaveTableResponse>) {
   const appId = ctx.appId
   const table = ctx.request.body
   const isImport = table.rows
+  const renaming = ctx.request.body._rename
 
-  let savedTable = await pickApi({ table }).save(ctx)
+  const api = pickApi({ table })
+  // do not pass _rename or _add if saving to CouchDB
+  if (api === internal) {
+    delete ctx.request.body._add
+    delete ctx.request.body._rename
+  }
+  let savedTable = await api.save(ctx, renaming)
   if (!table._id) {
     await events.table.created(savedTable)
     savedTable = sdk.tables.enrichViewSchemas(savedTable)

packages/server/src/api/controllers/table/internal.ts

@@ -12,11 +12,12 @@ import {
 } from "@budibase/types"
 import sdk from "../../../sdk"
 
-export async function save(ctx: UserCtx<SaveTableRequest, SaveTableResponse>) {
+export async function save(
+  ctx: UserCtx<SaveTableRequest, SaveTableResponse>,
+  renaming?: RenameColumn
+) {
   const { rows, ...rest } = ctx.request.body
-  let tableToSave: Table & {
+  let tableToSave: Table = {
-    _rename?: RenameColumn
-  } = {
     _id: generateTableID(),
     ...rest,
     // Ensure these fields are populated, even if not sent in the request
@@ -28,15 +29,12 @@ export async function save(ctx: UserCtx<SaveTableRequest, SaveTableResponse>) {
     tableToSave.views = {}
   }
 
-  const renaming = tableToSave._rename
-  delete tableToSave._rename
-
   try {
     const { table } = await sdk.tables.internal.save(tableToSave, {
       user: ctx.user,
       rowsToImport: rows,
       tableId: ctx.request.body._id,
-      renaming: renaming,
+      renaming,
     })
 
     return table

packages/server/src/api/routes/tests/apikeys.spec.js

@@ -13,7 +13,7 @@ describe("/api/keys", () => {
 
   describe("fetch", () => {
     it("should allow fetching", async () => {
-      await setup.switchToSelfHosted(async () => {
+      await config.withEnv({ SELF_HOSTED: "true" }, async () => {
         const res = await request
           .get(`/api/keys`)
           .set(config.defaultHeaders())
@@ -34,7 +34,7 @@ describe("/api/keys", () => {
 
   describe("update", () => {
     it("should allow updating a value", async () => {
-      await setup.switchToSelfHosted(async () => {
+      await config.withEnv({ SELF_HOSTED: "true" }, async () => {
         const res = await request
           .put(`/api/keys/TEST`)
           .send({

packages/server/src/api/routes/tests/application.spec.ts

@@ -184,7 +184,7 @@ describe("/applications", () => {
     it("app should not sync if production", async () => {
       const { message } = await config.api.application.sync(
         app.appId.replace("_dev", ""),
-        { statusCode: 400 }
+        { status: 400 }
       )
 
       expect(message).toEqual(
@@ -248,4 +248,13 @@ describe("/applications", () => {
       expect(devLogs.data.length).toBe(0)
     })
   })
+
+  describe("permissions", () => {
+    it("should only return apps a user has access to", async () => {
+      const user = await config.createUser()
+
+      const apps = await config.api.application.fetch()
+      expect(apps.length).toBeGreaterThan(0)
+    })
+  })
 })

packages/server/src/api/routes/tests/attachment.spec.ts

@@ -29,7 +29,7 @@ describe("/api/applications/:appId/sync", () => {
         let resp = (await config.api.attachment.process(
           "ohno.exe",
           Buffer.from([0]),
-          { expectStatus: 400 }
+          { status: 400 }
         )) as unknown as APIError
         expect(resp.message).toContain("invalid extension")
       })
@@ -40,7 +40,7 @@ describe("/api/applications/:appId/sync", () => {
         let resp = (await config.api.attachment.process(
           "OHNO.EXE",
           Buffer.from([0]),
-          { expectStatus: 400 }
+          { status: 400 }
         )) as unknown as APIError
         expect(resp.message).toContain("invalid extension")
       })
@@ -51,7 +51,7 @@ describe("/api/applications/:appId/sync", () => {
         undefined as any,
         undefined as any,
         {
-          expectStatus: 400,
+          status: 400,
         }
       )) as unknown as APIError
       expect(resp.message).toContain("No file provided")

packages/server/src/api/routes/tests/backup.spec.ts

@@ -19,11 +19,8 @@ describe("/backups", () => {
 
   describe("/api/backups/export", () => {
     it("should be able to export app", async () => {
-      const { body, headers } = await config.api.backup.exportBasicBackup(
+      const body = await config.api.backup.exportBasicBackup(config.getAppId()!)
-        config.getAppId()!
-      )
       expect(body instanceof Buffer).toBe(true)
-      expect(headers["content-type"]).toEqual("application/gzip")
       expect(events.app.exported).toBeCalledTimes(1)
     })
 
@@ -38,15 +35,13 @@ describe("/backups", () => {
     it("should infer the app name from the app", async () => {
       tk.freeze(mocks.date.MOCK_DATE)
 
-      const { headers } = await config.api.backup.exportBasicBackup(
+      await config.api.backup.exportBasicBackup(config.getAppId()!, {
-        config.getAppId()!
+        headers: {
-      )
+          "content-disposition": `attachment; filename="${
-
+            config.getApp().name
-      expect(headers["content-disposition"]).toEqual(
+          }-export-${mocks.date.MOCK_DATE.getTime()}.tar.gz"`,
-        `attachment; filename="${
+        },
-          config.getApp().name
+      })
-        }-export-${mocks.date.MOCK_DATE.getTime()}.tar.gz"`
-      )
     })
   })
 

packages/server/src/api/routes/tests/permissions.spec.ts

@@ -45,7 +45,7 @@ describe("/permission", () => {
     table = (await config.createTable()) as typeof table
     row = await config.createRow()
     view = await config.api.viewV2.create({ tableId: table._id })
-    perms = await config.api.permission.set({
+    perms = await config.api.permission.add({
       roleId: STD_ROLE_ID,
       resourceId: table._id,
       level: PermissionLevel.READ,
@@ -88,13 +88,13 @@ describe("/permission", () => {
     })
 
     it("should get resource permissions with multiple roles", async () => {
-      perms = await config.api.permission.set({
+      perms = await config.api.permission.add({
         roleId: HIGHER_ROLE_ID,
         resourceId: table._id,
         level: PermissionLevel.WRITE,
       })
       const res = await config.api.permission.get(table._id)
-      expect(res.body).toEqual({
+      expect(res).toEqual({
         permissions: {
           read: { permissionType: "EXPLICIT", role: STD_ROLE_ID },
           write: { permissionType: "EXPLICIT", role: HIGHER_ROLE_ID },
@@ -117,16 +117,19 @@ describe("/permission", () => {
         level: PermissionLevel.READ,
       })
 
-      const response = await config.api.permission.set(
+      await config.api.permission.add(
         {
           roleId: STD_ROLE_ID,
           resourceId: table._id,
           level: PermissionLevel.EXECUTE,
         },
-        { expectStatus: 403 }
+        {
-      )
+          status: 403,
-      expect(response.message).toEqual(
+          body: {
-        "You are not allowed to 'read' the resource type 'datasource'"
+            message:
+              "You are not allowed to 'read' the resource type 'datasource'",
+          },
+        }
       )
     })
   })
@@ -138,9 +141,9 @@ describe("/permission", () => {
         resourceId: table._id,
         level: PermissionLevel.READ,
       })
-      expect(res.body[0]._id).toEqual(STD_ROLE_ID)
+      expect(res[0]._id).toEqual(STD_ROLE_ID)
       const permsRes = await config.api.permission.get(table._id)
-      expect(permsRes.body[STD_ROLE_ID]).toBeUndefined()
+      expect(permsRes.permissions[STD_ROLE_ID]).toBeUndefined()
     })
 
     it("throw forbidden if the action is not allowed for the resource", async () => {
@@ -156,10 +159,13 @@ describe("/permission", () => {
           resourceId: table._id,
           level: PermissionLevel.EXECUTE,
         },
-        { expectStatus: 403 }
+        {
-      )
+          status: 403,
-      expect(response.body.message).toEqual(
+          body: {
-        "You are not allowed to 'read' the resource type 'datasource'"
+            message:
+              "You are not allowed to 'read' the resource type 'datasource'",
+          },
+        }
       )
     })
   })
@@ -181,10 +187,8 @@ describe("/permission", () => {
       // replicate changes before checking permissions
       await config.publish()
 
-      const res = await config.api.viewV2.search(view.id, undefined, {
+      const res = await config.api.viewV2.publicSearch(view.id)
-        usePublicUser: true,
+      expect(res.rows[0]._id).toEqual(row._id)
-      })
-      expect(res.body.rows[0]._id).toEqual(row._id)
     })
 
     it("should not be able to access the view data when the table is not public and there are no view permissions overrides", async () => {
@@ -196,14 +200,11 @@ describe("/permission", () => {
       // replicate changes before checking permissions
       await config.publish()
 
-      await config.api.viewV2.search(view.id, undefined, {
+      await config.api.viewV2.publicSearch(view.id, undefined, { status: 403 })
-        expectStatus: 403,
-        usePublicUser: true,
-      })
     })
 
     it("should ignore the view permissions if the flag is not on", async () => {
-      await config.api.permission.set({
+      await config.api.permission.add({
         roleId: STD_ROLE_ID,
         resourceId: view.id,
         level: PermissionLevel.READ,
@@ -216,15 +217,14 @@ describe("/permission", () => {
       // replicate changes before checking permissions
       await config.publish()
 
-      await config.api.viewV2.search(view.id, undefined, {
+      await config.api.viewV2.publicSearch(view.id, undefined, {
-        expectStatus: 403,
+        status: 403,
-        usePublicUser: true,
       })
     })
 
     it("should use the view permissions if the flag is on", async () => {
       mocks.licenses.useViewPermissions()
-      await config.api.permission.set({
+      await config.api.permission.add({
         roleId: STD_ROLE_ID,
         resourceId: view.id,
         level: PermissionLevel.READ,
@@ -237,10 +237,8 @@ describe("/permission", () => {
       // replicate changes before checking permissions
       await config.publish()
 
-      const res = await config.api.viewV2.search(view.id, undefined, {
+      const res = await config.api.viewV2.publicSearch(view.id)
-        usePublicUser: true,
+      expect(res.rows[0]._id).toEqual(row._id)
-      })
-      expect(res.body.rows[0]._id).toEqual(row._id)
     })
 
     it("shouldn't allow writing from a public user", async () => {
@@ -277,7 +275,7 @@ describe("/permission", () => {
 
       const res = await config.api.permission.get(legacyView.name)
 
-      expect(res.body).toEqual({
+      expect(res).toEqual({
         permissions: {
           read: {
             permissionType: "BASE",

packages/server/src/api/routes/tests/queries/query.seq.spec.ts

@@ -157,7 +157,7 @@ describe("/queries", () => {
     })
 
     it("should find a query in cloud", async () => {
-      await setup.switchToSelfHosted(async () => {
+      await config.withEnv({ SELF_HOSTED: "true" }, async () => {
         const query = await config.createQuery()
         const res = await request
           .get(`/api/queries/${query._id}`)
@@ -397,15 +397,16 @@ describe("/queries", () => {
     })
 
     it("should fail with invalid integration type", async () => {
-      const response = await config.api.datasource.create(
+      const datasource: Datasource = {
-        {
+        ...basicDatasource().datasource,
-          ...basicDatasource().datasource,
+        source: "INVALID_INTEGRATION" as SourceName,
-          source: "INVALID_INTEGRATION" as SourceName,
+      }
+      await config.api.datasource.create(datasource, {
+        status: 500,
+        body: {
+          message: "No datasource implementation found.",
         },
-        { expectStatus: 500, rawResponse: true }
+      })
-      )
-
-      expect(response.body.message).toBe("No datasource implementation found.")
     })
   })
 

packages/server/src/api/routes/tests/role.spec.js

@@ -93,7 +93,7 @@ describe("/roles", () => {
 
     it("should be able to get the role with a permission added", async () => {
       const table = await config.createTable()
-      await config.api.permission.set({
+      await config.api.permission.add({
         roleId: BUILTIN_ROLE_IDS.POWER,
         resourceId: table._id,
         level: PermissionLevel.READ,

packages/server/src/api/routes/tests/row.spec.ts

@@ -7,6 +7,7 @@ import { context, InternalTable, roles, tenancy } from "@budibase/backend-core"
 import { quotas } from "@budibase/pro"
 import {
   AutoFieldSubType,
+  DeleteRow,
   FieldSchema,
   FieldType,
   FieldTypeSubtypes,
@@ -106,9 +107,6 @@ describe.each([
     mocks.licenses.useCloudFree()
   })
 
-  const loadRow = (id: string, tbl_Id: string, status = 200) =>
-    config.api.row.get(tbl_Id, id, { expectStatus: status })
-
   const getRowUsage = async () => {
     const { total } = await config.doInContext(undefined, () =>
       quotas.getCurrentUsageValues(QuotaUsageType.STATIC, StaticQuotaName.ROWS)
@@ -235,7 +233,7 @@ describe.each([
 
       const res = await config.api.row.get(tableId, existing._id!)
 
-      expect(res.body).toEqual({
+      expect(res).toEqual({
         ...existing,
         ...defaultRowFields,
       })
@@ -265,7 +263,7 @@ describe.each([
       await config.createRow()
 
       await config.api.row.get(tableId, "1234567", {
-        expectStatus: 404,
+        status: 404,
       })
     })
 
@@ -395,7 +393,7 @@ describe.each([
         const createdRow = await config.createRow(row)
         const id = createdRow._id!
 
-        const saved = (await loadRow(id, table._id!)).body
+        const saved = await config.api.row.get(table._id!, id)
 
         expect(saved.stringUndefined).toBe(undefined)
         expect(saved.stringNull).toBe(null)
@@ -476,8 +474,8 @@ describe.each([
       )
 
       const row = await config.api.row.get(table._id!, createRowResponse._id!)
-      expect(row.body.Story).toBeUndefined()
+      expect(row.Story).toBeUndefined()
-      expect(row.body).toEqual({
+      expect(row).toEqual({
         ...defaultRowFields,
         OrderID: 1111,
         Country: "Aussy",
@@ -524,10 +522,10 @@ describe.each([
       expect(row.name).toEqual("Updated Name")
       expect(row.description).toEqual(existing.description)
 
-      const savedRow = await loadRow(row._id!, table._id!)
+      const savedRow = await config.api.row.get(table._id!, row._id!)
 
-      expect(savedRow.body.description).toEqual(existing.description)
+      expect(savedRow.description).toEqual(existing.description)
-      expect(savedRow.body.name).toEqual("Updated Name")
+      expect(savedRow.name).toEqual("Updated Name")
       await assertRowUsage(rowUsage)
     })
 
@@ -543,7 +541,7 @@ describe.each([
           tableId: table._id!,
           name: 1,
         },
-        { expectStatus: 400 }
+        { status: 400 }
       )
 
       await assertRowUsage(rowUsage)
@@ -582,8 +580,8 @@ describe.each([
       })
 
       let getResp = await config.api.row.get(table._id!, row._id!)
-      expect(getResp.body.user1[0]._id).toEqual(user1._id)
+      expect(getResp.user1[0]._id).toEqual(user1._id)
-      expect(getResp.body.user2[0]._id).toEqual(user2._id)
+      expect(getResp.user2[0]._id).toEqual(user2._id)
 
       let patchResp = await config.api.row.patch(table._id!, {
         _id: row._id!,
@@ -595,8 +593,8 @@ describe.each([
       expect(patchResp.user2[0]._id).toEqual(user2._id)
 
       getResp = await config.api.row.get(table._id!, row._id!)
-      expect(getResp.body.user1[0]._id).toEqual(user2._id)
+      expect(getResp.user1[0]._id).toEqual(user2._id)
-      expect(getResp.body.user2[0]._id).toEqual(user2._id)
+      expect(getResp.user2[0]._id).toEqual(user2._id)
     })
 
     it("should be able to update relationships when both columns are same name", async () => {
@@ -609,7 +607,7 @@ describe.each([
         description: "test",
         relationship: [row._id],
       })
-      row = (await config.api.row.get(table._id!, row._id!)).body
+      row = await config.api.row.get(table._id!, row._id!)
       expect(row.relationship.length).toBe(1)
       const resp = await config.api.row.patch(table._id!, {
         _id: row._id!,
@@ -632,8 +630,10 @@ describe.each([
       const createdRow = await config.createRow()
       const rowUsage = await getRowUsage()
 
-      const res = await config.api.row.delete(table._id!, [createdRow])
+      const res = await config.api.row.bulkDelete(table._id!, {
-      expect(res.body[0]._id).toEqual(createdRow._id)
+        rows: [createdRow],
+      })
+      expect(res[0]._id).toEqual(createdRow._id)
       await assertRowUsage(rowUsage - 1)
     })
   })
@@ -682,10 +682,12 @@ describe.each([
       const row2 = await config.createRow()
       const rowUsage = await getRowUsage()
 
-      const res = await config.api.row.delete(table._id!, [row1, row2])
+      const res = await config.api.row.bulkDelete(table._id!, {
+        rows: [row1, row2],
+      })
 
-      expect(res.body.length).toEqual(2)
+      expect(res.length).toEqual(2)
-      await loadRow(row1._id!, table._id!, 404)
+      await config.api.row.get(table._id!, row1._id!, { status: 404 })
       await assertRowUsage(rowUsage - 2)
     })
 
@@ -697,14 +699,12 @@ describe.each([
       ])
       const rowUsage = await getRowUsage()
 
-      const res = await config.api.row.delete(table._id!, [
+      const res = await config.api.row.bulkDelete(table._id!, {
-        row1,
+        rows: [row1, row2._id!, { _id: row3._id }],
-        row2._id,
+      })
-        { _id: row3._id },
-      ])
 
-      expect(res.body.length).toEqual(3)
+      expect(res.length).toEqual(3)
-      await loadRow(row1._id!, table._id!, 404)
+      await config.api.row.get(table._id!, row1._id!, { status: 404 })
       await assertRowUsage(rowUsage - 3)
     })
 
@@ -712,34 +712,36 @@ describe.each([
       const row1 = await config.createRow()
       const rowUsage = await getRowUsage()
 
-      const res = await config.api.row.delete(table._id!, row1)
+      const res = await config.api.row.delete(table._id!, row1 as DeleteRow)
 
-      expect(res.body.id).toEqual(row1._id)
+      expect(res.id).toEqual(row1._id)
-      await loadRow(row1._id!, table._id!, 404)
+      await config.api.row.get(table._id!, row1._id!, { status: 404 })
       await assertRowUsage(rowUsage - 1)
     })
 
     it("Should ignore malformed/invalid delete requests", async () => {
       const rowUsage = await getRowUsage()
 
-      const res = await config.api.row.delete(
+      await config.api.row.delete(table._id!, { not: "valid" } as any, {
-        table._id!,
+        status: 400,
-        { not: "valid" },
+        body: {
-        { expectStatus: 400 }
+          message: "Invalid delete rows request",
-      )
+        },
-      expect(res.body.message).toEqual("Invalid delete rows request")
+      })
-
+
-      const res2 = await config.api.row.delete(
+      await config.api.row.delete(table._id!, { rows: 123 } as any, {
-        table._id!,
+        status: 400,
-        { rows: 123 },
+        body: {
-        { expectStatus: 400 }
+          message: "Invalid delete rows request",
-      )
+        },
-      expect(res2.body.message).toEqual("Invalid delete rows request")
+      })
-
+
-      const res3 = await config.api.row.delete(table._id!, "invalid", {
+      await config.api.row.delete(table._id!, "invalid" as any, {
-        expectStatus: 400,
+        status: 400,
+        body: {
+          message: "Invalid delete rows request",
+        },
       })
-      expect(res3.body.message).toEqual("Invalid delete rows request")
 
       await assertRowUsage(rowUsage)
     })
@@ -757,16 +759,16 @@ describe.each([
         const row = await config.createRow()
         const rowUsage = await getRowUsage()
 
-        const res = await config.api.legacyView.get(table._id!)
+        const rows = await config.api.legacyView.get(table._id!)
-        expect(res.body.length).toEqual(1)
+        expect(rows.length).toEqual(1)
-        expect(res.body[0]._id).toEqual(row._id)
+        expect(rows[0]._id).toEqual(row._id)
         await assertRowUsage(rowUsage)
       })
 
       it("should throw an error if view doesn't exist", async () => {
         const rowUsage = await getRowUsage()
 
-        await config.api.legacyView.get("derp", { expectStatus: 404 })
+        await config.api.legacyView.get("derp", { status: 404 })
 
         await assertRowUsage(rowUsage)
       })
@@ -781,9 +783,9 @@ describe.each([
         const row = await config.createRow()
         const rowUsage = await getRowUsage()
 
-        const res = await config.api.legacyView.get(view.name)
+        const rows = await config.api.legacyView.get(view.name)
-        expect(res.body.length).toEqual(1)
+        expect(rows.length).toEqual(1)
-        expect(res.body[0]._id).toEqual(row._id)
+        expect(rows[0]._id).toEqual(row._id)
 
         await assertRowUsage(rowUsage)
       })
@@ -841,8 +843,8 @@ describe.each([
         linkedTable._id!,
         secondRow._id!
       )
-      expect(resBasic.body.link.length).toBe(1)
+      expect(resBasic.link.length).toBe(1)
-      expect(resBasic.body.link[0]).toEqual({
+      expect(resBasic.link[0]).toEqual({
         _id: firstRow._id,
         primaryDisplay: firstRow.name,
       })
@@ -852,10 +854,10 @@ describe.each([
         linkedTable._id!,
         secondRow._id!
       )
-      expect(resEnriched.body.link.length).toBe(1)
+      expect(resEnriched.link.length).toBe(1)
-      expect(resEnriched.body.link[0]._id).toBe(firstRow._id)
+      expect(resEnriched.link[0]._id).toBe(firstRow._id)
-      expect(resEnriched.body.link[0].name).toBe("Test Contact")
+      expect(resEnriched.link[0].name).toBe("Test Contact")
-      expect(resEnriched.body.link[0].description).toBe("original description")
+      expect(resEnriched.link[0].description).toBe("original description")
       await assertRowUsage(rowUsage)
     })
   })
@@ -880,8 +882,7 @@ describe.each([
           ],
           tableId: table._id,
         })
-        // the environment needs configured for this
+        await config.withEnv({ SELF_HOSTED: "true" }, async () => {
-        await setup.switchToSelfHosted(async () => {
           return context.doInAppContext(config.getAppId(), async () => {
             const enriched = await outputProcessing(table, [row])
             expect((enriched as Row[])[0].attachment[0].url).toBe(
@@ -903,7 +904,7 @@ describe.each([
       const res = await config.api.row.exportRows(table._id!, {
         rows: [existing._id!],
       })
-      const results = JSON.parse(res.text)
+      const results = JSON.parse(res)
       expect(results.length).toEqual(1)
       const row = results[0]
 
@@ -922,7 +923,7 @@ describe.each([
         rows: [existing._id!],
         columns: ["_id"],
       })
-      const results = JSON.parse(res.text)
+      const results = JSON.parse(res)
       expect(results.length).toEqual(1)
       const row = results[0]
 
@@ -1000,7 +1001,7 @@ describe.each([
         })
 
         const row = await config.api.row.get(table._id!, newRow._id!)
-        expect(row.body).toEqual({
+        expect(row).toEqual({
           name: data.name,
           surname: data.surname,
           address: data.address,
@@ -1010,9 +1011,9 @@ describe.each([
           id: newRow.id,
           ...defaultRowFields,
         })
-        expect(row.body._viewId).toBeUndefined()
+        expect(row._viewId).toBeUndefined()
-        expect(row.body.age).toBeUndefined()
+        expect(row.age).toBeUndefined()
-        expect(row.body.jobTitle).toBeUndefined()
+        expect(row.jobTitle).toBeUndefined()
       })
     })
 
@@ -1042,7 +1043,7 @@ describe.each([
         })
 
         const row = await config.api.row.get(tableId, newRow._id!)
-        expect(row.body).toEqual({
+        expect(row).toEqual({
           ...newRow,
           name: newData.name,
           address: newData.address,
@@ -1051,9 +1052,9 @@ describe.each([
           id: newRow.id,
           ...defaultRowFields,
         })
-        expect(row.body._viewId).toBeUndefined()
+        expect(row._viewId).toBeUndefined()
-        expect(row.body.age).toBeUndefined()
+        expect(row.age).toBeUndefined()
-        expect(row.body.jobTitle).toBeUndefined()
+        expect(row.jobTitle).toBeUndefined()
       })
     })
 
@@ -1071,12 +1072,12 @@ describe.each([
         const createdRow = await config.createRow()
         const rowUsage = await getRowUsage()
 
-        await config.api.row.delete(view.id, [createdRow])
+        await config.api.row.bulkDelete(view.id, { rows: [createdRow] })
 
         await assertRowUsage(rowUsage - 1)
 
         await config.api.row.get(tableId, createdRow._id!, {
-          expectStatus: 404,
+          status: 404,
         })
       })
 
@@ -1097,17 +1098,17 @@ describe.each([
         ])
         const rowUsage = await getRowUsage()
 
-        await config.api.row.delete(view.id, [rows[0], rows[2]])
+        await config.api.row.bulkDelete(view.id, { rows: [rows[0], rows[2]] })
 
         await assertRowUsage(rowUsage - 2)
 
         await config.api.row.get(tableId, rows[0]._id!, {
-          expectStatus: 404,
+          status: 404,
         })
         await config.api.row.get(tableId, rows[2]._id!, {
-          expectStatus: 404,
+          status: 404,
         })
-        await config.api.row.get(tableId, rows[1]._id!, { expectStatus: 200 })
+        await config.api.row.get(tableId, rows[1]._id!, { status: 200 })
       })
     })
 
@@ -1154,8 +1155,8 @@ describe.each([
         const createViewResponse = await config.createView()
         const response = await config.api.viewV2.search(createViewResponse.id)
 
-        expect(response.body.rows).toHaveLength(10)
+        expect(response.rows).toHaveLength(10)
-        expect(response.body).toEqual({
+        expect(response).toEqual({
           rows: expect.arrayContaining(
             rows.map(r => ({
               _viewId: createViewResponse.id,
@@ -1206,8 +1207,8 @@ describe.each([
 
         const response = await config.api.viewV2.search(createViewResponse.id)
 
-        expect(response.body.rows).toHaveLength(5)
+        expect(response.rows).toHaveLength(5)
-        expect(response.body).toEqual({
+        expect(response).toEqual({
           rows: expect.arrayContaining(
             expectedRows.map(r => ({
               _viewId: createViewResponse.id,
@@ -1328,8 +1329,8 @@ describe.each([
               createViewResponse.id
             )
 
-            expect(response.body.rows).toHaveLength(4)
+            expect(response.rows).toHaveLength(4)
-            expect(response.body.rows).toEqual(
+            expect(response.rows).toEqual(
               expected.map(name => expect.objectContaining({ name }))
             )
           }
@@ -1357,8 +1358,8 @@ describe.each([
               }
             )
 
-            expect(response.body.rows).toHaveLength(4)
+            expect(response.rows).toHaveLength(4)
-            expect(response.body.rows).toEqual(
+            expect(response.rows).toEqual(
               expected.map(name => expect.objectContaining({ name }))
             )
           }
@@ -1382,8 +1383,8 @@ describe.each([
         })
         const response = await config.api.viewV2.search(view.id)
 
-        expect(response.body.rows).toHaveLength(10)
+        expect(response.rows).toHaveLength(10)
-        expect(response.body.rows).toEqual(
+        expect(response.rows).toEqual(
           expect.arrayContaining(
             rows.map(r => ({
               ...(isInternal
@@ -1402,7 +1403,7 @@ describe.each([
         const createViewResponse = await config.createView()
         const response = await config.api.viewV2.search(createViewResponse.id)
 
-        expect(response.body.rows).toHaveLength(0)
+        expect(response.rows).toHaveLength(0)
       })
 
       it("respects the limit parameter", async () => {
@@ -1417,7 +1418,7 @@ describe.each([
           query: {},
         })
 
-        expect(response.body.rows).toHaveLength(limit)
+        expect(response.rows).toHaveLength(limit)
       })
 
       it("can handle pagination", async () => {
@@ -1426,7 +1427,7 @@ describe.each([
 
         const createViewResponse = await config.createView()
         const allRows = (await config.api.viewV2.search(createViewResponse.id))
-          .body.rows
+          .rows
 
         const firstPageResponse = await config.api.viewV2.search(
           createViewResponse.id,
@@ -1436,7 +1437,7 @@ describe.each([
             query: {},
           }
         )
-        expect(firstPageResponse.body).toEqual({
+        expect(firstPageResponse).toEqual({
           rows: expect.arrayContaining(allRows.slice(0, 4)),
           totalRows: isInternal ? 10 : undefined,
           hasNextPage: true,
@@ -1448,12 +1449,12 @@ describe.each([
           {
             paginate: true,
             limit: 4,
-            bookmark: firstPageResponse.body.bookmark,
+            bookmark: firstPageResponse.bookmark,
 
             query: {},
           }
         )
-        expect(secondPageResponse.body).toEqual({
+        expect(secondPageResponse).toEqual({
           rows: expect.arrayContaining(allRows.slice(4, 8)),
           totalRows: isInternal ? 10 : undefined,
           hasNextPage: true,
@@ -1465,11 +1466,11 @@ describe.each([
           {
             paginate: true,
             limit: 4,
-            bookmark: secondPageResponse.body.bookmark,
+            bookmark: secondPageResponse.bookmark,
             query: {},
           }
         )
-        expect(lastPageResponse.body).toEqual({
+        expect(lastPageResponse).toEqual({
           rows: expect.arrayContaining(allRows.slice(8)),
           totalRows: isInternal ? 10 : undefined,
           hasNextPage: false,
@@ -1489,7 +1490,7 @@ describe.each([
               email: "joe@joe.com",
               roles: {},
             },
-            { expectStatus: 400 }
+            { status: 400 }
           )
           expect(response.message).toBe("Cannot create new user entry.")
         })
@@ -1516,58 +1517,52 @@ describe.each([
 
         it("does not allow public users to fetch by default", async () => {
           await config.publish()
-          await config.api.viewV2.search(viewId, undefined, {
+          await config.api.viewV2.publicSearch(viewId, undefined, {
-            expectStatus: 403,
+            status: 403,
-            usePublicUser: true,
           })
         })
 
         it("allow public users to fetch when permissions are explicit", async () => {
-          await config.api.permission.set({
+          await config.api.permission.add({
             roleId: roles.BUILTIN_ROLE_IDS.PUBLIC,
             level: PermissionLevel.READ,
             resourceId: viewId,
           })
           await config.publish()
 
-          const response = await config.api.viewV2.search(viewId, undefined, {
+          const response = await config.api.viewV2.publicSearch(viewId)
-            usePublicUser: true,
-          })
 
-          expect(response.body.rows).toHaveLength(10)
+          expect(response.rows).toHaveLength(10)
         })
 
         it("allow public users to fetch when permissions are inherited", async () => {
-          await config.api.permission.set({
+          await config.api.permission.add({
             roleId: roles.BUILTIN_ROLE_IDS.PUBLIC,
             level: PermissionLevel.READ,
             resourceId: tableId,
           })
           await config.publish()
 
-          const response = await config.api.viewV2.search(viewId, undefined, {
+          const response = await config.api.viewV2.publicSearch(viewId)
-            usePublicUser: true,
-          })
 
-          expect(response.body.rows).toHaveLength(10)
+          expect(response.rows).toHaveLength(10)
         })
 
         it("respects inherited permissions, not allowing not public views from public tables", async () => {
-          await config.api.permission.set({
+          await config.api.permission.add({
             roleId: roles.BUILTIN_ROLE_IDS.PUBLIC,
             level: PermissionLevel.READ,
             resourceId: tableId,
           })
-          await config.api.permission.set({
+          await config.api.permission.add({
             roleId: roles.BUILTIN_ROLE_IDS.POWER,
             level: PermissionLevel.READ,
             resourceId: viewId,
           })
           await config.publish()
 
-          await config.api.viewV2.search(viewId, undefined, {
+          await config.api.viewV2.publicSearch(viewId, undefined, {
-            usePublicUser: true,
+            status: 403,
-            expectStatus: 403,
           })
         })
       })
@@ -1754,7 +1749,7 @@ describe.each([
       }
       const row = await config.api.row.save(tableId, rowData)
 
-      const { body: retrieved } = await config.api.row.get(tableId, row._id!)
+      const retrieved = await config.api.row.get(tableId, row._id!)
       expect(retrieved).toEqual({
         name: rowData.name,
         description: rowData.description,
@@ -1781,7 +1776,7 @@ describe.each([
       }
       const row = await config.api.row.save(tableId, rowData)
 
-      const { body: retrieved } = await config.api.row.get(tableId, row._id!)
+      const retrieved = await config.api.row.get(tableId, row._id!)
       expect(retrieved).toEqual({
         name: rowData.name,
         description: rowData.description,

packages/server/src/api/routes/tests/table.spec.ts

@@ -26,6 +26,7 @@ import { TableToBuild } from "../../../tests/utilities/TestConfiguration"
 tk.freeze(mocks.date.MOCK_DATE)
 
 const { basicTable } = setup.structures
+const ISO_REGEX_PATTERN = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/
 
 describe("/tables", () => {
   let request = setup.getRequest()
@@ -285,6 +286,35 @@ describe("/tables", () => {
         expect(res.body.schema.roleId).toBeDefined()
       })
     })
+
+    it("should add a new column for an internal DB table", async () => {
+      const saveTableRequest: SaveTableRequest = {
+        _add: {
+          name: "NEW_COLUMN",
+        },
+        ...basicTable(),
+      }
+
+      const response = await request
+        .post(`/api/tables`)
+        .send(saveTableRequest)
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(200)
+
+      const expectedResponse = {
+        ...saveTableRequest,
+        _rev: expect.stringMatching(/^\d-.+/),
+        _id: expect.stringMatching(/^ta_.+/),
+        createdAt: expect.stringMatching(ISO_REGEX_PATTERN),
+        updatedAt: expect.stringMatching(ISO_REGEX_PATTERN),
+        views: {},
+      }
+      delete expectedResponse._add
+
+      expect(response.status).toBe(200)
+      expect(response.body).toEqual(expectedResponse)
+    })
   })
 
   describe("import", () => {
@@ -663,8 +693,7 @@ describe("/tables", () => {
       expect(migratedTable.schema["user column"]).toBeDefined()
       expect(migratedTable.schema["user relationship"]).not.toBeDefined()
 
-      const resp = await config.api.row.get(table._id!, testRow._id!)
+      const migratedRow = await config.api.row.get(table._id!, testRow._id!)
-      const migratedRow = resp.body as Row
 
       expect(migratedRow["user column"]).toBeDefined()
       expect(migratedRow["user relationship"]).not.toBeDefined()
@@ -716,15 +745,13 @@ describe("/tables", () => {
       expect(migratedTable.schema["user column"]).toBeDefined()
       expect(migratedTable.schema["user relationship"]).not.toBeDefined()
 
-      const row1Migrated = (await config.api.row.get(table._id!, row1._id!))
+      const row1Migrated = await config.api.row.get(table._id!, row1._id!)
-        .body as Row
       expect(row1Migrated["user relationship"]).not.toBeDefined()
       expect(row1Migrated["user column"].map((r: Row) => r._id)).toEqual(
         expect.arrayContaining([users[0]._id, users[1]._id])
       )
 
-      const row2Migrated = (await config.api.row.get(table._id!, row2._id!))
+      const row2Migrated = await config.api.row.get(table._id!, row2._id!)
-        .body as Row
       expect(row2Migrated["user relationship"]).not.toBeDefined()
       expect(row2Migrated["user column"].map((r: Row) => r._id)).toEqual(
         expect.arrayContaining([users[1]._id, users[2]._id])
@@ -773,15 +800,13 @@ describe("/tables", () => {
       expect(migratedTable.schema["user column"]).toBeDefined()
       expect(migratedTable.schema["user relationship"]).not.toBeDefined()
 
-      const row1Migrated = (await config.api.row.get(table._id!, row1._id!))
+      const row1Migrated = await config.api.row.get(table._id!, row1._id!)
-        .body as Row
       expect(row1Migrated["user relationship"]).not.toBeDefined()
       expect(row1Migrated["user column"].map((r: Row) => r._id)).toEqual(
         expect.arrayContaining([users[0]._id, users[1]._id])
       )
 
-      const row2Migrated = (await config.api.row.get(table._id!, row2._id!))
+      const row2Migrated = await config.api.row.get(table._id!, row2._id!)
-        .body as Row
       expect(row2Migrated["user relationship"]).not.toBeDefined()
       expect(row2Migrated["user column"].map((r: Row) => r._id)).toEqual([
         users[2]._id,
@@ -831,7 +856,7 @@ describe("/tables", () => {
               subtype: FieldSubtype.USERS,
             },
           },
-          { expectStatus: 400 }
+          { status: 400 }
         )
       })
 
@@ -846,7 +871,7 @@ describe("/tables", () => {
               subtype: FieldSubtype.USERS,
             },
           },
-          { expectStatus: 400 }
+          { status: 400 }
         )
       })
 
@@ -861,7 +886,7 @@ describe("/tables", () => {
               subtype: FieldSubtype.USERS,
             },
           },
-          { expectStatus: 400 }
+          { status: 400 }
         )
       })
 
@@ -880,7 +905,7 @@ describe("/tables", () => {
               subtype: FieldSubtype.USERS,
             },
           },
-          { expectStatus: 400 }
+          { status: 400 }
         )
       })
     })

packages/server/src/api/routes/tests/user.spec.ts

@@ -90,7 +90,7 @@ describe("/users", () => {
       })
       await config.api.user.update(
         { ...user, roleId: roles.BUILTIN_ROLE_IDS.POWER },
-        { expectStatus: 409 }
+        { status: 409 }
       )
     })
   })

packages/server/src/api/routes/tests/utilities/index.ts

@@ -77,21 +77,3 @@ export function getConfig() {
   }
   return config!
 }
-
-export async function switchToSelfHosted(func: any) {
-  // self hosted stops any attempts to Dynamo
-  env._set("NODE_ENV", "production")
-  env._set("SELF_HOSTED", true)
-  let error
-  try {
-    await func()
-  } catch (err) {
-    error = err
-  }
-  env._set("NODE_ENV", "jest")
-  env._set("SELF_HOSTED", false)
-  // don't throw error until after reset
-  if (error) {
-    throw error
-  }
-}

packages/server/src/api/routes/tests/viewV2.spec.ts

@@ -177,7 +177,7 @@ describe.each([
       }
 
       await config.api.viewV2.create(newView, {
-        expectStatus: 201,
+        status: 201,
       })
     })
   })
@@ -275,7 +275,7 @@ describe.each([
       const tableId = table._id!
       await config.api.viewV2.update(
         { ...view, id: generator.guid() },
-        { expectStatus: 404 }
+        { status: 404 }
       )
 
       expect(await config.api.table.get(tableId)).toEqual(
@@ -304,7 +304,7 @@ describe.each([
             },
           ],
         },
-        { expectStatus: 404 }
+        { status: 404 }
       )
 
       expect(await config.api.table.get(tableId)).toEqual(
@@ -326,12 +326,10 @@ describe.each([
           ...viewV1,
         },
         {
-          expectStatus: 400,
+          status: 400,
-          handleResponse: r => {
+          body: {
-            expect(r.body).toEqual({
+            message: "Only views V2 can be updated",
-              message: "Only views V2 can be updated",
+            status: 400,
-              status: 400,
-            })
           },
         }
       )
@@ -403,7 +401,7 @@ describe.each([
           } as Record<string, FieldSchema>,
         },
         {
-          expectStatus: 200,
+          status: 200,
         }
       )
     })

packages/server/src/appMigrations/tests/migrations.spec.ts

@@ -30,9 +30,9 @@ describe("migrations", () => {
 
     const appId = config.getAppId()
 
-    const response = await config.api.application.getRaw(appId)
+    await config.api.application.get(appId, {
-
+      headersNotPresent: [Header.MIGRATING_APP],
-    expect(response.headers[Header.MIGRATING_APP]).toBeUndefined()
+    })
   })
 
   it("accessing an app that has pending migrations will attach the migrating header", async () => {
@@ -46,8 +46,10 @@ describe("migrations", () => {
       func: async () => {},
     })
 
-    const response = await config.api.application.getRaw(appId)
+    await config.api.application.get(appId, {
-
+      headers: {
-    expect(response.headers[Header.MIGRATING_APP]).toEqual(appId)
+        [Header.MIGRATING_APP]: appId,
+      },
+    })
   })
 })

packages/server/src/automations/tests/createRow.spec.ts

@@ -24,7 +24,7 @@ describe("test the create row action", () => {
     expect(res.id).toBeDefined()
     expect(res.revision).toBeDefined()
     expect(res.success).toEqual(true)
-    const gottenRow = await config.getRow(table._id, res.id)
+    const gottenRow = await config.api.row.get(table._id, res.id)
     expect(gottenRow.name).toEqual("test")
     expect(gottenRow.description).toEqual("test")
   })

packages/server/src/automations/tests/updateRow.spec.ts

@@ -36,7 +36,7 @@ describe("test the update row action", () => {
   it("should be able to run the action", async () => {
     const res = await setup.runStep(setup.actions.UPDATE_ROW.stepId, inputs)
     expect(res.success).toEqual(true)
-    const updatedRow = await config.getRow(table._id!, res.id)
+    const updatedRow = await config.api.row.get(table._id!, res.id)
     expect(updatedRow.name).toEqual("Updated name")
     expect(updatedRow.description).not.toEqual("")
   })
@@ -87,8 +87,8 @@ describe("test the update row action", () => {
     })
 
     let getResp = await config.api.row.get(table._id!, row._id!)
-    expect(getResp.body.user1[0]._id).toEqual(user1._id)
+    expect(getResp.user1[0]._id).toEqual(user1._id)
-    expect(getResp.body.user2[0]._id).toEqual(user2._id)
+    expect(getResp.user2[0]._id).toEqual(user2._id)
 
     let stepResp = await setup.runStep(setup.actions.UPDATE_ROW.stepId, {
       rowId: row._id,
@@ -103,8 +103,8 @@ describe("test the update row action", () => {
     expect(stepResp.success).toEqual(true)
 
     getResp = await config.api.row.get(table._id!, row._id!)
-    expect(getResp.body.user1[0]._id).toEqual(user2._id)
+    expect(getResp.user1[0]._id).toEqual(user2._id)
-    expect(getResp.body.user2[0]._id).toEqual(user2._id)
+    expect(getResp.user2[0]._id).toEqual(user2._id)
   })
 
   it("should overwrite links if those links are not set and we ask it do", async () => {
@@ -140,8 +140,8 @@ describe("test the update row action", () => {
     })
 
     let getResp = await config.api.row.get(table._id!, row._id!)
-    expect(getResp.body.user1[0]._id).toEqual(user1._id)
+    expect(getResp.user1[0]._id).toEqual(user1._id)
-    expect(getResp.body.user2[0]._id).toEqual(user2._id)
+    expect(getResp.user2[0]._id).toEqual(user2._id)
 
     let stepResp = await setup.runStep(setup.actions.UPDATE_ROW.stepId, {
       rowId: row._id,
@@ -163,7 +163,7 @@ describe("test the update row action", () => {
     expect(stepResp.success).toEqual(true)
 
     getResp = await config.api.row.get(table._id!, row._id!)
-    expect(getResp.body.user1[0]._id).toEqual(user2._id)
+    expect(getResp.user1[0]._id).toEqual(user2._id)
-    expect(getResp.body.user2).toBeUndefined()
+    expect(getResp.user2).toBeUndefined()
   })
 })

packages/server/src/db/tests/linkController.spec.ts

@@ -100,7 +100,7 @@ describe("test the link controller", () => {
     const { _id } = await config.createRow(
       basicLinkedRow(t1._id!, row._id!, linkField)
     )
-    return config.getRow(t1._id!, _id!)
+    return config.api.row.get(t1._id!, _id!)
   }
 
   it("should be able to confirm if two table schemas are equal", async () => {

packages/server/src/environment.ts

@@ -76,13 +76,16 @@ const environment = {
     DEFAULTS.AUTOMATION_THREAD_TIMEOUT > QUERY_THREAD_TIMEOUT
       ? DEFAULTS.AUTOMATION_THREAD_TIMEOUT
       : QUERY_THREAD_TIMEOUT,
-  SQL_MAX_ROWS: process.env.SQL_MAX_ROWS,
   BB_ADMIN_USER_EMAIL: process.env.BB_ADMIN_USER_EMAIL,
   BB_ADMIN_USER_PASSWORD: process.env.BB_ADMIN_USER_PASSWORD,
   PLUGINS_DIR: process.env.PLUGINS_DIR || DEFAULTS.PLUGINS_DIR,
   OPENAI_API_KEY: process.env.OPENAI_API_KEY,
   MAX_IMPORT_SIZE_MB: process.env.MAX_IMPORT_SIZE_MB,
   SESSION_EXPIRY_SECONDS: process.env.SESSION_EXPIRY_SECONDS,
+  // SQL
+  SQL_MAX_ROWS: process.env.SQL_MAX_ROWS,
+  SQL_LOGGING_ENABLE: process.env.SQL_LOGGING_ENABLE,
+  SQL_ALIASING_DISABLE: process.env.SQL_ALIASING_DISABLE,
   // flags
   ALLOW_DEV_AUTOMATIONS: process.env.ALLOW_DEV_AUTOMATIONS,
   DISABLE_THREADING: process.env.DISABLE_THREADING,

packages/server/src/integration-test/mysql.spec.ts

@@ -0,0 +1,363 @@
+import fetch from "node-fetch"
+import {
+  generateMakeRequest,
+  MakeRequestResponse,
+} from "../api/routes/public/tests/utils"
+import { v4 as uuidv4 } from "uuid"
+import * as setup from "../api/routes/tests/utilities"
+import {
+  Datasource,
+  FieldType,
+  Table,
+  TableRequest,
+  TableSourceType,
+} from "@budibase/types"
+import _ from "lodash"
+import { databaseTestProviders } from "../integrations/tests/utils"
+import mysql from "mysql2/promise"
+import { builderSocket } from "../websockets"
+// @ts-ignore
+fetch.mockSearch()
+
+const config = setup.getConfig()!
+
+jest.unmock("mysql2/promise")
+jest.mock("../websockets", () => ({
+  clientAppSocket: jest.fn(),
+  gridAppSocket: jest.fn(),
+  initialise: jest.fn(),
+  builderSocket: {
+    emitTableUpdate: jest.fn(),
+    emitTableDeletion: jest.fn(),
+    emitDatasourceUpdate: jest.fn(),
+    emitDatasourceDeletion: jest.fn(),
+    emitScreenUpdate: jest.fn(),
+    emitAppMetadataUpdate: jest.fn(),
+    emitAppPublish: jest.fn(),
+  },
+}))
+
+describe("mysql integrations", () => {
+  let makeRequest: MakeRequestResponse,
+    mysqlDatasource: Datasource,
+    primaryMySqlTable: Table
+
+  beforeAll(async () => {
+    await config.init()
+    const apiKey = await config.generateApiKey()
+
+    makeRequest = generateMakeRequest(apiKey, true)
+
+    mysqlDatasource = await config.api.datasource.create(
+      await databaseTestProviders.mysql.datasource()
+    )
+  })
+
+  afterAll(async () => {
+    await databaseTestProviders.mysql.stop()
+  })
+
+  beforeEach(async () => {
+    primaryMySqlTable = await config.createTable({
+      name: uuidv4(),
+      type: "table",
+      primary: ["id"],
+      schema: {
+        id: {
+          name: "id",
+          type: FieldType.AUTO,
+          autocolumn: true,
+        },
+        name: {
+          name: "name",
+          type: FieldType.STRING,
+        },
+        description: {
+          name: "description",
+          type: FieldType.STRING,
+        },
+        value: {
+          name: "value",
+          type: FieldType.NUMBER,
+        },
+      },
+      sourceId: mysqlDatasource._id,
+      sourceType: TableSourceType.EXTERNAL,
+    })
+  })
+
+  afterAll(config.end)
+
+  it("validate table schema", async () => {
+    const res = await makeRequest(
+      "get",
+      `/api/datasources/${mysqlDatasource._id}`
+    )
+
+    expect(res.status).toBe(200)
+    expect(res.body).toEqual({
+      config: {
+        database: "mysql",
+        host: mysqlDatasource.config!.host,
+        password: "--secret-value--",
+        port: mysqlDatasource.config!.port,
+        user: "root",
+      },
+      plus: true,
+      source: "MYSQL",
+      type: "datasource_plus",
+      _id: expect.any(String),
+      _rev: expect.any(String),
+      createdAt: expect.any(String),
+      updatedAt: expect.any(String),
+      entities: expect.any(Object),
+    })
+  })
+
+  describe("POST /api/datasources/verify", () => {
+    it("should be able to verify the connection", async () => {
+      await config.api.datasource.verify(
+        {
+          datasource: await databaseTestProviders.mysql.datasource(),
+        },
+        {
+          body: {
+            connected: true,
+          },
+        }
+      )
+    })
+
+    it("should state an invalid datasource cannot connect", async () => {
+      const dbConfig = await databaseTestProviders.mysql.datasource()
+      await config.api.datasource.verify(
+        {
+          datasource: {
+            ...dbConfig,
+            config: {
+              ...dbConfig.config,
+              password: "wrongpassword",
+            },
+          },
+        },
+        {
+          body: {
+            connected: false,
+            error:
+              "Access denied for the specified user. User does not have the necessary privileges or the provided credentials are incorrect. Please verify the credentials, and ensure that the user has appropriate permissions.",
+          },
+        }
+      )
+    })
+  })
+
+  describe("POST /api/datasources/info", () => {
+    it("should fetch information about mysql datasource", async () => {
+      const primaryName = primaryMySqlTable.name
+      const response = await makeRequest("post", "/api/datasources/info", {
+        datasource: mysqlDatasource,
+      })
+      expect(response.status).toBe(200)
+      expect(response.body.tableNames).toBeDefined()
+      expect(response.body.tableNames.indexOf(primaryName)).not.toBe(-1)
+    })
+  })
+
+  describe("Integration compatibility with mysql search_path", () => {
+    let client: mysql.Connection, pathDatasource: Datasource
+    const database = "test1"
+    const database2 = "test-2"
+
+    beforeAll(async () => {
+      const dsConfig = await databaseTestProviders.mysql.datasource()
+      const dbConfig = dsConfig.config!
+
+      client = await mysql.createConnection(dbConfig)
+      await client.query(`CREATE DATABASE \`${database}\`;`)
+      await client.query(`CREATE DATABASE \`${database2}\`;`)
+
+      const pathConfig: any = {
+        ...dsConfig,
+        config: {
+          ...dbConfig,
+          database,
+        },
+      }
+      pathDatasource = await config.api.datasource.create(pathConfig)
+    })
+
+    afterAll(async () => {
+      await client.query(`DROP DATABASE \`${database}\`;`)
+      await client.query(`DROP DATABASE \`${database2}\`;`)
+      await client.end()
+    })
+
+    it("discovers tables from any schema in search path", async () => {
+      await client.query(
+        `CREATE TABLE \`${database}\`.table1 (id1 SERIAL PRIMARY KEY);`
+      )
+      const response = await makeRequest("post", "/api/datasources/info", {
+        datasource: pathDatasource,
+      })
+      expect(response.status).toBe(200)
+      expect(response.body.tableNames).toBeDefined()
+      expect(response.body.tableNames).toEqual(
+        expect.arrayContaining(["table1"])
+      )
+    })
+
+    it("does not mix columns from different tables", async () => {
+      const repeated_table_name = "table_same_name"
+      await client.query(
+        `CREATE TABLE \`${database}\`.${repeated_table_name} (id SERIAL PRIMARY KEY, val1 TEXT);`
+      )
+      await client.query(
+        `CREATE TABLE \`${database2}\`.${repeated_table_name} (id2 SERIAL PRIMARY KEY, val2 TEXT);`
+      )
+      const response = await makeRequest(
+        "post",
+        `/api/datasources/${pathDatasource._id}/schema`,
+        {
+          tablesFilter: [repeated_table_name],
+        }
+      )
+      expect(response.status).toBe(200)
+      expect(
+        response.body.datasource.entities[repeated_table_name].schema
+      ).toBeDefined()
+      const schema =
+        response.body.datasource.entities[repeated_table_name].schema
+      expect(Object.keys(schema).sort()).toEqual(["id", "val1"])
+    })
+  })
+
+  describe("POST /api/tables/", () => {
+    let client: mysql.Connection
+    const emitDatasourceUpdateMock = jest.fn()
+
+    beforeEach(async () => {
+      client = await mysql.createConnection(
+        (
+          await databaseTestProviders.mysql.datasource()
+        ).config!
+      )
+      mysqlDatasource = await config.api.datasource.create(
+        await databaseTestProviders.mysql.datasource()
+      )
+    })
+
+    afterEach(async () => {
+      await client.end()
+    })
+
+    it("will emit the datasource entity schema with externalType to the front-end when adding a new column", async () => {
+      const addColumnToTable: TableRequest = {
+        type: "table",
+        sourceType: TableSourceType.EXTERNAL,
+        name: "table",
+        sourceId: mysqlDatasource._id!,
+        primary: ["id"],
+        schema: {
+          id: {
+            type: FieldType.AUTO,
+            name: "id",
+            autocolumn: true,
+          },
+          new_column: {
+            type: FieldType.NUMBER,
+            name: "new_column",
+          },
+        },
+        _add: {
+          name: "new_column",
+        },
+      }
+
+      jest
+        .spyOn(builderSocket!, "emitDatasourceUpdate")
+        .mockImplementation(emitDatasourceUpdateMock)
+
+      await makeRequest("post", "/api/tables/", addColumnToTable)
+
+      const expectedTable: TableRequest = {
+        ...addColumnToTable,
+        schema: {
+          id: {
+            type: FieldType.NUMBER,
+            name: "id",
+            autocolumn: true,
+            constraints: {
+              presence: false,
+            },
+            externalType: "int unsigned",
+          },
+          new_column: {
+            type: FieldType.NUMBER,
+            name: "new_column",
+            autocolumn: false,
+            constraints: {
+              presence: false,
+            },
+            externalType: "float(8,2)",
+          },
+        },
+        created: true,
+        _id: `${mysqlDatasource._id}__table`,
+      }
+      delete expectedTable._add
+
+      expect(emitDatasourceUpdateMock).toBeCalledTimes(1)
+      const emittedDatasource: Datasource =
+        emitDatasourceUpdateMock.mock.calls[0][1]
+      expect(emittedDatasource.entities!["table"]).toEqual(expectedTable)
+    })
+
+    it("will rename a column", async () => {
+      await makeRequest("post", "/api/tables/", primaryMySqlTable)
+
+      let renameColumnOnTable: TableRequest = {
+        ...primaryMySqlTable,
+        schema: {
+          id: {
+            name: "id",
+            type: FieldType.AUTO,
+            autocolumn: true,
+            externalType: "unsigned integer",
+          },
+          name: {
+            name: "name",
+            type: FieldType.STRING,
+            externalType: "text",
+          },
+          description: {
+            name: "description",
+            type: FieldType.STRING,
+            externalType: "text",
+          },
+          age: {
+            name: "age",
+            type: FieldType.NUMBER,
+            externalType: "float(8,2)",
+          },
+        },
+      }
+
+      const response = await makeRequest(
+        "post",
+        "/api/tables/",
+        renameColumnOnTable
+      )
+      mysqlDatasource = (
+        await makeRequest(
+          "post",
+          `/api/datasources/${mysqlDatasource._id}/schema`
+        )
+      ).body.datasource
+
+      expect(response.status).toEqual(200)
+      expect(
+        Object.keys(mysqlDatasource.entities![primaryMySqlTable.name].schema)
+      ).toEqual(["id", "name", "description", "age"])
+    })
+  })
+})

packages/server/src/integration-test/postgres.spec.ts

@@ -398,7 +398,7 @@ describe("postgres integrations", () => {
         expect(res.status).toBe(200)
         expect(res.body).toEqual(updatedRow)
 
-        const persistedRow = await config.getRow(
+        const persistedRow = await config.api.row.get(
           primaryPostgresTable._id!,
           row.id
         )
@@ -1040,28 +1040,37 @@ describe("postgres integrations", () => {
 
   describe("POST /api/datasources/verify", () => {
     it("should be able to verify the connection", async () => {
-      const response = await config.api.datasource.verify({
+      await config.api.datasource.verify(
-        datasource: await databaseTestProviders.postgres.datasource(),
+        {
-      })
+          datasource: await databaseTestProviders.postgres.datasource(),
-      expect(response.status).toBe(200)
+        },
-      expect(response.body.connected).toBe(true)
+        {
+          body: {
+            connected: true,
+          },
+        }
+      )
     })
 
     it("should state an invalid datasource cannot connect", async () => {
       const dbConfig = await databaseTestProviders.postgres.datasource()
-      const response = await config.api.datasource.verify({
+      await config.api.datasource.verify(
-        datasource: {
+        {
-          ...dbConfig,
+          datasource: {
-          config: {
+            ...dbConfig,
-            ...dbConfig.config,
+            config: {
-            password: "wrongpassword",
+              ...dbConfig.config,
+              password: "wrongpassword",
+            },
           },
         },
-      })
+        {
-
+          body: {
-      expect(response.status).toBe(200)
+            connected: false,
-      expect(response.body.connected).toBe(false)
+            error: 'password authentication failed for user "postgres"',
-      expect(response.body.error).toBeDefined()
+          },
+        }
+      )
     })
   })
 

packages/server/src/integrations/base/query.ts

@@ -1,11 +1,15 @@
-import { QueryJson, Datasource } from "@budibase/types"
+import {
+  QueryJson,
+  Datasource,
+  DatasourcePlusQueryResponse,
+} from "@budibase/types"
 import { getIntegration } from "../index"
 import sdk from "../../sdk"
 
 export async function makeExternalQuery(
   datasource: Datasource,
   json: QueryJson
-) {
+): DatasourcePlusQueryResponse {
   datasource = await sdk.datasources.enrich(datasource)
   const Integration = await getIntegration(datasource.source)
   // query is the opinionated function

packages/server/src/integrations/base/sql.ts

@@ -12,12 +12,13 @@ import {
 } from "@budibase/types"
 import environment from "../../environment"
 
+type QueryFunction = (query: Knex.SqlNative, operation: Operation) => any
+
 const envLimit = environment.SQL_MAX_ROWS
   ? parseInt(environment.SQL_MAX_ROWS)
   : null
 const BASE_LIMIT = envLimit || 5000
 
-type KnexQuery = Knex.QueryBuilder | Knex
 // these are invalid dates sent by the client, need to convert them to a real max date
 const MIN_ISO_DATE = "0000-00-00T00:00:00.000Z"
 const MAX_ISO_DATE = "9999-00-00T00:00:00.000Z"
@@ -127,10 +128,15 @@ class InternalBuilder {
 
   // right now we only do filters on the specific table being queried
   addFilters(
-    query: KnexQuery,
+    query: Knex.QueryBuilder,
     filters: SearchFilters | undefined,
-    opts: { relationship?: boolean; tableName?: string }
+    tableName: string,
-  ): KnexQuery {
+    opts: { aliases?: Record<string, string>; relationship?: boolean }
+  ): Knex.QueryBuilder {
+    function getTableName(name: string) {
+      const alias = opts.aliases?.[name]
+      return alias || name
+    }
     function iterate(
       structure: { [key: string]: any },
       fn: (key: string, value: any) => void
@@ -139,10 +145,11 @@ class InternalBuilder {
         const updatedKey = dbCore.removeKeyNumbering(key)
         const isRelationshipField = updatedKey.includes(".")
         if (!opts.relationship && !isRelationshipField) {
-          fn(`${opts.tableName}.${updatedKey}`, value)
+          fn(`${getTableName(tableName)}.${updatedKey}`, value)
         }
         if (opts.relationship && isRelationshipField) {
-          fn(updatedKey, value)
+          const [filterTableName, property] = updatedKey.split(".")
+          fn(`${getTableName(filterTableName)}.${property}`, value)
         }
       }
     }
@@ -314,32 +321,47 @@ class InternalBuilder {
     return query
   }
 
-  addSorting(query: KnexQuery, json: QueryJson): KnexQuery {
+  addSorting(query: Knex.QueryBuilder, json: QueryJson): Knex.QueryBuilder {
     let { sort, paginate } = json
     const table = json.meta?.table
+    const aliases = json.tableAliases
+    const aliased =
+      table?.name && aliases?.[table.name] ? aliases[table.name] : table?.name
     if (sort && Object.keys(sort || {}).length > 0) {
       for (let [key, value] of Object.entries(sort)) {
         const direction =
           value.direction === SortDirection.ASCENDING ? "asc" : "desc"
-        query = query.orderBy(`${table?.name}.${key}`, direction)
+        query = query.orderBy(`${aliased}.${key}`, direction)
       }
     } else if (this.client === SqlClient.MS_SQL && paginate?.limit) {
       // @ts-ignore
-      query = query.orderBy(`${table?.name}.${table?.primary[0]}`)
+      query = query.orderBy(`${aliased}.${table?.primary[0]}`)
     }
     return query
   }
 
+  tableNameWithSchema(
+    tableName: string,
+    opts?: { alias?: string; schema?: string }
+  ) {
+    let withSchema = opts?.schema ? `${opts.schema}.${tableName}` : tableName
+    if (opts?.alias) {
+      withSchema += ` as ${opts.alias}`
+    }
+    return withSchema
+  }
+
   addRelationships(
-    query: KnexQuery,
+    query: Knex.QueryBuilder,
     fromTable: string,
     relationships: RelationshipsJson[] | undefined,
-    schema: string | undefined
+    schema: string | undefined,
-  ): KnexQuery {
+    aliases?: Record<string, string>
+  ): Knex.QueryBuilder {
     if (!relationships) {
       return query
     }
-    const tableSets: Record<string, [any]> = {}
+    const tableSets: Record<string, [RelationshipsJson]> = {}
     // aggregate into table sets (all the same to tables)
     for (let relationship of relationships) {
       const keyObj: { toTable: string; throughTable: string | undefined } = {
@@ -358,10 +380,17 @@ class InternalBuilder {
     }
     for (let [key, relationships] of Object.entries(tableSets)) {
       const { toTable, throughTable } = JSON.parse(key)
-      const toTableWithSchema = schema ? `${schema}.${toTable}` : toTable
+      const toAlias = aliases?.[toTable] || toTable,
-      const throughTableWithSchema = schema
+        throughAlias = aliases?.[throughTable] || throughTable,
-        ? `${schema}.${throughTable}`
+        fromAlias = aliases?.[fromTable] || fromTable
-        : throughTable
+      let toTableWithSchema = this.tableNameWithSchema(toTable, {
+        alias: toAlias,
+        schema,
+      })
+      let throughTableWithSchema = this.tableNameWithSchema(throughTable, {
+        alias: throughAlias,
+        schema,
+      })
       if (!throughTable) {
         // @ts-ignore
         query = query.leftJoin(toTableWithSchema, function () {
@@ -369,7 +398,7 @@ class InternalBuilder {
             const from = relationship.from,
               to = relationship.to
             // @ts-ignore
-            this.orOn(`${fromTable}.${from}`, "=", `${toTable}.${to}`)
+            this.orOn(`${fromAlias}.${from}`, "=", `${toAlias}.${to}`)
           }
         })
       } else {
@@ -381,9 +410,9 @@ class InternalBuilder {
               const from = relationship.from
               // @ts-ignore
               this.orOn(
-                `${fromTable}.${fromPrimary}`,
+                `${fromAlias}.${fromPrimary}`,
                 "=",
-                `${throughTable}.${from}`
+                `${throughAlias}.${from}`
               )
             }
           })
@@ -392,7 +421,7 @@ class InternalBuilder {
               const toPrimary = relationship.toPrimary
               const to = relationship.to
               // @ts-ignore
-              this.orOn(`${toTable}.${toPrimary}`, `${throughTable}.${to}`)
+              this.orOn(`${toAlias}.${toPrimary}`, `${throughAlias}.${to}`)
             }
           })
       }
@@ -400,12 +429,25 @@ class InternalBuilder {
     return query.limit(BASE_LIMIT)
   }
 
-  create(knex: Knex, json: QueryJson, opts: QueryOptions): Knex.QueryBuilder {
+  knexWithAlias(
-    const { endpoint, body } = json
+    knex: Knex,
-    let query: KnexQuery = knex(endpoint.entityId)
+    endpoint: QueryJson["endpoint"],
+    aliases?: QueryJson["tableAliases"]
+  ): Knex.QueryBuilder {
+    const tableName = endpoint.entityId
+    const tableAliased = aliases?.[tableName]
+      ? `${tableName} as ${aliases?.[tableName]}`
+      : tableName
+    let query = knex(tableAliased)
     if (endpoint.schema) {
       query = query.withSchema(endpoint.schema)
     }
+    return query
+  }
+
+  create(knex: Knex, json: QueryJson, opts: QueryOptions): Knex.QueryBuilder {
+    const { endpoint, body } = json
+    let query = this.knexWithAlias(knex, endpoint)
     const parsedBody = parseBody(body)
     // make sure no null values in body for creation
     for (let [key, value] of Object.entries(parsedBody)) {
@@ -424,10 +466,7 @@ class InternalBuilder {
 
   bulkCreate(knex: Knex, json: QueryJson): Knex.QueryBuilder {
     const { endpoint, body } = json
-    let query: KnexQuery = knex(endpoint.entityId)
+    let query = this.knexWithAlias(knex, endpoint)
-    if (endpoint.schema) {
-      query = query.withSchema(endpoint.schema)
-    }
     if (!Array.isArray(body)) {
       return query
     }
@@ -435,8 +474,10 @@ class InternalBuilder {
     return query.insert(parsedBody)
   }
 
-  read(knex: Knex, json: QueryJson, limit: number): KnexQuery {
+  read(knex: Knex, json: QueryJson, limit: number): Knex.QueryBuilder {
-    let { endpoint, resource, filters, paginate, relationships } = json
+    let { endpoint, resource, filters, paginate, relationships, tableAliases } =
+      json
+
     const tableName = endpoint.entityId
     // select all if not specified
     if (!resource) {
@@ -462,21 +503,20 @@ class InternalBuilder {
       foundLimit = paginate.limit
     }
     // start building the query
-    let query: KnexQuery = knex(tableName).limit(foundLimit)
+    let query = this.knexWithAlias(knex, endpoint, tableAliases)
-    if (endpoint.schema) {
+    query = query.limit(foundLimit)
-      query = query.withSchema(endpoint.schema)
-    }
     if (foundOffset) {
       query = query.offset(foundOffset)
     }
-    query = this.addFilters(query, filters, { tableName })
+    query = this.addFilters(query, filters, tableName, {
+      aliases: tableAliases,
+    })
     // add sorting to pre-query
     query = this.addSorting(query, json)
-    // @ts-ignore
+    const alias = tableAliases?.[tableName] || tableName
-    let preQuery: KnexQuery = knex({
+    let preQuery = knex({
-      // @ts-ignore
+      [alias]: query,
-      [tableName]: query,
+    } as any).select(selectStatement) as any
-    }).select(selectStatement)
     // have to add after as well (this breaks MS-SQL)
     if (this.client !== SqlClient.MS_SQL) {
       preQuery = this.addSorting(preQuery, json)
@@ -486,19 +526,22 @@ class InternalBuilder {
       preQuery,
       tableName,
       relationships,
-      endpoint.schema
+      endpoint.schema,
+      tableAliases
     )
-    return this.addFilters(query, filters, { relationship: true })
+    return this.addFilters(query, filters, tableName, {
+      relationship: true,
+      aliases: tableAliases,
+    })
   }
 
   update(knex: Knex, json: QueryJson, opts: QueryOptions): Knex.QueryBuilder {
-    const { endpoint, body, filters } = json
+    const { endpoint, body, filters, tableAliases } = json
-    let query: KnexQuery = knex(endpoint.entityId)
+    let query = this.knexWithAlias(knex, endpoint, tableAliases)
-    if (endpoint.schema) {
-      query = query.withSchema(endpoint.schema)
-    }
     const parsedBody = parseBody(body)
-    query = this.addFilters(query, filters, { tableName: endpoint.entityId })
+    query = this.addFilters(query, filters, endpoint.entityId, {
+      aliases: tableAliases,
+    })
     // mysql can't use returning
     if (opts.disableReturning) {
       return query.update(parsedBody)
@@ -508,12 +551,11 @@ class InternalBuilder {
   }
 
   delete(knex: Knex, json: QueryJson, opts: QueryOptions): Knex.QueryBuilder {
-    const { endpoint, filters } = json
+    const { endpoint, filters, tableAliases } = json
-    let query: KnexQuery = knex(endpoint.entityId)
+    let query = this.knexWithAlias(knex, endpoint, tableAliases)
-    if (endpoint.schema) {
+    query = this.addFilters(query, filters, endpoint.entityId, {
-      query = query.withSchema(endpoint.schema)
+      aliases: tableAliases,
-    }
+    })
-    query = this.addFilters(query, filters, { tableName: endpoint.entityId })
     // mysql can't use returning
     if (opts.disableReturning) {
       return query.delete()
@@ -547,7 +589,7 @@ class SqlQueryBuilder extends SqlTableQueryBuilder {
         query = builder.create(client, json, opts)
         break
       case Operation.READ:
-        query = builder.read(client, json, this.limit) as Knex.QueryBuilder
+        query = builder.read(client, json, this.limit)
         break
       case Operation.UPDATE:
         query = builder.update(client, json, opts)
@@ -568,7 +610,7 @@ class SqlQueryBuilder extends SqlTableQueryBuilder {
     return query.toSQL().toNative()
   }
 
-  async getReturningRow(queryFn: Function, json: QueryJson) {
+  async getReturningRow(queryFn: QueryFunction, json: QueryJson) {
     if (!json.extra || !json.extra.idFilter) {
       return {}
     }
@@ -580,7 +622,7 @@ class SqlQueryBuilder extends SqlTableQueryBuilder {
       resource: {
         fields: [],
       },
-      filters: json.extra.idFilter,
+      filters: json.extra?.idFilter,
       paginate: {
         limit: 1,
       },
@@ -609,7 +651,7 @@ class SqlQueryBuilder extends SqlTableQueryBuilder {
   // this function recreates the returning functionality of postgres
   async queryWithReturning(
     json: QueryJson,
-    queryFn: Function,
+    queryFn: QueryFunction,
     processFn: Function = (result: any) => result
   ) {
     const sqlClient = this.getSqlClient()
@@ -646,6 +688,18 @@ class SqlQueryBuilder extends SqlTableQueryBuilder {
     }
     return results.length ? results : [{ [operation.toLowerCase()]: true }]
   }
+
+  log(query: string, values?: any[]) {
+    if (!environment.SQL_LOGGING_ENABLE) {
+      return
+    }
+    const sqlClient = this.getSqlClient()
+    let string = `[SQL] [${sqlClient.toUpperCase()}] query="${query}"`
+    if (values) {
+      string += ` values="${values.join(", ")}"`
+    }
+    console.log(string)
+  }
 }
 
 export default SqlQueryBuilder

packages/server/src/integrations/googlesheets.ts

@@ -16,6 +16,7 @@ import {
   Table,
   TableRequest,
   TableSourceType,
+  DatasourcePlusQueryResponse,
 } from "@budibase/types"
 import { OAuth2Client } from "google-auth-library"
 import {
@@ -334,7 +335,7 @@ class GoogleSheetsIntegration implements DatasourcePlus {
     return { tables: externalTables, errors }
   }
 
-  async query(json: QueryJson) {
+  async query(json: QueryJson): DatasourcePlusQueryResponse {
     const sheet = json.endpoint.entityId
     switch (json.endpoint.operation) {
       case Operation.CREATE:
@@ -384,7 +385,7 @@ class GoogleSheetsIntegration implements DatasourcePlus {
     }
     try {
       await this.connect()
-      return await this.client.addSheet({ title: name, headerValues: [name] })
+      await this.client.addSheet({ title: name, headerValues: [name] })
     } catch (err) {
       console.error("Error creating new table in google sheets", err)
       throw err
@@ -450,7 +451,7 @@ class GoogleSheetsIntegration implements DatasourcePlus {
     try {
       await this.connect()
       const sheetToDelete = this.client.sheetsByTitle[sheet]
-      return await sheetToDelete.delete()
+      await sheetToDelete.delete()
     } catch (err) {
       console.error("Error deleting table in google sheets", err)
       throw err

packages/server/src/integrations/microsoftSqlServer.ts

@@ -13,6 +13,7 @@ import {
   SourceName,
   Schema,
   TableSourceType,
+  DatasourcePlusQueryResponse,
 } from "@budibase/types"
 import {
   getSqlQuery,
@@ -329,6 +330,7 @@ class SqlServerIntegration extends Sql implements DatasourcePlus {
         operation === Operation.CREATE
           ? `${query.sql}; SELECT SCOPE_IDENTITY() AS id;`
           : query.sql
+      this.log(sql, query.bindings)
       return await request.query(sql)
     } catch (err: any) {
       let readableMessage = getReadableErrorMessage(
@@ -492,7 +494,7 @@ class SqlServerIntegration extends Sql implements DatasourcePlus {
     return response.recordset || [{ deleted: true }]
   }
 
-  async query(json: QueryJson) {
+  async query(json: QueryJson): DatasourcePlusQueryResponse {
     const schema = this.config.schema
     await this.connect()
     if (schema && schema !== DEFAULT_SCHEMA && json?.endpoint) {

packages/server/src/integrations/mysql.ts

@@ -12,6 +12,7 @@ import {
   SourceName,
   Schema,
   TableSourceType,
+  DatasourcePlusQueryResponse,
 } from "@budibase/types"
 import {
   getSqlQuery,
@@ -260,6 +261,7 @@ class MySQLIntegration extends Sql implements DatasourcePlus {
       const bindings = opts?.disableCoercion
         ? baseBindings
         : bindingTypeCoerce(baseBindings)
+      this.log(query.sql, bindings)
       // Node MySQL is callback based, so we must wrap our call in a promise
       const response = await this.client!.query(query.sql, bindings)
       return response[0]
@@ -379,7 +381,7 @@ class MySQLIntegration extends Sql implements DatasourcePlus {
     return results.length ? results : [{ deleted: true }]
   }
 
-  async query(json: QueryJson) {
+  async query(json: QueryJson): DatasourcePlusQueryResponse {
     await this.connect()
     try {
       const queryFn = (query: any) =>

packages/server/src/integrations/oracle.ts

@@ -12,6 +12,8 @@ import {
   ConnectionInfo,
   Schema,
   TableSourceType,
+  Row,
+  DatasourcePlusQueryResponse,
 } from "@budibase/types"
 import {
   buildExternalTableId,
@@ -368,6 +370,7 @@ class OracleIntegration extends Sql implements DatasourcePlus {
       const options: ExecuteOptions = { autoCommit: true }
       const bindings: BindParameters = query.bindings || []
 
+      this.log(query.sql, bindings)
       return await connection.execute<T>(query.sql, bindings, options)
     } finally {
       if (connection) {
@@ -419,7 +422,7 @@ class OracleIntegration extends Sql implements DatasourcePlus {
       : [{ deleted: true }]
   }
 
-  async query(json: QueryJson) {
+  async query(json: QueryJson): DatasourcePlusQueryResponse {
     const operation = this._operation(json)
     const input = this._query(json, { disableReturning: true }) as SqlQuery
     if (Array.isArray(input)) {
@@ -443,7 +446,7 @@ class OracleIntegration extends Sql implements DatasourcePlus {
       if (deletedRows?.rows?.length) {
         return deletedRows.rows
       } else if (response.rows?.length) {
-        return response.rows
+        return response.rows as Row[]
       } else {
         // get the last row that was updated
         if (
@@ -454,7 +457,7 @@ class OracleIntegration extends Sql implements DatasourcePlus {
           const lastRow = await this.internalQuery({
             sql: `SELECT * FROM \"${json.endpoint.entityId}\" WHERE ROWID = '${response.lastRowid}'`,
           })
-          return lastRow.rows
+          return lastRow.rows as Row[]
         } else {
           return [{ [operation.toLowerCase()]: true }]
         }

packages/server/src/integrations/postgres.ts

@@ -12,6 +12,7 @@ import {
   SourceName,
   Schema,
   TableSourceType,
+  DatasourcePlusQueryResponse,
 } from "@budibase/types"
 import {
   getSqlQuery,
@@ -268,7 +269,9 @@ class PostgresIntegration extends Sql implements DatasourcePlus {
       }
     }
     try {
-      return await client.query(query.sql, query.bindings || [])
+      const bindings = query.bindings || []
+      this.log(query.sql, bindings)
+      return await client.query(query.sql, bindings)
     } catch (err: any) {
       await this.closeConnection()
       let readableMessage = getReadableErrorMessage(
@@ -417,7 +420,7 @@ class PostgresIntegration extends Sql implements DatasourcePlus {
     return response.rows.length ? response.rows : [{ deleted: true }]
   }
 
-  async query(json: QueryJson) {
+  async query(json: QueryJson): DatasourcePlusQueryResponse {
     const operation = this._operation(json).toLowerCase()
     const input = this._query(json) as SqlQuery
     if (Array.isArray(input)) {

packages/server/src/integrations/tests/sql.spec.ts

@@ -1,3 +1,5 @@
+import { SqlClient } from "../utils"
+import Sql from "../base/sql"
 import {
   Operation,
   QueryJson,
@@ -6,9 +8,6 @@ import {
   FieldType,
 } from "@budibase/types"
 
-const Sql = require("../base/sql").default
-const { SqlClient } = require("../utils")
-
 const TABLE_NAME = "test"
 
 function endpoint(table: any, operation: any) {
@@ -42,7 +41,7 @@ function generateReadJson({
         schema: {},
         name: table || TABLE_NAME,
         primary: ["id"],
-      },
+      } as any,
     },
   }
 }
@@ -519,7 +518,7 @@ describe("SQL query builder", () => {
     const query = sql._query(generateRelationshipJson({ schema: "production" }))
     expect(query).toEqual({
       bindings: [500, 5000],
-      sql: `select "brands"."brand_id" as "brands.brand_id", "brands"."brand_name" as "brands.brand_name", "products"."product_id" as "products.product_id", "products"."product_name" as "products.product_name", "products"."brand_id" as "products.brand_id" from (select * from "production"."brands" limit $1) as "brands" left join "production"."products" on "brands"."brand_id" = "products"."brand_id" limit $2`,
+      sql: `select "brands"."brand_id" as "brands.brand_id", "brands"."brand_name" as "brands.brand_name", "products"."product_id" as "products.product_id", "products"."product_name" as "products.product_name", "products"."brand_id" as "products.brand_id" from (select * from "production"."brands" limit $1) as "brands" left join "production"."products" as "products" on "brands"."brand_id" = "products"."brand_id" limit $2`,
     })
   })
 
@@ -527,7 +526,7 @@ describe("SQL query builder", () => {
     const query = sql._query(generateRelationshipJson())
     expect(query).toEqual({
       bindings: [500, 5000],
-      sql: `select "brands"."brand_id" as "brands.brand_id", "brands"."brand_name" as "brands.brand_name", "products"."product_id" as "products.product_id", "products"."product_name" as "products.product_name", "products"."brand_id" as "products.brand_id" from (select * from "brands" limit $1) as "brands" left join "products" on "brands"."brand_id" = "products"."brand_id" limit $2`,
+      sql: `select "brands"."brand_id" as "brands.brand_id", "brands"."brand_name" as "brands.brand_name", "products"."product_id" as "products.product_id", "products"."product_name" as "products.product_name", "products"."brand_id" as "products.brand_id" from (select * from "brands" limit $1) as "brands" left join "products" as "products" on "brands"."brand_id" = "products"."brand_id" limit $2`,
     })
   })
 
@@ -537,7 +536,7 @@ describe("SQL query builder", () => {
     )
     expect(query).toEqual({
       bindings: [500, 5000],
-      sql: `select "stores"."store_id" as "stores.store_id", "stores"."store_name" as "stores.store_name", "products"."product_id" as "products.product_id", "products"."product_name" as "products.product_name" from (select * from "production"."stores" limit $1) as "stores" left join "production"."stocks" on "stores"."store_id" = "stocks"."store_id" left join "production"."products" on "products"."product_id" = "stocks"."product_id" limit $2`,
+      sql: `select "stores"."store_id" as "stores.store_id", "stores"."store_name" as "stores.store_name", "products"."product_id" as "products.product_id", "products"."product_name" as "products.product_name" from (select * from "production"."stores" limit $1) as "stores" left join "production"."stocks" as "stocks" on "stores"."store_id" = "stocks"."store_id" left join "production"."products" as "products" on "products"."product_id" = "stocks"."product_id" limit $2`,
     })
   })
 
@@ -733,7 +732,7 @@ describe("SQL query builder", () => {
       },
       meta: {
         table: oldTable,
-        tables: [oldTable],
+        tables: { [oldTable.name]: oldTable },
         renamed: {
           old: "name",
           updated: "first_name",

packages/server/src/integrations/tests/sqlAlias.spec.ts

@@ -0,0 +1,227 @@
+import { QueryJson } from "@budibase/types"
+import { join } from "path"
+import Sql from "../base/sql"
+import { SqlClient } from "../utils"
+import AliasTables from "../../api/controllers/row/alias"
+import { generator } from "@budibase/backend-core/tests"
+import { Knex } from "knex"
+
+function multiline(sql: string) {
+  return sql.replace(/\n/g, "").replace(/ +/g, " ")
+}
+
+describe("Captures of real examples", () => {
+  const limit = 5000
+  const relationshipLimit = 100
+
+  function getJson(name: string): QueryJson {
+    return require(join(__dirname, "sqlQueryJson", name)) as QueryJson
+  }
+
+  describe("create", () => {
+    it("should create a row with relationships", () => {
+      const queryJson = getJson("createWithRelationships.json")
+      let query = new Sql(SqlClient.POSTGRES, limit)._query(queryJson)
+      expect(query).toEqual({
+        bindings: ["A Street", 34, "London", "A", "B", "designer", 1990],
+        sql: multiline(`insert into "persons" ("address", "age", "city", "firstname", "lastname", "type", "year") 
+              values ($1, $2, $3, $4, $5, $6, $7) returning *`),
+      })
+    })
+  })
+
+  describe("read", () => {
+    it("should handle basic retrieval with relationships", () => {
+      const queryJson = getJson("basicFetchWithRelationships.json")
+      let query = new Sql(SqlClient.POSTGRES, limit)._query(queryJson)
+      expect(query).toEqual({
+        bindings: [relationshipLimit, limit],
+        sql: multiline(`select "a"."year" as "a.year", "a"."firstname" as "a.firstname", "a"."personid" as "a.personid", 
+              "a"."address" as "a.address", "a"."age" as "a.age", "a"."type" as "a.type", "a"."city" as "a.city", 
+              "a"."lastname" as "a.lastname", "b"."executorid" as "b.executorid", "b"."taskname" as "b.taskname", 
+              "b"."taskid" as "b.taskid", "b"."completed" as "b.completed", "b"."qaid" as "b.qaid", 
+              "b"."executorid" as "b.executorid", "b"."taskname" as "b.taskname", "b"."taskid" as "b.taskid", 
+              "b"."completed" as "b.completed", "b"."qaid" as "b.qaid" 
+              from (select * from "persons" as "a" order by "a"."firstname" asc limit $1) as "a" 
+              left join "tasks" as "b" on "a"."personid" = "b"."qaid" or "a"."personid" = "b"."executorid" 
+              order by "a"."firstname" asc limit $2`),
+      })
+    })
+
+    it("should handle filtering by relationship", () => {
+      const queryJson = getJson("filterByRelationship.json")
+      let query = new Sql(SqlClient.POSTGRES, limit)._query(queryJson)
+      expect(query).toEqual({
+        bindings: [relationshipLimit, "assembling", limit],
+        sql: multiline(`select "a"."productname" as "a.productname", "a"."productid" as "a.productid", 
+              "b"."executorid" as "b.executorid", "b"."taskname" as "b.taskname", "b"."taskid" as "b.taskid", 
+              "b"."completed" as "b.completed", "b"."qaid" as "b.qaid" 
+              from (select * from "products" as "a" order by "a"."productname" asc limit $1) as "a" 
+              left join "products_tasks" as "c" on "a"."productid" = "c"."productid" 
+              left join "tasks" as "b" on "b"."taskid" = "c"."taskid" where "b"."taskname" = $2 
+              order by "a"."productname" asc limit $3`),
+      })
+    })
+
+    it("should handle fetching many to many relationships", () => {
+      const queryJson = getJson("fetchManyToMany.json")
+      let query = new Sql(SqlClient.POSTGRES, limit)._query(queryJson)
+      expect(query).toEqual({
+        bindings: [relationshipLimit, limit],
+        sql: multiline(`select "a"."productname" as "a.productname", "a"."productid" as "a.productid", 
+              "b"."executorid" as "b.executorid", "b"."taskname" as "b.taskname", "b"."taskid" as "b.taskid", 
+              "b"."completed" as "b.completed", "b"."qaid" as "b.qaid" 
+              from (select * from "products" as "a" order by "a"."productname" asc limit $1) as "a" 
+              left join "products_tasks" as "c" on "a"."productid" = "c"."productid" 
+              left join "tasks" as "b" on "b"."taskid" = "c"."taskid" 
+              order by "a"."productname" asc limit $2`),
+      })
+    })
+
+    it("should handle enrichment of rows", () => {
+      const queryJson = getJson("enrichRelationship.json")
+      const filters = queryJson.filters?.oneOf?.taskid as number[]
+      let query = new Sql(SqlClient.POSTGRES, limit)._query(queryJson)
+      expect(query).toEqual({
+        bindings: [...filters, limit, limit],
+        sql: multiline(`select "a"."executorid" as "a.executorid", "a"."taskname" as "a.taskname", 
+             "a"."taskid" as "a.taskid", "a"."completed" as "a.completed", "a"."qaid" as "a.qaid", 
+             "b"."productname" as "b.productname", "b"."productid" as "b.productid" 
+             from (select * from "tasks" as "a" where "a"."taskid" in ($1, $2) limit $3) as "a" 
+             left join "products_tasks" as "c" on "a"."taskid" = "c"."taskid" 
+             left join "products" as "b" on "b"."productid" = "c"."productid" limit $4`),
+      })
+    })
+
+    it("should manage query with many relationship filters", () => {
+      const queryJson = getJson("manyRelationshipFilters.json")
+      let query = new Sql(SqlClient.POSTGRES, limit)._query(queryJson)
+      const filters = queryJson.filters
+      const notEqualsValue = Object.values(filters?.notEqual!)[0]
+      const rangeValue = Object.values(filters?.range!)[0]
+      const equalValue = Object.values(filters?.equal!)[0]
+
+      expect(query).toEqual({
+        bindings: [
+          notEqualsValue,
+          relationshipLimit,
+          rangeValue.low,
+          rangeValue.high,
+          equalValue,
+          limit,
+        ],
+        sql: multiline(`select "a"."executorid" as "a.executorid", "a"."taskname" as "a.taskname", "a"."taskid" as "a.taskid", 
+             "a"."completed" as "a.completed", "a"."qaid" as "a.qaid", "b"."productname" as "b.productname", 
+             "b"."productid" as "b.productid", "c"."year" as "c.year", "c"."firstname" as "c.firstname", 
+             "c"."personid" as "c.personid", "c"."address" as "c.address", "c"."age" as "c.age", "c"."type" as "c.type", 
+             "c"."city" as "c.city", "c"."lastname" as "c.lastname", "c"."year" as "c.year", "c"."firstname" as "c.firstname", 
+             "c"."personid" as "c.personid", "c"."address" as "c.address", "c"."age" as "c.age", "c"."type" as "c.type", 
+             "c"."city" as "c.city", "c"."lastname" as "c.lastname" 
+             from (select * from "tasks" as "a" where not "a"."completed" = $1 
+             order by "a"."taskname" asc limit $2) as "a" 
+             left join "products_tasks" as "d" on "a"."taskid" = "d"."taskid" 
+             left join "products" as "b" on "b"."productid" = "d"."productid" 
+             left join "persons" as "c" on "a"."executorid" = "c"."personid" or "a"."qaid" = "c"."personid" 
+             where "c"."year" between $3 and $4 and "b"."productname" = $5 order by "a"."taskname" asc limit $6`),
+      })
+    })
+  })
+
+  describe("update", () => {
+    it("should handle performing a simple update", () => {
+      const queryJson = getJson("updateSimple.json")
+      let query = new Sql(SqlClient.POSTGRES, limit)._query(queryJson)
+      expect(query).toEqual({
+        bindings: [1990, "C", "A Street", 34, "designer", "London", "B", 5],
+        sql: multiline(`update "persons" as "a" set "year" = $1, "firstname" = $2, "address" = $3, "age" = $4, 
+             "type" = $5, "city" = $6, "lastname" = $7 where "a"."personid" = $8 returning *`),
+      })
+    })
+
+    it("should handle performing an update of relationships", () => {
+      const queryJson = getJson("updateRelationship.json")
+      let query = new Sql(SqlClient.POSTGRES, limit)._query(queryJson)
+      expect(query).toEqual({
+        bindings: [1990, "C", "A Street", 34, "designer", "London", "B", 5],
+        sql: multiline(`update "persons" as "a" set "year" = $1, "firstname" = $2, "address" = $3, "age" = $4, 
+             "type" = $5, "city" = $6, "lastname" = $7 where "a"."personid" = $8 returning *`),
+      })
+    })
+  })
+
+  describe("delete", () => {
+    it("should handle deleting with relationships", () => {
+      const queryJson = getJson("deleteSimple.json")
+      let query = new Sql(SqlClient.POSTGRES, limit)._query(queryJson)
+      expect(query).toEqual({
+        bindings: ["ddd", ""],
+        sql: multiline(`delete from "compositetable" as "a" where "a"."keypartone" = $1 and "a"."keyparttwo" = $2 
+             returning "a"."keyparttwo" as "a.keyparttwo", "a"."keypartone" as "a.keypartone", "a"."name" as "a.name"`),
+      })
+    })
+  })
+
+  describe("returning (everything bar Postgres)", () => {
+    it("should be able to handle row returning", () => {
+      const queryJson = getJson("createSimple.json")
+      const SQL = new Sql(SqlClient.MS_SQL, limit)
+      let query = SQL._query(queryJson, { disableReturning: true })
+      expect(query).toEqual({
+        sql: "insert into [people] ([age], [name]) values (@p0, @p1)",
+        bindings: [22, "Test"],
+      })
+
+      // now check returning
+      let returningQuery: Knex.SqlNative = { sql: "", bindings: [] }
+      SQL.getReturningRow((input: Knex.SqlNative) => {
+        returningQuery = input
+      }, queryJson)
+      expect(returningQuery).toEqual({
+        sql: "select * from (select top (@p0) * from [people] where [people].[name] = @p1 and [people].[age] = @p2 order by [people].[name] asc) as [people]",
+        bindings: [1, "Test", 22],
+      })
+    })
+  })
+
+  describe("check max character aliasing", () => {
+    it("should handle over 'z' max character alias", () => {
+      const tableNames = []
+      for (let i = 0; i < 100; i++) {
+        tableNames.push(generator.guid())
+      }
+      const aliasing = new AliasTables(tableNames)
+      let alias: string = ""
+      for (let table of tableNames) {
+        alias = aliasing.getAlias(table)
+      }
+      expect(alias).toEqual("cv")
+    })
+  })
+
+  describe("check some edge cases", () => {
+    const tableNames = ["hello", "world"]
+
+    it("should handle quoted table names", () => {
+      const aliasing = new AliasTables(tableNames)
+      const aliased = aliasing.aliasField(`"hello"."field"`)
+      expect(aliased).toEqual(`"a"."field"`)
+    })
+
+    it("should handle quoted table names with graves", () => {
+      const aliasing = new AliasTables(tableNames)
+      const aliased = aliasing.aliasField("`hello`.`world`")
+      expect(aliased).toEqual("`a`.`world`")
+    })
+
+    it("should handle table names in table names correctly", () => {
+      const tableNames = ["he", "hell", "hello"]
+      const aliasing = new AliasTables(tableNames)
+      const aliased1 = aliasing.aliasField("`he`.`world`")
+      const aliased2 = aliasing.aliasField("`hell`.`world`")
+      const aliased3 = aliasing.aliasField("`hello`.`world`")
+      expect(aliased1).toEqual("`a`.`world`")
+      expect(aliased2).toEqual("`b`.`world`")
+      expect(aliased3).toEqual("`c`.`world`")
+    })
+  })
+})

packages/server/src/integrations/tests/sqlQueryJson/basicFetchWithRelationships.json

@@ -0,0 +1,183 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+    "entityId": "persons",
+    "operation": "READ"
+  },
+  "resource": {
+    "fields": [
+      "a.year",
+      "a.firstname",
+      "a.personid",
+      "a.address",
+      "a.age",
+      "a.type",
+      "a.city",
+      "a.lastname",
+      "b.executorid",
+      "b.taskname",
+      "b.taskid",
+      "b.completed",
+      "b.qaid",
+      "b.executorid",
+      "b.taskname",
+      "b.taskid",
+      "b.completed",
+      "b.qaid"
+    ]
+  },
+  "filters": {},
+  "sort": {
+    "firstname": {
+      "direction": "ASCENDING"
+    }
+  },
+  "paginate": {
+    "limit": 100,
+    "page": 1
+  },
+  "relationships": [
+    {
+      "tableName": "tasks",
+      "column": "QA",
+      "from": "personid",
+      "to": "qaid",
+      "aliases": {
+        "tasks": "b",
+        "persons": "a"
+      }
+    },
+    {
+      "tableName": "tasks",
+      "column": "executor",
+      "from": "personid",
+      "to": "executorid",
+      "aliases": {
+        "tasks": "b",
+        "persons": "a"
+      }
+    }
+  ],
+  "extra": {
+    "idFilter": {}
+  },
+  "meta": {
+    "table": {
+      "type": "table",
+      "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons",
+      "primary": [
+        "personid"
+      ],
+      "name": "persons",
+      "schema": {
+        "year": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "year",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "firstname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "firstname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "personid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": true,
+          "name": "personid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "address": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "address",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "age": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "age",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "type": {
+          "type": "options",
+          "externalType": "USER-DEFINED",
+          "autocolumn": false,
+          "name": "type",
+          "constraints": {
+            "presence": false,
+            "inclusion": [
+              "support",
+              "designer",
+              "programmer",
+              "qa"
+            ]
+          }
+        },
+        "city": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "city",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "lastname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "lastname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "QA": {
+          "tableId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__tasks",
+          "name": "QA",
+          "relationshipType": "many-to-one",
+          "fieldName": "qaid",
+          "type": "link",
+          "main": true,
+          "_id": "ccb68481c80c34217a4540a2c6c27fe46",
+          "foreignKey": "personid"
+        },
+        "executor": {
+          "tableId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__tasks",
+          "name": "executor",
+          "relationshipType": "many-to-one",
+          "fieldName": "executorid",
+          "type": "link",
+          "main": true,
+          "_id": "c89530b9770d94bec851e062b5cff3001",
+          "foreignKey": "personid",
+          "tableName": "persons"
+        }
+      },
+      "sourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+      "sourceType": "external",
+      "primaryDisplay": "firstname",
+      "views": {}
+    }
+  },
+  "tableAliases": {
+    "persons": "a",
+    "tasks": "b"
+  }
+}

packages/server/src/integrations/tests/sqlQueryJson/createSimple.json

@@ -0,0 +1,64 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_0ed5835e5552496285df546030f7c4ae",
+    "entityId": "people",
+    "operation": "CREATE"
+  },
+  "resource": {
+    "fields": [
+      "a.name",
+      "a.age"
+    ]
+  },
+  "filters": {},
+  "relationships": [],
+  "body": {
+    "name": "Test",
+    "age": 22
+  },
+  "extra": {
+    "idFilter": {
+      "equal": {
+        "name": "Test",
+        "age": 22
+      }
+    }
+  },
+  "meta": {
+    "table": {
+      "_id": "datasource_plus_0ed5835e5552496285df546030f7c4ae__people",
+      "type": "table",
+      "sourceId": "datasource_plus_0ed5835e5552496285df546030f7c4ae",
+      "sourceType": "external",
+      "primary": [
+        "name",
+        "age"
+      ],
+      "name": "people",
+      "schema": {
+        "name": {
+          "type": "string",
+          "externalType": "varchar",
+          "autocolumn": false,
+          "name": "name",
+          "constraints": {
+            "presence": true
+          }
+        },
+        "age": {
+          "type": "number",
+          "externalType": "int",
+          "autocolumn": false,
+          "name": "age",
+          "constraints": {
+            "presence": false
+          }
+        }
+      },
+      "primaryDisplay": "name"
+    }
+  },
+  "tableAliases": {
+    "people": "a"
+  }
+}

packages/server/src/integrations/tests/sqlQueryJson/createWithRelationships.json

@@ -0,0 +1,173 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+    "entityId": "persons",
+    "operation": "CREATE"
+  },
+  "resource": {
+    "fields": [
+      "a.year",
+      "a.firstname",
+      "a.personid",
+      "a.address",
+      "a.age",
+      "a.type",
+      "a.city",
+      "a.lastname"
+    ]
+  },
+  "filters": {},
+  "relationships": [
+    {
+      "tableName": "tasks",
+      "column": "QA",
+      "from": "personid",
+      "to": "qaid",
+      "aliases": {
+        "tasks": "b",
+        "persons": "a"
+      }
+    },
+    {
+      "tableName": "tasks",
+      "column": "executor",
+      "from": "personid",
+      "to": "executorid",
+      "aliases": {
+        "tasks": "b",
+        "persons": "a"
+      }
+    }
+  ],
+  "body": {
+    "year": 1990,
+    "firstname": "A",
+    "address": "A Street",
+    "age": 34,
+    "type": "designer",
+    "city": "London",
+    "lastname": "B"
+  },
+  "extra": {
+    "idFilter": {}
+  },
+  "meta": {
+    "table": {
+      "type": "table",
+      "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons",
+      "primary": [
+        "personid"
+      ],
+      "name": "persons",
+      "schema": {
+        "year": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "year",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "firstname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "firstname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "personid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": true,
+          "name": "personid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "address": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "address",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "age": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "age",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "type": {
+          "type": "options",
+          "externalType": "USER-DEFINED",
+          "autocolumn": false,
+          "name": "type",
+          "constraints": {
+            "presence": false,
+            "inclusion": [
+              "support",
+              "designer",
+              "programmer",
+              "qa"
+            ]
+          }
+        },
+        "city": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "city",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "lastname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "lastname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "QA": {
+          "tableId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__tasks",
+          "name": "QA",
+          "relationshipType": "many-to-one",
+          "fieldName": "qaid",
+          "type": "link",
+          "main": true,
+          "_id": "ccb68481c80c34217a4540a2c6c27fe46",
+          "foreignKey": "personid"
+        },
+        "executor": {
+          "tableId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__tasks",
+          "name": "executor",
+          "relationshipType": "many-to-one",
+          "fieldName": "executorid",
+          "type": "link",
+          "main": true,
+          "_id": "c89530b9770d94bec851e062b5cff3001",
+          "foreignKey": "personid",
+          "tableName": "persons"
+        }
+      },
+      "sourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+      "sourceType": "external",
+      "primaryDisplay": "firstname",
+      "views": {}
+    }
+  },
+  "tableAliases": {
+    "persons": "a",
+    "tasks": "b"
+  }
+}

packages/server/src/integrations/tests/sqlQueryJson/deleteSimple.json

@@ -0,0 +1,75 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+    "entityId": "compositetable",
+    "operation": "DELETE"
+  },
+  "resource": {
+    "fields": [
+      "a.keyparttwo",
+      "a.keypartone",
+      "a.name"
+    ]
+  },
+  "filters": {
+    "equal": {
+      "keypartone": "ddd",
+      "keyparttwo": ""
+    }
+  },
+  "relationships": [],
+  "extra": {
+    "idFilter": {
+      "equal": {
+        "keypartone": "ddd",
+        "keyparttwo": ""
+      }
+    }
+  },
+  "meta": {
+    "table": {
+      "type": "table",
+      "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__compositetable",
+      "primary": [
+        "keypartone",
+        "keyparttwo"
+      ],
+      "name": "compositetable",
+      "schema": {
+        "keyparttwo": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "keyparttwo",
+          "constraints": {
+            "presence": true
+          }
+        },
+        "keypartone": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "keypartone",
+          "constraints": {
+            "presence": true
+          }
+        },
+        "name": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "name",
+          "constraints": {
+            "presence": false
+          }
+        }
+      },
+      "sourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+      "sourceType": "external",
+      "primaryDisplay": "keypartone"
+    }
+  },
+  "tableAliases": {
+    "compositetable": "a"
+  }
+}

packages/server/src/integrations/tests/sqlQueryJson/enrichRelationship.json

@@ -0,0 +1,123 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81",
+    "entityId": "tasks",
+    "operation": "READ"
+  },
+  "resource": {
+    "fields": [
+      "a.executorid",
+      "a.taskname",
+      "a.taskid",
+      "a.completed",
+      "a.qaid",
+      "b.productname",
+      "b.productid"
+    ]
+  },
+  "filters": {
+    "oneOf": {
+      "taskid": [
+        1,
+        2
+      ]
+    }
+  },
+  "relationships": [
+    {
+      "tableName": "products",
+      "column": "products",
+      "through": "products_tasks",
+      "from": "taskid",
+      "to": "productid",
+      "fromPrimary": "taskid",
+      "toPrimary": "productid",
+      "aliases": {
+        "products_tasks": "c",
+        "products": "b",
+        "tasks": "a"
+      }
+    }
+  ],
+  "extra": {
+    "idFilter": {}
+  },
+  "meta": {
+    "table": {
+      "type": "table",
+      "_id": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__tasks",
+      "primary": [
+        "taskid"
+      ],
+      "name": "tasks",
+      "schema": {
+        "executorid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "executorid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "taskname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "taskname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "taskid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": true,
+          "name": "taskid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "completed": {
+          "type": "boolean",
+          "externalType": "boolean",
+          "autocolumn": false,
+          "name": "completed",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "qaid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "qaid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "products": {
+          "tableId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__products",
+          "name": "products",
+          "relationshipType": "many-to-many",
+          "through": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__products_tasks",
+          "type": "link",
+          "_id": "c3b91d00cd36c4cc1a347794725b9adbd",
+          "fieldName": "productid",
+          "throughFrom": "productid",
+          "throughTo": "taskid"
+        }
+      },
+      "sourceId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81",
+      "sourceType": "external",
+      "primaryDisplay": "taskname",
+      "sql": true,
+      "views": {}
+    }
+  },
+  "tableAliases": {
+    "tasks": "a",
+    "products": "b",
+    "products_tasks": "c"
+  }
+}

packages/server/src/integrations/tests/sqlQueryJson/fetchManyToMany.json

@@ -0,0 +1,109 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81",
+    "entityId": "products",
+    "operation": "READ"
+  },
+  "resource": {
+    "fields": [
+      "a.productname",
+      "a.productid",
+      "b.executorid",
+      "b.taskname",
+      "b.taskid",
+      "b.completed",
+      "b.qaid"
+    ]
+  },
+  "filters": {
+    "string": {},
+    "fuzzy": {},
+    "range": {},
+    "equal": {},
+    "notEqual": {},
+    "empty": {},
+    "notEmpty": {},
+    "contains": {},
+    "notContains": {},
+    "oneOf": {},
+    "containsAny": {}
+  },
+  "sort": {
+    "productname": {
+      "direction": "ASCENDING"
+    }
+  },
+  "paginate": {
+    "limit": 100,
+    "page": 1
+  },
+  "relationships": [
+    {
+      "tableName": "tasks",
+      "column": "tasks",
+      "through": "products_tasks",
+      "from": "productid",
+      "to": "taskid",
+      "fromPrimary": "productid",
+      "toPrimary": "taskid",
+      "aliases": {
+        "products_tasks": "c",
+        "tasks": "b",
+        "products": "a"
+      }
+    }
+  ],
+  "extra": {
+    "idFilter": {}
+  },
+  "meta": {
+    "table": {
+      "type": "table",
+      "_id": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__products",
+      "primary": [
+        "productid"
+      ],
+      "name": "products",
+      "schema": {
+        "productname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "productname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "productid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": true,
+          "name": "productid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "tasks": {
+          "tableId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__tasks",
+          "name": "tasks",
+          "relationshipType": "many-to-many",
+          "fieldName": "taskid",
+          "through": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__products_tasks",
+          "throughFrom": "taskid",
+          "throughTo": "productid",
+          "type": "link",
+          "main": true,
+          "_id": "c3b91d00cd36c4cc1a347794725b9adbd"
+        }
+      },
+      "sourceId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81",
+      "sourceType": "external",
+      "primaryDisplay": "productname"
+    }
+  },
+  "tableAliases": {
+    "products": "a",
+    "tasks": "b",
+    "products_tasks": "c"
+  }
+}

packages/server/src/integrations/tests/sqlQueryJson/filterByRelationship.json

@@ -0,0 +1,94 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+    "entityId": "products",
+    "operation": "READ"
+  },
+  "resource": {
+    "fields": [
+      "a.productname",
+      "a.productid",
+      "b.executorid",
+      "b.taskname",
+      "b.taskid",
+      "b.completed",
+      "b.qaid"
+    ]
+  },
+  "filters": {
+    "equal": {
+      "1:tasks.taskname": "assembling"
+    },
+    "onEmptyFilter": "all"
+  },
+  "sort": {
+    "productname": {
+      "direction": "ASCENDING"
+    }
+  },
+  "paginate": {
+    "limit": 100,
+    "page": 1
+  },
+  "relationships": [
+    {
+      "tableName": "tasks",
+      "column": "tasks",
+      "through": "products_tasks",
+      "from": "productid",
+      "to": "taskid",
+      "fromPrimary": "productid",
+      "toPrimary": "taskid"
+    }
+  ],
+  "tableAliases": {
+    "products_tasks": "c",
+    "tasks": "b",
+    "products": "a"
+  },
+  "meta": {
+    "table": {
+      "type": "table",
+      "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__products",
+      "primary": [
+        "productid"
+      ],
+      "name": "products",
+      "schema": {
+        "productname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "productname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "productid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": true,
+          "name": "productid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "tasks": {
+          "tableId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__tasks",
+          "name": "tasks",
+          "relationshipType": "many-to-many",
+          "fieldName": "taskid",
+          "through": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__products_tasks",
+          "throughFrom": "taskid",
+          "throughTo": "productid",
+          "type": "link",
+          "main": true,
+          "_id": "ca6862d9ba09146dd8a68e3b5b7055a09"
+        }
+      },
+      "sourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+      "sourceType": "external",
+      "primaryDisplay": "productname"
+    }
+  }
+}

packages/server/src/integrations/tests/sqlQueryJson/manyRelationshipFilters.json

@@ -0,0 +1,202 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81",
+    "entityId": "tasks",
+    "operation": "READ"
+  },
+  "resource": {
+    "fields": [
+      "a.executorid",
+      "a.taskname",
+      "a.taskid",
+      "a.completed",
+      "a.qaid",
+      "b.productname",
+      "b.productid",
+      "c.year",
+      "c.firstname",
+      "c.personid",
+      "c.address",
+      "c.age",
+      "c.type",
+      "c.city",
+      "c.lastname",
+      "c.year",
+      "c.firstname",
+      "c.personid",
+      "c.address",
+      "c.age",
+      "c.type",
+      "c.city",
+      "c.lastname"
+    ]
+  },
+  "filters": {
+    "string": {},
+    "fuzzy": {},
+    "range": {
+      "1:persons.year": {
+        "low": 1990,
+        "high": 2147483647
+      }
+    },
+    "equal": {
+      "2:products.productname": "Computers"
+    },
+    "notEqual": {
+      "3:completed": true
+    },
+    "empty": {},
+    "notEmpty": {},
+    "contains": {},
+    "notContains": {},
+    "oneOf": {},
+    "containsAny": {},
+    "onEmptyFilter": "all"
+  },
+  "sort": {
+    "taskname": {
+      "direction": "ASCENDING"
+    }
+  },
+  "paginate": {
+    "limit": 100,
+    "page": 1
+  },
+  "relationships": [
+    {
+      "tableName": "products",
+      "column": "products",
+      "through": "products_tasks",
+      "from": "taskid",
+      "to": "productid",
+      "fromPrimary": "taskid",
+      "toPrimary": "productid",
+      "aliases": {
+        "products_tasks": "d",
+        "products": "b",
+        "tasks": "a"
+      }
+    },
+    {
+      "tableName": "persons",
+      "column": "tasksToExecute",
+      "from": "executorid",
+      "to": "personid",
+      "aliases": {
+        "persons": "c",
+        "tasks": "a"
+      }
+    },
+    {
+      "tableName": "persons",
+      "column": "tasksToQA",
+      "from": "qaid",
+      "to": "personid",
+      "aliases": {
+        "persons": "c",
+        "tasks": "a"
+      }
+    }
+  ],
+  "extra": {
+    "idFilter": {}
+  },
+  "meta": {
+    "table": {
+      "type": "table",
+      "_id": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__tasks",
+      "primary": [
+        "taskid"
+      ],
+      "name": "tasks",
+      "schema": {
+        "executorid": {
+          "type": "number",
+          "externalType": "integer",
+          "name": "executorid",
+          "constraints": {
+            "presence": false
+          },
+          "autocolumn": true,
+          "autoReason": "foreign_key"
+        },
+        "taskname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "taskname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "taskid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": true,
+          "name": "taskid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "completed": {
+          "type": "boolean",
+          "externalType": "boolean",
+          "autocolumn": false,
+          "name": "completed",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "qaid": {
+          "type": "number",
+          "externalType": "integer",
+          "name": "qaid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "products": {
+          "tableId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__products",
+          "name": "products",
+          "relationshipType": "many-to-many",
+          "through": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__products_tasks",
+          "type": "link",
+          "_id": "c3b91d00cd36c4cc1a347794725b9adbd",
+          "fieldName": "productid",
+          "throughFrom": "productid",
+          "throughTo": "taskid"
+        },
+        "tasksToExecute": {
+          "tableId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__persons",
+          "name": "tasksToExecute",
+          "relationshipType": "one-to-many",
+          "type": "link",
+          "_id": "c0f440590bda04f28846242156c1dd60b",
+          "foreignKey": "executorid",
+          "fieldName": "personid"
+        },
+        "tasksToQA": {
+          "tableId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__persons",
+          "name": "tasksToQA",
+          "relationshipType": "one-to-many",
+          "type": "link",
+          "_id": "c5fdf453a0ba743d58e29491d174c974b",
+          "foreignKey": "qaid",
+          "fieldName": "personid"
+        }
+      },
+      "sourceId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81",
+      "sourceType": "external",
+      "primaryDisplay": "taskname",
+      "sql": true,
+      "views": {}
+    }
+  },
+  "tableAliases": {
+    "tasks": "a",
+    "products": "b",
+    "persons": "c",
+    "products_tasks": "d"
+  }
+}

packages/server/src/integrations/tests/sqlQueryJson/updateRelationship.json

@@ -0,0 +1,181 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+    "entityId": "persons",
+    "operation": "UPDATE"
+  },
+  "resource": {
+    "fields": [
+      "a.year",
+      "a.firstname",
+      "a.personid",
+      "a.address",
+      "a.age",
+      "a.type",
+      "a.city",
+      "a.lastname"
+    ]
+  },
+  "filters": {
+    "equal": {
+      "personid": 5
+    }
+  },
+  "relationships": [
+    {
+      "tableName": "tasks",
+      "column": "QA",
+      "from": "personid",
+      "to": "qaid",
+      "aliases": {
+        "tasks": "b",
+        "persons": "a"
+      }
+    },
+    {
+      "tableName": "tasks",
+      "column": "executor",
+      "from": "personid",
+      "to": "executorid",
+      "aliases": {
+        "tasks": "b",
+        "persons": "a"
+      }
+    }
+  ],
+  "body": {
+    "year": 1990,
+    "firstname": "C",
+    "address": "A Street",
+    "age": 34,
+    "type": "designer",
+    "city": "London",
+    "lastname": "B"
+  },
+  "extra": {
+    "idFilter": {
+      "equal": {
+        "personid": 5
+      }
+    }
+  },
+  "meta": {
+    "table": {
+      "type": "table",
+      "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons",
+      "primary": [
+        "personid"
+      ],
+      "name": "persons",
+      "schema": {
+        "year": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "year",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "firstname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "firstname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "personid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": true,
+          "name": "personid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "address": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "address",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "age": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "age",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "type": {
+          "type": "options",
+          "externalType": "USER-DEFINED",
+          "autocolumn": false,
+          "name": "type",
+          "constraints": {
+            "presence": false,
+            "inclusion": [
+              "support",
+              "designer",
+              "programmer",
+              "qa"
+            ]
+          }
+        },
+        "city": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "city",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "lastname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "lastname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "QA": {
+          "tableId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__tasks",
+          "name": "QA",
+          "relationshipType": "many-to-one",
+          "fieldName": "qaid",
+          "type": "link",
+          "main": true,
+          "_id": "ccb68481c80c34217a4540a2c6c27fe46",
+          "foreignKey": "personid"
+        },
+        "executor": {
+          "tableId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__tasks",
+          "name": "executor",
+          "relationshipType": "many-to-one",
+          "fieldName": "executorid",
+          "type": "link",
+          "main": true,
+          "_id": "c89530b9770d94bec851e062b5cff3001",
+          "foreignKey": "personid",
+          "tableName": "persons"
+        }
+      },
+      "sourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+      "sourceType": "external",
+      "primaryDisplay": "firstname",
+      "views": {}
+    }
+  },
+  "tableAliases": {
+    "persons": "a",
+    "tasks": "b"
+  }
+}

packages/server/src/integrations/tests/sqlQueryJson/updateSimple.json

@@ -0,0 +1,181 @@
+{
+  "endpoint": {
+    "datasourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+    "entityId": "persons",
+    "operation": "UPDATE"
+  },
+  "resource": {
+    "fields": [
+      "a.year",
+      "a.firstname",
+      "a.personid",
+      "a.address",
+      "a.age",
+      "a.type",
+      "a.city",
+      "a.lastname"
+    ]
+  },
+  "filters": {
+    "equal": {
+      "personid": 5
+    }
+  },
+  "relationships": [
+    {
+      "tableName": "tasks",
+      "column": "QA",
+      "from": "personid",
+      "to": "qaid",
+      "aliases": {
+        "tasks": "b",
+        "persons": "a"
+      }
+    },
+    {
+      "tableName": "tasks",
+      "column": "executor",
+      "from": "personid",
+      "to": "executorid",
+      "aliases": {
+        "tasks": "b",
+        "persons": "a"
+      }
+    }
+  ],
+  "body": {
+    "year": 1990,
+    "firstname": "C",
+    "address": "A Street",
+    "age": 34,
+    "type": "designer",
+    "city": "London",
+    "lastname": "B"
+  },
+  "extra": {
+    "idFilter": {
+      "equal": {
+        "personid": 5
+      }
+    }
+  },
+  "meta": {
+    "table": {
+      "type": "table",
+      "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons",
+      "primary": [
+        "personid"
+      ],
+      "name": "persons",
+      "schema": {
+        "year": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "year",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "firstname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "firstname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "personid": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": true,
+          "name": "personid",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "address": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "address",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "age": {
+          "type": "number",
+          "externalType": "integer",
+          "autocolumn": false,
+          "name": "age",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "type": {
+          "type": "options",
+          "externalType": "USER-DEFINED",
+          "autocolumn": false,
+          "name": "type",
+          "constraints": {
+            "presence": false,
+            "inclusion": [
+              "support",
+              "designer",
+              "programmer",
+              "qa"
+            ]
+          }
+        },
+        "city": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "city",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "lastname": {
+          "type": "string",
+          "externalType": "character varying",
+          "autocolumn": false,
+          "name": "lastname",
+          "constraints": {
+            "presence": false
+          }
+        },
+        "QA": {
+          "tableId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__tasks",
+          "name": "QA",
+          "relationshipType": "many-to-one",
+          "fieldName": "qaid",
+          "type": "link",
+          "main": true,
+          "_id": "ccb68481c80c34217a4540a2c6c27fe46",
+          "foreignKey": "personid"
+        },
+        "executor": {
+          "tableId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__tasks",
+          "name": "executor",
+          "relationshipType": "many-to-one",
+          "fieldName": "executorid",
+          "type": "link",
+          "main": true,
+          "_id": "c89530b9770d94bec851e062b5cff3001",
+          "foreignKey": "personid",
+          "tableName": "persons"
+        }
+      },
+      "sourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
+      "sourceType": "external",
+      "primaryDisplay": "firstname",
+      "views": {}
+    }
+  },
+  "tableAliases": {
+    "persons": "a",
+    "tasks": "b"
+  }
+}

packages/server/src/sdk/app/datasources/plus.ts

@@ -3,12 +3,33 @@ import {
   DatasourcePlus,
   IntegrationBase,
   Schema,
+  Table,
 } from "@budibase/types"
 import * as datasources from "./datasources"
 import tableSdk from "../tables"
 import { getIntegration } from "../../../integrations"
 import { context } from "@budibase/backend-core"
 
+function checkForSchemaErrors(schema: Record<string, Table>) {
+  const errors: Record<string, string> = {}
+  for (let [tableName, table] of Object.entries(schema)) {
+    if (tableName.includes(".")) {
+      errors[tableName] = "Table names containing dots are not supported."
+    } else {
+      const columnNames = Object.keys(table.schema)
+      const invalidColumnName = columnNames.find(columnName =>
+        columnName.includes(".")
+      )
+      if (invalidColumnName) {
+        errors[
+          tableName
+        ] = `Column '${invalidColumnName}' is not supported as it contains a dot.`
+      }
+    }
+  }
+  return errors
+}
+
 export async function buildFilteredSchema(
   datasource: Datasource,
   filter?: string[]
@@ -30,16 +51,19 @@ export async function buildFilteredSchema(
       filteredSchema.errors[key] = schema.errors[key]
     }
   }
-  return filteredSchema
+
+  return {
+    ...filteredSchema,
+    errors: {
+      ...filteredSchema.errors,
+      ...checkForSchemaErrors(filteredSchema.tables),
+    },
+  }
 }
 
 async function buildSchemaHelper(datasource: Datasource): Promise<Schema> {
   const connector = (await getConnector(datasource)) as DatasourcePlus
-  const externalSchema = await connector.buildSchema(
+  return await connector.buildSchema(datasource._id!, datasource.entities!)
-    datasource._id!,
-    datasource.entities!
-  )
-  return externalSchema
 }
 
 export async function getConnector(

packages/server/src/sdk/app/rows/search/external.ts

@@ -11,7 +11,10 @@ import {
 import * as exporters from "../../../../api/controllers/view/exporters"
 import sdk from "../../../../sdk"
 import { handleRequest } from "../../../../api/controllers/row/external"
-import { breakExternalTableId } from "../../../../integrations/utils"
+import {
+  breakExternalTableId,
+  breakRowIdField,
+} from "../../../../integrations/utils"
 import { cleanExportRows } from "../utils"
 import { utils } from "@budibase/shared-core"
 import { ExportRowsParams, ExportRowsResult } from "../search"
@@ -52,6 +55,15 @@ export async function search(options: SearchParams) {
     }
   }
 
+  // Make sure oneOf _id queries decode the Row IDs
+  if (query?.oneOf?._id) {
+    const rowIds = query.oneOf._id
+    query.oneOf._id = rowIds.map((row: string) => {
+      const ids = breakRowIdField(row)
+      return ids[0]
+    })
+  }
+
   try {
     const table = await sdk.tables.getTable(tableId)
     options = searchInputMapping(table, options)
@@ -119,9 +131,7 @@ export async function exportRows(
     requestQuery = {
       oneOf: {
         _id: rowIds.map((row: string) => {
-          const ids = JSON.parse(
+          const ids = breakRowIdField(row)
-            decodeURI(row).replace(/'/g, `"`).replace(/%2C/g, ",")
-          )
           if (ids.length > 1) {
             throw new HTTPError(
               "Export data does not support composite keys.",

packages/server/src/sdk/app/rows/search/tests/external.spec.ts

@@ -21,10 +21,11 @@ jest.unmock("mysql2/promise")
 
 jest.setTimeout(30000)
 
-describe.skip("external", () => {
+describe("external search", () => {
   const config = new TestConfiguration()
 
   let externalDatasource: Datasource, tableData: Table
+  const rows: Row[] = []
 
   beforeAll(async () => {
     const container = await new GenericContainer("mysql")
@@ -89,67 +90,81 @@ describe.skip("external", () => {
         },
       },
     }
+
+    const table = await config.createExternalTable({
+      ...tableData,
+      sourceId: externalDatasource._id,
+    })
+    for (let i = 0; i < 10; i++) {
+      rows.push(
+        await config.createRow({
+          tableId: table._id,
+          name: generator.first(),
+          surname: generator.last(),
+          age: generator.age(),
+          address: generator.address(),
+        })
+      )
+    }
   })
 
-  describe("search", () => {
+  it("default search returns all the data", async () => {
-    const rows: Row[] = []
+    await config.doInContext(config.appId, async () => {
-    beforeAll(async () => {
+      const tableId = config.table!._id!
-      const table = await config.createExternalTable({
+
-        ...tableData,
+      const searchParams: SearchParams = {
-        sourceId: externalDatasource._id,
+        tableId,
-      })
+        query: {},
-      for (let i = 0; i < 10; i++) {
-        rows.push(
-          await config.createRow({
-            tableId: table._id,
-            name: generator.first(),
-            surname: generator.last(),
-            age: generator.age(),
-            address: generator.address(),
-          })
-        )
       }
+      const result = await search(searchParams)
+
+      expect(result.rows).toHaveLength(10)
+      expect(result.rows).toEqual(
+        expect.arrayContaining(rows.map(r => expect.objectContaining(r)))
+      )
     })
+  })
 
-    it("default search returns all the data", async () => {
+  it("querying by fields will always return data attribute columns", async () => {
-      await config.doInContext(config.appId, async () => {
+    await config.doInContext(config.appId, async () => {
-        const tableId = config.table!._id!
+      const tableId = config.table!._id!
 
-        const searchParams: SearchParams = {
+      const searchParams: SearchParams = {
-          tableId,
+        tableId,
-          query: {},
+        query: {},
-        }
+        fields: ["name", "age"],
-        const result = await search(searchParams)
+      }
+      const result = await search(searchParams)
 
-        expect(result.rows).toHaveLength(10)
+      expect(result.rows).toHaveLength(10)
-        expect(result.rows).toEqual(
+      expect(result.rows).toEqual(
-          expect.arrayContaining(rows.map(r => expect.objectContaining(r)))
+        expect.arrayContaining(
+          rows.map(r => ({
+            ...expectAnyExternalColsAttributes,
+            name: r.name,
+            age: r.age,
+          }))
         )
-      })
+      )
     })
+  })
 
-    it("querying by fields will always return data attribute columns", async () => {
+  it("will decode _id in oneOf query", async () => {
-      await config.doInContext(config.appId, async () => {
+    await config.doInContext(config.appId, async () => {
-        const tableId = config.table!._id!
+      const tableId = config.table!._id!
 
-        const searchParams: SearchParams = {
+      const searchParams: SearchParams = {
-          tableId,
+        tableId,
-          query: {},
+        query: {
-          fields: ["name", "age"],
+          oneOf: {
-        }
+            _id: ["%5B1%5D", "%5B4%5D", "%5B8%5D"],
-        const result = await search(searchParams)
+          },
+        },
+      }
+      const result = await search(searchParams)
 
-        expect(result.rows).toHaveLength(10)
+      expect(result.rows).toHaveLength(3)
-        expect(result.rows).toEqual(
+      expect(result.rows.map(row => row.id)).toEqual([1, 4, 8])
-          expect.arrayContaining(
-            rows.map(r => ({
-              ...expectAnyExternalColsAttributes,
-              name: r.name,
-              age: r.age,
-            }))
-          )
-        )
-      })
     })
   })
 })

packages/server/src/sdk/app/rows/search/utils.ts

@@ -1,6 +1,5 @@
 import {
   FieldType,
-  FieldTypeSubtypes,
   SearchParams,
   Table,
   DocumentType,

packages/server/src/sdk/app/rows/tests/internal.spec.ts

@@ -98,7 +98,10 @@ describe("sdk >> rows >> internal", () => {
           },
         })
 
-        const persistedRow = await config.getRow(table._id!, response.row._id!)
+        const persistedRow = await config.api.row.get(
+          table._id!,
+          response.row._id!
+        )
         expect(persistedRow).toEqual({
           ...row,
           type: "row",
@@ -157,7 +160,10 @@ describe("sdk >> rows >> internal", () => {
           },
         })
 
-        const persistedRow = await config.getRow(table._id!, response.row._id!)
+        const persistedRow = await config.api.row.get(
+          table._id!,
+          response.row._id!
+        )
         expect(persistedRow).toEqual({
           ...row,
           type: "row",

packages/server/src/sdk/app/rows/utils.ts

@@ -1,12 +1,21 @@
 import cloneDeep from "lodash/cloneDeep"
 import validateJs from "validate.js"
-import { FieldType, Row, Table, TableSchema } from "@budibase/types"
+import {
+  FieldType,
+  QueryJson,
+  Row,
+  Table,
+  TableSchema,
+  DatasourcePlusQueryResponse,
+} from "@budibase/types"
 import { makeExternalQuery } from "../../../integrations/base/query"
 import { Format } from "../../../api/controllers/view/exporters"
 import sdk from "../.."
 import { isRelationshipColumn } from "../../../db/utils"
 
-export async function getDatasourceAndQuery(json: any) {
+export async function getDatasourceAndQuery(
+  json: QueryJson
+): DatasourcePlusQueryResponse {
   const datasourceId = json.endpoint.datasourceId
   const datasource = await sdk.datasources.get(datasourceId)
   return makeExternalQuery(datasource, json)

packages/server/src/sdk/app/tables/external/index.ts

@@ -3,6 +3,7 @@ import {
   Operation,
   RelationshipType,
   RenameColumn,
+  AddColumn,
   Table,
   TableRequest,
   ViewV2,
@@ -32,7 +33,7 @@ import * as viewSdk from "../../views"
 export async function save(
   datasourceId: string,
   update: Table,
-  opts?: { tableId?: string; renaming?: RenameColumn }
+  opts?: { tableId?: string; renaming?: RenameColumn; adding?: AddColumn }
 ) {
   let tableToSave: TableRequest = {
     ...update,
@@ -165,8 +166,17 @@ export async function save(
 
   // remove the rename prop
   delete tableToSave._rename
+
+  // if adding a new column, we need to rebuild the schema for that table to get the 'externalType' of the column
+  if (opts?.adding) {
+    datasource.entities[tableToSave.name] = (
+      await datasourceSdk.buildFilteredSchema(datasource, [tableToSave.name])
+    ).tables[tableToSave.name]
+  } else {
+    datasource.entities[tableToSave.name] = tableToSave
+  }
+
   // store it into couch now for budibase reference
-  datasource.entities[tableToSave.name] = tableToSave
   await db.put(populateExternalTableSchemas(datasource))
 
   // Since tables are stored inside datasources, we need to notify clients

packages/server/src/tests/utilities/TestConfiguration.ts

@@ -712,11 +712,6 @@ export default class TestConfiguration {
     return this.api.row.save(tableId, config)
   }
 
-  async getRow(tableId: string, rowId: string): Promise<Row> {
-    const res = await this.api.row.get(tableId, rowId)
-    return res.body
-  }
-
   async getRows(tableId: string) {
     if (!tableId && this.table) {
       tableId = this.table._id!

packages/server/src/tests/utilities/api/application.ts

@@ -1,193 +1,133 @@
-import { Response } from "supertest"
 import {
   App,
+  PublishResponse,
   type CreateAppRequest,
   type FetchAppDefinitionResponse,
   type FetchAppPackageResponse,
 } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
+import { Expectations, TestAPI } from "./base"
-import { TestAPI } from "./base"
 import { AppStatus } from "../../../db/utils"
 import { constants } from "@budibase/backend-core"
 
 export class ApplicationAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
+  create = async (
-    super(config)
+    app: CreateAppRequest,
+    expectations?: Expectations
+  ): Promise<App> => {
+    const files = app.templateFile ? { templateFile: app.templateFile } : {}
+    delete app.templateFile
+    return await this._post<App>("/api/applications", {
+      fields: app,
+      files,
+      expectations,
+    })
   }
 
-  create = async (app: CreateAppRequest): Promise<App> => {
+  delete = async (
-    const request = this.request
+    appId: string,
-      .post("/api/applications")
+    expectations?: Expectations
-      .set(this.config.defaultHeaders())
+  ): Promise<void> => {
-      .expect("Content-Type", /json/)
+    await this._delete(`/api/applications/${appId}`, { expectations })
-
-    for (const key of Object.keys(app)) {
-      request.field(key, (app as any)[key])
-    }
-
-    if (app.templateFile) {
-      request.attach("templateFile", app.templateFile)
-    }
-
-    const result = await request
-
-    if (result.statusCode !== 200) {
-      throw new Error(JSON.stringify(result.body))
-    }
-
-    return result.body as App
   }
 
-  delete = async (appId: string): Promise<void> => {
+  publish = async (appId: string): Promise<PublishResponse> => {
-    await this.request
+    return await this._post<PublishResponse>(
-      .delete(`/api/applications/${appId}`)
+      `/api/applications/${appId}/publish`,
-      .set(this.config.defaultHeaders())
+      {
-      .expect(200)
+        // While the publish endpoint does take an :appId parameter, it doesn't
-  }
+        // use it. It uses the appId from the context.
-
+        headers: {
-  publish = async (
+          [constants.Header.APP_ID]: appId,
-    appId: string
+        },
-  ): Promise<{ _id: string; status: string; appUrl: string }> => {
+      }
-    // While the publish endpoint does take an :appId parameter, it doesn't
+    )
-    // use it. It uses the appId from the context.
-    let headers = {
-      ...this.config.defaultHeaders(),
-      [constants.Header.APP_ID]: appId,
-    }
-    const result = await this.request
-      .post(`/api/applications/${appId}/publish`)
-      .set(headers)
-      .expect("Content-Type", /json/)
-      .expect(200)
-    return result.body as { _id: string; status: string; appUrl: string }
   }
 
   unpublish = async (appId: string): Promise<void> => {
-    await this.request
+    await this._post(`/api/applications/${appId}/unpublish`, {
-      .post(`/api/applications/${appId}/unpublish`)
+      expectations: { status: 204 },
-      .set(this.config.defaultHeaders())
+    })
-      .expect(204)
   }
 
   sync = async (
     appId: string,
-    { statusCode }: { statusCode: number } = { statusCode: 200 }
+    expectations?: Expectations
   ): Promise<{ message: string }> => {
-    const result = await this.request
+    return await this._post<{ message: string }>(
-      .post(`/api/applications/${appId}/sync`)
+      `/api/applications/${appId}/sync`,
-      .set(this.config.defaultHeaders())
+      { expectations }
-      .expect("Content-Type", /json/)
+    )
-      .expect(statusCode)
-    return result.body
   }
 
-  getRaw = async (appId: string): Promise<Response> => {
+  get = async (appId: string, expectations?: Expectations): Promise<App> => {
-    // While the appPackage endpoint does take an :appId parameter, it doesn't
+    return await this._get<App>(`/api/applications/${appId}`, {
-    // use it. It uses the appId from the context.
+      // While the get endpoint does take an :appId parameter, it doesn't use
-    let headers = {
+      // it. It uses the appId from the context.
-      ...this.config.defaultHeaders(),
+      headers: {
-      [constants.Header.APP_ID]: appId,
+        [constants.Header.APP_ID]: appId,
-    }
+      },
-    const result = await this.request
+      expectations,
-      .get(`/api/applications/${appId}/appPackage`)
+    })
-      .set(headers)
-      .expect("Content-Type", /json/)
-      .expect(200)
-    return result
-  }
-
-  get = async (appId: string): Promise<App> => {
-    const result = await this.getRaw(appId)
-    return result.body.application as App
   }
 
   getDefinition = async (
-    appId: string
+    appId: string,
+    expectations?: Expectations
   ): Promise<FetchAppDefinitionResponse> => {
-    const result = await this.request
+    return await this._get<FetchAppDefinitionResponse>(
-      .get(`/api/applications/${appId}/definition`)
+      `/api/applications/${appId}/definition`,
-      .set(this.config.defaultHeaders())
+      { expectations }
-      .expect("Content-Type", /json/)
+    )
-      .expect(200)
-    return result.body as FetchAppDefinitionResponse
   }
 
-  getAppPackage = async (appId: string): Promise<FetchAppPackageResponse> => {
+  getAppPackage = async (
-    const result = await this.request
+    appId: string,
-      .get(`/api/applications/${appId}/appPackage`)
+    expectations?: Expectations
-      .set(this.config.defaultHeaders())
+  ): Promise<FetchAppPackageResponse> => {
-      .expect("Content-Type", /json/)
+    return await this._get<FetchAppPackageResponse>(
-      .expect(200)
+      `/api/applications/${appId}/appPackage`,
-    return result.body
+      { expectations }
+    )
   }
 
   update = async (
     appId: string,
-    app: { name?: string; url?: string }
+    app: { name?: string; url?: string },
+    expectations?: Expectations
   ): Promise<App> => {
-    const request = this.request
+    return await this._put<App>(`/api/applications/${appId}`, {
-      .put(`/api/applications/${appId}`)
+      fields: app,
-      .set(this.config.defaultHeaders())
+      expectations,
-      .expect("Content-Type", /json/)
+    })
-
-    for (const key of Object.keys(app)) {
-      request.field(key, (app as any)[key])
-    }
-
-    const result = await request
-
-    if (result.statusCode !== 200) {
-      throw new Error(JSON.stringify(result.body))
-    }
-
-    return result.body as App
   }
 
-  updateClient = async (appId: string): Promise<void> => {
+  updateClient = async (
-    // While the updateClient endpoint does take an :appId parameter, it doesn't
+    appId: string,
-    // use it. It uses the appId from the context.
+    expectations?: Expectations
-    let headers = {
+  ): Promise<void> => {
-      ...this.config.defaultHeaders(),
+    await this._post(`/api/applications/${appId}/client/update`, {
-      [constants.Header.APP_ID]: appId,
+      // While the updateClient endpoint does take an :appId parameter, it doesn't
-    }
+      // use it. It uses the appId from the context.
-    const response = await this.request
+      headers: {
-      .post(`/api/applications/${appId}/client/update`)
+        [constants.Header.APP_ID]: appId,
-      .set(headers)
+      },
-      .expect("Content-Type", /json/)
+      expectations,
-
+    })
-    if (response.statusCode !== 200) {
-      throw new Error(JSON.stringify(response.body))
-    }
   }
 
   revertClient = async (appId: string): Promise<void> => {
-    // While the revertClient endpoint does take an :appId parameter, it doesn't
+    await this._post(`/api/applications/${appId}/client/revert`, {
-    // use it. It uses the appId from the context.
+      // While the revertClient endpoint does take an :appId parameter, it doesn't
-    let headers = {
+      // use it. It uses the appId from the context.
-      ...this.config.defaultHeaders(),
+      headers: {
-      [constants.Header.APP_ID]: appId,
+        [constants.Header.APP_ID]: appId,
-    }
+      },
-    const response = await this.request
+    })
-      .post(`/api/applications/${appId}/client/revert`)
-      .set(headers)
-      .expect("Content-Type", /json/)
-
-    if (response.statusCode !== 200) {
-      throw new Error(JSON.stringify(response.body))
-    }
   }
 
   fetch = async ({ status }: { status?: AppStatus } = {}): Promise<App[]> => {
-    let query = []
+    return await this._get<App[]>("/api/applications", {
-    if (status) {
+      query: { status },
-      query.push(`status=${status}`)
+    })
-    }
-
-    const result = await this.request
-      .get(`/api/applications${query.length ? `?${query.join("&")}` : ""}`)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(200)
-    return result.body as App[]
   }
 }

packages/server/src/tests/utilities/api/attachment.ts

@@ -1,35 +1,16 @@
-import {
+import { ProcessAttachmentResponse } from "@budibase/types"
-  APIError,
+import { Expectations, TestAPI } from "./base"
-  Datasource,
-  ProcessAttachmentResponse,
-} from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
-import { TestAPI } from "./base"
 import fs from "fs"
 
 export class AttachmentAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   process = async (
     name: string,
     file: Buffer | fs.ReadStream | string,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<ProcessAttachmentResponse> => {
-    const result = await this.request
+    return await this._post(`/api/attachments/process`, {
-      .post(`/api/attachments/process`)
+      files: { file: { name, file } },
-      .attach("file", file, name)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-
-    if (result.statusCode !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          result.statusCode
-        }, body: ${JSON.stringify(result.body)}`
-      )
-    }
-
-    return result.body
   }
 }

packages/server/src/tests/utilities/api/backup.ts

@@ -2,42 +2,38 @@ import {
   CreateAppBackupResponse,
   ImportAppBackupResponse,
 } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
+import { Expectations, TestAPI } from "./base"
-import { TestAPI } from "./base"
 
 export class BackupAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
+  exportBasicBackup = async (appId: string, expectations?: Expectations) => {
-    super(config)
+    const exp = {
-  }
+      ...expectations,
-
+      headers: {
-  exportBasicBackup = async (appId: string) => {
+        ...expectations?.headers,
-    const result = await this.request
+        "Content-Type": "application/gzip",
-      .post(`/api/backups/export?appId=${appId}`)
+      },
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /application\/gzip/)
-      .expect(200)
-    return {
-      body: result.body as Buffer,
-      headers: result.headers,
     }
+    return await this._post<Buffer>(`/api/backups/export`, {
+      query: { appId },
+      expectations: exp,
+    })
   }
 
-  createBackup = async (appId: string) => {
+  createBackup = async (appId: string, expectations?: Expectations) => {
-    const result = await this.request
+    return await this._post<CreateAppBackupResponse>(
-      .post(`/api/apps/${appId}/backups`)
+      `/api/apps/${appId}/backups`,
-      .set(this.config.defaultHeaders())
+      { expectations }
-      .expect("Content-Type", /json/)
+    )
-      .expect(200)
-    return result.body as CreateAppBackupResponse
   }
 
   waitForBackupToComplete = async (appId: string, backupId: string) => {
     for (let i = 0; i < 10; i++) {
       await new Promise(resolve => setTimeout(resolve, 1000))
-      const result = await this.request
+      const response = await this._requestRaw(
-        .get(`/api/apps/${appId}/backups/${backupId}/file`)
+        "get",
-        .set(this.config.defaultHeaders())
+        `/api/apps/${appId}/backups/${backupId}/file`
-      if (result.status === 200) {
+      )
+      if (response.status === 200) {
         return
       }
     }
@@ -46,13 +42,12 @@ export class BackupAPI extends TestAPI {
 
   importBackup = async (
     appId: string,
-    backupId: string
+    backupId: string,
+    expectations?: Expectations
   ): Promise<ImportAppBackupResponse> => {
-    const result = await this.request
+    return await this._post<ImportAppBackupResponse>(
-      .post(`/api/apps/${appId}/backups/${backupId}/import`)
+      `/api/apps/${appId}/backups/${backupId}/import`,
-      .set(this.config.defaultHeaders())
+      { expectations }
-      .expect("Content-Type", /json/)
+    )
-      .expect(200)
-    return result.body as ImportAppBackupResponse
   }
 }

packages/server/src/tests/utilities/api/base.ts

@@ -1,17 +1,196 @@
 import TestConfiguration from "../TestConfiguration"
-import { SuperTest, Test } from "supertest"
+import { SuperTest, Test, Response } from "supertest"
+import { ReadStream } from "fs"
 
-export interface TestAPIOpts {
+type Headers = Record<string, string | string[] | undefined>
-  headers?: any
+type Method = "get" | "post" | "put" | "patch" | "delete"
+
+export interface AttachedFile {
+  name: string
+  file: Buffer | ReadStream | string
+}
+
+function isAttachedFile(file: any): file is AttachedFile {
+  if (file === undefined) {
+    return false
+  }
+  const attachedFile = file as AttachedFile
+  return (
+    Object.hasOwnProperty.call(attachedFile, "file") &&
+    Object.hasOwnProperty.call(attachedFile, "name")
+  )
+}
+
+export interface Expectations {
   status?: number
+  headers?: Record<string, string | RegExp>
+  headersNotPresent?: string[]
+  body?: Record<string, any>
+}
+
+export interface RequestOpts {
+  headers?: Headers
+  query?: Record<string, string | undefined>
+  body?: Record<string, any>
+  fields?: Record<string, any>
+  files?: Record<
+    string,
+    Buffer | ReadStream | string | AttachedFile | undefined
+  >
+  expectations?: Expectations
+  publicUser?: boolean
 }
 
 export abstract class TestAPI {
   config: TestConfiguration
   request: SuperTest<Test>
 
-  protected constructor(config: TestConfiguration) {
+  constructor(config: TestConfiguration) {
     this.config = config
     this.request = config.request!
   }
+
+  protected _get = async <T>(url: string, opts?: RequestOpts): Promise<T> => {
+    return await this._request<T>("get", url, opts)
+  }
+
+  protected _post = async <T>(url: string, opts?: RequestOpts): Promise<T> => {
+    return await this._request<T>("post", url, opts)
+  }
+
+  protected _put = async <T>(url: string, opts?: RequestOpts): Promise<T> => {
+    return await this._request<T>("put", url, opts)
+  }
+
+  protected _patch = async <T>(url: string, opts?: RequestOpts): Promise<T> => {
+    return await this._request<T>("patch", url, opts)
+  }
+
+  protected _delete = async <T>(
+    url: string,
+    opts?: RequestOpts
+  ): Promise<T> => {
+    return await this._request<T>("delete", url, opts)
+  }
+
+  protected _requestRaw = async (
+    method: "get" | "post" | "put" | "patch" | "delete",
+    url: string,
+    opts?: RequestOpts
+  ): Promise<Response> => {
+    const {
+      headers = {},
+      query = {},
+      body,
+      fields = {},
+      files = {},
+      expectations,
+      publicUser = false,
+    } = opts || {}
+    const { status = 200 } = expectations || {}
+    const expectHeaders = expectations?.headers || {}
+
+    if (status !== 204 && !expectHeaders["Content-Type"]) {
+      expectHeaders["Content-Type"] = /^application\/json/
+    }
+
+    let queryParams = []
+    for (const [key, value] of Object.entries(query)) {
+      if (value) {
+        queryParams.push(`${key}=${value}`)
+      }
+    }
+    if (queryParams.length) {
+      url += `?${queryParams.join("&")}`
+    }
+
+    const headersFn = publicUser
+      ? this.config.publicHeaders.bind(this.config)
+      : this.config.defaultHeaders.bind(this.config)
+    let request = this.request[method](url).set(
+      headersFn({
+        "x-budibase-include-stacktrace": "true",
+      })
+    )
+    if (headers) {
+      request = request.set(headers)
+    }
+    if (body) {
+      request = request.send(body)
+    }
+    for (const [key, value] of Object.entries(fields)) {
+      request = request.field(key, value)
+    }
+
+    for (const [key, value] of Object.entries(files)) {
+      if (isAttachedFile(value)) {
+        request = request.attach(key, value.file, value.name)
+      } else {
+        request = request.attach(key, value as any)
+      }
+    }
+    if (expectations?.headers) {
+      for (const [key, value] of Object.entries(expectations.headers)) {
+        if (value === undefined) {
+          throw new Error(
+            `Got an undefined expected value for header "${key}", if you want to check for the absence of a header, use headersNotPresent`
+          )
+        }
+        request = request.expect(key, value as any)
+      }
+    }
+
+    return await request
+  }
+
+  protected _request = async <T>(
+    method: Method,
+    url: string,
+    opts?: RequestOpts
+  ): Promise<T> => {
+    const { expectations } = opts || {}
+    const { status = 200 } = expectations || {}
+
+    const response = await this._requestRaw(method, url, opts)
+
+    if (response.status !== status) {
+      let message = `Expected status ${status} but got ${response.status}`
+
+      const stack = response.body.stack
+      delete response.body.stack
+
+      if (response.body) {
+        message += `\n\nBody:`
+        const body = JSON.stringify(response.body, null, 2)
+        for (const line of body.split("\n")) {
+          message += `\n⏐ ${line}`
+        }
+      }
+
+      if (stack) {
+        message += `\n\nStack from request handler:`
+        for (const line of stack.split("\n")) {
+          message += `\n⏐ ${line}`
+        }
+      }
+
+      throw new Error(message)
+    }
+
+    if (expectations?.headersNotPresent) {
+      for (const header of expectations.headersNotPresent) {
+        if (response.headers[header]) {
+          throw new Error(
+            `Expected header ${header} not to be present, found value "${response.headers[header]}"`
+          )
+        }
+      }
+    }
+
+    if (expectations?.body) {
+      expect(response.body).toMatchObject(expectations.body)
+    }
+
+    return response.body
+  }
 }

packages/server/src/tests/utilities/api/datasource.ts

@@ -1,63 +1,48 @@
 import {
-  CreateDatasourceRequest,
   Datasource,
   VerifyDatasourceRequest,
+  CreateDatasourceResponse,
+  UpdateDatasourceResponse,
+  UpdateDatasourceRequest,
 } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
+import { Expectations, TestAPI } from "./base"
-import { TestAPI } from "./base"
-import supertest from "supertest"
 
 export class DatasourceAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
+  create = async (
-    super(config)
-  }
-
-  create = async <B extends boolean = false>(
     config: Datasource,
-    {
+    expectations?: Expectations
-      expectStatus,
+  ): Promise<Datasource> => {
-      rawResponse,
+    const response = await this._post<CreateDatasourceResponse>(
-    }: { expectStatus?: number; rawResponse?: B } = {}
+      `/api/datasources`,
-  ): Promise<B extends false ? Datasource : supertest.Response> => {
+      {
-    const body: CreateDatasourceRequest = {
+        body: {
-      datasource: config,
+          datasource: config,
-      tablesFilter: [],
+          tablesFilter: [],
-    }
+        },
-    const result = await this.request
+        expectations,
-      .post(`/api/datasources`)
+      }
-      .send(body)
+    )
-      .set(this.config.defaultHeaders())
+    return response.datasource
-      .expect("Content-Type", /json/)
-      .expect(expectStatus || 200)
-    if (rawResponse) {
-      return result as any
-    }
-    return result.body.datasource
   }
 
   update = async (
-    datasource: Datasource,
+    datasource: UpdateDatasourceRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<Datasource> => {
-    const result = await this.request
+    const response = await this._put<UpdateDatasourceResponse>(
-      .put(`/api/datasources/${datasource._id}`)
+      `/api/datasources/${datasource._id}`,
-      .send(datasource)
+      { body: datasource, expectations }
-      .set(this.config.defaultHeaders())
+    )
-      .expect("Content-Type", /json/)
+    return response.datasource
-      .expect(expectStatus)
-    return result.body.datasource as Datasource
   }
 
   verify = async (
     data: VerifyDatasourceRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ) => {
-    const result = await this.request
+    return await this._post(`/api/datasources/verify`, {
-      .post(`/api/datasources/verify`)
+      body: data,
-      .send(data)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect("Content-Type", /json/)
-      .expect(expectStatus)
-    return result
   }
 }

packages/server/src/tests/utilities/api/legacyView.ts

@@ -1,16 +1,8 @@
-import TestConfiguration from "../TestConfiguration"
+import { Expectations, TestAPI } from "./base"
-import { TestAPI } from "./base"
+import { Row } from "@budibase/types"
 
 export class LegacyViewAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
+  get = async (id: string, expectations?: Expectations) => {
-    super(config)
+    return await this._get<Row[]>(`/api/views/${id}`, { expectations })
-  }
-
-  get = async (id: string, { expectStatus } = { expectStatus: 200 }) => {
-    return await this.request
-      .get(`/api/views/${id}`)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(expectStatus)
   }
 }

packages/server/src/tests/utilities/api/permission.ts

@@ -1,52 +1,39 @@
-import { AnyDocument, PermissionLevel } from "@budibase/types"
+import {
-import TestConfiguration from "../TestConfiguration"
+  AddPermissionRequest,
-import { TestAPI } from "./base"
+  AddPermissionResponse,
+  GetResourcePermsResponse,
+  RemovePermissionRequest,
+  RemovePermissionResponse,
+} from "@budibase/types"
+import { Expectations, TestAPI } from "./base"
 
 export class PermissionAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
+  get = async (resourceId: string, expectations?: Expectations) => {
-    super(config)
+    return await this._get<GetResourcePermsResponse>(
+      `/api/permission/${resourceId}`,
+      { expectations }
+    )
   }
 
-  get = async (
+  add = async (
-    resourceId: string,
+    request: AddPermissionRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
-  ) => {
+  ): Promise<AddPermissionResponse> => {
-    return this.request
+    const { roleId, resourceId, level } = request
-      .get(`/api/permission/${resourceId}`)
+    return await this._post<AddPermissionResponse>(
-      .set(this.config.defaultHeaders())
+      `/api/permission/${roleId}/${resourceId}/${level}`,
-      .expect("Content-Type", /json/)
+      { expectations }
-      .expect(expectStatus)
+    )
-  }
-
-  set = async (
-    {
-      roleId,
-      resourceId,
-      level,
-    }: { roleId: string; resourceId: string; level: PermissionLevel },
-    { expectStatus } = { expectStatus: 200 }
-  ): Promise<any> => {
-    const res = await this.request
-      .post(`/api/permission/${roleId}/${resourceId}/${level}`)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(expectStatus)
-    return res.body
   }
 
   revoke = async (
-    {
+    request: RemovePermissionRequest,
-      roleId,
+    expectations?: Expectations
-      resourceId,
-      level,
-    }: { roleId: string; resourceId: string; level: PermissionLevel },
-    { expectStatus } = { expectStatus: 200 }
   ) => {
-    const res = await this.request
+    const { roleId, resourceId, level } = request
-      .delete(`/api/permission/${roleId}/${resourceId}/${level}`)
+    return await this._delete<RemovePermissionResponse>(
-      .set(this.config.defaultHeaders())
+      `/api/permission/${roleId}/${resourceId}/${level}`,
-      .expect("Content-Type", /json/)
+      { expectations }
-      .expect(expectStatus)
+    )
-    return res
   }
 }

packages/server/src/tests/utilities/api/query.ts

@@ -1,60 +1,32 @@
-import TestConfiguration from "../TestConfiguration"
 import {
   Query,
-  QueryPreview,
+  ExecuteQueryRequest,
-  type ExecuteQueryRequest,
+  ExecuteQueryResponse,
-  type ExecuteQueryResponse,
+  PreviewQueryRequest,
+  PreviewQueryResponse,
 } from "@budibase/types"
 import { TestAPI } from "./base"
 
 export class QueryAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   create = async (body: Query): Promise<Query> => {
-    const res = await this.request
+    return await this._post<Query>(`/api/queries`, { body })
-      .post(`/api/queries`)
-      .set(this.config.defaultHeaders())
-      .send(body)
-      .expect("Content-Type", /json/)
-
-    if (res.status !== 200) {
-      throw new Error(JSON.stringify(res.body))
-    }
-
-    return res.body as Query
   }
 
   execute = async (
     queryId: string,
     body?: ExecuteQueryRequest
   ): Promise<ExecuteQueryResponse> => {
-    const res = await this.request
+    return await this._post<ExecuteQueryResponse>(
-      .post(`/api/v2/queries/${queryId}`)
+      `/api/v2/queries/${queryId}`,
-      .set(this.config.defaultHeaders())
+      {
-      .send(body)
+        body,
-      .expect("Content-Type", /json/)
+      }
-
+    )
-    if (res.status !== 200) {
-      throw new Error(JSON.stringify(res.body))
-    }
-
-    return res.body
   }
 
-  previewQuery = async (queryPreview: QueryPreview) => {
+  previewQuery = async (queryPreview: PreviewQueryRequest) => {
-    const res = await this.request
+    return await this._post<PreviewQueryResponse>(`/api/queries/preview`, {
-      .post(`/api/queries/preview`)
+      body: queryPreview,
-      .send(queryPreview)
+    })
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(200)
-
-    if (res.status !== 200) {
-      throw new Error(JSON.stringify(res.body))
-    }
-
-    return res.body
   }
 }

packages/server/src/tests/utilities/api/row.ts

@@ -8,162 +8,140 @@ import {
   BulkImportResponse,
   SearchRowResponse,
   SearchParams,
+  DeleteRowRequest,
+  DeleteRows,
+  DeleteRow,
+  ExportRowsResponse,
 } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
+import { Expectations, TestAPI } from "./base"
-import { TestAPI } from "./base"
 
 export class RowAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   get = async (
     sourceId: string,
     rowId: string,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ) => {
-    const request = this.request
+    return await this._get<Row>(`/api/${sourceId}/rows/${rowId}`, {
-      .get(`/api/${sourceId}/rows/${rowId}`)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect(expectStatus)
-    if (expectStatus !== 404) {
-      request.expect("Content-Type", /json/)
-    }
-    return request
   }
 
   getEnriched = async (
     sourceId: string,
     rowId: string,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ) => {
-    const request = this.request
+    return await this._get<Row>(`/api/${sourceId}/${rowId}/enrich`, {
-      .get(`/api/${sourceId}/${rowId}/enrich`)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect(expectStatus)
-    if (expectStatus !== 404) {
-      request.expect("Content-Type", /json/)
-    }
-    return request
   }
 
   save = async (
     tableId: string,
     row: SaveRowRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<Row> => {
-    const resp = await this.request
+    return await this._post<Row>(`/api/${tableId}/rows`, {
-      .post(`/api/${tableId}/rows`)
+      body: row,
-      .send(row)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect("Content-Type", /json/)
-    if (resp.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          resp.status
-        }, body: ${JSON.stringify(resp.body)}`
-      )
-    }
-    return resp.body as Row
   }
 
   validate = async (
     sourceId: string,
     row: SaveRowRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<ValidateResponse> => {
-    const resp = await this.request
+    return await this._post<ValidateResponse>(
-      .post(`/api/${sourceId}/rows/validate`)
+      `/api/${sourceId}/rows/validate`,
-      .send(row)
+      {
-      .set(this.config.defaultHeaders())
+        body: row,
-      .expect("Content-Type", /json/)
+        expectations,
-      .expect(expectStatus)
+      }
-    return resp.body as ValidateResponse
+    )
   }
 
   patch = async (
     sourceId: string,
     row: PatchRowRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<Row> => {
-    let resp = await this.request
+    return await this._patch<Row>(`/api/${sourceId}/rows`, {
-      .patch(`/api/${sourceId}/rows`)
+      body: row,
-      .send(row)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect("Content-Type", /json/)
-    if (resp.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          resp.status
-        }, body: ${JSON.stringify(resp.body)}`
-      )
-    }
-    return resp.body as Row
   }
 
   delete = async (
     sourceId: string,
-    rows: Row | string | (Row | string)[],
+    row: DeleteRow,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ) => {
-    return this.request
+    return await this._delete<Row>(`/api/${sourceId}/rows`, {
-      .delete(`/api/${sourceId}/rows`)
+      body: row,
-      .send(Array.isArray(rows) ? { rows } : rows)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect("Content-Type", /json/)
+  }
-      .expect(expectStatus)
+
+  bulkDelete = async (
+    sourceId: string,
+    body: DeleteRows,
+    expectations?: Expectations
+  ) => {
+    return await this._delete<Row[]>(`/api/${sourceId}/rows`, {
+      body,
+      expectations,
+    })
   }
 
   fetch = async (
     sourceId: string,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<Row[]> => {
-    const request = this.request
+    return await this._get<Row[]>(`/api/${sourceId}/rows`, {
-      .get(`/api/${sourceId}/rows`)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect(expectStatus)
-
-    return (await request).body
   }
 
   exportRows = async (
     tableId: string,
     body: ExportRowsRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ) => {
-    const request = this.request
+    const response = await this._requestRaw(
-      .post(`/api/${tableId}/rows/exportRows?format=json`)
+      "post",
-      .set(this.config.defaultHeaders())
+      `/api/${tableId}/rows/exportRows`,
-      .send(body)
+      {
-      .expect("Content-Type", /json/)
+        body,
-      .expect(expectStatus)
+        query: { format: "json" },
-    return request
+        expectations,
+      }
+    )
+    return response.text
   }
 
   bulkImport = async (
     tableId: string,
     body: BulkImportRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<BulkImportResponse> => {
-    let request = this.request
+    return await this._post<BulkImportResponse>(
-      .post(`/api/tables/${tableId}/import`)
+      `/api/tables/${tableId}/import`,
-      .send(body)
+      {
-      .set(this.config.defaultHeaders())
+        body,
-      .expect(expectStatus)
+        expectations,
-    return (await request).body
+      }
+    )
   }
 
   search = async (
     sourceId: string,
     params?: SearchParams,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<SearchRowResponse> => {
-    const request = this.request
+    return await this._post<SearchRowResponse>(`/api/${sourceId}/search`, {
-      .post(`/api/${sourceId}/search`)
+      body: params,
-      .send(params)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect(expectStatus)
-
-    return (await request).body
   }
 }

packages/server/src/tests/utilities/api/screen.ts

@@ -1,18 +1,8 @@
-import TestConfiguration from "../TestConfiguration"
 import { Screen } from "@budibase/types"
-import { TestAPI } from "./base"
+import { Expectations, TestAPI } from "./base"
 
 export class ScreenAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
+  list = async (expectations?: Expectations): Promise<Screen[]> => {
-    super(config)
+    return await this._get<Screen[]>(`/api/screens`, { expectations })
-  }
-
-  list = async (): Promise<Screen[]> => {
-    const res = await this.request
-      .get(`/api/screens`)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(200)
-    return res.body as Screen[]
   }
 }

packages/server/src/tests/utilities/api/table.ts

@@ -5,74 +5,38 @@ import {
   SaveTableResponse,
   Table,
 } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
+import { Expectations, TestAPI } from "./base"
-import { TestAPI } from "./base"
 
 export class TableAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   save = async (
     data: SaveTableRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<SaveTableResponse> => {
-    const res = await this.request
+    return await this._post<SaveTableResponse>("/api/tables", {
-      .post(`/api/tables`)
+      body: data,
-      .send(data)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect("Content-Type", /json/)
-
-    if (res.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-
-    return res.body
   }
 
-  fetch = async (
+  fetch = async (expectations?: Expectations): Promise<Table[]> => {
-    { expectStatus } = { expectStatus: 200 }
+    return await this._get<Table[]>("/api/tables", { expectations })
-  ): Promise<Table[]> => {
-    const res = await this.request
-      .get(`/api/tables`)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(expectStatus)
-    return res.body
   }
 
   get = async (
     tableId: string,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<Table> => {
-    const res = await this.request
+    return await this._get<Table>(`/api/tables/${tableId}`, { expectations })
-      .get(`/api/tables/${tableId}`)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(expectStatus)
-    return res.body
   }
 
   migrate = async (
     tableId: string,
     data: MigrateRequest,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<MigrateResponse> => {
-    const res = await this.request
+    return await this._post<MigrateResponse>(`/api/tables/${tableId}/migrate`, {
-      .post(`/api/tables/${tableId}/migrate`)
+      body: data,
-      .send(data)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-    if (res.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-    return res.body
   }
 }

packages/server/src/tests/utilities/api/user.ts

@@ -4,154 +4,79 @@ import {
   Flags,
   UserMetadata,
 } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
+import { Expectations, TestAPI } from "./base"
-import { TestAPI } from "./base"
 import { DocumentInsertResponse } from "@budibase/nano"
 
 export class UserAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   fetch = async (
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<FetchUserMetadataResponse> => {
-    const res = await this.request
+    return await this._get<FetchUserMetadataResponse>("/api/users/metadata", {
-      .get(`/api/users/metadata`)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect("Content-Type", /json/)
-
-    if (res.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-
-    return res.body
   }
 
   find = async (
     id: string,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<FindUserMetadataResponse> => {
-    const res = await this.request
+    return await this._get<FindUserMetadataResponse>(
-      .get(`/api/users/metadata/${id}`)
+      `/api/users/metadata/${id}`,
-      .set(this.config.defaultHeaders())
+      {
-      .expect("Content-Type", /json/)
+        expectations,
-
+      }
-    if (res.status !== expectStatus) {
+    )
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-
-    return res.body
   }
 
   update = async (
     user: UserMetadata,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<DocumentInsertResponse> => {
-    const res = await this.request
+    return await this._put<DocumentInsertResponse>("/api/users/metadata", {
-      .put(`/api/users/metadata`)
+      body: user,
-      .set(this.config.defaultHeaders())
+      expectations,
-      .send(user)
+    })
-      .expect("Content-Type", /json/)
-
-    if (res.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-
-    return res.body as DocumentInsertResponse
   }
 
   updateSelf = async (
     user: UserMetadata,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<DocumentInsertResponse> => {
-    const res = await this.request
+    return await this._post<DocumentInsertResponse>(
-      .post(`/api/users/metadata/self`)
+      "/api/users/metadata/self",
-      .set(this.config.defaultHeaders())
+      {
-      .send(user)
+        body: user,
-      .expect("Content-Type", /json/)
+        expectations,
-
+      }
-    if (res.status !== expectStatus) {
+    )
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-
-    return res.body as DocumentInsertResponse
   }
 
   destroy = async (
     id: string,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<{ message: string }> => {
-    const res = await this.request
+    return await this._delete<{ message: string }>(
-      .delete(`/api/users/metadata/${id}`)
+      `/api/users/metadata/${id}`,
-      .set(this.config.defaultHeaders())
+      {
-      .expect("Content-Type", /json/)
+        expectations,
-
+      }
-    if (res.status !== expectStatus) {
+    )
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-
-    return res.body as { message: string }
   }
 
   setFlag = async (
     flag: string,
     value: any,
-    { expectStatus } = { expectStatus: 200 }
+    expectations?: Expectations
   ): Promise<{ message: string }> => {
-    const res = await this.request
+    return await this._post<{ message: string }>(`/api/users/flags`, {
-      .post(`/api/users/flags`)
+      body: { flag, value },
-      .set(this.config.defaultHeaders())
+      expectations,
-      .send({ flag, value })
+    })
-      .expect("Content-Type", /json/)
-
-    if (res.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-
-    return res.body as { message: string }
   }
 
-  getFlags = async (
+  getFlags = async (expectations?: Expectations): Promise<Flags> => {
-    { expectStatus } = { expectStatus: 200 }
+    return await this._get<Flags>(`/api/users/flags`, {
-  ): Promise<Flags> => {
+      expectations,
-    const res = await this.request
+    })
-      .get(`/api/users/flags`)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-
-    if (res.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-
-    return res.body as Flags
   }
 }

packages/server/src/tests/utilities/api/viewV2.ts

@@ -3,21 +3,16 @@ import {
   UpdateViewRequest,
   ViewV2,
   SearchViewRowRequest,
+  PaginatedSearchRowResponse,
 } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
+import { Expectations, TestAPI } from "./base"
-import { TestAPI } from "./base"
 import { generator } from "@budibase/backend-core/tests"
-import { Response } from "superagent"
 import sdk from "../../../sdk"
 
 export class ViewV2API extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   create = async (
     viewData?: Partial<CreateViewRequest>,
-    { expectStatus } = { expectStatus: 201 }
+    expectations?: Expectations
   ): Promise<ViewV2> => {
     let tableId = viewData?.tableId
     if (!tableId && !this.config.table) {
@@ -30,43 +25,36 @@ export class ViewV2API extends TestAPI {
       name: generator.guid(),
       ...viewData,
     }
-    const result = await this.request
+
-      .post(`/api/v2/views`)
+    const exp: Expectations = {
-      .send(view)
+      status: 201,
-      .set(this.config.defaultHeaders())
+      ...expectations,
-      .expect("Content-Type", /json/)
+    }
-      .expect(expectStatus)
+
-    return result.body.data as ViewV2
+    const resp = await this._post<{ data: ViewV2 }>("/api/v2/views", {
+      body: view,
+      expectations: exp,
+    })
+    return resp.data
   }
 
   update = async (
     view: UpdateViewRequest,
-    {
+    expectations?: Expectations
-      expectStatus,
-      handleResponse,
-    }: {
-      expectStatus: number
-      handleResponse?: (response: Response) => void
-    } = { expectStatus: 200 }
   ): Promise<ViewV2> => {
-    const result = await this.request
+    const resp = await this._put<{ data: ViewV2 }>(`/api/v2/views/${view.id}`, {
-      .put(`/api/v2/views/${view.id}`)
+      body: view,
-      .send(view)
+      expectations,
-      .set(this.config.defaultHeaders())
+    })
-      .expect("Content-Type", /json/)
+    return resp.data
-      .expect(expectStatus)
-
-    if (handleResponse) {
-      handleResponse(result)
-    }
-    return result.body.data as ViewV2
   }
 
-  delete = async (viewId: string, { expectStatus } = { expectStatus: 204 }) => {
+  delete = async (viewId: string, expectations?: Expectations) => {
-    return this.request
+    const exp = {
-      .delete(`/api/v2/views/${viewId}`)
+      status: 204,
-      .set(this.config.defaultHeaders())
+      ...expectations,
-      .expect(expectStatus)
+    }
+    return await this._delete(`/api/v2/views/${viewId}`, { expectations: exp })
   }
 
   get = async (viewId: string) => {
@@ -78,17 +66,29 @@ export class ViewV2API extends TestAPI {
   search = async (
     viewId: string,
     params?: SearchViewRowRequest,
-    { expectStatus = 200, usePublicUser = false } = {}
+    expectations?: Expectations
   ) => {
-    return this.request
+    return await this._post<PaginatedSearchRowResponse>(
-      .post(`/api/v2/views/${viewId}/search`)
+      `/api/v2/views/${viewId}/search`,
-      .send(params)
+      {
-      .set(
+        body: params,
-        usePublicUser
+        expectations,
-          ? this.config.publicHeaders()
+      }
-          : this.config.defaultHeaders()
+    )
-      )
+  }
-      .expect("Content-Type", /json/)
+
-      .expect(expectStatus)
+  publicSearch = async (
+    viewId: string,
+    params?: SearchViewRowRequest,
+    expectations?: Expectations
+  ) => {
+    return await this._post<PaginatedSearchRowResponse>(
+      `/api/v2/views/${viewId}/search`,
+      {
+        body: params,
+        expectations,
+        publicUser: true,
+      }
+    )
   }
 }

packages/types/src/api/web/app/permission.ts

@@ -1,4 +1,4 @@
-import { PlanType } from "../../../sdk"
+import { PermissionLevel, PlanType } from "../../../sdk"
 
 export interface ResourcePermissionInfo {
   role: string
@@ -14,3 +14,21 @@ export interface GetResourcePermsResponse {
 export interface GetDependantResourcesResponse {
   resourceByType?: Record<string, number>
 }
+
+export interface AddedPermission {
+  _id?: string
+  rev?: string
+  error?: string
+  reason?: string
+}
+
+export type AddPermissionResponse = AddedPermission[]
+
+export interface AddPermissionRequest {
+  roleId: string
+  resourceId: string
+  level: PermissionLevel
+}
+
+export interface RemovePermissionRequest extends AddPermissionRequest {}
+export interface RemovePermissionResponse extends AddPermissionResponse {}

packages/types/src/api/web/app/rows.ts

@@ -1,6 +1,6 @@
 import { SearchFilters, SearchParams } from "../../../sdk"
 import { Row } from "../../../documents"
-import { SortOrder } from "../../../api"
+import { PaginationResponse, SortOrder } from "../../../api"
 import { ReadStream } from "fs"
 
 export interface SaveRowRequest extends Row {}
@@ -31,6 +31,10 @@ export interface SearchRowResponse {
   rows: any[]
 }
 
+export interface PaginatedSearchRowResponse
+  extends SearchRowResponse,
+    PaginationResponse {}
+
 export interface ExportRowsRequest {
   rows: string[]
   columns?: string[]

packages/types/src/api/web/application.ts

@@ -27,3 +27,9 @@ export interface FetchAppPackageResponse {
   clientLibPath: string
   hasLock: boolean
 }
+
+export interface PublishResponse {
+  _id: string
+  status: string
+  appUrl: string
+}

packages/types/src/api/web/index.ts

@@ -13,3 +13,4 @@ export * from "./searchFilter"
 export * from "./cookies"
 export * from "./automation"
 export * from "./layout"
+export * from "./query"

packages/types/src/api/web/query.ts

@@ -0,0 +1,20 @@
+import { QueryPreview, QuerySchema } from "../../documents"
+
+export interface PreviewQueryRequest extends QueryPreview {}
+
+export interface PreviewQueryResponse {
+  rows: any[]
+  nestedSchemaFields: { [key: string]: { [key: string]: string | QuerySchema } }
+  schema: { [key: string]: string | QuerySchema }
+  info: any
+  extra: any
+}
+
+export interface ExecuteQueryRequest {
+  parameters?: { [key: string]: string }
+  pagination?: any
+}
+
+export interface ExecuteQueryResponse {
+  data: Record<string, any>[]
+}

packages/types/src/documents/app/query.ts

@@ -62,22 +62,6 @@ export interface PaginationValues {
   limit: number | null
 }
 
-export interface PreviewQueryRequest extends Omit<Query, "parameters"> {
-  parameters: {}
-  flags?: {
-    urlName?: boolean
-  }
-}
-
-export interface ExecuteQueryRequest {
-  parameters?: { [key: string]: string }
-  pagination?: any
-}
-
-export interface ExecuteQueryResponse {
-  data: Row[]
-}
-
 export enum HttpMethod {
   GET = "GET",
   POST = "POST",

packages/types/src/documents/app/table/table.ts

@@ -1,6 +1,6 @@
 import { Document } from "../../document"
 import { View, ViewV2 } from "../view"
-import { RenameColumn } from "../../../sdk"
+import { AddColumn, RenameColumn } from "../../../sdk"
 import { TableSchema } from "./schema"
 
 export const INTERNAL_TABLE_SOURCE_ID = "bb_internal"
@@ -29,5 +29,6 @@ export interface Table extends Document {
 
 export interface TableRequest extends Table {
   _rename?: RenameColumn
+  _add?: AddColumn
   created?: boolean
 }

packages/types/src/sdk/datasources.ts

@@ -1,4 +1,5 @@
-import { Table } from "../documents"
+import { Table, Row } from "../documents"
+import { QueryJson } from "./search"
 
 export const PASSWORD_REPLACEMENT = "--secret-value--"
 
@@ -181,11 +182,24 @@ export interface Schema {
   errors: Record<string, string>
 }
 
+// return these when an operation occurred but we got no response
+enum DSPlusOperation {
+  CREATE = "create",
+  READ = "read",
+  UPDATE = "update",
+  DELETE = "delete",
+}
+
+export type DatasourcePlusQueryResponse = Promise<
+  Row[] | Record<DSPlusOperation, boolean>[] | void
+>
+
 export interface DatasourcePlus extends IntegrationBase {
   // if the datasource supports the use of bindings directly (to protect against SQL injection)
   // this returns the format of the identifier
   getBindingIdentifier(): string
   getStringConcat(parts: string[]): string
+  query(json: QueryJson): DatasourcePlusQueryResponse
   buildSchema(
     datasourceId: string,
     entities: Record<string, Table>

packages/types/src/sdk/db.ts

@@ -128,7 +128,7 @@ export interface Database {
 
   exists(): Promise<boolean>
   get<T extends Document>(id?: string): Promise<T>
-  docExists(id: string): Promise<boolean>
+  exists(docId: string): Promise<boolean>
   getMultiple<T extends Document>(
     ids: string[],
     opts?: { allowMissing?: boolean }

packages/types/src/sdk/search.ts

@@ -60,6 +60,10 @@ export interface RenameColumn {
   updated: string
 }
 
+export interface AddColumn {
+  name: string
+}
+
 export interface RelationshipsJson {
   through?: string
   from?: string
@@ -94,6 +98,7 @@ export interface QueryJson {
     idFilter?: SearchFilters
   }
   relationships?: RelationshipsJson[]
+  tableAliases?: Record<string, string>
 }
 
 export interface SqlQuery {