@l-v-yonsama/multi-platform-database-drivers 0.14.4 → 1.1.0

package/built/src/helpers/SQLHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.separateMultipleQueries = exports.toCreateTableDDL = exports.needsQuoting = exports.wrapQuote = exports.wrapBackQuote = exports.wrapDoubleQuote = exports.wrapSingleQuote = exports.resolveLastOrderByColumn = exports.getResourcePositions = exports.getProposals = exports.createTableDefinisionsForPrompt = exports.normalizeSimpleParametersQuery = exports.normalizePositionedParametersQuery = exports.normalizeQuery = exports.parseQuery = exports.hasSetVariableClause = exports.toSafeQueryForPgsqlAst = exports.toViewDataNormalizedQuery = exports.toViewDataQuery = exports.createColumnNames = exports.createTableNames = exports.toCountRecordsQuery = exports.toViewRecordsQuery = exports.toDeleteStatement = exports.toUpdateStatement = exports.toInsertStatement = exports.createUndoChangeSQL = exports.formatQuery = exports.getSqlLanguage = void 0;
+exports.toRdsDatabase = exports.separateMultipleQueries = exports.needsQuoting = exports.wrapQuote = exports.wrapBackQuote = exports.wrapDoubleQuote = exports.wrapSingleQuote = exports.normalizeSimpleParametersQuery = exports.normalizePositionedParametersQuery = exports.normalizeQuery = exports.isReadOnlyQuery = exports.parseQuery = exports.hasSetVariableClause = exports.toSafeQueryForPgsqlAst = exports.toViewDataNormalizedQuery = exports.toViewDataQuery = exports.createColumnNames = exports.createTableNames = exports.toCountRecordsQuery = exports.toViewRecordsQuery = exports.toDeleteStatement = exports.toUpdateStatement = exports.toInsertStatement = exports.createUndoChangeSQL = exports.formatQuery = exports.getSqlLanguage = void 0;
 const tslib_1 = require("tslib");
 const rdh_1 = require("@l-v-yonsama/rdh");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
