ops_backups 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6162626296f9b33f706c46ad74419d1580deb96117cc6cfb994c1cab6606517e
-  data.tar.gz: aa24b48098a259532ccb7f46aa103d0103b358b0c488d6d19c9b1e87f9a357e7
+  metadata.gz: 9c5630e25e938e9e3ff8df947ec38c0135b12a2d94b3a46e9c6d55d3b70f5a0c
+  data.tar.gz: 8bb0cab72c776e01cda428050591c97658de1401cf3420b7bde758ace3b44c06
 SHA512:
-  metadata.gz: fd70dada6f380d7ec9a841a1b8d1b021cffe3531bf1766db1527acebc2b92bdba8e46fc7f9cfd71fd6826bd43a41a4c3a33981453571f8f6a338bad4930234e4
-  data.tar.gz: 20e4668207a653ce6c3b2a48c8dd1a752cf305701b45c5f68dcf0d3609ec3018d79f71516d50616a3d2fea7f180620907f522350481f82f23156d8df0c9780ad
+  metadata.gz: 9c06a9d87783b4950fac61f6e60f75d67288cff322d47bf953a1ffd33c7cbf71972b1b24cff28bd5310e0f9d92e4ebd1fa5280ab97a4ff8f37f43ffbf99f2d00
+  data.tar.gz: 357728c90e376f3101b07f948d2a28b379f453ddc8cd8aa7d0e29009e83506a4a8bc7c2ae0d3aeb47038f18fa31d305398b4cf4291ac1d6698c49c0178286b03

data/README.md

@@ -14,6 +14,30 @@ bundle add ops_backups
 rails generate ops_backups:install
 ```
 
+# Scripts
+
+`pgdb` is a script that can be used to backup and restore a postgres database and wraps pg_dump and pg_restore in the context of [Kamal](https://kamal-deploy.org/) for ease of use. Environment here coresponds to the destination in Kamal.
+
+```
+Usage: pgdb <command> <environment> [<additional_args>]
+
+Available commands:
+  console <environment>                   - Opens a database console for the specified environment.
+  create <environment>                    - Creates a new database for the specified environment.
+  revert <environment> <backup_db_name>   - Reverts the database to a specified backup.
+  backup <environment>                    - Creates a clone of the remote database as a backup on the server.
+  backup:local <environment>              - Backs up the remote database to a local dump file.
+  drop <environment>                      - Drops the database of the specified environment after confirmation.
+  pull <environment|url> [local_db_name]  - Pulls the remote database to a local database with an optional custom name (optional).
+  push <environment> <local_db_name>      - Pushes a local database to the remote environment, creating a backup of the remote.
+  rename <environment> [new_db_name]      - Renames the main database of the specified environment, optionally using a new name (optional).
+  copy <source_env> <target_env>          - Copies a database from one environment to another, with backup of the target database.
+  list <environment>                      - Lists databases for the base URL associated with the environment.
+
+set EXCLUDE_TABLE_DATA to exclude data from specific tables on export
+e.g. EXCLUDE_TABLE_DATA=versions   bin/pgdb pull staging
+```
+
 # ActiveAdmin Integration
 
 If you are using ActiveAdmin, you can manage your backups through the admin interface. The generator rails generate ops_backups:activeadmin will create the necessary example configuration.
@@ -30,6 +54,5 @@ rails generate ops_backups:activeadmin
 - Create Unversioned Backup: Create a new unversioned backup, excluding specific tables.
 
 
-
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/db/migrate/20241114173612_create_ops_backups.rb

@@ -1,4 +1,4 @@
-class CreateOpsBackups < ActiveRecord::Migration[8.0]
+class CreateOpsBackups < ActiveRecord::Migration[5.0]
   def change
     # check if the table already exists
     return if table_exists?(:ops_backups)

data/lib/ops_backups/version.rb

@@ -1,3 +1,3 @@
 module OpsBackups
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ops_backups
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Koen Handekyn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-23 00:00:00.000000000 Z
+date: 2024-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails