Reverse engineer PostgreSQL database as a detailed JS Object.
npm install pg-structureReverse engineer PostgreSQL database as a detailed JS Object.
- Home Page
- Installation
- Synopsis
- Details
Please see pg-structure.com for details.
$ npm install pg-structure
``ts
import pgStructure from "pg-structure";
async function demo() {
// Prefer to use environment variables or ".env" file for the credentials. See the ".env.example" file.
const db = await pgStructure({ host: "host", database: "db", user: "u", password: "pass" }, { includeSchemas: ["public"] });
const table = db.get("contact");
const columnNames = table.columns.map((c) => c.name);
const columnTypeName = table.columns.get("options").type.name;
const indexColumnNames = table.indexes.get("ix_mail").columns;
const relatedTables = table.hasManyTables;
}
`
pg-structure` reverse engineers PostgreSQL database and lets you easily code, analyze, operate on PostgreSQL database structure by providing details about DB, Schema, Table, Column, ForeignKey, Relation, Index, Type and others.