psql-cm 0.0.6 → 0.0.7

data/History.md

@@ -1,3 +1,12 @@
+# 0.0.7 - 2012-04-20
+
+--database CLI option for specifying a single database name.
+
+--change CLI option for submitting either a sql change string or an sql change
+file name.
+
+Implemented 'submit' action.
+
 # 0.0.6 - 2012-04-20
 
 Merged {base.sql, cm.sql} into a single sql-path/{database}/{schema}.sql file.

data/README.md

@@ -44,40 +44,67 @@ Once the prerequisites have been satisfied on your system, using the
 Setup the psql\_cm control tables on the target databases, use a comma (',')
 to separate multiple database names.
 
-    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" setup
+    $ psql-cm setup --database psqlcm_test
 
 ## Dump
 
 Dump the current database schema to the specified --sql-path directory, if none
 specified it dumps to $PWD/sql
 
-    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" dump
+    $ psql-cm dump --database psqlcm_test
 
 ## Restore
 
 Restore a previously psql-cm dumped database schema into a brand new postgresql
 database cluster.
 
-    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" restore
+    $ psql-cm restore --database psqlcm_test
 
-## Change
+## Submit
 
-TODO: Document how to commit a change.
+There are two ways to submit schema changes. The first is by passing the schema
+change on the command line as a string and the second is by specifying the path
+to a sql file. An example of each follows.
 
-## Command line parameters
+### SQL String
 
---databases argument may take multiple database targets, to do this pass them
-in ',' separated format, no spaces. Specifically the format is,
+    $ psql-cm submit --database psqlcm_test --schema schema_two --change "ALTER TABLE a_varchar ADD COLUMN a_timestamp timestamptz;"
 
-    $ psql-cm --databases adatabase,anotherdatabase,... ...
+Note that if you do not specify --schema the change is applied against the
+default schema (typically 'public').
 
---uri has the format,
+### SQL File
+
+    $ echo "ALTER TABLE a_varchar ADD COLUMN a_timestamp timestamptz;" > add_a_timestamp.sql
+    $ psql-cm submit --database psqlcm_test --schema schema_two --change add_a_timestamp.sql
+
+Note that when we do not specify a full path to the file, psql-cm will look
+for the file in the current working directory.
+
+## Options
+
+Available actions are those exposed above
+
+````--database```` argument specifies a single database name and can be used
+multiple times if required, although using the --databases argument (below) is
+more succient and preferred.
+
+    $ psql-cm --database a_database
+
+````--database```` argument may take multiple database targets, to do this pass
+them in ',' separated format, no spaces. Specifically the format is,
+
+    $ psql-cm --databases a_database,another_database,... ...
+
+````--uri```` can be given to change from the default of
+"postgres://127.0.0.1:5432" and has the format,
 
     $ psql-cm --uri "postgres://{user}:{password}@{host}:{port}/{database}?{sslmode}={mode}"
 
-user, password, port, the ? and everything after it (the query) are all optional.
+Host and database are the only required entries in a uri string. Eg.  user,
+password, port, the ? and everything after it (the query) are all optional.
 
-sslmode mode may be one of disable, allow, prefer, require if used.
+sslmode mode may be one of {disable, allow, prefer, require} if it is used.
 
 # Walkthrough
 
@@ -90,16 +117,12 @@ by default when the database is created) and a table for each schema for our
 database.
 
     $ psql psqlcm_test -c '
-        SET search_path = public;
         CREATE SCHEMA schema_one;
-        CREATE TABLE a_bool(a BOOL);
-
-        SET search_path = schema_one;
-        CREATE TABLE an_integer(an INTEGER);
-
         CREATE SCHEMA schema_two;
-        SET search_path = schema_two;
-        CREATE TABLE a_varchar(a VARCHAR);'
+        CREATE TABLE public.a_bool(a BOOL);
+        CREATE TABLE schema_one.an_integer(an INTEGER);
+        CREATE TABLE schema_two.a_varchar(a VARCHAR);'
+
 
 Now that we have a base set of database(s) and schemas that we wish to apply
 change management process to we can setup the psql-cm control tables.
@@ -107,7 +130,7 @@ change management process to we can setup the psql-cm control tables.
 The setup action adds one table called 'pg\_psql\_cm' to each of the target
 database schemas.
 
-    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" setup
+    $ psql-cm --database psqlcm_test setup
 
 Use a PostgreSQL client tool (psql/pgAdmin/Navicat/...) and examine the schemas
 for the psqlcm\_test database for which there should be three:
