This commit is contained in:
Sam Rose 2024-11-26 16:28:22 +00:00
parent 5952b2457e
commit 594af57339
No known key found for this signature in database
23 changed files with 854 additions and 927 deletions

View File

@ -18,6 +18,7 @@ import {
BasicOperator, BasicOperator,
BBReferenceFieldMetadata, BBReferenceFieldMetadata,
CalculationType, CalculationType,
EnrichedQueryJson,
FieldSchema, FieldSchema,
FieldType, FieldType,
INTERNAL_TABLE_SOURCE_ID, INTERNAL_TABLE_SOURCE_ID,
@ -27,7 +28,6 @@ import {
LogicalOperator, LogicalOperator,
Operation, Operation,
prefixed, prefixed,
QueryJson,
QueryOptions, QueryOptions,
RangeOperator, RangeOperator,
RelationshipsJson, RelationshipsJson,
@ -134,18 +134,18 @@ const allowEmptyRelationships: Record<SearchFilterKey, boolean> = {
class InternalBuilder { class InternalBuilder {
private readonly client: SqlClient private readonly client: SqlClient
private readonly query: QueryJson private readonly query: EnrichedQueryJson
private readonly splitter: dataFilters.ColumnSplitter private readonly splitter: dataFilters.ColumnSplitter
private readonly knex: Knex private readonly knex: Knex
constructor(client: SqlClient, knex: Knex, query: QueryJson) { constructor(client: SqlClient, knex: Knex, query: EnrichedQueryJson) {
this.client = client this.client = client
this.query = query this.query = query
this.knex = knex this.knex = knex
this.splitter = new dataFilters.ColumnSplitter([this.table], { this.splitter = new dataFilters.ColumnSplitter([this.table], {
aliases: this.query.tableAliases, aliases: this.query.tableAliases,
columnPrefix: this.query.meta.columnPrefix, columnPrefix: this.query.meta?.columnPrefix,
}) })
} }
@ -167,7 +167,7 @@ class InternalBuilder {
} }
get table(): Table { get table(): Table {
return this.query.meta.table return this.query.table
} }
get knexClient(): Knex.Client { get knexClient(): Knex.Client {
@ -273,8 +273,7 @@ class InternalBuilder {
} }
private isFullSelectStatementRequired(): boolean { private isFullSelectStatementRequired(): boolean {
const { meta } = this.query for (let column of Object.values(this.table.schema)) {
for (let column of Object.values(meta.table.schema)) {
if (this.SPECIAL_SELECT_CASES.POSTGRES_MONEY(column)) { if (this.SPECIAL_SELECT_CASES.POSTGRES_MONEY(column)) {
return true return true
} else if (this.SPECIAL_SELECT_CASES.MSSQL_DATES(column)) { } else if (this.SPECIAL_SELECT_CASES.MSSQL_DATES(column)) {
@ -285,14 +284,14 @@ class InternalBuilder {
} }
private generateSelectStatement(): (string | Knex.Raw)[] | "*" { private generateSelectStatement(): (string | Knex.Raw)[] | "*" {
const { meta, endpoint, resource } = this.query const { endpoint, resource } = this.query
if (!resource || !resource.fields || resource.fields.length === 0) { if (!resource || !resource.fields || resource.fields.length === 0) {
return "*" return "*"
} }
const alias = this.getTableName(endpoint.entityId) const alias = this.getTableName(endpoint.entityId)
const schema = meta.table.schema const schema = this.table.schema
if (!this.isFullSelectStatementRequired()) { if (!this.isFullSelectStatementRequired()) {
return [this.knex.raw("??", [`${alias}.*`])] return [this.knex.raw("??", [`${alias}.*`])]
} }
@ -1018,15 +1017,15 @@ class InternalBuilder {
const name = tableOrName const name = tableOrName
if (this.query.table?.name === name) { if (this.query.table?.name === name) {
table = this.query.table table = this.query.table
} else if (this.query.meta.table?.name === name) { } else if (this.query.table.name === name) {
table = this.query.meta.table table = this.query.table
} else if (!this.query.meta.tables?.[name]) { } else if (!this.query.tables[name]) {
// This can legitimately happen in custom queries, where the user is // This can legitimately happen in custom queries, where the user is
// querying against a table that may not have been imported into // querying against a table that may not have been imported into
// Budibase. // Budibase.
return name return name
} else { } else {
table = this.query.meta.tables[name] table = this.query.tables[name]
} }
} else if (tableOrName) { } else if (tableOrName) {
table = tableOrName table = tableOrName
@ -1238,7 +1237,7 @@ class InternalBuilder {
): Knex.QueryBuilder { ): Knex.QueryBuilder {
const sqlClient = this.client const sqlClient = this.client
const knex = this.knex const knex = this.knex
const { resource, tableAliases: aliases, endpoint, meta } = this.query const { resource, tableAliases: aliases, endpoint, tables } = this.query
const fields = resource?.fields || [] const fields = resource?.fields || []
for (let relationship of relationships) { for (let relationship of relationships) {
const { const {
@ -1253,7 +1252,7 @@ class InternalBuilder {
if (!toTable || !fromTable) { if (!toTable || !fromTable) {
continue continue
} }
const relatedTable = meta.tables?.[toTable] const relatedTable = tables[toTable]
const toAlias = aliases?.[toTable] || toTable, const toAlias = aliases?.[toTable] || toTable,
fromAlias = aliases?.[fromTable] || fromTable, fromAlias = aliases?.[fromTable] || fromTable,
throughAlias = (throughTable && aliases?.[throughTable]) || throughTable throughAlias = (throughTable && aliases?.[throughTable]) || throughTable
@ -1276,7 +1275,7 @@ class InternalBuilder {
Math.floor(this.maxFunctionParameters() / 2) Math.floor(this.maxFunctionParameters() / 2)
) )
const fieldList = relationshipFields.map(field => const fieldList = relationshipFields.map(field =>
this.buildJsonField(relatedTable!, field) this.buildJsonField(relatedTable, field)
) )
const fieldListFormatted = fieldList const fieldListFormatted = fieldList
.map(f => { .map(f => {
@ -1472,9 +1471,7 @@ class InternalBuilder {
if (this.client === SqlClient.ORACLE) { if (this.client === SqlClient.ORACLE) {
// Oracle doesn't seem to automatically insert nulls // Oracle doesn't seem to automatically insert nulls
// if we don't specify them, so we need to do that here // if we don't specify them, so we need to do that here
for (const [column, schema] of Object.entries( for (const [column, schema] of Object.entries(this.query.table.schema)) {
this.query.meta.table.schema
)) {
if ( if (
schema.constraints?.presence === true || schema.constraints?.presence === true ||
schema.type === FieldType.FORMULA || schema.type === FieldType.FORMULA ||
@ -1678,7 +1675,10 @@ class SqlQueryBuilder extends SqlTableQueryBuilder {
* which for the sake of mySQL stops adding the returning statement to inserts, updates and deletes. * which for the sake of mySQL stops adding the returning statement to inserts, updates and deletes.
* @return the query ready to be passed to the driver. * @return the query ready to be passed to the driver.
*/ */
_query(json: QueryJson, opts: QueryOptions = {}): SqlQuery | SqlQuery[] { _query(
json: EnrichedQueryJson,
opts: QueryOptions = {}
): SqlQuery | SqlQuery[] {
const sqlClient = this.getSqlClient() const sqlClient = this.getSqlClient()
const config: Knex.Config = { const config: Knex.Config = {
client: this.getBaseSqlClient(), client: this.getBaseSqlClient(),
@ -1728,34 +1728,30 @@ class SqlQueryBuilder extends SqlTableQueryBuilder {
return this.convertToNative(query, opts) return this.convertToNative(query, opts)
} }
async getReturningRow(queryFn: QueryFunction, json: QueryJson) { async getReturningRow(queryFn: QueryFunction, json: EnrichedQueryJson) {
if (!json.extra || !json.extra.idFilter) { if (!json.extra || !json.extra.idFilter) {
return {} return {}
} }
const input = this._query({ const input = this._query({
...json,
endpoint: { endpoint: {
...json.endpoint, ...json.endpoint,
operation: Operation.READ, operation: Operation.READ,
}, },
resource: { resource: { fields: [] },
fields: [],
},
filters: json.extra?.idFilter, filters: json.extra?.idFilter,
paginate: { paginate: { limit: 1 },
limit: 1,
},
meta: json.meta,
}) })
return queryFn(input, Operation.READ) return queryFn(input, Operation.READ)
} }
// when creating if an ID has been inserted need to make sure // when creating if an ID has been inserted need to make sure
// the id filter is enriched with it before trying to retrieve the row // the id filter is enriched with it before trying to retrieve the row
checkLookupKeys(id: any, json: QueryJson) { checkLookupKeys(id: any, json: EnrichedQueryJson) {
if (!id || !json.meta.table || !json.meta.table.primary) { if (!id || !json.table.primary) {
return json return json
} }
const primaryKey = json.meta.table.primary?.[0] const primaryKey = json.table.primary[0]
json.extra = { json.extra = {
idFilter: { idFilter: {
equal: { equal: {
@ -1768,7 +1764,7 @@ class SqlQueryBuilder extends SqlTableQueryBuilder {
// this function recreates the returning functionality of postgres // this function recreates the returning functionality of postgres
async queryWithReturning( async queryWithReturning(
json: QueryJson, json: EnrichedQueryJson,
queryFn: QueryFunction, queryFn: QueryFunction,
processFn: Function = (result: any) => result processFn: Function = (result: any) => result
) { ) {

View File

@ -3,13 +3,13 @@ import {
FieldType, FieldType,
NumberFieldMetadata, NumberFieldMetadata,
Operation, Operation,
QueryJson,
RelationshipType, RelationshipType,
RenameColumn, RenameColumn,
SqlQuery, SqlQuery,
Table, Table,
TableSourceType, TableSourceType,
SqlClient, SqlClient,
EnrichedQueryJson,
} from "@budibase/types" } from "@budibase/types"
import { breakExternalTableId, getNativeSql } from "./utils" import { breakExternalTableId, getNativeSql } from "./utils"
import { helpers, utils } from "@budibase/shared-core" import { helpers, utils } from "@budibase/shared-core"
@ -200,7 +200,7 @@ function buildUpdateTable(
table: Table, table: Table,
tables: Record<string, Table>, tables: Record<string, Table>,
oldTable: Table, oldTable: Table,
renamed: RenameColumn renamed?: RenameColumn
): SchemaBuilder { ): SchemaBuilder {
return knex.alterTable(table.name, schema => { return knex.alterTable(table.name, schema => {
generateSchema(schema, table, tables, oldTable, renamed) generateSchema(schema, table, tables, oldTable, renamed)
@ -238,11 +238,11 @@ class SqlTableQueryBuilder {
* @param json the input JSON structure from which an SQL query will be built. * @param json the input JSON structure from which an SQL query will be built.
* @return the operation that was found in the JSON. * @return the operation that was found in the JSON.
*/ */
_operation(json: QueryJson): Operation { _operation(json: EnrichedQueryJson): Operation {
return json.endpoint.operation return json.endpoint.operation
} }
_tableQuery(json: QueryJson): SqlQuery | SqlQuery[] { _tableQuery(json: EnrichedQueryJson): SqlQuery | SqlQuery[] {
let client = knex({ client: this.sqlClient }).schema let client = knex({ client: this.sqlClient }).schema
let schemaName = json?.endpoint?.schema let schemaName = json?.endpoint?.schema
if (schemaName) { if (schemaName) {
@ -250,7 +250,7 @@ class SqlTableQueryBuilder {
} }
let query: Knex.SchemaBuilder let query: Knex.SchemaBuilder
if (!json.table || !json.meta || !json.meta.tables) { if (!json.table || !json.tables) {
throw new Error("Cannot execute without table being specified") throw new Error("Cannot execute without table being specified")
} }
if (json.table.sourceType === TableSourceType.INTERNAL) { if (json.table.sourceType === TableSourceType.INTERNAL) {
@ -259,14 +259,14 @@ class SqlTableQueryBuilder {
switch (this._operation(json)) { switch (this._operation(json)) {
case Operation.CREATE_TABLE: case Operation.CREATE_TABLE:
query = buildCreateTable(client, json.table, json.meta.tables) query = buildCreateTable(client, json.table, json.tables)
break break
case Operation.UPDATE_TABLE: case Operation.UPDATE_TABLE:
if (!json.meta || !json.meta.table) { if (!json.table) {
throw new Error("Must specify old table for update") throw new Error("Must specify old table for update")
} }
// renameColumn does not work for MySQL, so return a raw query // renameColumn does not work for MySQL, so return a raw query
if (this.sqlClient === SqlClient.MY_SQL && json.meta.renamed) { if (this.sqlClient === SqlClient.MY_SQL && json.meta?.renamed) {
const updatedColumn = json.meta.renamed.updated const updatedColumn = json.meta.renamed.updated
const tableName = schemaName const tableName = schemaName
? `\`${schemaName}\`.\`${json.table.name}\`` ? `\`${schemaName}\`.\`${json.table.name}\``
@ -280,14 +280,14 @@ class SqlTableQueryBuilder {
query = buildUpdateTable( query = buildUpdateTable(
client, client,
json.table, json.table,
json.meta.tables, json.tables,
json.meta.table, json.table,
json.meta.renamed! json.meta?.renamed
) )
// renameColumn for SQL Server returns a parameterised `sp_rename` query, // renameColumn for SQL Server returns a parameterised `sp_rename` query,
// which is not supported by SQL Server and gives a syntax error. // which is not supported by SQL Server and gives a syntax error.
if (this.sqlClient === SqlClient.MS_SQL && json.meta.renamed) { if (this.sqlClient === SqlClient.MS_SQL && json.meta?.renamed) {
const oldColumn = json.meta.renamed.old const oldColumn = json.meta.renamed.old
const updatedColumn = json.meta.renamed.updated const updatedColumn = json.meta.renamed.updated
const tableName = schemaName const tableName = schemaName

View File

@ -42,7 +42,7 @@ import {
sqlOutputProcessing, sqlOutputProcessing,
} from "./utils" } from "./utils"
import { import {
getDatasourceAndQuery, enrichQueryJson,
processRowCountResponse, processRowCountResponse,
} from "../../../sdk/app/rows/utils" } from "../../../sdk/app/rows/utils"
import { processObjectSync } from "@budibase/string-templates" import { processObjectSync } from "@budibase/string-templates"
@ -135,16 +135,9 @@ function cleanupConfig(config: RunConfig, table: Table): RunConfig {
return config return config
} }
function getEndpoint(tableId: string | undefined, operation: string) { function getEndpoint(tableId: string, operation: Operation) {
if (!tableId) {
throw new Error("Cannot get endpoint information - no table ID specified")
}
const { datasourceId, tableName } = breakExternalTableId(tableId) const { datasourceId, tableName } = breakExternalTableId(tableId)
return { return { datasourceId, entityId: tableName, operation }
datasourceId: datasourceId,
entityId: tableName,
operation: operation as Operation,
}
} }
function isOneSide( function isOneSide(
@ -268,12 +261,9 @@ export class ExternalRequest<T extends Operation> {
const filters = this.prepareFilters(rowId, {}, table) const filters = this.prepareFilters(rowId, {}, table)
// safety check, if there are no filters on deletion bad things happen // safety check, if there are no filters on deletion bad things happen
if (Object.keys(filters).length !== 0) { if (Object.keys(filters).length !== 0) {
return getDatasourceAndQuery({ return makeExternalQuery({
endpoint: getEndpoint(tableId, Operation.DELETE), endpoint: getEndpoint(tableId, Operation.DELETE),
filters, filters,
meta: {
table,
},
}) })
} else { } else {
return [] return []
@ -289,13 +279,10 @@ export class ExternalRequest<T extends Operation> {
const filters = this.prepareFilters(rowId, {}, table) const filters = this.prepareFilters(rowId, {}, table)
// safety check, if there are no filters on deletion bad things happen // safety check, if there are no filters on deletion bad things happen
if (Object.keys(filters).length !== 0) { if (Object.keys(filters).length !== 0) {
return getDatasourceAndQuery({ return makeExternalQuery({
endpoint: getEndpoint(tableId, Operation.UPDATE), endpoint: getEndpoint(tableId, Operation.UPDATE),
body: { [colName]: null }, body: { [colName]: null },
filters, filters,
meta: {
table,
},
}) })
} else { } else {
return [] return []
@ -311,12 +298,9 @@ export class ExternalRequest<T extends Operation> {
} }
async getRow(table: Table, rowId: string): Promise<Row> { async getRow(table: Table, rowId: string): Promise<Row> {
const response = await getDatasourceAndQuery({ const response = await makeExternalQuery({
endpoint: getEndpoint(table._id!, Operation.READ), endpoint: getEndpoint(table._id!, Operation.READ),
filters: this.prepareFilters(rowId, {}, table), filters: this.prepareFilters(rowId, {}, table),
meta: {
table,
},
}) })
if (Array.isArray(response) && response.length > 0) { if (Array.isArray(response) && response.length > 0) {
return response[0] return response[0]
@ -490,16 +474,13 @@ export class ExternalRequest<T extends Operation> {
if (!relatedTable) { if (!relatedTable) {
throw new Error("unable to find related table") throw new Error("unable to find related table")
} }
const response = await getDatasourceAndQuery({ const response = await makeExternalQuery({
endpoint: endpoint, endpoint,
filters: { filters: {
equal: { equal: {
[fieldName]: row[lookupField], [fieldName]: row[lookupField],
}, },
}, },
meta: {
table: relatedTable,
},
}) })
// this is the response from knex if no rows found // this is the response from knex if no rows found
const rows: Row[] = const rows: Row[] =
@ -537,6 +518,11 @@ export class ExternalRequest<T extends Operation> {
for (let relationship of relationships) { for (let relationship of relationships) {
const { key, tableId, isUpdate, id, relationshipType, ...rest } = const { key, tableId, isUpdate, id, relationshipType, ...rest } =
relationship relationship
if (!tableId) {
throw new Error("Table ID is unknown, cannot find table")
}
const body: { [key: string]: any } = processObjectSync(rest, row, {}) const body: { [key: string]: any } = processObjectSync(rest, row, {})
const linkTable = this.getTable(tableId) const linkTable = this.getTable(tableId)
const relationshipPrimary = linkTable?.primary || [] const relationshipPrimary = linkTable?.primary || []
@ -583,14 +569,11 @@ export class ExternalRequest<T extends Operation> {
const operation = isUpdate ? Operation.UPDATE : Operation.CREATE const operation = isUpdate ? Operation.UPDATE : Operation.CREATE
if (!existingRelationship) { if (!existingRelationship) {
promises.push( promises.push(
getDatasourceAndQuery({ makeExternalQuery({
endpoint: getEndpoint(tableId, operation), endpoint: getEndpoint(tableId, operation),
// if we're doing many relationships then we're writing, only one response // if we're doing many relationships then we're writing, only one response
body, body,
filters: this.prepareFilters(id, {}, linkTable), filters: this.prepareFilters(id, {}, linkTable),
meta: {
table: linkTable,
},
}) })
) )
} else { } else {
@ -749,10 +732,6 @@ export class ExternalRequest<T extends Operation> {
table table
), ),
}, },
meta: {
table,
tables: this.tables,
},
} }
// remove any relationships that could block deletion // remove any relationships that could block deletion
@ -773,8 +752,11 @@ export class ExternalRequest<T extends Operation> {
response = [unprocessedRow] response = [unprocessedRow]
} else { } else {
response = env.SQL_ALIASING_DISABLE response = env.SQL_ALIASING_DISABLE
? await getDatasourceAndQuery(json) ? await makeExternalQuery(json)
: await aliasing.queryWithAliasing(json, makeExternalQuery) : await aliasing.queryWithAliasing(
await enrichQueryJson(json),
makeExternalQuery
)
} }
// if it's a counting operation there will be no more processing, just return the number // if it's a counting operation there will be no more processing, just return the number

View File

@ -1,37 +1,27 @@
import { import { DatasourcePlusQueryResponse, QueryJson } from "@budibase/types"
QueryJson,
Datasource,
DatasourcePlusQueryResponse,
RowOperations,
} from "@budibase/types"
import { getIntegration } from "../index" import { getIntegration } from "../index"
import sdk from "../../sdk" import sdk from "../../sdk"
import { enrichQueryJson } from "../../sdk/app/rows/utils"
export async function makeExternalQuery( export async function makeExternalQuery(
datasource: Datasource,
json: QueryJson json: QueryJson
): Promise<DatasourcePlusQueryResponse> { ): Promise<DatasourcePlusQueryResponse> {
const entityId = json.endpoint.entityId, const enrichedJson = await enrichQueryJson(json)
tableName = json.meta.table.name, if (!enrichedJson.datasource) {
tableId = json.meta.table._id
// case found during testing - make sure this doesn't happen again
if (
RowOperations.includes(json.endpoint.operation) &&
entityId !== tableId &&
entityId !== tableName
) {
throw new Error("Entity ID and table metadata do not align")
}
if (!datasource) {
throw new Error("No datasource provided for external query") throw new Error("No datasource provided for external query")
} }
datasource = await sdk.datasources.enrich(datasource)
const Integration = await getIntegration(datasource.source) enrichedJson.datasource = await sdk.datasources.enrich(
enrichedJson.datasource
)
const Integration = await getIntegration(enrichedJson.datasource.source)
// query is the opinionated function // query is the opinionated function
if (Integration.prototype.query) { if (!Integration.prototype.query) {
const integration = new Integration(datasource.config)
return integration.query(json)
} else {
throw "Datasource does not support query." throw "Datasource does not support query."
} }
const integration = new Integration(enrichedJson.datasource.config)
return integration.query(json)
} }

View File

@ -4,9 +4,9 @@ import {
DatasourceFieldType, DatasourceFieldType,
DatasourcePlus, DatasourcePlus,
DatasourcePlusQueryResponse, DatasourcePlusQueryResponse,
EnrichedQueryJson,
Integration, Integration,
Operation, Operation,
QueryJson,
QueryType, QueryType,
Schema, Schema,
SourceName, SourceName,
@ -506,7 +506,7 @@ class SqlServerIntegration extends Sql implements DatasourcePlus {
return response.recordset || [{ deleted: true }] return response.recordset || [{ deleted: true }]
} }
async query(json: QueryJson): Promise<DatasourcePlusQueryResponse> { async query(json: EnrichedQueryJson): Promise<DatasourcePlusQueryResponse> {
const schema = this.config.schema const schema = this.config.schema
await this.connect() await this.connect()
if (schema && schema !== DEFAULT_SCHEMA && json?.endpoint) { if (schema && schema !== DEFAULT_SCHEMA && json?.endpoint) {
@ -515,14 +515,12 @@ class SqlServerIntegration extends Sql implements DatasourcePlus {
const operation = this._operation(json) const operation = this._operation(json)
const queryFn = (query: any, op: string) => this.internalQuery(query, op) const queryFn = (query: any, op: string) => this.internalQuery(query, op)
const processFn = (result: any) => { const processFn = (result: any) => {
if (json?.meta?.table && result.recordset) { if (result.recordset) {
return this.convertJsonStringColumns( return this.convertJsonStringColumns(
json.meta.table, json.table,
result.recordset, result.recordset,
json.tableAliases json.tableAliases
) )
} else if (result.recordset) {
return result.recordset
} }
return [{ [operation]: true }] return [{ [operation]: true }]
} }

View File

@ -2,7 +2,6 @@ import {
Integration, Integration,
DatasourceFieldType, DatasourceFieldType,
QueryType, QueryType,
QueryJson,
SqlQuery, SqlQuery,
Table, Table,
TableSchema, TableSchema,
@ -15,6 +14,7 @@ import {
DatasourcePlusQueryResponse, DatasourcePlusQueryResponse,
SqlQueryBinding, SqlQueryBinding,
SqlClient, SqlClient,
EnrichedQueryJson,
} from "@budibase/types" } from "@budibase/types"
import { import {
getSqlQuery, getSqlQuery,
@ -390,15 +390,15 @@ class MySQLIntegration extends Sql implements DatasourcePlus {
return results.length ? results : [{ deleted: true }] return results.length ? results : [{ deleted: true }]
} }
async query(json: QueryJson): Promise<DatasourcePlusQueryResponse> { async query(json: EnrichedQueryJson): Promise<DatasourcePlusQueryResponse> {
await this.connect() await this.connect()
try { try {
const queryFn = (query: any) => const queryFn = (query: any) =>
this.internalQuery(query, { connect: false, disableCoercion: true }) this.internalQuery(query, { connect: false, disableCoercion: true })
const processFn = (result: any) => { const processFn = (result: any) => {
if (json?.meta?.table && Array.isArray(result)) { if (Array.isArray(result)) {
return this.convertJsonStringColumns( return this.convertJsonStringColumns(
json.meta.table, json.table,
result, result,
json.tableAliases json.tableAliases
) )

View File

@ -3,7 +3,6 @@ import {
DatasourceFieldType, DatasourceFieldType,
Integration, Integration,
Operation, Operation,
QueryJson,
QueryType, QueryType,
SqlQuery, SqlQuery,
Table, Table,
@ -15,6 +14,7 @@ import {
Row, Row,
DatasourcePlusQueryResponse, DatasourcePlusQueryResponse,
SqlClient, SqlClient,
EnrichedQueryJson,
} from "@budibase/types" } from "@budibase/types"
import { import {
buildExternalTableId, buildExternalTableId,
@ -545,7 +545,7 @@ class OracleIntegration extends Sql implements DatasourcePlus {
: [{ deleted: true }] : [{ deleted: true }]
} }
async query(json: QueryJson): Promise<DatasourcePlusQueryResponse> { async query(json: EnrichedQueryJson): Promise<DatasourcePlusQueryResponse> {
const operation = this._operation(json) const operation = this._operation(json)
const input = this._query(json, { disableReturning: true }) as SqlQuery const input = this._query(json, { disableReturning: true }) as SqlQuery
if (Array.isArray(input)) { if (Array.isArray(input)) {

View File

@ -3,7 +3,6 @@ import {
Integration, Integration,
DatasourceFieldType, DatasourceFieldType,
QueryType, QueryType,
QueryJson,
SqlQuery, SqlQuery,
Table, Table,
DatasourcePlus, DatasourcePlus,
@ -14,6 +13,7 @@ import {
TableSourceType, TableSourceType,
DatasourcePlusQueryResponse, DatasourcePlusQueryResponse,
SqlClient, SqlClient,
EnrichedQueryJson,
} from "@budibase/types" } from "@budibase/types"
import { import {
getSqlQuery, getSqlQuery,
@ -419,7 +419,7 @@ class PostgresIntegration extends Sql implements DatasourcePlus {
return response.rows.length ? response.rows : [{ deleted: true }] return response.rows.length ? response.rows : [{ deleted: true }]
} }
async query(json: QueryJson): Promise<DatasourcePlusQueryResponse> { async query(json: EnrichedQueryJson): Promise<DatasourcePlusQueryResponse> {
const operation = this._operation(json).toLowerCase() const operation = this._operation(json).toLowerCase()
const input = this._query(json) as SqlQuery const input = this._query(json) as SqlQuery
if (Array.isArray(input)) { if (Array.isArray(input)) {

View File

@ -61,7 +61,6 @@
"extra": { "extra": {
"idFilter": {} "idFilter": {}
}, },
"meta": {
"table": { "table": {
"type": "table", "type": "table",
"_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons", "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons",
@ -167,7 +166,6 @@
"sourceType": "external", "sourceType": "external",
"primaryDisplay": "firstname", "primaryDisplay": "firstname",
"views": {} "views": {}
}
}, },
"tableAliases": { "tableAliases": {
"persons": "a", "persons": "a",

View File

@ -5,10 +5,7 @@
"operation": "CREATE" "operation": "CREATE"
}, },
"resource": { "resource": {
"fields": [ "fields": ["a.name", "a.age"]
"a.name",
"a.age"
]
}, },
"filters": {}, "filters": {},
"relationships": [], "relationships": [],
@ -24,16 +21,12 @@
} }
} }
}, },
"meta": {
"table": { "table": {
"_id": "datasource_plus_0ed5835e5552496285df546030f7c4ae__people", "_id": "datasource_plus_0ed5835e5552496285df546030f7c4ae__people",
"type": "table", "type": "table",
"sourceId": "datasource_plus_0ed5835e5552496285df546030f7c4ae", "sourceId": "datasource_plus_0ed5835e5552496285df546030f7c4ae",
"sourceType": "external", "sourceType": "external",
"primary": [ "primary": ["name", "age"],
"name",
"age"
],
"name": "people", "name": "people",
"schema": { "schema": {
"name": { "name": {
@ -56,7 +49,6 @@
} }
}, },
"primaryDisplay": "name" "primaryDisplay": "name"
}
}, },
"tableAliases": { "tableAliases": {
"people": "a" "people": "a"

View File

@ -52,12 +52,9 @@
"idFilter": {} "idFilter": {}
}, },
"meta": { "meta": {
"table": {
"type": "table", "type": "table",
"_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons", "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons",
"primary": [ "primary": ["personid"],
"personid"
],
"name": "persons", "name": "persons",
"schema": { "schema": {
"year": { "year": {
@ -112,12 +109,7 @@
"name": "type", "name": "type",
"constraints": { "constraints": {
"presence": false, "presence": false,
"inclusion": [ "inclusion": ["support", "designer", "programmer", "qa"]
"support",
"designer",
"programmer",
"qa"
]
} }
}, },
"city": { "city": {
@ -164,7 +156,6 @@
"sourceType": "external", "sourceType": "external",
"primaryDisplay": "firstname", "primaryDisplay": "firstname",
"views": {} "views": {}
}
}, },
"tableAliases": { "tableAliases": {
"persons": "a", "persons": "a",

View File

@ -5,11 +5,7 @@
"operation": "DELETE" "operation": "DELETE"
}, },
"resource": { "resource": {
"fields": [ "fields": ["a.keyparttwo", "a.keypartone", "a.name"]
"a.keyparttwo",
"a.keypartone",
"a.name"
]
}, },
"filters": { "filters": {
"equal": { "equal": {
@ -26,14 +22,10 @@
} }
} }
}, },
"meta": {
"table": { "table": {
"type": "table", "type": "table",
"_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__compositetable", "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__compositetable",
"primary": [ "primary": ["keypartone", "keyparttwo"],
"keypartone",
"keyparttwo"
],
"name": "compositetable", "name": "compositetable",
"schema": { "schema": {
"keyparttwo": { "keyparttwo": {
@ -67,7 +59,6 @@
"sourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7", "sourceId": "datasource_plus_8066e56456784eb2a00129d31be5c3e7",
"sourceType": "external", "sourceType": "external",
"primaryDisplay": "keypartone" "primaryDisplay": "keypartone"
}
}, },
"tableAliases": { "tableAliases": {
"compositetable": "a" "compositetable": "a"

View File

@ -17,10 +17,7 @@
}, },
"filters": { "filters": {
"oneOf": { "oneOf": {
"taskid": [ "taskid": [1, 2]
1,
2
]
} }
}, },
"relationships": [ "relationships": [
@ -42,13 +39,10 @@
"extra": { "extra": {
"idFilter": {} "idFilter": {}
}, },
"meta": {
"table": { "table": {
"type": "table", "type": "table",
"_id": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__tasks", "_id": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__tasks",
"primary": [ "primary": ["taskid"],
"taskid"
],
"name": "tasks", "name": "tasks",
"schema": { "schema": {
"executorid": { "executorid": {
@ -113,7 +107,6 @@
"primaryDisplay": "taskname", "primaryDisplay": "taskname",
"sql": true, "sql": true,
"views": {} "views": {}
}
}, },
"tableAliases": { "tableAliases": {
"tasks": "a", "tasks": "a",

View File

@ -56,7 +56,6 @@
"extra": { "extra": {
"idFilter": {} "idFilter": {}
}, },
"meta": {
"table": { "table": {
"type": "table", "type": "table",
"_id": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__products", "_id": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__products",
@ -97,7 +96,6 @@
"sourceId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81", "sourceId": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81",
"sourceType": "external", "sourceType": "external",
"primaryDisplay": "productname" "primaryDisplay": "productname"
}
}, },
"tableAliases": { "tableAliases": {
"products": "a", "products": "a",

View File

@ -46,7 +46,6 @@
"tasks": "b", "tasks": "b",
"products": "a" "products": "a"
}, },
"meta": {
"table": { "table": {
"type": "table", "type": "table",
"_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__products", "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__products",
@ -88,5 +87,4 @@
"sourceType": "external", "sourceType": "external",
"primaryDisplay": "productname" "primaryDisplay": "productname"
} }
}
} }

View File

@ -102,7 +102,6 @@
"extra": { "extra": {
"idFilter": {} "idFilter": {}
}, },
"meta": {
"table": { "table": {
"type": "table", "type": "table",
"_id": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__tasks", "_id": "datasource_plus_44a967caf37a435f84fe01cd6dfe8f81__tasks",
@ -189,7 +188,6 @@
"primaryDisplay": "taskname", "primaryDisplay": "taskname",
"sql": true, "sql": true,
"views": {} "views": {}
}
}, },
"tableAliases": { "tableAliases": {
"tasks": "a", "tasks": "a",

View File

@ -59,13 +59,10 @@
} }
} }
}, },
"meta": {
"table": { "table": {
"type": "table", "type": "table",
"_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons", "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons",
"primary": [ "primary": ["personid"],
"personid"
],
"name": "persons", "name": "persons",
"schema": { "schema": {
"year": { "year": {
@ -120,12 +117,7 @@
"name": "type", "name": "type",
"constraints": { "constraints": {
"presence": false, "presence": false,
"inclusion": [ "inclusion": ["support", "designer", "programmer", "qa"]
"support",
"designer",
"programmer",
"qa"
]
} }
}, },
"city": { "city": {
@ -172,7 +164,6 @@
"sourceType": "external", "sourceType": "external",
"primaryDisplay": "firstname", "primaryDisplay": "firstname",
"views": {} "views": {}
}
}, },
"tableAliases": { "tableAliases": {
"persons": "a", "persons": "a",

View File

@ -59,13 +59,10 @@
} }
} }
}, },
"meta": {
"table": { "table": {
"type": "table", "type": "table",
"_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons", "_id": "datasource_plus_8066e56456784eb2a00129d31be5c3e7__persons",
"primary": [ "primary": ["personid"],
"personid"
],
"name": "persons", "name": "persons",
"schema": { "schema": {
"year": { "year": {
@ -120,12 +117,7 @@
"name": "type", "name": "type",
"constraints": { "constraints": {
"presence": false, "presence": false,
"inclusion": [ "inclusion": ["support", "designer", "programmer", "qa"]
"support",
"designer",
"programmer",
"qa"
]
} }
}, },
"city": { "city": {
@ -172,7 +164,6 @@
"sourceType": "external", "sourceType": "external",
"primaryDisplay": "firstname", "primaryDisplay": "firstname",
"views": {} "views": {}
}
}, },
"tableAliases": { "tableAliases": {
"persons": "a", "persons": "a",

View File

@ -1,8 +1,8 @@
import { import {
Aggregation, Aggregation,
CalculationType, CalculationType,
Datasource,
DocumentType, DocumentType,
EnrichedQueryJson,
FieldType, FieldType,
isLogicalSearchOperator, isLogicalSearchOperator,
Operation, Operation,
@ -38,7 +38,7 @@ import { generateJunctionTableID } from "../../../../../db/utils"
import AliasTables from "../../sqlAlias" import AliasTables from "../../sqlAlias"
import { outputProcessing } from "../../../../../utilities/rowProcessor" import { outputProcessing } from "../../../../../utilities/rowProcessor"
import pick from "lodash/pick" import pick from "lodash/pick"
import { processRowCountResponse } from "../../utils" import { enrichQueryJson, processRowCountResponse } from "../../utils"
import { import {
dataFilters, dataFilters,
helpers, helpers,
@ -223,18 +223,18 @@ function reverseUserColumnMapping(rows: Row[], table?: Table) {
} }
function runSqlQuery( function runSqlQuery(
json: QueryJson, json: EnrichedQueryJson,
tables: Table[], tables: Table[],
relationships: RelationshipsJson[] relationships: RelationshipsJson[]
): Promise<Row[]> ): Promise<Row[]>
function runSqlQuery( function runSqlQuery(
json: QueryJson, json: EnrichedQueryJson,
tables: Table[], tables: Table[],
relationships: RelationshipsJson[], relationships: RelationshipsJson[],
opts: { countTotalRows: true } opts: { countTotalRows: true }
): Promise<number> ): Promise<number>
async function runSqlQuery( async function runSqlQuery(
json: QueryJson, json: EnrichedQueryJson,
tables: Table[], tables: Table[],
relationships: RelationshipsJson[], relationships: RelationshipsJson[],
opts?: { countTotalRows?: boolean } opts?: { countTotalRows?: boolean }
@ -246,7 +246,7 @@ async function runSqlQuery(
if (opts?.countTotalRows) { if (opts?.countTotalRows) {
json.endpoint.operation = Operation.COUNT json.endpoint.operation = Operation.COUNT
} }
const processSQLQuery = async (_: Datasource, json: QueryJson) => { const processSQLQuery = async (json: EnrichedQueryJson) => {
const query = builder._query(json, { const query = builder._query(json, {
disableReturning: true, disableReturning: true,
}) })
@ -281,7 +281,7 @@ async function runSqlQuery(
if (opts?.countTotalRows) { if (opts?.countTotalRows) {
return processRowCountResponse(response) return processRowCountResponse(response)
} else if (Array.isArray(response)) { } else if (Array.isArray(response)) {
return reverseUserColumnMapping(response, json.meta.table) return reverseUserColumnMapping(response, json.table)
} }
return response return response
} }
@ -372,10 +372,7 @@ export async function search(
operation: Operation.READ, operation: Operation.READ,
}, },
filters: searchFilters, filters: searchFilters,
table,
meta: { meta: {
table,
tables: allTablesMap,
columnPrefix: USER_COLUMN_PREFIX, columnPrefix: USER_COLUMN_PREFIX,
}, },
resource: { resource: {
@ -427,11 +424,13 @@ export async function search(
} }
} }
const enrichedRequest = await enrichQueryJson(request)
try { try {
const [rows, totalRows] = await Promise.all([ const [rows, totalRows] = await Promise.all([
runSqlQuery(request, allTables, relationships), runSqlQuery(enrichedRequest, allTables, relationships),
options.countRows options.countRows
? runSqlQuery(request, allTables, relationships, { ? runSqlQuery(enrichedRequest, allTables, relationships, {
countTotalRows: true, countTotalRows: true,
}) })
: Promise.resolve(undefined), : Promise.resolve(undefined),

View File

@ -1,11 +1,13 @@
import { import {
Datasource, Datasource,
DatasourcePlusQueryResponse, DatasourcePlusQueryResponse,
EnrichedQueryJson,
Operation, Operation,
QueryJson, QueryJson,
Row, Row,
SearchFilters, SearchFilters,
SqlClient, SqlClient,
Table,
} from "@budibase/types" } from "@budibase/types"
import { SQS_DATASOURCE_INTERNAL } from "@budibase/backend-core" import { SQS_DATASOURCE_INTERNAL } from "@budibase/backend-core"
import { getSQLClient } from "./utils" import { getSQLClient } from "./utils"
@ -15,7 +17,6 @@ import { BudibaseInternalDB } from "../../../db/utils"
import { dataFilters } from "@budibase/shared-core" import { dataFilters } from "@budibase/shared-core"
type PerformQueryFunction = ( type PerformQueryFunction = (
datasource: Datasource,
json: QueryJson json: QueryJson
) => Promise<DatasourcePlusQueryResponse> ) => Promise<DatasourcePlusQueryResponse>
@ -99,7 +100,11 @@ export default class AliasTables {
return true return true
} }
getAlias(tableName: string) { getAlias(tableName: string | Table) {
if (typeof tableName === "object") {
tableName = tableName.name
}
if (this.aliases[tableName]) { if (this.aliases[tableName]) {
return this.aliases[tableName] return this.aliases[tableName]
} }
@ -177,7 +182,7 @@ export default class AliasTables {
} }
async queryWithAliasing( async queryWithAliasing(
json: QueryJson, json: EnrichedQueryJson,
queryFn: PerformQueryFunction queryFn: PerformQueryFunction
): Promise<DatasourcePlusQueryResponse> { ): Promise<DatasourcePlusQueryResponse> {
const datasourceId = json.endpoint.datasourceId const datasourceId = json.endpoint.datasourceId
@ -215,14 +220,7 @@ export default class AliasTables {
} }
json.filters = aliasFilters(json.filters) json.filters = aliasFilters(json.filters)
} }
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) { if (json.relationships) {
json.relationships = json.relationships.map(relationship => ({ json.relationships = json.relationships.map(relationship => ({
...relationship, ...relationship,
@ -233,6 +231,12 @@ export default class AliasTables {
]), ]),
})) }))
} }
this.getAlias(json.table)
for (const tableName of Object.keys(json.tables)) {
this.getAlias(tableName)
}
// invert and return // invert and return
const invertedTableAliases: Record<string, string> = {} const invertedTableAliases: Record<string, string> = {}
for (let [key, value] of Object.entries(this.tableAliases)) { for (let [key, value] of Object.entries(this.tableAliases)) {
@ -241,7 +245,7 @@ export default class AliasTables {
json.tableAliases = invertedTableAliases json.tableAliases = invertedTableAliases
} }
let response: DatasourcePlusQueryResponse = await queryFn(datasource, json) let response = await queryFn(json)
if (Array.isArray(response) && aliasingEnabled) { if (Array.isArray(response) && aliasingEnabled) {
return this.reverse(response) return this.reverse(response)
} else { } else {

View File

@ -14,13 +14,13 @@ import {
SqlClient, SqlClient,
ArrayOperator, ArrayOperator,
ViewV2, ViewV2,
EnrichedQueryJson,
} from "@budibase/types" } from "@budibase/types"
import { makeExternalQuery } from "../../../integrations/base/query"
import { Format } from "../../../api/controllers/view/exporters" import { Format } from "../../../api/controllers/view/exporters"
import sdk from "../.." import sdk from "../.."
import { extractViewInfoFromID, isRelationshipColumn } from "../../../db/utils" import { extractViewInfoFromID, isRelationshipColumn } from "../../../db/utils"
import { isSQL } from "../../../integrations/utils" import { isSQL } from "../../../integrations/utils"
import { docIds, sql } from "@budibase/backend-core" import { docIds, sql, SQS_DATASOURCE_INTERNAL } from "@budibase/backend-core"
import { getTableFromSource } from "../../../api/controllers/row/utils" import { getTableFromSource } from "../../../api/controllers/row/utils"
import env from "../../../environment" import env from "../../../environment"
@ -73,18 +73,32 @@ export function processRowCountResponse(
} }
} }
export async function getDatasourceAndQuery( export async function enrichQueryJson(
json: QueryJson json: QueryJson
): Promise<DatasourcePlusQueryResponse> { ): Promise<EnrichedQueryJson> {
const datasourceId = json.endpoint.datasourceId let datasource: Datasource | undefined = undefined
const datasource = await sdk.datasources.get(datasourceId) if (json.endpoint.datasourceId !== SQS_DATASOURCE_INTERNAL) {
const table = datasource.entities?.[json.endpoint.entityId] datasource = await sdk.datasources.get(json.endpoint.datasourceId)
if (!json.meta && table) { }
json.meta = {
let tables: Record<string, Table>
if (datasource) {
tables = datasource.entities || {}
} else {
tables = {}
for (const table of await sdk.tables.getAllInternalTables()) {
tables[table._id!] = table
}
}
const table = tables[json.endpoint.entityId]
return {
table, table,
tables,
datasource,
...json,
} }
}
return makeExternalQuery(datasource, json)
} }
export function cleanExportRows( export function cleanExportRows(

View File

@ -1,5 +1,5 @@
import { Table, Row } from "../documents" import { Table, Row } from "../documents"
import { QueryJson } from "./search" import { EnrichedQueryJson } from "./search"
export const PASSWORD_REPLACEMENT = "--secret-value--" export const PASSWORD_REPLACEMENT = "--secret-value--"
@ -207,7 +207,7 @@ export interface DatasourcePlus extends IntegrationBase {
// this returns the format of the identifier // this returns the format of the identifier
getBindingIdentifier(): string getBindingIdentifier(): string
getStringConcat(parts: string[]): string getStringConcat(parts: string[]): string
query(json: QueryJson): Promise<DatasourcePlusQueryResponse> query(json: EnrichedQueryJson): Promise<DatasourcePlusQueryResponse>
buildSchema( buildSchema(
datasourceId: string, datasourceId: string,
entities: Record<string, Table> entities: Record<string, Table>

View File

@ -1,5 +1,5 @@
import { Operation } from "./datasources" import { Operation } from "./datasources"
import { Row, Table, DocumentType } from "../documents" import { Row, DocumentType, Table, Datasource } from "../documents"
import { SortOrder, SortType } from "../api" import { SortOrder, SortType } from "../api"
import { Knex } from "knex" import { Knex } from "knex"
import { Aggregation } from "./row" import { Aggregation } from "./row"
@ -171,10 +171,7 @@ export interface QueryJson {
sort?: SortJson sort?: SortJson
paginate?: PaginationJson paginate?: PaginationJson
body?: Row | Row[] body?: Row | Row[]
table?: Table meta?: {
meta: {
table: Table
tables?: Record<string, Table>
renamed?: RenameColumn renamed?: RenameColumn
// can specify something that columns could be prefixed with // can specify something that columns could be prefixed with
columnPrefix?: string columnPrefix?: string
@ -186,6 +183,12 @@ export interface QueryJson {
tableAliases?: Record<string, string> tableAliases?: Record<string, string>
} }
export interface EnrichedQueryJson extends QueryJson {
table: Table
tables: Record<string, Table>
datasource?: Datasource
}
export interface QueryOptions { export interface QueryOptions {
disableReturning?: boolean disableReturning?: boolean
disableBindings?: boolean disableBindings?: boolean