@dbml/core 5.1.0 → 5.3.0

package/lib/export/DbmlExporter.js

@@ -49,7 +49,7 @@ var DbmlExporter = /*#__PURE__*/function () {
         // Only safe chars, no simple quotes nor CR/LF
         return "'".concat(newStr, "'");
       }
-      newStr = newStr.replaceAll("'", "\\'");
+      newStr = newStr.replaceAll('\'', '\\\'');
       newStr = newStr.replaceAll('\r\n', '\n'); // turn all CRLF to LF
       return "'''".concat(newStr, "'''");
     }
@@ -103,7 +103,7 @@ var DbmlExporter = /*#__PURE__*/function () {
               break;
             case 'string':
               {
-                var quote = field.dbdefault.value.includes('\n') ? "'''" : "'";
+                var quote = field.dbdefault.value.includes('\n') ? '\'\'\'' : '\'';
                 value += "".concat(quote).concat(field.dbdefault.value).concat(quote);
                 break;
               }
@@ -111,6 +111,7 @@ var DbmlExporter = /*#__PURE__*/function () {
               value += "`".concat(field.dbdefault.value, "`");
               break;
             default:
+              value += "`".concat(field.dbdefault.value, "`");
               break;
           }
           constraints.push(value);

package/lib/export/MysqlExporter.js

@@ -77,7 +77,7 @@ var MySQLExporter = /*#__PURE__*/function () {
           }
         }
         if (field.note) {
-          line += " COMMENT '".concat(field.note.replace(/'/g, "''"), "'");
+          line += " COMMENT '".concat(field.note.replace(/'/g, '\'\''), "'");
         }
         return line;
       });
