Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeyism/psql2csv
A library and a CLI to download PostgreSQL schemas and tables
https://github.com/joeyism/psql2csv
cli command-line command-line-tool csv downloader postgresql psql schema sql table
Last synced: about 2 months ago
JSON representation
A library and a CLI to download PostgreSQL schemas and tables
- Host: GitHub
- URL: https://github.com/joeyism/psql2csv
- Owner: joeyism
- License: other
- Created: 2017-12-23T19:20:11.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-24T15:37:07.000Z (about 7 years ago)
- Last Synced: 2024-10-14T02:23:06.887Z (3 months ago)
- Topics: cli, command-line, command-line-tool, csv, downloader, postgresql, psql, schema, sql, table
- Language: Python
- Homepage:
- Size: 32.2 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# psql2csv
A library and a CLI to download PostgreSQL schemas and tables
# Installation
```bash
pip3 install psql2csv
```
# Usage
## CLI
To run the CLI normally, just run
```bash
psql2csv
```
which, by default, downloads the entire database of all schemas and all of its tables into a folder called `output/`. If your database is large, THIS IS NOT RECOMMENDED. To specify the details, see the options below.
```bash
Options:
--dbname TEXT The database name
--host TEXT URL Endpoint of the database
--user TEXT Login username
--password TEXT Login password
--all Downloads everything
--schema Downloads a schema
--table Downloads a table
--stdout Whether to print which schema and table is downloading
--help Show this message and exit.
```
For example, downloading a specific table can be done by running
```bash
psql2csv --table
```
and downloading all tables in a schema can be done by running
```bash
psql2csv --schema
```
## API
There are 3 runnable functions:
* [download_all](#download_all)
* [download_schema](#download_schema)
* [download_table](#download_table)
### download_all
**download_all**(conn, output_folder='output', exclude_schemas=['pg_toast', 'pg_temp_1', 'pg_toast_temp_1', 'pg_catalog', 'public', 'information_schema'], stdout=False)
Downloads all schemas and all its tables by specifying schema
* conn: input connection or psql2csv.DataBase. If it's an input connection, it'll eventually be converted to psql2csv.DataBase class
* output_folder: the name of the folder to place the data
* exclude_schemas: Which schemas to exclude while downloading everything
* stdout: whether to print which schema and table is downloading. True = print
```python
from psql2csv import download_all
import psycopg2
conn = psycopg2.connect("dbname='dbname' user='username' host='url' password='password'")
download_all(conn)
```
### download_schema
**download_schema**(conn, schema, output_folder='output', stdout=False)
Downloads schema and its tables by specifying schema
* conn: input connection or psql2csv.DataBase. If it's an input connection, it'll eventually be converted to psql2csv.DataBase class
* schema: name of the schema to download
* output_folder: the name of the folder to place the data
* stdout: whether to print which schema and table is downloading. True = print
```python
from psql2csv import download_schema
import psycopg2
conn = psycopg2.connect("dbname='dbname' user='username' host='url' password='password'")
download_schema(conn, "schema_name")
```
### download_table
**download_table**(conn, schema, table, output_folder='output', stdout=False)
Downloads table by specifying schema and table
* conn: input connection or psql2csv.DataBase. If it's an input connection, it'll eventually be converted to psql2csv.DataBase class
* schema: name of the schema that the table belongs to
* table: name of the table to download
* output_folder: the name of the folder to place the data
* stdout: whether to print which table is downloading. True = print
```python
from psql2csv import download_table
import psycopg2
conn = psycopg2.connect("dbname='dbname' user='username' host='url' password='password'")
download_table(conn, "schema_name", "table_name")
```
## Versions
**1.1.x**
* Added CLI
**1.0.x**
* First publish