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

pg-to-excel

v1.1.0

Published

Generates an excel file from a postgres query and connection

Downloads

7

Readme

pg-to-excel

Generates an excel file from a postgresql connection and a query file.

Parameters:

queryfile, f            path to a query file, must be used if query is not specified        string
query, q                query as string, must be used if queryfile is not specified         string
outputfile, o           path to the output file, will be defaulted to ${timestamp}.xlsx     string
constr, c               connection string, <postgres://user:password@host:port/database>    string

Queryfiles and output files can both be defined relative or absolute.

Examples

The queries contain mixed examples, for example -c <value> vs --c <value> vs -c=<value> vs --c=<value> to demonstrate that all of them are possible. You can substitute one with the other.

With a query file

pg-to-excel -f query.sql -c 'postgres://user:password@localhost:5432/database'

With a query

pg-to-excel --q 'SELECT * FROM user' --c 'postgres://user:password@localhost:5432/database'

With a specified output filename

pg-to-excel -q='SELECT * FROM user' -c='postgres://user:password@localhost:5432/database' -o=test.xlsx

Relative and absolute paths

pg-to-excel --q=/opt/project/queryfile.sql --c='postgres://user:password@localhost:5432/database' --o=output.xlsx

API

The API is also exposed with a function and can be called with (queryFile, query, outputfile, connection). The function is async and returns the output parameter, because I had no idea what to return. The file stream?

const run = require('pg-to-excel');

const query = 'SELECT * FROM user;';
const output = 'testfile.xlsx';
const constr = 'postgres://user:password@localhost:5432/database';

run(null, query, output, constr);