semvec/pypi-packages huggingface dataset:
psql2csv 1.1.4
A library and a CLI to download PostgreSQL schemas and tables

psql2csv
========

A library and a CLI to download PostgreSQL schemas and tables

Installation
============

.. code:: bash

    pip3 install psql2csv

Usage
=====

CLI
---

To run the CLI normally, just run

.. code:: bash

    psql2csv

.. code:: 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.

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

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

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

Versions
--------

**1.1.x**

-  Added CLI

**1.0.x**

-  First publish