duckerd 0.1.1 → 0.1.3

package/README.md

@@ -26,7 +26,7 @@ Generate an ERD diagram of the database schemas.
 
 - `-d, --database <path>`: Path to the database file
 - `-t, --theme [theme]`: Theme of the chart (choices: `default`, `forest`, `dark`, `neutral`, default: `default`)
-- `-o, --output [output]`: Path to the output file
+- `-o, --output <path>`: Path to the output file
 - `-w, --width [width]`: Width of the page (default: `1024`)
 - `-H, --height [height]`: Height of the page (default: `768`)
 - `-f, --outputFormat [format]`: Output format for the generated image (choices: `svg`, `png`, `pdf`, default: `png`)
@@ -36,3 +36,25 @@ Generate an ERD diagram of the database schemas.
 ```bash
 duckerd -d ./mydb.duckdb -o ./erd.png -f png -t neutral -w 1600
 ```
+
+**It's possible that you need to re-run the command after the first execution, because the DuckERD CLI automatically installs the `@mermaid-js/mermaid-cli` package globally when it's missing on your system.**
+
+## Usage example
+
+### Download the example database
+For this example we use the [AWS IAM database](https://raw.githubusercontent.com/tobilg/aws-iam-data/main/data/db/iam.duckdb) from the [AWS IAM Data](https://github.com/tobilg/aws-iam-data) project.
+
+```bash
+curl -LO https://raw.githubusercontent.com/tobilg/aws-iam-data/main/data/db/iam.duckdb
+```
+
+### Generate the ERD
+Then, we can generate the ERD as PNG with the `neutral` theme and otherwise default settings:
+
+```bash
+duckerd -d ./iam.duckdb -f png -t neutral
+```
+
+### Result
+
+![ERD of the AWS IAM DuckDB database](docs/iam_erd.png)

package/dist/index.js

@@ -16,13 +16,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const path = __importStar(require("path"));
@@ -67,7 +77,8 @@ const run = async (dbPath, options) => {
                 return;
             }
             if (stderr) {
-                console.error(`ERD generation stderr: ${stderr}`);
+                console.error(`ERD generation: ${stderr}`);
+                console.error(`Please re-run the command!`);
                 return;
             }
             console.log(`ERD diagram generated: ${outputFile}`);

package/dist/lib/metadata.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeDataType = exports.generateMermaidCodeForAllDBs = exports.getMetadata = void 0;
+exports.addCommentIfNecessary = exports.sanitizeDataType = exports.generateMermaidCodeForAllDBs = exports.getMetadata = void 0;
 // Database metadata query
 const databaseMetadataQuery = `SELECT database_name as databaseName FROM duckdb_databases() WHERE database_name NOT IN ('system', 'temp') ORDER BY database_name`;
 // Schema metadata query
@@ -84,7 +84,7 @@ const generateMermaidCodeForAllDBs = (metadata) => {
             // Add tables, columns and constraints
             mermaidCode += tables.map((table) => {
                 return `"${table.databaseName}.${table.name}" {
-${table.columns.map((column) => `      ${(0, exports.sanitizeDataType)(column.dataType.toUpperCase())} ${column.name} ${table.constraints?.filter((constraint) => constraint.columnName === column.name).map((constraint) => ((constraint.constraintType === "PRIMARY KEY" ? "PK" : "") || (constraint.constraintType === "FOREIGN KEY" ? "FK" : "") || "")).filter(str => str)}`).join("\n")}
+${table.columns.map((column) => `      ${(0, exports.sanitizeDataType)(column.dataType.toUpperCase())} ${column.name} ${table.constraints?.filter((constraint) => constraint.columnName === column.name).map((constraint) => ((constraint.constraintType === "PRIMARY KEY" ? "PK" : "") || (constraint.constraintType === "FOREIGN KEY" ? "FK" : "") || "")).filter(str => str)}${(0, exports.addCommentIfNecessary)(column.dataType)}`).join("\n")}
     }\n${table.constraints?.filter((constraint) => constraint.constraintType === "FOREIGN KEY").map((constraint) => `    "${table.databaseName}.${constraint.sql.match(/(?:^|)REFERENCES\s([^*]+?)\b\(/i)[1]}" ||--o{ "${table.databaseName}.${table.name}" : has`).join("\n")}`;
             }).join("\n    ");
             return mermaidCode;
@@ -99,6 +99,22 @@ ${table.columns.map((column) => `      ${(0, exports.sanitizeDataType)(column.da
 };
 exports.generateMermaidCodeForAllDBs = generateMermaidCodeForAllDBs;
 const sanitizeDataType = (dataType) => {
-    return dataType.startsWith("STRUCT(") ? "STRUCT" : dataType;
+    if (dataType.startsWith("STRUCT(")) {
+        return dataType.replace("STRUCT(", "STRUCT").replace(")", "");
+    }
+    if (dataType.startsWith("ENUM(")) {
+        return "ENUM";
+    }
+    if (dataType.includes(",")) {
+        return dataType.replace(",", "_");
+    }
+    return dataType;
 };
 exports.sanitizeDataType = sanitizeDataType;
+const addCommentIfNecessary = (dataType) => {
+    if (dataType.startsWith("ENUM(")) {
+        return ` "${dataType.replace("ENUM(", "").replace(")", "").split(",").map((value) => value.trim().replace(/'/g, "").replace(/"/g, "")).join(", ")}"`;
+    }
+    return "";
+};
+exports.addCommentIfNecessary = addCommentIfNecessary;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "duckerd",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "A CLI tool for generating ERD diagrams from DuckDB databases",
   "author": "TobiLG <tobilg@gmail.com>",
   "repository": {
@@ -16,7 +16,7 @@
     "duckerd": "dist/index.js"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "rm -rf dist && tsc",
     "start": "ts-node src/index.ts"
   },
   "engines": {
@@ -24,12 +24,12 @@
   },
   "keywords": ["duckdb", "erd", "diagram", "cli"],
   "dependencies": {
-    "commander": "^12.1.0",
-    "duckdb-async": "^1.0.0"
+    "commander": "^13.1.0",
+    "duckdb-async": "^1.2.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.9",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.6.2"
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.2"
   }
 }