import { Knex, knex } from "knex" import { RelationshipType, FieldSubtype, NumberFieldMetadata, Operation, QueryJson, RenameColumn, Table, FieldType, } from "@budibase/types" import { breakExternalTableId, SqlClient } from "../utils" import SchemaBuilder = Knex.SchemaBuilder import CreateTableBuilder = Knex.CreateTableBuilder import { utils } from "@budibase/shared-core" function isIgnoredType(type: FieldType) { const ignored = [FieldType.LINK, FieldType.FORMULA] return ignored.indexOf(type) !== -1 } function generateSchema( schema: CreateTableBuilder, table: Table, tables: Record, oldTable: null | Table = null, renamed?: RenameColumn ) { let primaryKey = table && table.primary ? table.primary[0] : null const columns = Object.values(table.schema) // all columns in a junction table will be meta let metaCols = columns.filter(col => (col as NumberFieldMetadata).meta) let isJunction = metaCols.length === columns.length // can't change primary once its set for now if (primaryKey && !oldTable && !isJunction) { schema.increments(primaryKey).primary() } else if (!oldTable && isJunction) { schema.primary(metaCols.map(col => col.name)) } // check if any columns need added const foreignKeys = Object.values(table.schema).map( col => (col as any).foreignKey ) for (let [key, column] of Object.entries(table.schema)) { // skip things that are already correct const oldColumn = oldTable ? oldTable.schema[key] : null if ( (oldColumn && oldColumn.type) || (primaryKey === key && !isJunction) || renamed?.updated === key ) { continue } switch (column.type) { case FieldType.STRING: case FieldType.OPTIONS: case FieldType.LONGFORM: case FieldType.BARCODEQR: schema.text(key) break case FieldType.BB_REFERENCE: const subtype = column.subtype as FieldSubtype switch (subtype) { case FieldSubtype.USER: schema.text(key) break case FieldSubtype.USERS: schema.json(key) break default: throw utils.unreachable(subtype) } break case FieldType.NUMBER: // if meta is specified then this is a junction table entry if (column.meta && column.meta.toKey && column.meta.toTable) { const { toKey, toTable } = column.meta schema.integer(key).unsigned() schema.foreign(key).references(`${toTable}.${toKey}`) } else if (foreignKeys.indexOf(key) === -1) { schema.float(key) } break case FieldType.BIGINT: schema.bigint(key) break case FieldType.BOOLEAN: schema.boolean(key) break case FieldType.DATETIME: schema.datetime(key, { useTz: !column.ignoreTimezones, }) break case FieldType.ARRAY: schema.json(key) break case FieldType.LINK: // this side of the relationship doesn't need any SQL work if ( column.relationshipType !== RelationshipType.MANY_TO_ONE && column.relationshipType !== RelationshipType.MANY_TO_MANY ) { if (!column.foreignKey || !column.tableId) { throw "Invalid relationship schema" } const { tableName } = breakExternalTableId(column.tableId) // @ts-ignore const relatedTable = tables[tableName] if (!relatedTable) { throw "Referenced table doesn't exist" } const relatedPrimary = relatedTable.primary[0] const externalType = relatedTable.schema[relatedPrimary].externalType if (externalType) { schema.specificType(column.foreignKey, externalType) } else { schema.integer(column.foreignKey).unsigned() } schema .foreign(column.foreignKey) .references(`${tableName}.${relatedPrimary}`) } break } } const oldType = renamed ? oldTable?.schema[renamed.old].type : undefined if (renamed && oldType && !isIgnoredType(oldType)) { schema.renameColumn(renamed.old, renamed.updated) } // need to check if any columns have been deleted if (oldTable) { const deletedColumns = Object.entries(oldTable.schema).filter( ([key, column]) => !isIgnoredType(column.type) && table.schema[key] == null ) deletedColumns.forEach(([key, column]) => { if (renamed?.old === key || isIgnoredType(column.type)) { return } if (oldTable.constrained && oldTable.constrained.indexOf(key) !== -1) { schema.dropForeign(key) } schema.dropColumn(key) }) } return schema } function buildCreateTable( knex: SchemaBuilder, table: Table, tables: Record ): SchemaBuilder { return knex.createTable(table.name, schema => { generateSchema(schema, table, tables) }) } function buildUpdateTable( knex: SchemaBuilder, table: Table, tables: Record, oldTable: Table, renamed: RenameColumn ): SchemaBuilder { return knex.alterTable(table.name, schema => { generateSchema(schema, table, tables, oldTable, renamed) }) } function buildDeleteTable(knex: SchemaBuilder, table: Table): SchemaBuilder { return knex.dropTable(table.name) } class SqlTableQueryBuilder { private readonly sqlClient: string // pass through client to get flavour of SQL constructor(client: string) { this.sqlClient = client } getSqlClient(): string { return this.sqlClient } /** * @param json the input JSON structure from which an SQL query will be built. * @return the operation that was found in the JSON. */ _operation(json: QueryJson): Operation { return json.endpoint.operation } _tableQuery(json: QueryJson): Knex.Sql | Knex.SqlNative { let client = knex({ client: this.sqlClient }).schema let schemaName = json?.endpoint?.schema if (schemaName) { client = client.withSchema(schemaName) } let query: Knex.SchemaBuilder if (!json.table || !json.meta || !json.meta.tables) { throw "Cannot execute without table being specified" } switch (this._operation(json)) { case Operation.CREATE_TABLE: query = buildCreateTable(client, json.table, json.meta.tables) break case Operation.UPDATE_TABLE: if (!json.meta || !json.meta.table) { throw "Must specify old table for update" } // renameColumn does not work for MySQL, so return a raw query if (this.sqlClient === SqlClient.MY_SQL && json.meta.renamed) { const updatedColumn = json.meta.renamed.updated const tableName = schemaName ? `\`${schemaName}\`.\`${json.table.name}\`` : `\`${json.table.name}\`` const externalType = json.table.schema[updatedColumn].externalType! return { sql: `alter table ${tableName} change column \`${json.meta.renamed.old}\` \`${updatedColumn}\` ${externalType};`, bindings: [], } } query = buildUpdateTable( client, json.table, json.meta.tables, json.meta.table, json.meta.renamed! ) break case Operation.DELETE_TABLE: query = buildDeleteTable(client, json.table) break default: throw "Table operation is of unknown type" } return query.toSQL() } } export default SqlTableQueryBuilder