|
| 1 | +/* eslint-env node */ |
| 2 | +import { readFileSync, readdirSync, writeFileSync } from 'fs-extra'; |
| 3 | +import { resolve, join } from 'path'; |
| 4 | +import { |
| 5 | + parse, |
| 6 | + type CreateTableStmt, |
| 7 | + type AlterTableStmt, |
| 8 | + type Program, |
| 9 | +} from 'sql-parser-cst'; |
| 10 | + |
| 11 | +// Currently this script only cares about CREATE TABLE statements and ALTER |
| 12 | +// TABLE statements that add primary key constraints. All the other schema aspects of the |
| 13 | +// pg_dump are generally beyond the capability of SQLite. Perhaps index creation |
| 14 | +// can be added but it will get really tricky fast since SQLite's indices are |
| 15 | +// much more simplistic than postgres. |
| 16 | + |
| 17 | +const args = process.argv; |
| 18 | +const migrationsDir = resolve(join(__dirname, '..', 'migrations')); |
| 19 | +const sqliteSchemaDir = resolve( |
| 20 | + join(__dirname, '..', '..', 'host', 'config', 'schema'), |
| 21 | +); |
| 22 | +const INDENT = ' '; |
| 23 | + |
| 24 | +let pgDumpFile = args[2]; |
| 25 | +if (!pgDumpFile) { |
| 26 | + console.error(`please specify the path of the pg_dump file`); |
| 27 | + process.exit(-1); |
| 28 | +} |
| 29 | +let pgDump = readFileSync(pgDumpFile, 'utf8'); |
| 30 | + |
| 31 | +let cst = parse(prepareDump(pgDump), { |
| 32 | + dialect: 'postgresql', |
| 33 | +}); |
| 34 | + |
| 35 | +let sql: string[] = [ |
| 36 | + ` |
| 37 | +-- This is auto-generated by packages/realm-server/scripts/convert-to-sqlite.ts |
| 38 | +-- Please don't directly modify this file |
| 39 | +
|
| 40 | +`, |
| 41 | +]; |
| 42 | +for (let statement of cst.statements) { |
| 43 | + if (statement.type !== 'create_table_stmt') { |
| 44 | + continue; |
| 45 | + } |
| 46 | + sql.push('CREATE TABLE IF NOT EXISTS'); |
| 47 | + if ( |
| 48 | + statement.name.type === 'member_expr' && |
| 49 | + statement.name.property.type === 'identifier' |
| 50 | + ) { |
| 51 | + let tableName = statement.name.property.name; |
| 52 | + sql.push(statement.name.property.name, '(\n'); |
| 53 | + createColumns(cst, tableName, statement, sql); |
| 54 | + } else { |
| 55 | + throw new Error(`could not determine table name to be created`); |
| 56 | + } |
| 57 | + |
| 58 | + sql.push('\n);\n\n'); |
| 59 | +} |
| 60 | + |
| 61 | +let result = sql.join(' ').trim(); |
| 62 | +let filename = getSchemaFilename(); |
| 63 | +let schemaFile = join(sqliteSchemaDir, filename); |
| 64 | +writeFileSync(schemaFile, result); |
| 65 | +console.log(`created SQLite schema file ${schemaFile}`); |
| 66 | + |
| 67 | +function createColumns( |
| 68 | + cst: Program, |
| 69 | + tableName: string, |
| 70 | + statement: CreateTableStmt, |
| 71 | + sql: string[], |
| 72 | +) { |
| 73 | + if (!statement.columns) { |
| 74 | + return; |
| 75 | + } |
| 76 | + let columns: string[] = []; |
| 77 | + for (let [index, item] of statement.columns.expr.items.entries()) { |
| 78 | + if (item.type !== 'column_definition') { |
| 79 | + continue; |
| 80 | + } |
| 81 | + let column: string[] = []; |
| 82 | + column.push(index === 0 ? INDENT.substring(1) : INDENT, item.name.name); |
| 83 | + if (item.dataType?.type === 'named_data_type') { |
| 84 | + let dataTypeName = Array.isArray(item.dataType.nameKw) |
| 85 | + ? item.dataType.nameKw[0] |
| 86 | + : item.dataType.nameKw; |
| 87 | + switch (dataTypeName.name) { |
| 88 | + case 'CHARACTER': |
| 89 | + column.push('TEXT'); |
| 90 | + break; |
| 91 | + case 'JSONB': |
| 92 | + // TODO change this to 'BLOB' after we do the sqlite BLOB storage |
| 93 | + // support in CS-6668 for faster performance |
| 94 | + column.push('JSON'); |
| 95 | + break; |
| 96 | + case 'BOOLEAN': |
| 97 | + column.push('BOOLEAN'); |
| 98 | + break; |
| 99 | + case 'INTEGER': |
| 100 | + column.push('INTEGER'); |
| 101 | + break; |
| 102 | + } |
| 103 | + } |
| 104 | + for (let constraint of item.constraints) { |
| 105 | + switch (constraint.type) { |
| 106 | + case 'constraint_not_null': |
| 107 | + column.push('NOT NULL'); |
| 108 | + break; |
| 109 | + case 'constraint_primary_key': |
| 110 | + column.push('PRIMARY KEY'); |
| 111 | + break; |
| 112 | + default: |
| 113 | + throw new Error( |
| 114 | + `Don't know how to serialize constraint ${constraint.type} for column '${item.name.name}'`, |
| 115 | + ); |
| 116 | + } |
| 117 | + } |
| 118 | + |
| 119 | + columns.push(column.join(' ')); |
| 120 | + } |
| 121 | + let pkConstraint = makePrimaryKeyConstraint(cst, tableName); |
| 122 | + sql.push([...columns, ...(pkConstraint ? [pkConstraint] : [])].join(',\n')); |
| 123 | +} |
| 124 | + |
| 125 | +function makePrimaryKeyConstraint( |
| 126 | + cst: Program, |
| 127 | + tableName: string, |
| 128 | +): string | undefined { |
| 129 | + let alterTableStmts = cst.statements.filter( |
| 130 | + (s) => |
| 131 | + s.type === 'alter_table_stmt' && |
| 132 | + s.table.type === 'table_without_inheritance' && |
| 133 | + s.table.table.type === 'member_expr' && |
| 134 | + s.table.table.property.type === 'identifier' && |
| 135 | + s.table.table.property.name === tableName, |
| 136 | + ) as AlterTableStmt[]; |
| 137 | + let pkConstraint: string[] = []; |
| 138 | + for (let alterTableStmt of alterTableStmts) { |
| 139 | + for (let item of alterTableStmt.actions.items) { |
| 140 | + if (item.type === 'alter_action_add_constraint') { |
| 141 | + switch (item.constraint.type) { |
| 142 | + case 'constraint_primary_key': { |
| 143 | + if (pkConstraint.length > 0) { |
| 144 | + throw new Error( |
| 145 | + `encountered multiple primary key constraints for table ${tableName}`, |
| 146 | + ); |
| 147 | + } |
| 148 | + if (item.constraint.columns) { |
| 149 | + let columns: string[] = []; |
| 150 | + if (item.constraint.columns.type === 'paren_expr') { |
| 151 | + for (let column of item.constraint.columns.expr.items) { |
| 152 | + if ( |
| 153 | + column.type === 'index_specification' && |
| 154 | + column.expr.type === 'identifier' |
| 155 | + ) { |
| 156 | + columns.push(column.expr.name); |
| 157 | + } |
| 158 | + } |
| 159 | + } else { |
| 160 | + throw new Error( |
| 161 | + `Don't know how to serialize constraint ${item.constraint.type} for table '${tableName}'`, |
| 162 | + ); |
| 163 | + } |
| 164 | + if (columns.length > 0) { |
| 165 | + pkConstraint.push( |
| 166 | + INDENT, |
| 167 | + 'PRIMARY KEY (', |
| 168 | + columns.join(', '), |
| 169 | + ')', |
| 170 | + ); |
| 171 | + } |
| 172 | + } |
| 173 | + break; |
| 174 | + } |
| 175 | + default: |
| 176 | + throw new Error( |
| 177 | + `Don't know how to serialize constraint ${item.constraint.type} for table '${tableName}'`, |
| 178 | + ); |
| 179 | + } |
| 180 | + } |
| 181 | + } |
| 182 | + } |
| 183 | + if (pkConstraint.length === 0) { |
| 184 | + return undefined; |
| 185 | + } |
| 186 | + return pkConstraint.join(' '); |
| 187 | +} |
| 188 | + |
| 189 | +// This strips out all the things that our SQL AST chokes on (it's still in an |
| 190 | +// experimental phase for postgresql) |
| 191 | +function prepareDump(sql: string): string { |
| 192 | + let result = sql |
| 193 | + .replace(/\s*SET\s[^;].*;/gm, '') |
| 194 | + .replace(/\s*CREATE\sTYPE\s[^;]*;/gm, ''); |
| 195 | + return result; |
| 196 | +} |
| 197 | + |
| 198 | +function getSchemaFilename(): string { |
| 199 | + let files = readdirSync(migrationsDir); |
| 200 | + let lastFile = files |
| 201 | + .filter((f) => f !== '.eslintrc.js') |
| 202 | + .sort() |
| 203 | + .pop()!; |
| 204 | + return `${lastFile.replace(/_.*/, '')}_schema.sql`; |
| 205 | +} |
0 commit comments