postgres-backup 0.0.4

Automation of the creation of backups of Postgres databases

Backup Postgres Database

Basic Usage

This simple Python package allows you to create easily the database backup of Postgres databases. You can upload them to cloud storage buckets by creating a cron job.

    from postgres_backup import Backup

    # Instantiate the backup object with Postgres database_uri
    backup = Backup(database_uri)

    # Create the file for backup
    backup.create()

Note that the URI has the following structure: db:engine:[//[user[:password]@][host][:port]/][dbname]

Bucket Storage

Have provided also the ability to store those backups in cloud buckets.

Google Cloud Storage

For using this functionality, you need to install the dependencies needed of the package:

    pip3 install postgres-backup[gcs]

And then after we have the backup created, we would keep following with:

    # Create the backup
    backup.create()

    # Upload it to google cloud storage
    backup.upload(
        provider=CloudProviders.gcs.value,
        bucket_name=bucket_name,
        google_cloud_certification
    )

Where the google_cloud_certification is a dictionary, with the key-values of the client api keys:

• type
• project_id
• private_key_id
• private_key
• client_email
• client_id
• auth_uri
• token_uri
• auth_provider_x509_cert_url
• client_x509_cert_url

An example would be:

    google_cloud_credentials = {
      type: "service_account",
      project_id: "xxx-saas",
      private_key_id: "xxxxxxxx",
      private_key: "-----BEGIN PRIVATE KEY-----\nxxxxxxxxxx\n-----END PRIVATE KEY-----\n",
      client_email: "[e-mail]",
      client_id: "xxx",
      auth_uri: "https://accounts.google.com/o/oauth2/auth",
      token_uri: "https://oauth2.googleapis.com/token",
      auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs",
      client_x509_cert_url: "https://www.googleapis.com/robot/v1/metadata/x509/xxx%xxx-saas.iam.gserviceaccount.com"
    }

In the case that we do not have a bucket already created for storing the backups, we could add additional parameters to create it:

    from postgres_backup.schemas import CloudStorageType, CloudProviders

    backup.upload(
        provider=CloudProviders.gcs.value,
        bucket_name=bucket_name,
        google_cloud_certification,
        create_bucket=True,
        storage_class=CloudStorageType.STANDARD.value
    )