https://github.com/david1602/pg-to-excel
Generates an excel file from a postgresql connection and a query (file)
https://github.com/david1602/pg-to-excel
excel postgres postgresql xlsx
Last synced: about 1 month ago
JSON representation
Generates an excel file from a postgresql connection and a query (file)
- Host: GitHub
- URL: https://github.com/david1602/pg-to-excel
- Owner: david1602
- License: apache-2.0
- Created: 2017-09-12T16:08:53.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-06-10T12:23:31.000Z (about 4 years ago)
- Last Synced: 2025-02-21T09:05:19.829Z (over 1 year ago)
- Topics: excel, postgres, postgresql, xlsx
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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, string
```
Queryfiles and output files can both be defined relative or absolute.
## Examples
The queries contain mixed examples, for example `-c ` vs `--c ` vs `-c=` vs `--c=` 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?
```javascript
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);
```