@@ -281,7 +281,7 @@ var MySQLExporter = /*#__PURE__*/function () {
         if (comment.type === 'table') {
           var table = model.tables[comment.tableId];
           var schema = model.schemas[table.schemaId];
-          line += "ALTER TABLE ".concat((0, _utils.shouldPrintSchema)(schema, model) ? "`".concat(schema.name, "`.") : '', "`").concat(table.name, "` COMMENT = '").concat(table.note.replace(/'/g, "''"), "'");
+          line += "ALTER TABLE ".concat((0, _utils.shouldPrintSchema)(schema, model) ? "`".concat(schema.name, "`.") : '', "`").concat(table.name, "` COMMENT = '").concat(table.note.replace(/'/g, '\'\''), "'");
         }
         line += ';\n';
         return line;

package/lib/export/OracleExporter.js

@@ -401,13 +401,13 @@ var OracleExporter = /*#__PURE__*/function () {
         switch (comment.type) {
           case 'table':
             {
-              line += " TABLE ".concat(tableName, " IS '").concat(table.note.replace(/'/g, "''"), "'");
+              line += " TABLE ".concat(tableName, " IS '").concat(table.note.replace(/'/g, '\'\''), "'");
               break;
             }
           case 'column':
             {
               var field = model.fields[comment.fieldId];
-              line += " COLUMN ".concat(tableName, ".").concat((0, _utils.escapeObjectName)(field.name, 'oracle'), " IS '").concat(field.note.replace(/'/g, "''"), "'");
+              line += " COLUMN ".concat(tableName, ".").concat((0, _utils.escapeObjectName)(field.name, 'oracle'), " IS '").concat(field.note.replace(/'/g, '\'\''), "'");
               break;
             }
           default:

package/lib/export/PostgresExporter.js

@@ -355,13 +355,13 @@ var PostgresExporter = /*#__PURE__*/function () {
         switch (comment.type) {
           case 'table':
             {
-              line += " TABLE ".concat((0, _utils.shouldPrintSchema)(schema, model) ? "\"".concat(schema.name, "\".") : '', "\"").concat(table.name, "\" IS '").concat(table.note.replace(/'/g, "''"), "'");
+              line += " TABLE ".concat((0, _utils.shouldPrintSchema)(schema, model) ? "\"".concat(schema.name, "\".") : '', "\"").concat(table.name, "\" IS '").concat(table.note.replace(/'/g, '\'\''), "'");
               break;
             }
           case 'column':
             {
               var field = model.fields[comment.fieldId];
-              line += " COLUMN ".concat((0, _utils.shouldPrintSchema)(schema, model) ? "\"".concat(schema.name, "\".") : '', "\"").concat(table.name, "\".\"").concat(field.name, "\" IS '").concat(field.note.replace(/'/g, "''"), "'");
+              line += " COLUMN ".concat((0, _utils.shouldPrintSchema)(schema, model) ? "\"".concat(schema.name, "\".") : '', "\"").concat(table.name, "\".\"").concat(field.name, "\" IS '").concat(field.note.replace(/'/g, '\'\''), "'");
               break;
             }
           default:

package/lib/export/SqlServerExporter.js

@@ -281,7 +281,7 @@ var SqlServerExporter = /*#__PURE__*/function () {
           case 'table':
             {
               line += '@name = N\'Table_Description\',\n';
-              line += "@value = '".concat(table.note.replace(/'/g, "''"), "',\n");
+              line += "@value = '".concat(table.note.replace(/'/g, '\'\''), "',\n");
               line += "@level0type = N'Schema', @level0name = '".concat((0, _utils.shouldPrintSchema)(schema, model) ? "".concat(schema.name) : 'dbo', "',\n");
               line += "@level1type = N'Table',  @level1name = '".concat(table.name, "';\n");
               break;
@@ -290,7 +290,7 @@ var SqlServerExporter = /*#__PURE__*/function () {
             {
               var field = model.fields[comment.fieldId];
               line += '@name = N\'Column_Description\',\n';
-              line += "@value = '".concat(field.note.replace(/'/g, "''"), "',\n");
+              line += "@value = '".concat(field.note.replace(/'/g, '\'\''), "',\n");
               line += "@level0type = N'Schema', @level0name = '".concat((0, _utils.shouldPrintSchema)(schema, model) ? "".concat(schema.name) : 'dbo', "',\n");
               line += "@level1type = N'Table',  @level1name = '".concat(table.name, "',\n");
               line += "@level2type = N'Column', @level2name = '".concat(field.name, "';\n");

package/lib/model_structure/element.js

@@ -20,7 +20,6 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
 function _isNativeFunction(t) { try { return -1 !== Function.toString.call(t).indexOf("[native code]"); } catch (n) { return "function" == typeof t; } }
 function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
 function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
-/* eslint-disable */
 var ElementError = /*#__PURE__*/function (_Error) {
   function ElementError(message) {
     var _this;
@@ -56,5 +55,4 @@ var Element = /*#__PURE__*/function () {
     }
   }]);
 }();
-var _default = exports["default"] = Element;
-/* eslint-enable */
+var _default = exports["default"] = Element;

package/lib/parse/ANTLR/ASTGeneration/AST.js

@@ -10,8 +10,6 @@ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o =
 function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-/* eslint-disable camelcase */
-/* eslint-disable max-classes-per-file */
 var Index = exports.Index = /*#__PURE__*/function () {
   /**
    * @param {{

package/lib/parse/ANTLR/ASTGeneration/constants.js

@@ -15,6 +15,7 @@ var TABLE_CONSTRAINT_KIND = exports.TABLE_CONSTRAINT_KIND = {
 };
 var COLUMN_CONSTRAINT_KIND = exports.COLUMN_CONSTRAINT_KIND = {
   NOT_NULL: 'not_null',
+  NULLABLE: 'nullable',
   UNIQUE: 'unique',
   PK: 'pk',
   DEFAULT: 'dbdefault',

package/lib/parse/ANTLR/ASTGeneration/index.js

@@ -18,10 +18,10 @@ var _ParserErrorListener = _interopRequireDefault(require("./ParserErrorListener
 var _TSqlLexer = _interopRequireDefault(require("../parsers/mssql/TSqlLexer"));
 var _TSqlParser = _interopRequireDefault(require("../parsers/mssql/TSqlParser"));
 var _MssqlASTGen = _interopRequireDefault(require("./mssql/MssqlASTGen"));
+var _OracleSqlLexer = _interopRequireDefault(require("../parsers/oraclesql/OracleSqlLexer"));
+var _OracleSqlParser = _interopRequireDefault(require("../parsers/oraclesql/OracleSqlParser"));
+var _OracleSQLASTGen = _interopRequireDefault(require("./oraclesql/OracleSQLASTGen"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
-/* eslint-disable import/no-named-as-default-member */
-/* eslint-disable import/no-named-as-default */
-
 function parse(input, format) {
   var chars = new _antlr["default"].InputStream(input);
   var database = null;
@@ -79,6 +79,19 @@ function parse(input, format) {
         if (errorListener.errors.length) throw errorListener.errors;
         break;
       }
+    case 'oracle':
+      {
+        var _lexer4 = new _OracleSqlLexer["default"](chars);
+        var _tokens4 = new _antlr["default"].CommonTokenStream(_lexer4);
+        var _parser4 = new _OracleSqlParser["default"](_tokens4);
+        _parser4.buildParseTrees = true;
+        _parser4.removeErrorListeners();
+        _parser4.addErrorListener(errorListener);
+        var _parseTree4 = _parser4.sql_script();
+        database = _parseTree4.accept(new _OracleSQLASTGen["default"]());
+        if (errorListener.errors.length) throw errorListener.errors;
+        break;
+      }
     default:
       throw new Error("Format not supported: ".concat(format));
   }

package/lib/parse/ANTLR/ASTGeneration/mssql/MssqlASTGen.js

@@ -35,7 +35,7 @@ function _nonIterableRest() { throw new TypeError("Invalid attempt to destructur
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
-function _arrayWithHoles(r) { if (Array.isArray(r)) return r; } /* eslint-disable class-methods-use-this */
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
 var ADD_DESCRIPTION_FUNCTION_NAME = 'sp_addextendedproperty';
 var getSchemaAndTableName = function getSchemaAndTableName(names) {
   var tableName = (0, _lodash.last)(names);

package/lib/parse/ANTLR/ASTGeneration/mssql/README.md

@@ -0,0 +1,157 @@
+# MSSQL model structure generator
+
+This folder houses the implementation of the MSSQL model structure generator based on the ANTLR4 parser.
+
+This file documents the current features and bugs of this model structure generator.
+
+In the below table, the following notation is used:
+  - ✅: Supported.
+  - 🤷🏼‍♂️: Invalid SQL in MSSQL.
+  - ❓: Valid SQL in MSSQL, the generator can still generate output but it ignores this syntax.
+  - ❌: Valid SQL in MSSQL, but the generator fails to generate any output.
+
+| SQL syntax                    | MSSQL         |
+|-------------------------------|---------------|
+| 1. INSERT statement           |           |
+| 1.a. Basic INSERT ... VALUES  | ✅            |
+| 1.b. INSERT ... SELECT        | ❌            |
+| 1.c. Multi-row INSERT         | ✅            |
+| 1.d. Common table expression (WITH clause) | ❌            |
+| 1.e. Target table alias       | 🤷🏼‍♂️         |
+| 1.f. INSERT … OUTPUT | ❓ (ignore the OUTPUT clause) |
+| 1.g. INSERT ... ON CONFLICT (UPSERT)/INSERT ... ON DUPLICATE KEY/INSERT … IGNORE | 🤷🏼‍♂️         |
+| 1.h. INSERT OVERWRITE         | 🤷🏼‍♂️         |
+| 1.i. Multi-table INSERT       | ❌            |
+| 1.j. Conditional multi-table INSERT (WHEN/FIRST/ALL) | ❌            |
+| 6. CREATE TABLE               |           |
+| 6.a. Basic syntax             | ✅            |
+| 6.a.i. Enumerated data type   | 🤷🏼‍♂️         |
+| 6.a.ii. Data type of the form name(...) | ✅            |
+| 6.a.iii. Data type of the form name\[...\] | 🤷🏼‍♂️         |
+| 6.b. PRIMARY KEY              |               |
+| 6.b.i. Inline PRIMARY KEY     | ✅            |
+| 6.b.ii. Out-of-line PRIMARY KEY | ✅            |
+| 6.b.iii. Composite PRIMARY KEY | ✅            |
+| 6.b.iv. Named PRIMARY KEY     | ✅            |
+| 6.b.v. Other options (deferrable, etc.) | ❓ (ignore the options) |
+| 6.c. FOREIGN KEY              |               |
+| 6.c.i. Inline FOREIGN KEY     | ❌ (bug) |
+| 6.c.ii. Out-of-line FOREIGN KEY | ❌ (bug) |
+| 6.c.iii. Composite FOREIGN KEY | ❌ (bug) |
+| 6.c.iv. Named FOREIGN KEY     | ❌ (bug) |
+| 6.c.v. ON UPDATE              | ❌ (bug) |
+| 6.c.vi. ON DELETE             | ❌ (bug) |
+| 6.c.vii. Other options (deferrable, etc.) | ❌ (bug) |
+| 6.d. UNIQUE                   |               |
+| 6.d.i. Inline UNIQUE          | ✅            |
+| 6.d.ii. Out-of-line UNIQUE    | ✅            |
+| 6.d.iii. Composite UNIQUE     | ✅            |
+| 6.d.iv. Named UNIQUE          | ❓ (ignore the name) |
+| 6.d.v. Other options (deferrable, etc) | ❓ (ignore the option) |
+| 6.d.vi. NULLS NOT DISTINCT    | 🤷🏼‍♂️         |
+| 6.d.vii. UNIQUE KEY/UNIQUE INDEX | 🤷🏼‍♂️         |
+| 6.e. CHECK                    |               |
+| 6.e.i. Inline CHECK           | ❌ (parse fail) |
+| 6.e.ii. Out-of-line CHECK     | ❌ (parse fail) |
+| 6.e.iii. Named CHECK          | ❌ (parse fail) |
+| 6.e.iv. Other options (enforcement control, etc.) | ❌ (parse fail) |
+| 6.f. DEFAULT values           |               |
+| 6.f.i. Inline DEFAULT         | ✅            |
+| 6.f.ii. Out-of-line DEFAULT   | ❌ (Totally ignore) |
+| 6.f.iii. Functional DEFAULT   | ✅            |
+| 6.f.iv. Named DEFAULT         | ❓ (ignore the name) |
+| 6.g. NULL                     | ✅            |
+| 6.h. NOT NULL                 |               |
+| 6.h.i. Inline NOT NULL        | ✅            |
+| 6.h.ii. Out-of-line NOT NULL  | 🤷🏼‍♂️         |
+| 6.h.iii. Named NOT NULL       | 🤷🏼‍♂️         |
+| 6.h.iv. Other options (deferrable, etc.) | ❓ (Ignore) |
+| 6.i. Indexes                  |               |
+| 6.i.i. Inline indexes         | 🤷🏼‍♂️ (except for UNIQUE/PRIMARY KEY) |
+| 6.i.ii. Out-of-line indexes   | 🤷🏼‍♂️ (except for UNIQUE/PRIMARY KEY) |
+| 6.i.iii. Named indexes        | 🤷🏼‍♂️         |
+| 6.i.iv. Multi-column indexes  | 🤷🏼‍♂️         |
+| 6.i.v. CLUSTERED/NONCLUSTERED | ❓ (ignore) |
+| 6.i.vi. FULLTEXT              | 🤷🏼‍♂️         |
+| 6.i.vii. SPATIAL              | 🤷🏼‍♂️         |
+| 6.i.viii. Other options       | 🤷🏼‍♂️         |
+| 6.i.ix. USING HASH/BTREE      | 🤷🏼‍♂️         |
+| 6.j. Auto-increment           |               |
+| 6.j.i. AUTO_INCREMENT         | 🤷🏼‍♂️         |
+| 6.j.ii. SERIAL/BIG SERIAL     | 🤷🏼‍♂️         |
+| 6.j.iii. IDENTITY             | ✅            |
+| 6.j.iv. Increment range       | ✅            |
+| 6.j.v. GENERATED ... AS IDENTITY | ❌ (parse fail) |
+| 6.k. Computed column          | ❓            |
+| 6.l. TEMPORARY tables         | ✅ (indication of temporary table via # prefix) |
+| 6.m. CREATE TABLE AS SELECT (CTAS) | ❌            |
+| 6.n. Comments                 |               |
+| 6.n.i. Table comments         | 🤷🏼‍♂️         |
+| 6.n.ii. Column comments       | 🤷🏼‍♂️         |
+| 6.o. Other options (inheritance, UNLOGGED, partition, collate, etc.) | ❓            |
+| 7. ALTER TABLE                |           |
+| 7.a. ADD COLUMN               |               |
+| 7.a.i. Type                   | ❌            |
+| 7.a.ii. DEFAULT               | ❌            |
+| 7.a.iii. NOT NULL             | ❌            |
+| 7.a.iv. NULL                  | ❌            |
+| 7.a.v. CHECK                  | ❌            |
+| 7.a.vi. UNIQUE                | ❌            |
+| 7.a.vii. FOREIGN KEY          | ❌ (parse fail) |
+| 7.a.viii. PRIMARY KEY         | ❌            |
+| 7.a.ix. AUTOINCREMENT/SERIAL/BIGSERIAL/IDENTITY/GENERATED AS IDENTITY | ❌            |
+| 7.a.x. Computed column        | ❌            |
+| 7.b. DROP COLUMN              | ❌            |
+| 7.c. ALTER COLUMN / MODIFY COLUMN |               |
+| 7.c.i. COMMENT                | 🤷🏼‍♂️         |
+| 7.c.ii. Others                | ❌            |
+| 7.d. RENAME COLUMN            | ❌            |
+| 7.e. ADD CONSTRAINT           |               |
+| 7.e.i. DEFAULT                | ✅ (ignore name) |
+| 7.e.ii. NOT NULL              | ❌            |
+| 7.e.iii. NULL                 | ❌            |
+| 7.e.iv. named CHECK           | ✅            |
+| 7.e.v. unnamed CHECK          | ✅            |
+| 7.e.vi. named UNIQUE          | ✅            |
+| 7.e.vii. unnamed UNIQUE       | ✅            |
+| 7.e.viii. named PRIMARY KEY   | ✅            |
+| 7.e.ix. unnamed PRIMARY KEY   | ✅            |
+| 7.e.x. named FOREIGN KEY      | ✅            |
+| 7.e.xi. unnamed FOREIGN KEY   | ✅            |
+| 7.g. DROP CONSTRAINT          | ❌            |
+| 7.h. ALTER CONSTRAINT         | ❌            |
+| 7.i. RENAME TABLE             | ❌            |
+| 7.j. SET SCHEMA               | ❌            |
+| 7.k. ALTER INDEX              | ❌            |
+| 7.l. DROP INDEX               | ❌            |
+| 7.m. SET COMMENT/COMMENT =    | 🤷🏼‍♂️         |
+| 7.n. ADD INDEX                | ❌            |
+| 8. DROP TABLE                 |               |
+| 8.a. Basic syntax             | ❌            |
+| 9. CREATE INDEX               |               |
+| 9.a. Basic syntax             | ✅            |
+| 9.b. Composite index          | ✅            |
+| 9.c. Named index              | ✅            |
+| 9.d. UNIQUE index             | ✅            |
+| 9.e. Partial/Filtered index   | ❓ (ignore) |
+| 9.f. BTREE/HASH/GIST/BRIN/… index | ❌ (parse fail) |
+| 9.g. INCLUDE columns          | ❓ (ignore) |
+| 9.h. CLUSTERED/NONCLUSTERED   | ❓ (ignore) |
+| 9.i. Functional index         | 🤷🏼‍♂️ (However, the MSSQL exporter is currently exporting this syntax) |
+| 9.j. FULLTEXT/SPATIAL index   | ❌ (parse fail) |
+| 9.k. COLLATE                  | 🤷🏼‍♂️         |
+| 9.l. COMMENT                  | 🤷🏼‍♂️         |
+| 9.m. NULLS LAST/FIRST         | 🤷🏼‍♂️         |
+| 9.n. ASC/DESC                 | ❓ (ignore) |
+| 10. DROP INDEX                |           |
+| 10.a. Basic syntax            | ❌            |
+| 11. ALTER INDEX               |           |
+| 11.a. RENAME                  | ❌            |
+| 11.b. ALTER COLUMN            | ❌            |
+| 12. CREATE VIEW               |           |
+| 12.a. Basic syntax            | ❌            |
+| 13. Comment                   |               |
+| 13.a. Table comments          | ✅ (but unreliable) |
+| 13.b. Column comments         | ✅ (but unreliable) |
+| 13.c. COMMENT … IS NULL       | ✅ (but unreliable) |
+| 13.d. Index comments          | ❌            |

package/lib/parse/ANTLR/ASTGeneration/mysql/MySQLASTGen.js

@@ -35,7 +35,7 @@ function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError(
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
 function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
-function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); } /* eslint-disable class-methods-use-this */
+function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
 var TABLE_OPTIONS_KIND = {
   NOTE: 'note'
 };

package/lib/parse/ANTLR/ASTGeneration/mysql/README.md

@@ -0,0 +1,157 @@
+# MySQL model structure generator
+
+This folder houses the implementation of the MySQL model structure generator based on the ANTLR4 parser.
+
+This file documents the current features and bugs of this model structure generator.
+
+In the below table, the following notation is used:
+  - ✅: Supported.
+  - 🤷🏼‍♂️: Invalid SQL in MySQL.
+  - ❓: Valid SQL in MySQL, the generator can still generate output but it ignores this syntax.
+  - ❌: Valid SQL in MySQL, but the generator fails to generate any output.
+
+| SQL syntax                    | MySQL         |
+|-------------------------------|---------------|
+| 1. INSERT statement           |           |
+| 1.a. Basic INSERT ... VALUES  | ✅            |
+| 1.b. INSERT ... SELECT        | ❌            |
+| 1.c. Multi-row INSERT         | ✅            |
+| 1.d. Common table expression (WITH clause) | ❌            |
+| 1.e. Target table alias       | 🤷🏼‍♂️         |
+| 1.f. INSERT ... RETURNING/INSERT … OUTPUT | 🤷🏼‍♂️         |
+| 1.g. INSERT ... ON CONFLICT (UPSERT)/INSERT ... ON DUPLICATE KEY/INSERT … IGNORE | ❓ (ignore the ON DUPLICATE KEY and IGNORE clauses) |
+| 1.h. INSERT OVERWRITE         | 🤷🏼‍♂️         |
+| 1.i. Multi-table INSERT       | ❌            |
+| 1.j. Conditional multi-table INSERT (WHEN/FIRST/ALL) | ❌            |
+| 6. CREATE TABLE               |           |
+| 6.a. Basic syntax             | ✅            |
+| 6.a.i. Enumerated data type   | 🤷🏼‍♂️         |
+| 6.a.ii. Data type of the form name(...) | ✅            |
+| 6.a.iii. Data type of the form name\[...\] | 🤷🏼‍♂️         |
+| 6.b. PRIMARY KEY              |               |
+| 6.b.i. Inline PRIMARY KEY     | ✅            |
+| 6.b.ii. Out-of-line PRIMARY KEY | ✅            |
+| 6.b.iii. Composite PRIMARY KEY | ✅            |
+| 6.b.iv. Named PRIMARY KEY     | ✅            |
+| 6.b.v. Other options (deferrable, etc.) | ❓ (ignore the options) |
+| 6.c. FOREIGN KEY              |               |
+| 6.c.i. Inline FOREIGN KEY     | ✅            |
+| 6.c.ii. Out-of-line FOREIGN KEY | ✅            |
+| 6.c.iii. Composite FOREIGN KEY | ✅            |
+| 6.c.iv. Named FOREIGN KEY     | ✅            |
+| 6.c.v. ON UPDATE              | ✅            |
+| 6.c.vi. ON DELETE             | ✅            |
+| 6.c.vii. Other options (deferrable, etc.) | ❓ (ignore the options) |
+| 6.d. UNIQUE                   |               |
+| 6.d.i. Inline UNIQUE          | ✅            |
+| 6.d.ii. Out-of-line UNIQUE    | ✅            |
+| 6.d.iii. Composite UNIQUE     | ✅            |
+| 6.d.iv. Named UNIQUE          | ✅            |
+| 6.d.v. Other options (deferrable, etc) | ❓ (ignore the option) |
+| 6.d.vi. NULLS NOT DISTINCT    | ❌ (parse fail) |
+| 6.d.vii. UNIQUE KEY/UNIQUE INDEX | ✅            |
+| 6.e. CHECK                    |               |
+| 6.e.i. Inline CHECK           | ✅            |
+| 6.e.ii. Out-of-line CHECK     | ✅            |
+| 6.e.iii. Named CHECK          | ✅ (ignored for inline checks) |
+| 6.e.iv. Other options (enforcement control, etc.) | ❓ (ignore the options) |
+| 6.f. DEFAULT values           |               |
+| 6.f.i. Inline DEFAULT         | ✅            |
+| 6.f.ii. Out-of-line DEFAULT   | 🤷🏼‍♂️         |
+| 6.f.iii. Functional DEFAULT   | ✅            |
+| 6.f.iv. Named DEFAULT         | 🤷🏼‍♂️         |
+| 6.g. NULL                     | ✅            |
+| 6.h. NOT NULL                 |               |
+| 6.h.i. Inline NOT NULL        | ✅            |
+| 6.h.ii. Out-of-line NOT NULL  | 🤷🏼‍♂️         |
+| 6.h.iii. Named NOT NULL       | 🤷🏼‍♂️         |
+| 6.h.iv. Other options (deferrable, etc.) | ❓ (ignore) |
+| 6.i. Indexes                  |               |
+| 6.i.i. Inline indexes         | ❌ (parse fail) |
+| 6.i.ii. Out-of-line indexes   | ✅            |
+| 6.i.iii. Named indexes        | ✅            |
+| 6.i.iv. Multi-column indexes  | ✅            |
+| 6.i.v. CLUSTERED/NONCLUSTERED | 🤷🏼‍♂️         |
+| 6.i.vi. FULLTEXT              | ❓ (ignore) |
+| 6.i.vii. SPATIAL              | ❓ (ignore) |
+| 6.i.viii. Other options       | ❓ (ignore) |
+| 6.i.ix. USING HASH/BTREE      | ✅            |
+| 6.j. Auto-increment           |               |
+| 6.j.i. AUTO_INCREMENT         | ✅            |
+| 6.j.ii. SERIAL/BIG SERIAL     | 🤷🏼‍♂️         |
+| 6.j.iii. IDENTITY             | 🤷🏼‍♂️         |
+| 6.j.iv. Increment range       | ❓ (ignore) |
+| 6.j.v. GENERATED ... AS IDENTITY | 🤷🏼‍♂️         |
+| 6.k. Computed column          | ❓            |
+| 6.l. TEMPORARY tables         | ❌ (Totally ignored) |
+| 6.m. CREATE TABLE AS SELECT (CTAS) | ❌            |
+| 6.n. Comments                 |               |
+| 6.n.i. Table comments         | ✅            |
+| 6.n.ii. Column comments       | ✅            |
+| 6.o. Other options (inheritance, UNLOGGED, partition, collate, etc.) | ❓            |
+| 7. ALTER TABLE                |           |
+| 7.a. ADD COLUMN               |               |
+| 7.a.i. Type                   | ❌            |
+| 7.a.ii. DEFAULT               | ❌            |
+| 7.a.iii. NOT NULL             | ❌            |
+| 7.a.iv. NULL                  | ❌            |
+| 7.a.v. CHECK                  | ❌            |
+| 7.a.vi. UNIQUE                | ❌ (parse fail when giving a name) |
+| 7.a.vii. FOREIGN KEY          | ❌ (parse fail for FOREIGN KEY name REFERENCES ...) |
+| 7.a.viii. PRIMARY KEY         | ❌            |
+| 7.a.ix. AUTOINCREMENT/SERIAL/BIGSERIAL/IDENTITY/GENERATED AS IDENTITY | ❌            |
+| 7.a.x. Computed column        | ❌            |
+| 7.b. DROP COLUMN              | ❌            |
+| 7.c. ALTER COLUMN / MODIFY COLUMN |               |
+| 7.c.i. COMMENT                | ❌            |
+| 7.c.ii. Others                | ❌            |
+| 7.d. RENAME COLUMN            | ❌            |
+| 7.e. ADD CONSTRAINT           |               |
+| 7.e.i. DEFAULT                | ❌ (parse fail) |
+| 7.e.ii. NOT NULL              | ❌            |
+| 7.e.iii. NULL                 | ❌            |
+| 7.e.iv. named CHECK           | ✅            |
+| 7.e.v. unnamed CHECK          | ✅            |
+| 7.e.vi. named UNIQUE          | ❌            |
+| 7.e.vii. unnamed UNIQUE       | ❌            |
+| 7.e.viii. named PRIMARY KEY   | ❓ (ignore name) |
+| 7.e.ix. unnamed PRIMARY KEY   | ✅            |
+| 7.e.x. named FOREIGN KEY      | ✅            |
+| 7.e.xi. unnamed FOREIGN KEY   | ✅            |
+| 7.g. DROP CONSTRAINT          | ❌            |
+| 7.h. ALTER CONSTRAINT         | ❌            |
+| 7.i. RENAME TABLE             | ❌            |
+| 7.j. SET SCHEMA               | ❌            |
+| 7.k. ALTER INDEX              | ❌            |
+| 7.l. DROP INDEX               | ❌            |
+| 7.m. SET COMMENT/COMMENT =    | ❌            |
+| 7.n. ADD INDEX                | ❌            |
+| 8. DROP TABLE                 |           |
+| 8.a. Basic syntax             | ❌            |
+| 9. CREATE INDEX               |           |
+| 9.a. Basic syntax             | ✅            |
+| 9.b. Composite index          | ✅            |
+| 9.c. Named index              | ✅            |
+| 9.d. UNIQUE index             | ✅            |
+| 9.e. Partial/Filtered index   | ❌ (parse fail) |
+| 9.f. BTREE/HASH/GIST/BRIN/… index | ✅            |
+| 9.g. INCLUDE columns          | 🤷🏼‍♂️         |
+| 9.h. CLUSTERED/NONCLUSTERED   | ❓ (ignore) |
+| 9.i. Functional index         | ✅            |
+| 9.j. FULLTEXT/SPATIAL index   | ❓ (ignore) |
+| 9.k. COLLATE                  | ❌ (parse fail) |
+| 9.l. COMMENT                  | ❓ (ignore) |
+| 9.m. NULLS LAST/FIRST         | 🤷🏼‍♂️         |
+| 9.n. ASC/DESC                 | ❓ (ignore) |
+| 10. DROP INDEX                |           |
+| 10.a. Basic syntax            | ❌            |
+| 11. ALTER INDEX               | 🤷🏼‍♂️         |
+| 11.a. RENAME                  | 🤷🏼‍♂️         |
+| 11.b. ALTER COLUMN            | 🤷🏼‍♂️         |
+| 12. CREATE VIEW               |           |
+| 12.a. Basic syntax            | ❌            |
+| 13. Comment                   |               |
+| 13.a. Table comments          | 🤷🏼‍♂️         |
+| 13.b. Column comments         | 🤷🏼‍♂️         |
+| 13.c. COMMENT … IS NULL       | 🤷🏼‍♂️         |
+| 13.d. Index comments          | ❌ (parse fail) |