psql-cm 0.0.7 → 0.0.8

data/History.md

@@ -1,3 +1,11 @@
+# 0.0.8 - 2012-04-23
+
+Corrected error message.
+
+Added overview to README as well as some clarifying changes.
+
+Added submit examples to README.
+
 # 0.0.7 - 2012-04-20
 
 --database CLI option for specifying a single database name.

data/README.md

@@ -1,5 +1,30 @@
 # PostgreSQL Change Management Tool
 
+## Overview
+
+Experienced software engineers and database administrators know very well that
+database systems need care and feeding, especially as they grow over time.
+
+A Database Change Management System (DB CMS) is one method of carefully
+accounting for  changes to live database schemas in a controlled manner with
+full history and auditability of who changed what and when.
+
+A DB CMS itself is a well documented process and is typically required to meet
+the following criteria,
+
+- Managed the deployment of changes to a schema, specifically the DDL and DML,
+  in a controlled and auditable manner
+
+- Control the deployment / migration of DDL from one Server/Database/Schema to
+  another
+
+- Integrate directly with the database system, backups and restores while
+  preserving the integrity of the data schema within the CMS
+
+- Regenerate DDL for Disaster Recovery in the absence of database backups
+
+psql-cm is a tool which was created to help make achieving these goals easier.
+
 ## What psql-cm is
 
 This project is a tool to assist with an ITIL like change management process
@@ -51,14 +76,14 @@ to separate multiple database names.
 Dump the current database schema to the specified --sql-path directory, if none
 specified it dumps to $PWD/sql
 
-    $ psql-cm dump --database psqlcm_test
+    $ psql-cm dump --database psqlcm_test --sql-path $HOME/sql
 
 ## Restore
 
 Restore a previously psql-cm dumped database schema into a brand new postgresql
 database cluster.
 
-    $ psql-cm restore --database psqlcm_test
+    $ psql-cm restore --database psqlcm_test --sql-path $HOME/sql
 
 ## Submit
 
@@ -155,8 +180,8 @@ a find command on \*nix:
     sql/psqlcm_test/schema_one.sql
     sql/psqlcm_test/schema_two.sql
 
-We can now do a restore restore by droping the database and then running the
-psql-cm restore action.
+We can now do a restore by droping the database and then running the psql-cm
+restore action.
 
     $ dropdb psqlcm_test
     $ psql-cm --database psqlcm_test restore
@@ -183,17 +208,24 @@ To play around inside of a running psql-cm Ruby environment use the console:
 The 'Walkthrough' from above is encoded as rake tasks, each step can be
 seen including all debugging output by running:
 
-    rake clean      # Remove the sql/ directory in the current working directory.
-    rake create     # Create the development database psqlcm_development, including two schemas.
-    rake debug      # Enable debugging using environment variable DEBUG
-    rake drop       # Drop the development database psqlcm_development
-    rake dump       # Remove sql/ from CWD and then run the psql-cm dump action on psqlcm_development
-    rake build      # Build the psql-cm gem.
-    rake install    # Build then install the psql-cm gem.
-    rake restore    # Create psqlcm_development, run psql-cm actions {setup, dump, restore} in order.
-    rake setup      # Create psqlcm_development and run psql-cm setup on it
+    rake build          # Build the psql-cm gem
+    rake clean          # Remove sql/ in the current working directory
+    rake console        # Console, builds installs then runs console
+    rake create         # Create database psqlcm_development, and two schemas
+    rake debug          # Enable debugging using environment variable DEBUG
+    rake drop           # Drop the database psqlcm_development
+    rake dump           # Run psql-cm dump on psqlcm_development
+    rake install        # Build then install the psql-cm gem
+    rake restore        # Run psql-cm restore on psqlcm_development
+    rake setup          # Run psql-cm setup on schemas within psqlcm_development
+    rake submit:file    # Run psql-cm submit with a file based change
+    rake submit:string  # Run psql-cm submit with a string change from cli
 
 Specifically to do a full-cycle walkthrough on the psqlcm\_development database,
 
-    rake drop create setup dump drop restore
+    rake create setup dump drop restore submit:string submit:file
+
+Then to re-run the full cycle we need to add 'drop' in the front,
+
+    rake drop create setup dump drop restore submit:string submit:file
 

data/lib/psql-cm/database.rb

@@ -12,7 +12,7 @@ module PSQLCM
 
     # Delegator to PG::Connection
     def __getobj__ ; @db end
-    def __setobj__(object) ;  end
+    def __setobj__(object) end
 
     def db
       unless @config[:dbname] == 'postgres'

data/lib/psql-cm/restore.rb

@@ -23,10 +23,10 @@ module PSQLCM
               sh "psql #{db(database).psql_args} #{database} < #{cm_file}"
 
               ensure_cm_table_exists(database,schema)
-              row = db(database).exec("SELECT content from #{schema}.#{config.cm_table}
+              Tempfile.open('base.sql') do |temp_file|
+                row = db(database).exec("SELECT content from #{schema}.#{config.cm_table}
                                       WHERE is_base IS true ORDER BY created_at
                                       DESC LIMIT 1;")
-              Tempfile.open('base.sql') do |temp_file|
                 temp_file.write(row)
                 sh "psql #{db(database).psql_args} #{database} < #{temp_file.path}"
               end

data/lib/psql-cm/submit.rb

@@ -4,7 +4,7 @@ module PSQLCM
       databases.each do |database|
         schemas(database).each do |schema|
           if config.change.to_s.empty?
-            halt! "Content must be given! (--content=<file or \"sql string\">)"
+            halt! "Content must be given! (--change=<file or \"sql string\">)"
           elsif File.exists?(config.change)
             content = File.open(config.change, 'r') { |file| file.read }
           else # SQL String
@@ -25,18 +25,13 @@ module PSQLCM
           debug "submit> #{database}.#{schema}.#{config.cm_table}: #{config.change}"
           db(database).exec(
             "INSERT INTO #{schema}.#{config.cm_table}
-          (is_base,implementer,content)
-          VALUES (false,$1,$2)",
-            [implementer,content]
-          )
+              (is_base,implementer,content)
+              VALUES (false,$1,$2)",
+                [implementer,content]
+            )
         end # schemas
       end # databases
     end # def submit!
 
-    private
-
-    def validate(change)
-
-    end
   end
 end

data/lib/psql-cm/version.rb

@@ -1,4 +1,4 @@
 module PSQLCM
-  Version = '0.0.7'
+  Version = '0.0.8'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: psql-cm
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
+date: 2012-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: PostgreSQL CM