sqleton

import Database from 'better-sqlite3'; import fs from 'node:fs'; // Sqleton is a CommonJS module, so 'require' is the canonical way to import. const sqleton = require('sqleton'); // Create a dummy in-memory SQLite database for demonstration const db = new Database(':memory:'); db.exec(` CREATE TABLE users ( id INTEGER PRIMARY KEY, name TEXT NOT NULL, email TEXT UNIQUE ); CREATE TABLE posts ( post_id INTEGER PRIMARY KEY, user_id INTEGER NOT NULL, title TEXT NOT NULL, content TEXT, FOREIGN KEY (user_id) REFERENCES users(id) ); CREATE TABLE comments ( comment_id INTEGER PRIMARY KEY, post_id INTEGER NOT NULL, user_id INTEGER NOT NULL, text TEXT NOT NULL, FOREIGN KEY (post_id) REFERENCES posts(post_id), FOREIGN KEY (user_id) REFERENCES users(id) ); `); const outputPath = 'db_schema.svg'; const outputStream = fs.createWriteStream(outputPath); // Generate the schema diagram sqleton(db, outputStream, { layout: 'dot', // Specify the Graphviz layout engine title: 'My Application Schema', direction: 'LR', // Graph direction: Left-to-Right edgeLabels: true, // Show labels on foreign key edges }) .then(() => { console.log(`Schema diagram generated successfully at ${outputPath}`); outputStream.end(); db.close(); }) .catch((err: Error) => { console.error('Failed to generate schema diagram:', err.message); // Provide specific guidance for the common Graphviz error if (err.message.includes('dot: not found') || err.message.includes('ENOENT')) { console.error('Error: Graphviz `dot` command not found. Please ensure Graphviz is installed and in your system PATH.'); console.error('Installation instructions: http://www.graphviz.org/download/'); } outputStream.end(); db.close(); });