@@ -120,29 +143,23 @@ each with two tables, the pg\_psql\_cm control table and one other table.
 
 Next we'll dump the schema to sql/ within our working directory
 
-    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" dump
+    $ psql-cm --database psqlcm_test dump
 
 At this point we have the base schema for the psqlcm\_test database recorded to
 the filesystem. You can see the filesystem structure and contents with
 a find command on \*nix:
 
-    $ find sql/psqlcm_test
+    $ find sql/psqlcm_test/
     sql/psqlcm_test
-    sql/psqlcm_test/public
-    sql/psqlcm_test/public/base.sql
-    sql/psqlcm_test/public/cm.sql
-    sql/psqlcm_test/schema_one
-    sql/psqlcm_test/schema_one/base.sql
-    sql/psqlcm_test/schema_one/cm.sql
-    sql/psqlcm_test/schema_two
-    sql/psqlcm_test/schema_two/base.sql
-    sql/psqlcm_test/schema_two/cm.sql
+    sql/psqlcm_test/public.sql
+    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.
 
     $ dropdb psqlcm_test
-    $ psql-cm --databases psqlcm_test --uri "postgres://127.0.0.1:5432" restore
+    $ psql-cm --database psqlcm_test restore
 
 Once again useing a client tool and verify that the schema is inded what it was
 after setup was run.
@@ -176,3 +193,7 @@ seen including all debugging output by running:
     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
 
+Specifically to do a full-cycle walkthrough on the psqlcm\_development database,
+
+    rake drop create setup dump drop restore
+

data/lib/psql-cm/base.rb

@@ -22,7 +22,7 @@ module PSQLCM
         exec("SELECT datname as name FROM pg_database WHERE datname !~ 'template*|postgres';").
         map {|row| row['name']}
 
-      if config.databases.to_a.empty?
+      if config.databases.empty?
         halt! 'A list of databases must be given:\n  --databases={database_one}[,{database_two}[,...]]'
       else # filter out databases not specified.
         @databases.select!{ |name| config.databases.include?(name) }
@@ -31,13 +31,16 @@ module PSQLCM
       @databases
     end
 
-    def schemas(name = 'postgres')
-      @schemas = db(name).
-        exec("SELECT nspname AS name FROM pg_namespace WHERE nspname !~ '^pg_.*|information_schema';").
-        map{|row| row['name']}
+    def schemas(dbname = 'postgres')
+      schema_select = "SELECT nspname AS name FROM pg_namespace WHERE nspname !~ '^pg_.*|information_schema';"
+
+      @schemas = db(dbname).exec(schema_select).map{|row| row['name']}
 
       # Filter out schemas not specified, if specified.
-      @schemas.select!{ |name| config.schemas.include?(name) } if config.schemas
+      unless config.schemas.empty?
+        @schemas.select!{ |name| config.schemas.include?(name) }
+      end
+
       debug "schemas> #{@schemas}"
       @schemas
     end
@@ -78,7 +81,7 @@ module PSQLCM
 
     def uri
       return config.uri unless config.uri.to_s.empty?
-      $stdout.puts "NOTICE: uri is not set, defaulting to postgres://127.0.0.1:5432 (format: postgres://{user}:{password}@{host}:{port}/{database}\nwhere user, password, port and database are optional)"
+      $stdout.puts "NOTICE: uri is not set, defaulting to postgres://127.0.0.1:5432 (format: postgres://{user}:{password}@{host}:{port}/{database} (where user, password, port and database are optional)"
       config.uri = "postgres://127.0.0.1:5432"
     end
 
@@ -128,6 +131,9 @@ module PSQLCM
   end # class << self
 end
 
+# Module configuration, initial values
 ::PSQLCM.config.debug = !!ENV['DEBUG']
 ::PSQLCM.config.cm_table = 'pg_psql_cm' # Default --cm-table name.
+::PSQLCM.config.databases = []
+::PSQLCM.config.schemas = []
 

data/lib/psql-cm/cli.rb

@@ -10,18 +10,38 @@ module PSQLCM
           options.separator ''
           options.separator 'Specific options:'
 
-          options.on('-s', '--sql-path PATH', 'Path to dump SQL cm files into.') do |path|
+          options.on('-p', '--sql-path PATH', 'Path to dump SQL cm files into.') do |path|
             ::PSQLCM.config.sql_path = path
           end
 
-          options.on('-a', '--databases=NAMES', 'A comma separated list of databases to cm.') do |names|
-            ::PSQLCM.config.databases = names.split(',')
+          options.on('-d', '--database NAME', 'A single databases name.') do |name|
+            ::PSQLCM.config.databases << name
           end
 
