semvec/pypi-packages huggingface dataset:
backwork-backup-postgresql 0.2.2
Backwork plug-in for PostgreSQL backups.
License: Apache 2

# backwork-backup-postgresql [![Build Status](https://travis-ci.org/IBM/backwork-backup-postgresql.svg?branch=master)](https://travis-ci.org/IBM/backwork-backup-postgresql) [![PyPI version](https://badge.fury.io/py/backwork-backup-postgresql.svg)](https://badge.fury.io/py/backwork-backup-postgresql)
Add support for PostgreSQL backups on [`backwork`](https://github.ibm.com/apset/backwork).

## 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:
```sh
$ pip install backwork-backup-postgresql
```

## Using
After installing the plug-in you will be able to use the `backup mysql` command
on `backwork`.

```sh
backwork backup postgresql -h
usage: backwork 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
$ backwork 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.
backwork-backup-mongo 0.3.2
Backwork plug-in for MongoDB backups.
License: Apache 2

# backwork-backup-mongo [![Build Status](https://travis-ci.org/IBM/backwork-backup-mongo.svg?branch=master)](https://travis-ci.org/IBM/backwork-backup-mongo) [![PyPI version](https://badge.fury.io/py/backwork-backup-mongo.svg)](https://badge.fury.io/py/backwork-backup-mongo)
Adds support for MongoDB backups to [`backwork`](https://github.com/IBM/backwork).

## Requirements
This plug-in is build on top of [`mongodump`](https://docs.mongodb.com/manual/reference/program/mongodump/#bin.mongodump),
so you will need to have [`mongo-tools`](https://github.com/mongodb/mongo-tools)
installed.

If you already have the `mongod` server or `mongo` client installed then you
should have `mongodump`. If not, you can install them using the
[official packages](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/#packages)
or build from [source](https://github.com/mongodb/mongo-tools).

## Installing
You can use `pip` to install this plug-in:
```sh
$ pip install backwork-backup-mongo
```

## Using
After installing the plug-in you will be able to use the `backup mongo` and `restore mongo` commands
on `backwork`.


#### `backwork backup mongo`
```sh
$ backwork backup mongo --help
usage: backwork backup mongo [-h]

Backup a MongoDB database. It uses `mongodump` so it's required to have it
installed and added to the system's PATH. You can use any of the arguments
supported by `mongodump`. Use `mongodump --help` for more information.

optional arguments:
  -h, --help  show this help message and exit
```

You can pass any option that you would normally use on `mongodump`, e.g.:

```sh
$ backwork backup mongo --user=user --password=pass --host=mongo
```

The only exception is `-h` which is reserved for the help/usage message, so the
host needs to be passed as `--host`.



#### `backwork restore mongo`

```sh
$ backwork restore mongo --help
usage: backwork restore mongo [-h]

Restore a MongoDB database. It uses `mongorestore` so it's required to have it
installed and added to the system's PATH. You can use any of the arguments
supported by `mongorestore`. Use `mongorestore --help` for more information.

optional arguments:
  -h, --help  show this help message and exit
```

You can pass any option that you would normally use on `mongorestore`, e.g.:

```sh
$ backwork restore mongo --user=user --password=pass --host=mongo dumps
```

The only exception is `-h` which is reserved for the help/usage message, so the
host needs to be passed as `--host`.
backwork-backup-mysql 0.3.1
Backwork plug-in for MySQL backups.
License: Apache 2

# backwork-backup-mysql [![Build Status](https://travis-ci.org/IBM/backwork-backup-mysql.svg?branch=master)](https://travis-ci.org/IBM/backwork-backup-mysql) [![PyPI version](https://badge.fury.io/py/backwork-backup-mysql.svg)](https://badge.fury.io/py/backwork-backup-mysql)
Add support for MySQL backups on [`backwork`](https://github.com/IBM/backwork).

## Requirements
This plug-in is build on top of [`mysqldump`](http://dev.mysql.com/doc/refman/en/mysqldump.html),
so you will need to it installed.

`mysqldump` is part of the `mysql` client.cd .

## Installing
You can use `pip` to install this plug-in:
```sh
$ pip install backwork-backup-mysql
```

## Using
After installing the plug-in you will be able to use the `backup mysql` and `restore mysql` commands
on `backwork`:


#### backwork backup mysql
```sh
$ backwork backup mysql -h
usage: backwork backup mysql [-h] [--gzip] [-o OUTPUT]

Backup a MySQL database. It uses `mysqldump` so it's required to have it
installed and added to the system's PATH. You can use any of the arguments
supported by `mysqldump`. Use `mysqldump -h` 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
```

You can pass any option that you would normally use on `mysqldump`:

```sh
$ backwork backup mysql --host 192.168.99.1 -u root -ppassword --port 32769 --all-databases
```

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 `mysqldump` into a
file.

#### backwork restore mysql

```sh
usage: backwork restore mysql [-h] [--gzip] [-i INPUT]

Restore MySQL databases. It uses `mysql` so it's required to have it
installed and added to the system's PATH.

optional arguments:
  -h, --help            show this help message and exit
  --gzip                decompress backup file before restoring (requires gzip to be installed)
  ```

You can pass any option that you would normally use to connect to your mysql instance:

```sh
$ backwork restore mysql --host 192.168.99.1 -u root -ppassword --port 32769 --gzip --input=="mybackup.archive.gz"
```

**Important:** There is a conflict with the `-h` argument since it is reserved
for the help/usage message. User `--host` to pass the hostname.
backwork-backup-files 0.3.1
Backwork plug-in for file backups.
License: Apache 2

# backwork-backup-files [![Build Status](https://travis-ci.org/IBM/backwork-backup-files.svg?branch=master)](https://travis-ci.org/IBM/backwork-backup-files) [![PyPI version](https://badge.fury.io/py/backwork-backup-files.svg)](https://badge.fury.io/py/backwork-backup-files)

Add support for file backups on [`backwork`](https://github.com/IBM/backwork).

## Requirements
This plug-in is build on top of [`tar`](https://linux.die.net/man/1/tar).

## Installing
You can use `pip` to install this plug-in:
```sh
$ pip install backwork-backup-files
```

## Using
After installing the plug-in you will be able to use the `backup files` and `restore files` commands
on `backwork`:

#### backwork backup files

```sh
$ backwork backup files -h
usage: backwork backup files [-h] -f FILE

Back up one or more files. It uses `tar -cz` which gzips the output. You can
use any of the arguments supported by `tar`. Add a list of files and
directories you want backed up as the last thing in the line. Use `tar --help`
for more information.

optional arguments:
  -h, --help            show this help message and exit
  -o FILE, --output FILE  output gzipped file path
```

You can pass any option that you would normally use with `tar`:

```sh
$ backwork backup files -o foo.tgz --verbose /tmp /var/log
```

As shown in the `--help` message, there is one required arguments you
must use in your backup process.

`-o FILE` or `--output FILE` will save the output of `tar` into a
file.

#### backwork restore files

```sh
usage: backwork restore files [-h] input

Restore one or more files from a .tar.gz file. It uses `tar xvzf`. You can
use any of the arguments supported by `tar`. Use `tar --help` for more
information.

positional arguments:
  input       .tar.gz file to restore from

optional arguments:
  -h, --help  show this help message and exit
```

**Important:** There is a conflict with the `-h` argument since it is reserved
for the help/usage message. Use `--dereference` to follow symlinks.

## Building and Publishing

Travis will publish builds for you. To build, push a tag to the repo:

```
git tag -a v0.1.2 -m 'v0.1.2'
git push --tags
```