@@ -32,6 +32,7 @@ const DBTypeToSqlLanguageMap = {
     Postgres: 'postgresql',
     SQLServer: 'transactsql',
     SQLite: 'sqlite',
+    Oracle: 'plsql',
     Redis: 'mysql',
     Memcache: 'mysql',
     Keycloak: 'mysql',
@@ -292,7 +293,7 @@ const toDeleteStatement = ({ schemaName, tableName, columns, conditions, bindOpt
     };
 };
 exports.toDeleteStatement = toDeleteStatement;
-function toViewRecordsQuery({ tableRes, schemaName, idQuoteCharacter, sqlLang, limit, limitAsTop, limitMode, limitLastColumn, }) {
+function toViewRecordsQuery({ tableRes, schemaName, idQuoteCharacter, sqlLang, limit, limitClauseStyle, limitMode, limitLastColumn, }) {
     const tableNameWithSchema = createTableNameWithSchema({
         schema: schemaName,
         table: tableRes.name,
@@ -300,7 +301,7 @@ function toViewRecordsQuery({ tableRes, schemaName, idQuoteCharacter, sqlLang, l
         sqlLang,
     });
     let query = '';
-    if (limitAsTop && limit) {
+    if (limitClauseStyle === 'top' && limit) {
         query = `SELECT TOP ${limit} * FROM ${tableNameWithSchema}`;
     }
     else {
@@ -315,9 +316,12 @@ function toViewRecordsQuery({ tableRes, schemaName, idQuoteCharacter, sqlLang, l
             : limitLastColumn;
         query += ` ORDER BY ${quotedColumn} DESC`;
     }
-    if (!limitAsTop && limit) {
+    if (limitClauseStyle === 'trailing' && limit) {
         query += ` LIMIT ${limit}`;
     }
+    else if (limitClauseStyle === 'fetchFirst' && limit) {
+        query += ` FETCH FIRST ${limit} ROWS ONLY`;
+    }
     return query;
 }
 exports.toViewRecordsQuery = toViewRecordsQuery;
@@ -601,6 +605,26 @@ const parseQuery = (sql) => {
     return undefined;
 };
 exports.parseQuery = parseQuery;
+const READ_ONLY_STATEMENT_TYPES = new Set([
+    'select',
+    'show',
+    'union',
+    'union all',
+    'values',
+]);
+const isReadOnlyQuery = (sql) => {
+    var _a;
+    const qst = (0, exports.parseQuery)(sql);
+    const type = (_a = qst === null || qst === void 0 ? void 0 : qst.ast) === null || _a === void 0 ? void 0 : _a.type;
+    if (!type) {
+        return false;
+    }
+    if (type === 'pragma') {
+        return !/\bpragma\s+[a-zA-Z0-9\-_.()]+\s*=\s*.+/i.test(sql);
+    }
+    return READ_ONLY_STATEMENT_TYPES.has(type);
+};
+exports.isReadOnlyQuery = isReadOnlyQuery;
 const normalizeQuery = ({ query, toPositionedParameter, toPositionalCharacter, bindParams, }) => {
     if (toPositionedParameter) {
         return (0, exports.normalizePositionedParametersQuery)(query, bindParams, toPositionalCharacter);
@@ -756,355 +780,11 @@ const normalizeSimpleParametersQuery = (query, bindParams) => {
     return { query: newLines.join('\n'), binds };
 };
 exports.normalizeSimpleParametersQuery = normalizeSimpleParametersQuery;
-const createTableDefinisionsForPrompt = (params) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    const { db: idb, sql, rdsDriver } = params;
-    const db = idb instanceof DbResource_1.RdsDatabase ? idb : toRdsDatabase(idb);
-    try {
-        if (db) {
-            const qst = (0, exports.parseQuery)(sql);
-            if (qst === undefined || qst.names === undefined) {
-                return undefined;
-            }
-            const dbTableWithSchemas = [];
-            const qnameList = [qst.names];
-            if (qst.additionalNames) {
-                qnameList.push(...qst.additionalNames);
-            }
-            qnameList.forEach(({ schemaName, tableName }) => {
-                var _a, _b;
-                const schemas = db.children.filter((it) => schemaName ? (0, rdh_1.equalsIgnoreCase)(it.name, schemaName) : true);
-                for (const schema of schemas) {
-                    const tbl = schema.children.find((it) => (0, rdh_1.equalsIgnoreCase)(it.name, tableName));
-                    if (tbl) {
-                        dbTableWithSchemas.push({ table: tbl, schemaName: schema.name });
-                        if ((_a = tbl.foreignKeys) === null || _a === void 0 ? void 0 : _a.referenceTo) {
-                            Object.values(tbl.foreignKeys.referenceTo).forEach((refTo) => {
-                                const tblTo = schema.children.find((it) => (0, rdh_1.equalsIgnoreCase)(it.name, refTo.tableName));
-                                if (tblTo &&
-                                    dbTableWithSchemas.find((it) => it.table.name === tblTo.name) === undefined) {
-                                    dbTableWithSchemas.push({
-                                        table: tblTo,
-                                        schemaName: schema.name,
-                                    });
-                                }
-                            });
-                        }
-                        if ((_b = tbl.foreignKeys) === null || _b === void 0 ? void 0 : _b.referencedFrom) {
-                            Object.values(tbl.foreignKeys.referencedFrom).forEach((refFrom) => {
-                                const tblFrom = schema.children.find((it) => (0, rdh_1.equalsIgnoreCase)(it.name, refFrom.tableName));
-                                if (tblFrom &&
-                                    dbTableWithSchemas.find((it) => it.table.name === tblFrom.name) === undefined) {
-                                    dbTableWithSchemas.push({
-                                        table: tblFrom,
-                                        schemaName: schema.name,
-                                    });
-                                }
-                            });
-                        }
-                        break;
-                    }
-                }
-            });
-            if (dbTableWithSchemas.length === 0) {
-                return undefined;
-            }
-            const lines = [];
-            for (const dbTable of dbTableWithSchemas) {
-                let tableDDL = '';
-                if (rdsDriver && rdsDriver.supportsShowCreate()) {
-                    tableDDL = yield rdsDriver.getTableDDL({
-                        schemaName: dbTable.schemaName,
-                        tableName: dbTable.table.name,
-                    });
-                }
-                if (tableDDL) {
-                    lines.push(tableDDL);
-                }
-                else {
-                    const tableDef = (0, exports.toCreateTableDDL)({ dbTable: dbTable.table });
-                    lines.push(tableDef);
-                }
-                lines.push('');
-            }
-            return lines.join('\n');
-        }
-    }
-    catch (_) {
-        console.error(_);
-    }
-    return undefined;
-});
-exports.createTableDefinisionsForPrompt = createTableDefinisionsForPrompt;
-const getProposals = (params) => {
-    const { db: idb, sql, lastChar, keyword, parentWord } = params;
-    const upperKeyword = keyword.toUpperCase();
-    const upperParentWord = parentWord === null || parentWord === void 0 ? void 0 : parentWord.toUpperCase();
-    let ast;
-    const retList = [];
-    const db = idb instanceof DbResource_1.RdsDatabase ? idb : toRdsDatabase(idb);
-    try {
-        if (db) {
-            try {
-                [ast] = (0, pgsql_ast_parser_1.parse)(sql, { locationTracking: true });
-            }
-            catch (_) {
-            }
-            if (parentWord) {
-                let list = getProposalsByKeywordWithParent(db, ast, upperKeyword, upperParentWord, lastChar);
-                if (list.length === 0) {
-                    list = getProposalsByKeyword(db, upperKeyword, lastChar);
-                }
-                retList.push(...list);
-            }
-            else {
-                if (keyword) {
-                    const list = getProposalsByKeyword(db, upperKeyword, lastChar);
-                    retList.push(...list);
-                }
-                else {
-                    retList.push(...getAllProposals(db));
-                }
-            }
-        }
-        if (lastChar !== '.' && !parentWord) {
-            constant_1.RESERVED_WORDS.filter((s) => s.startsWith(upperKeyword)).forEach((s) => {
-                retList.push({
-                    label: s,
-                    kind: types_1.ProposalKind.ReservedWord,
-                });
-            });
-        }
-    }
-    catch (_) {
-    }
-    const uniqueRetList = Array.from(retList
-        .reduce((map, p) => {
-        const key = `${p.kind}:${p.label}`;
-        const existing = map.get(key);
-        if (!existing || (!existing.detail && p.detail)) {
-            map.set(key, p);
-        }
-        return map;
-    }, new Map())
-        .values());
-    return uniqueRetList;
-};
-exports.getProposals = getProposals;
-const getResourcePositions = (params) => {
-    const { db: idb, sql } = params;
-    const sqlLowerCase = sql.toLocaleLowerCase();
-    const retList = [];
-    if (idb === undefined) {
-        return retList;
-    }
-    const schema = idb instanceof DbResource_1.RdsDatabase
-        ? idb.getSchema({ isDefault: true })
-        : toRdsDatabase(idb).getSchema({ isDefault: true });
-    const tableNames = schema.children
-        .map((it) => it.name.toLocaleLowerCase())
-        .join('|');
-    const reg = new RegExp('\\b(' + tableNames + ')\\b', 'g');
-    let m;
-    const tableResList = [];
-    const columnNameSet = new Set();
-    while ((m = reg.exec(sqlLowerCase)) !== null) {
-        const name = m[0];
-        let comment = undefined;
-        const tableRes = schema.children.find((it) => it.name.toLocaleLowerCase() === name);
-        if (tableRes) {
-            tableResList.push(tableRes);
-            comment = tableRes.comment;
-            tableRes.children.forEach((it) => {
-                columnNameSet.add(it.name.toLowerCase());
-            });
-        }
-        retList.push({
-            kind: types_1.ProposalKind.Table,
-            name: tableRes.name,
-            comment,
-            offset: m.index,
-            length: name.length,
-        });
-    }
-    if (columnNameSet.size > 0) {
-        const reg2 = new RegExp('\\b(' + Array.from(columnNameSet).join('|') + ')\\b', 'g');
-        let m2;
-        while ((m2 = reg2.exec(sqlLowerCase)) !== null) {
-            const name = m2[0];
-            const columnRes = tableResList
-                .flatMap((table) => table.children)
-                .find((column) => column.name.toLocaleLowerCase() === name);
-            if (!columnRes) {
-                continue;
-            }
-            retList.push({
-                kind: types_1.ProposalKind.Column,
-                name: columnRes.name,
-                comment: columnRes.comment,
-                offset: m2.index,
-                length: name.length,
-            });
-        }
-    }
-    return retList;
-};
-exports.getResourcePositions = getResourcePositions;
-const resolveAlias = (ast, alias) => {
-    if (!ast || !alias) {
-        return undefined;
-    }
-    if (ast.type === 'select') {
-        for (const tbl of ast.from) {
-            if (tbl.type === 'table') {
-                if (tbl.name.alias.toUpperCase() === alias) {
-                    return tbl.name.name;
-                }
-            }
-        }
-    }
-    return undefined;
-};
-const matchKeyword = (list, keyword) => {
-    return list.some((it) => it.toUpperCase().startsWith(keyword));
-};
-function resolveLastOrderByColumn(table) {
-    const columns = table.children;
-    if (!(columns === null || columns === void 0 ? void 0 : columns.length)) {
-        return undefined;
-    }
-    const dateColumn = columns.find((col) => {
-        const name = col.name.toLowerCase();
-        const looksLikeCreated = /created(_at)?$/.test(name) ||
-            /create(d)?date$/.test(name) ||
-            /insert(ed)?(_at)?$/.test(name);
-        return (0, rdh_1.isDateTimeOrDate)(col.colType) && looksLikeCreated;
-    });
-    if (dateColumn) {
-        return dateColumn.name;
-    }
-    const pks = table.getPrimaryColumnNames();
-    if (pks.length === 1) {
-        const pkCol = columns.find((c) => c.name === pks[0]);
-        if (pkCol && (0, rdh_1.isNumericLike)(pkCol.colType)) {
-            return pkCol.name;
-        }
-    }
-    return undefined;
-}
-exports.resolveLastOrderByColumn = resolveLastOrderByColumn;
-const getProposalsByKeywordWithParent = (db, ast, keyword, parentWord, lastChar) => {
-    var _a;
-    const retList = [];
-    const schema = db.children.find((it) => it.name.toUpperCase() === parentWord);
-    if (schema) {
-        schema.children.forEach((table) => {
-            var _a;
-            const table_comment = (_a = table.comment) !== null && _a !== void 0 ? _a : '';
-            if (keyword === '' ||
-                matchKeyword([table.name, table_comment], keyword)) {
-                retList.push(createTableProposal(schema, table));
-            }
-        });
-    }
-    const defaultSchema = db.getSchema({ isDefault: true });
-    let table = defaultSchema.children.find((it) => it.name.toUpperCase() === parentWord);
-    if (!table) {
-        const resolvedName = resolveAlias(ast, parentWord);
-        if (resolvedName) {
-            table = defaultSchema.children.find((it) => it.name.toUpperCase() === resolvedName.toUpperCase());
-        }
-    }
-    if (table) {
-        const table_comment = (_a = table.comment) !== null && _a !== void 0 ? _a : '';
-        if (matchKeyword([table.name, table_comment], keyword)) {
-            retList.push(createTableProposal(schema, table));
-        }
-        table.children.forEach((column) => {
-            var _a;
-            const columnComment = (_a = column.comment) !== null && _a !== void 0 ? _a : '';
-            if (keyword === '' ||
-                matchKeyword([column.name, columnComment], keyword)) {
-                retList.push(createColumnProposal(table, column));
-            }
-        });
-    }
-    return retList;
-};
-const getProposalsByKeyword = (db, keyword, lastChar) => {
-    const retList = [];
-    const schema = db.getSchema({ isDefault: true });
-    if (lastChar === ' ') {
-        if (['INTO', 'UPDATE', 'FROM'].includes(keyword)) {
-            schema.children.forEach((table) => {
-                retList.push(createTableProposal(schema, table));
-            });
-            return retList;
-        }
-        if ('DELETE' === keyword) {
-            retList.push(createReservedWordProposal('FROM'));
-        }
-    }
-    schema.children.forEach((table) => {
-        var _a;
-        const table_comment = (_a = table.comment) !== null && _a !== void 0 ? _a : '';
-        if (matchKeyword([table.name, table_comment], keyword)) {
-            retList.push(createTableProposal(schema, table));
-        }
-        table.children.forEach((column) => {
-            var _a;
-            const columnComment = (_a = column.comment) !== null && _a !== void 0 ? _a : '';
-            if (matchKeyword([column.name, columnComment], keyword)) {
-                retList.push(createColumnProposal(table, column));
-            }
-        });
-    });
-    return retList;
-};
-const getAllProposals = (db) => {
-    const retList = [];
-    const schema = db.getSchema({ isDefault: true });
-    schema.children.forEach((table) => {
-        retList.push(createTableProposal(schema, table));
-    });
-    schema.getUniqColumnNameWithComments().forEach((it) => {
-        var _a;
-        retList.push({
-            label: it.name,
-            kind: types_1.ProposalKind.Column,
-            detail: (_a = it.comment) !== null && _a !== void 0 ? _a : '',
-        });
-    });
-    return retList;
-};
-const createTableProposal = (schema, table) => {
-    var _a;
-    const detail = (_a = table.comment) !== null && _a !== void 0 ? _a : '';
-    return {
-        label: table.name,
-        kind: types_1.ProposalKind.Table,
-        detail,
-    };
-};
-const createColumnProposal = (table, column) => {
-    var _a;
-    const detail = (_a = column.comment) !== null && _a !== void 0 ? _a : '';
-    return {
-        label: column.name,
-        kind: types_1.ProposalKind.Column,
-        detail,
-    };
-};
 const stripComment = (query) => {
     return query
         .replace(/\/\*[^*]*\*\//gm, '')
         .replace(/(\s)?(#|--)\s+.*$/gm, '$1');
 };
-const createReservedWordProposal = (word) => {
-    return {
-        label: word,
-        kind: types_1.ProposalKind.ReservedWord,
-    };
-};
 const wrapSingleQuote = (input) => (0, exports.wrapQuote)(input, "'");
 exports.wrapSingleQuote = wrapSingleQuote;
 const wrapDoubleQuote = (input) => (0, exports.wrapQuote)(input, '"');
@@ -1202,7 +882,8 @@ const toEmbeddedStringValue = (colType, value) => {
         return (0, exports.wrapSingleQuote)(value);
     }
     if ((0, rdh_1.isJsonLike)(colType)) {
-        return (0, exports.wrapSingleQuote)(JSON.stringify(value));
+        const text = typeof value === 'string' ? value : JSON.stringify(value);
+        return (0, exports.wrapSingleQuote)(text);
     }
     if (value.length === 0) {
         return 'NULL';
@@ -1315,52 +996,7 @@ const createQNamesUsingLocation = ({ tableName, schemaName, location, sql, }) =>
         schemaName,
     };
 };
-const toCreateTableDDL = ({ dbTable }) => {
-    var _a;
-    const columns = dbTable.children;
-    const colDefs = [];
-    columns.forEach((col) => {
-        let line = `  ${col.name} ${col.colType}`;
-        if (col.primaryKey) {
-            line += ' PRIMARY KEY';
-        }
-        else {
-            if (col.nullable === false) {
-                line += ' NOT NULL';
-            }
-        }
-        if (col.uniqKey) {
-            line += ' UNIQUE';
-        }
-        if (col.extra) {
-            if (col.extra.toLocaleLowerCase() === 'auto_increment') {
-                line += ' AUTO_INCREMENT';
-            }
-        }
-        if (col.default) {
-            line += ` DEFAULT ${col.default}`;
-        }
-        if (col.comment) {
-            line += ` COMMENT '${col.comment}'`;
-        }
-        colDefs.push(line);
-    });
-    if ((_a = dbTable.foreignKeys) === null || _a === void 0 ? void 0 : _a.referenceTo) {
-        Object.entries(dbTable.foreignKeys.referenceTo).forEach(([colName, refTo]) => {
-            colDefs.push(`  FOREIGN KEY ${refTo.constraintName}(${colName}) REFERENCES ${refTo.tableName}(${refTo.columnName})`);
-        });
-    }
-    let tableDef = `CREATE TABLE ${dbTable.name} (\n${colDefs.join(',\n')}\n)`;
-    if (dbTable.comment) {
-        tableDef += ` COMMENT '${dbTable.comment}';`;
-    }
-    else {
-        tableDef += `;`;
-    }
-    return tableDef;
-};
-exports.toCreateTableDDL = toCreateTableDDL;
-const toGeneralQuery = ({ selectClause, tableRes, schemaName, conditions, quote, idQuoteCharacter, sqlLang, limit, limitAsTop, }) => {
+const toGeneralQuery = ({ selectClause, tableRes, schemaName, conditions, quote, idQuoteCharacter, sqlLang, limit, limitClauseStyle, }) => {
     const tableNameWithSchema = createTableNameWithSchema({
         schema: schemaName,
         table: tableRes.name,
@@ -1372,7 +1008,7 @@ const toGeneralQuery = ({ selectClause, tableRes, schemaName, conditions, quote,
         bindParams: {},
     };
     let top = '';
-    if (limitAsTop === true) {
+    if (limitClauseStyle === 'top' && limit !== undefined) {
         top = `TOP ${limit} `;
     }
     let query = `SELECT ${top}${selectClause} ${os.EOL}FROM ${tableNameWithSchema} `;
@@ -1389,9 +1025,12 @@ const toGeneralQuery = ({ selectClause, tableRes, schemaName, conditions, quote,
             query += os.EOL + 'WHERE' + os.EOL + q;
         }
     }
-    if (limitAsTop !== true && limit !== undefined) {
+    if (limitClauseStyle === 'trailing' && limit !== undefined) {
         query += os.EOL + 'LIMIT ' + limit;
     }
+    else if (limitClauseStyle === 'fetchFirst' && limit !== undefined) {
+        query += os.EOL + 'FETCH FIRST ' + limit + ' ROWS ONLY';
+    }
     return {
         query: query.trim(),
         binds: params.bindParams,
@@ -1443,4 +1082,5 @@ const toRdsDatabase = (awsDb) => {
     });
     return db;
 };
+exports.toRdsDatabase = toRdsDatabase;
 //# sourceMappingURL=SQLHelper.js.map