-          options.on('-u', '--uri=URI', 'Path to the sink database connection file.') do |uri|
+          options.on('-a', '--databases NAMES', 'A comma separated list of databases to cm.') do |names|
+            ::PSQLCM.config.databases += names.split(',')
+          end
+
+          options.on('-s', '--schema NAME', 'A single schemas name.') do |name|
+            ::PSQLCM.config.schemas << name
+          end
+
+          options.on('-m', '--schemas NAMES', 'A comma separated list of schemas to cm.') do |names|
+            ::PSQLCM.config.schemas += names.split(',')
+          end
+
+          options.on('-u', '--uri URI', 'Path to the sink database connection file.') do |uri|
             ::PSQLCM.config.uri = uri
           end
 
+          options.on('-c', '--change SQL|FILE') do |change|
+            ::PSQLCM.config.change = change
+          end
+
+          options.on('-t', '--cm-table TABLE') do |cm_table|
+            ::PSQLCM.config.cm_table = cm_table
+          end
+
           options.on('-D', '--[no-]debug', 'Output debugging information.') do |debug|
             ::PSQLCM.config.debug = debug.nil? ? false : true
           end
@@ -30,10 +50,6 @@ module PSQLCM
             ::PSQLCM.config.verbose = verbose
           end
 
-          options.on('-c', '--cm-table=TABLE') do |cm_table|
-            ::PSQLCM.config.cm_table = cm_table
-          end
-
           options.on_tail('-h', '--help', 'Print help and exit.') do
             puts options
             exit 0

data/lib/psql-cm/setup.rb

@@ -10,14 +10,19 @@ module PSQLCM
           Tempfile.open('base.sql') do |temp_file|
             sh " pg_dump #{db(database).psql_args} --schema-only --no-owner --schema=#{schema} --file=#{temp_file.path} #{database}"
 
-            contents = %x{cat #{temp_file.path}}
-            implementer = %Q|#{%x[git config user.name].strip} <#{%x[git config user.email].strip}>|
+            content = %x{cat #{temp_file.path}}
+            name = %x{git config user.name}.strip
+            email = %x{git config user.email}.strip
+            implementer = "#{name}"
+            implementer << "<#{email}>" unless email.empty?
+
             db(database).exec(
-              "INSERT INTO #{schema}.#{config.cm_table} (is_base, implementer, content) VALUES (true, $1, $2);",
-              [implementer, contents]
+              "INSERT INTO #{schema}.#{config.cm_table}
+              (is_base, implementer, content)
+              VALUES (true, $1, $2);",
+              [implementer, content]
             )
           end
-
         end
       end
 

data/lib/psql-cm/submit.rb

@@ -1,14 +1,42 @@
 module PSQLCM
   class << self
     def submit!
-      puts "TODO: allow change string and/or file to be specified and add to the
-      specified database scema control table"
+      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\">)"
+          elsif File.exists?(config.change)
+            content = File.open(config.change, 'r') { |file| file.read }
+          else # SQL String
+            content = config.change
+          end
 
-      # TOOD: get values x,y,z
-      sql = "INSERT INTO #{schema}.#{config.cm_table} (is_base,implementer,content) VALUES (x,y,z)"
-      debug "submit:#{database}:#{schema}> sql\n#{sql}"
-      db(database).exec sql
+          name = %x{git config user.name}.strip
+          email = %x{git config user.email}.strip
+          implementer = "#{name}"
+          implementer << "<#{email}>" unless email.empty?
+
+          debug "validate> #{database}.#{schema}.#{config.cm_table}: #{config.change}"
+
+          # Transactional Validation -- Submit if successful, blow up otherwise.
+          transaction = "BEGIN;SET search_path TO #{schema},public; #{content}; COMMIT;"
+          result = db(database).exec(transaction)
+
+          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]
+          )
+        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.6'
+  Version = '0.0.7'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: psql-cm
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -48,8 +48,6 @@ files:
 - LICENCE
 - README.md
 - History.md
-- spec/psql-cm_spec.rb
-- spec/spec_helper.rb
 homepage: http://rubygems.org/gems/psql-cm/
 licenses: []
 post_install_message: 
@@ -74,6 +72,4 @@ rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: PostgreSQL CM
-test_files:
-- spec/psql-cm_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/psql-cm_spec.rb

@@ -1,6 +0,0 @@
-require_relative 'spec_helper'
-
-describe PSQLCM do
-  before do
-  end
-end

data/spec/spec_helper.rb

@@ -1,4 +0,0 @@
-require 'minitest/spec'
-require 'minitest/autorun'
-
-require 'psql-cm'