pg-structure
TypeScript icon, indicating that this package has built-in type declarations

7.15.3 • Public • Published

pg-structure

Reverse engineer PostgreSQL database as a detailed JS Object.

Home Page

Please see pg-structure.com for details.

Installation

$ npm install pg-structure

Synopsis

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;
}

Details

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.

Package Sidebar

Install

npm i pg-structure

Weekly Downloads

3,433

Version

7.15.3

License

MIT

Unpacked Size

533 kB

Total Files

226

Last publish

Collaborators

  • ozum