Metadata-Version: 2.1
Name: backwork-backup-postgresql
Version: 0.1.5
Summary: Backwork plug-in for PostgreSQL backups.
Home-page: https://github.com/ibm/backwork-backup-postgresql
Author: Luiz Aoqui
Author-email: laoqui@ca.ibm.com
License: Apache 2
Description: # monsoon-backup-postgresql
        Add support for PostgreSQL backups on [`monsoon`](https://github.ibm.com/apset/monsoon).
        
        ## Requirements
        This plug-in is build on top of [`pg_dump`](https://www.postgresql.org/docs/current/static/app-pgdump.html),
        so you will need to it installed.
        
        `pg_dump` is part of the `postgresql` client.
        
        ## Installing
        You can use `pip` to install this plug-in from Artifactory.
        
        First you will need to configure your pip client by creating or editing the
        `~/.pip/pip.conf` file to look like this:
        
        ```
        [global]
        index-url = https://pypi.python.org/simple
        extra-index-url = https://<USERNAME>:<API KEY>@na.artifactory.swg-devops.com/artifactory/api/pypi/apset-pypi-local/simple
        ```
        
        After that you should be able to run
        ```sh
        $ pip install monsoon-backup-postgresql
        ```
        
        Alternatively, you can install it directly from GHE:
        ```sh
        $ pip install git+ssh://git@github.ibm.com/apset/monsoon-backup-postgresql
        ```
        
        ## Using
        After installing the plug-in you will be able to use the `backup mysql` command
        on `monsoon`.
        
        ```sh
        monsoon backup postgresql -h
        usage: monsoon backup postgresql [-h] [--gzip] [-o OUTPUT] -P PASSWORD
        
        Backup a PostgreSQL database. It uses `pg_dump` so it's required to have it
        installed and added to the system's PATH. You can use any of the arguments
        supported by `pg_dump`. Use `pg_dump --help` for more information.
        
        optional arguments:
          -h, --help            show this help message and exit
          --gzip                compress output file (requires gzip to be installed)
          -o OUTPUT, --output OUTPUT
                                output file path
          -P PASSWORD, --password PASSWORD
                                PostgreSQL connection password
        ```
        
        You can pass any option that you would normally use on `mysqldump`:
        
        ```sh
        $ monsoon backup postgresql -P password --host=192.168.99.1 --username=root --port=32769 --dbname=MY_DATABASE
        ```
        
        As shown in the `--help` message, there are two extra arguments you can use in
        your backup process `--gzip` and `-o`.
        
        `--gzip` will compress the output and requires the `gzip` command to be
        available in your system.
        
        `-o OUTPUT` or `--output OUTPUT` will save the output of `pg_dump` into a
        file.
        
        **Important:** There is a conflict with the `-h` argument since it is reserved
        for the help/usage message. User `--host` to pass the hostname.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 2 :: Only
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Database
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
