npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

easy-pg-scanner

v1.0.4

Published

Easy postgres database loader

Downloads

33

Readme

Easy PG Scanner

Easy PG Scanner is a Node.js package designed specifically for personal usage to simplify the process of reading PostgreSQL database schemas, including tables, functions, columns, triggers, indexes, and check constraints. It provides a convenient interface to fetch this information and organize it into a structured array.

Installation

To install Easy PG Scanner, you can use npm:

npm install easy-pg-scanner

Usage

Here's a simple example demonstrating how to use Easy PG Scanner:

const loadDatabase = require("easy-pg-scanner");

// Your PostgreSQL connection options
const connectionOptions = {
  host: "...",
  port: 5432,
  user: "...",
  password: "...",
  database: "postgres",
};

const fetchDatabase = async () => {
  try {
    const database = await loadDatabase(connectionOptions);
    console.log(database);
  } catch (error) {
    console.error("Error loading database:", error);
  }
};

fetchDatabase();

Output Format

The package exports a function loadDatabase which, when invoked with the appropriate connection options, asynchronously fetches the database schema and returns an array representing the schema information. The array contains objects representing each schema in the database. Each schema object includes the following properties:

  • schema: The name of the schema.
  • checkConstraints: An array of check constraints defined in the schema.
  • functions: An array of functions defined in the schema.
  • tables: An array of objects representing each table in the schema. Each table object contains:
    • table: The name of the table.
    • columns: An array of column objects representing the columns in the table. Each column object includes properties such as name, nullable, defaultValue, type,isArray,unique, primary, foreign, and check.
    • indexes: An array of indexes defined on the table.
    • foreignKeys: An array of foreign keys defined on the table.
    • triggers: An array of triggers defined on the table.