relational-schema

import { generateSchema, introspectSchema } from 'relational-schema'; import fs from 'node:fs/promises'; import path from 'node:path'; async function runSchemaGeneration() { const config = { host: process.env.DB_HOST ?? '127.0.0.1', client: process.env.DB_CLIENT ?? 'postgres', // or 'mysql' port: parseInt(process.env.DB_PORT ?? '5432', 10), // 3306 for mysql user: process.env.DB_USER ?? 'postgres', password: process.env.DB_PASSWORD ?? 'secure_password', database: process.env.DB_NAME ?? 'mydb', outdir: './src/schemas', format: 'typescript' }; try { console.log('Introspecting database schema...'); const schema = await introspectSchema(config); console.log('Schema introspected successfully. Generating files...'); // The generateSchema function returns an object of { filePath: content } const generatedFiles = await generateSchema(schema, config); await fs.mkdir(config.outdir, { recursive: true }); for (const [fileName, content] of Object.entries(generatedFiles)) { const fullPath = path.join(config.outdir, fileName); await fs.writeFile(fullPath, content); console.log(`Generated: ${fullPath}`); } console.log('Schema generation complete!'); } catch (error) { console.error('Failed to generate schema:', error); process.exit(1); } } // To run this example, ensure you have a database running and set environment variables. // Example of typical CLI usage: // 1. Create a `relation-config.json` in your project root: // { // "host": "127.0.0.1", "client": "postgres", "port": 5432, // "user": "postgres", "password": "secure_password", // "database": "mydb", "outdir": "src/schemas", "format": "typescript" // } // 2. Run from your terminal: // npx relations introspect runSchemaGeneration();