pg_examiner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 3febec877bf8581fc25e2d473161b5c49a7342a0
+  data.tar.gz: cc1fb74e5cec4fa2423f57fb9c39c75e1446f31a
+SHA512: 
+  metadata.gz: 57219283bfba79a7768afb659f7b0c245d3eecf7277454570d9e3a70c92c9e3f34626a07732566ab33eed49dd0b58650a66da335449a62eda31cea94e38a8e5e
+  data.tar.gz: bbe34e55e39676b49dcbdc68f7f434ebd70c4186f11f67ac909b89de05fef68386dc5a0987e20f0885153aad236394f729873cc1860314653c65066c10f9004d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pg_examiner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Hanks
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# PGExaminer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pg_examiner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_examiner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pg_examiner/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/TODO.txt

@@ -0,0 +1,133 @@
+(Notes on other system tables and columns that seem useful)
+
+
+
+
+
+pg_aggregate (http://www.postgresql.org/docs/9.3/static/catalog-pg-aggregate.html)
+aggfnoid
+aggtransfn
+aggfinalfn
+aggsortopaggtranstype
+agginitval
+
+pg_attribute: (http://www.postgresql.org/docs/9.3/static/catalog-pg-attribute.html)
+attstorage for toast storage configuration
+attinhcount: to do with inheritance?
+attcollation: defined collation for a column
+attoptions: 
+In a dropped column's pg_attribute entry, atttypid is reset to zero, but attlen and the other fields copied from pg_type are still valid. This arrangement is needed to cope with the situation where the dropped column's data type was later dropped, and so there is no pg_type row anymore. attlen and the other fields can be used to interpret the contents of a row of the table.
+
+pg_class: (http://www.postgresql.org/docs/9.3/static/catalog-pg-class.html)
+relam: index type
+relkind: table/index/view/sequence/matview/composite type/...
+
+pg_constraint:
+connamespace: schema oid?
+contype: check/foreign key/primary key/exclusion/unique/trigger
+condeferrable:
+condeferred:
+contypid: constraint on domain?
+conindid:
+confrelid: which table a foreign key is on
+confmatchtype: MATCH TYPE
+conkey
+confkey
+conexclop
+
+pg_description (http://www.postgresql.org/docs/9.3/static/catalog-pg-description.html)
+objoid
+classoid
+objsubid
+description
+
+pg_enum (http://www.postgresql.org/docs/9.3/static/catalog-pg-enum.html)
+enumtypid
+enumsortorder (don't care about exact values, just order)
+enumlabel
+
+pg_event_trigger (http://www.postgresql.org/docs/9.3/static/catalog-pg-event-trigger.html)
+evtname
+evtevent
+evtfoid
+
+pg_index (http://www.postgresql.org/docs/9.3/static/catalog-pg-index.html)
+indisexclusion
+indimmediate
+indisclustered
+indisvalid?
+indisready?
+indislive?
+indnatts?
+
+pg_inherits (http://www.postgresql.org/docs/9.3/static/catalog-pg-inherits.html)
+inhrelid
+inhparent
+inhseqno
+
+pg_language (http://www.postgresql.org/docs/9.3/static/catalog-pg-language.html)
+lanname
+
+pg_proc (http://www.postgresql.org/docs/9.3/static/catalog-pg-proc.html)
+proname
+pronamespace
+procost
+prorows?
+provariadic
+proisagg
+proiswindow
+proleakproof?
+proisstrict
+proretset
+provolatile
+pronargs
+pronargdefaults
+prorettype
+proargtypes
+proallargtypes
+proargmodes
+proargnames
+nodeToString(proargdefaults)
+
+pg_trigger (http://www.postgresql.org/docs/9.3/static/catalog-pg-trigger.html)
+tgrelid
+tgname
+tgfoid
+tgtype
+tgisinternal
+tgconstrrelid
+togconstrindid
+tgconstraint
+tgdeferrable
+tginitdeferred
+tgnargs
+tgattr
+tgargs
+tgqual (nodeToString())
+
+pg_type (http://www.postgresql.org/docs/9.3/static/catalog-pg-type.html)
+typname
+typnamespace
+typlen
+typbyval
+typtype
+typdelim
+typrelid
+typelem
+typarray
+typalign
+typstorage
+typnotnull
+typbasetype
+typndims
+typdefault
+
+pg_views (http://www.postgresql.org/docs/9.3/static/view-pg-views.html)
+schemaname
+viewname
+definition? or can get all this from pg_class?
+
+pg_matviews (http://www.postgresql.org/docs/9.3/static/view-pg-matviews.html)
+schemaname
+matviewname
+definition

data/lib/pg_examiner/result/base.rb

@@ -0,0 +1,28 @@
+module PGExaminer
+  class Result
+    class Base
+      attr_reader :result, :row, :parent
+
+      def initialize(result, row, parent = nil)
+        @result, @row, @parent = result, row, parent
+      end
+
+      def oid
+        @row['oid']
+      end
+
+      def name
+        @row['name']
+      end
+
+      def ==(other)
+        columns = self.class::COMPARISON_COLUMNS
+        self.class == other.class && row.values_at(*columns) == other.row.values_at(*columns)
+      end
+
+      def inspect
+        "#<#{self.class} @row=#{@row.inspect}>"
+      end
+    end
+  end
+end

data/lib/pg_examiner/result/column.rb

@@ -0,0 +1,27 @@
+module PGExaminer
+  class Result
+    class Column < Base
+      COMPARISON_COLUMNS = %w(name attndims attnotnull atttypmod)
+
+      def type
+        @type ||= result.pg_type.find{|t| t['oid'] == row['atttypid']}['name']
+      end
+
+      def default
+        # Have to dance a bit so that the lack of a default becomes nil, but isn't recalculated each time.
+        if @default_calculated
+          @default
+        else
+          @default_calculated = true
+          @default = result.pg_attrdef.find{|d| d['adrelid'] == row['attrelid']}['default'] if row['atthasdef'] == 't'
+        end
+      end
+
+      def ==(other)
+        super &&
+          type == other.type &&
+          default == other.default
+      end
+    end
+  end
+end

data/lib/pg_examiner/result/constraint.rb

@@ -0,0 +1,7 @@
+module PGExaminer
+  class Result
+    class Constraint < Base
+      COMPARISON_COLUMNS = %w(name definition)
+    end
+  end
+end

data/lib/pg_examiner/result/extension.rb

@@ -0,0 +1,16 @@
+module PGExaminer
+  class Result
+    class Extension < Base
+      COMPARISON_COLUMNS = %w(name extversion)
+
+      def schema
+        @schema ||= result.schemas.find { |s| s.oid == row['extnamespace'] }
+      end
+
+      def ==(other)
+        super &&
+          (schema && schema.name) == (other.schema && other.schema.name)
+      end
+    end
+  end
+end

data/lib/pg_examiner/result/function.rb

@@ -0,0 +1,28 @@
+module PGExaminer
+  class Result
+    class Function < Base
+      COMPARISON_COLUMNS = %w(name proargmodes definition)
+
+      def argument_types
+        @argument_types ||= @row['proargtypes'].split.map do |oid|
+          result.pg_type.find{|t| t['oid'] == oid}['name']
+        end
+      end
+
+      def return_type
+        @return_type ||= result.pg_type.find{|t| t['oid'] == @row['prorettype']}['name']
+      end
+
+      def language
+        @language ||= result.pg_language.find{|l| l['oid'] == @row['prolang']}['name']
+      end
+
+      def ==(other)
+        super &&
+          argument_types == other.argument_types &&
+          return_type    == other.return_type &&
+          language       == other.language
+      end
+    end
+  end
+end

data/lib/pg_examiner/result/index.rb

@@ -0,0 +1,16 @@
+module PGExaminer
+  class Result
+    class Index < Base
+      COMPARISON_COLUMNS = %w(name filter indisunique indisprimary)
+
+      def expression
+        @row['expression'] || @row['indkey'].split.map{|i| parent.columns.find{|c| c.row['attnum'] == i}}.map(&:name)
+      end
+
+      def ==(other)
+        super &&
+          expression == other.expression
+      end
+    end
+  end
+end

data/lib/pg_examiner/result/language.rb

@@ -0,0 +1,7 @@
+module PGExaminer
+  class Result
+    class Language < Base
+      COMPARISON_COLUMNS = %w(name)
+    end
+  end
+end

data/lib/pg_examiner/result/schema.rb

@@ -0,0 +1,25 @@
+module PGExaminer
+  class Result
+    class Schema < Base
+      COMPARISON_COLUMNS = %w(name)
+
+      def tables
+        @tables ||= result.pg_class.select do |c|
+          c['relnamespace'] == oid && c['relkind'] == 'r'
+        end.map{|row| Table.new(result, row, self)}.sort_by(&:name)
+      end
+
+      def functions
+        @functions ||= result.pg_proc.select do |c|
+          c['pronamespace'] == oid
+        end.map{|row| Function.new(result, row, self)}.sort_by(&:name)
+      end
+
+      def ==(other)
+        super &&
+          tables    == other.tables &&
+          functions == other.functions
+      end
+    end
+  end
+end

data/lib/pg_examiner/result/table.rb

@@ -0,0 +1,39 @@
+module PGExaminer
+  class Result
+    class Table < Base
+      COMPARISON_COLUMNS = %w(name relpersistence reloptions)
+
+      def columns
+        @columns ||= result.pg_attribute.select do |c|
+          c['attrelid'] == oid
+        end.sort_by{|c| c['attnum'].to_i}.map { |row| Column.new(result, row, self) }
+      end
+
+      def indexes
+        @indexes ||= result.pg_index.select do |c|
+          c['indrelid'] == oid
+        end.map{|row| Index.new(result, row, self)}.sort_by(&:name)
+      end
+
+      def constraints
+        @constraints ||= result.pg_constraint.select do |c|
+          c['conrelid'] == oid
+        end.map{|row| Constraint.new(result, row, self)}.sort_by(&:name)
+      end
+
+      def triggers
+        @triggers ||= result.pg_trigger.select do |t|
+          t['tgrelid'] == oid
+        end.map{|row| Trigger.new(result, row, self)}.sort_by(&:name)
+      end
+
+      def ==(other)
+        super &&
+          columns     == other.columns &&
+          indexes     == other.indexes &&
+          constraints == other.constraints &&
+          triggers    == other.triggers
+      end
+    end
+  end
+end

data/lib/pg_examiner/result/trigger.rb

@@ -0,0 +1,16 @@
+module PGExaminer
+  class Result
+    class Trigger < Base
+      COMPARISON_COLUMNS = %w(name tgtype)
+
+      def function
+        @function ||= result.pg_proc.find{|f| f['oid'] == @row['tgfoid']}['name']
+      end
+
+      def ==(other)
+        super &&
+          function == other.function
+      end
+    end
+  end
+end

data/lib/pg_examiner/result.rb

@@ -0,0 +1,145 @@
+require 'pg_examiner/result/base'
+require 'pg_examiner/result/column'
+require 'pg_examiner/result/constraint'
+require 'pg_examiner/result/extension'
+require 'pg_examiner/result/function'
+require 'pg_examiner/result/index'
+require 'pg_examiner/result/language'
+require 'pg_examiner/result/schema'
+require 'pg_examiner/result/table'
+require 'pg_examiner/result/trigger'
+
+module PGExaminer
+  class Result
+    attr_reader :pg_namespace,
+                :pg_class,
+                :pg_type,
+                :pg_index,
+                :pg_attrdef,
+                :pg_attribute,
+                :pg_extension,
+                :pg_constraint,
+                :pg_proc,
+                :pg_language,
+                :pg_trigger
+
+    def initialize(connection)
+      @conn = connection
+      load_schema
+    end
+
+    def schemas
+      @schemas ||= @pg_namespace.map{|row| Schema.new(self, row)}.sort_by(&:name)
+    end
+
+    def extensions
+      @extensions ||= @pg_extension.map{|row| Extension.new(self, row)}.sort_by(&:name)
+    end
+
+    def languages
+      @languages ||= @pg_language.map{|row| Language.new(self, row)}.sort_by(&:name)
+    end
+
+    def ==(other)
+      other.is_a?(Result) &&
+        schemas    == other.schemas &&
+        extensions == other.extensions &&
+        languages  == other.languages
+    end
+
+    def inspect
+      "#<#{self.class} @schemas=#{@schemas.inspect}, @extensions=#{@extensions.inspect}>"
+    end
+
+    private
+
+    def execute(*args)
+      @conn.async_exec(*args).to_a
+    end
+
+    def load_schema
+      # Get all relevant schemas/namespaces, which includes public but not
+      # information_schema or system schemas, which are prefixed with pg_. It
+      # wouldn't be a good practice for anyone to name a custom schema
+      # starting with pg_ anyway.
+      @pg_namespace = execute <<-SQL
+        SELECT oid, nspname AS name
+        FROM pg_namespace
+        WHERE nspname != 'information_schema'
+        AND nspname NOT LIKE 'pg_%'
+      SQL
+
+      @pg_class = load_table @pg_namespace.map{|ns| ns['oid']}, <<-SQL
+        SELECT oid, relname AS name, relkind, relpersistence, reloptions, relnamespace
+        FROM pg_class
+        WHERE relnamespace IN (?)
+      SQL
+
+      @pg_attribute = load_table @pg_class.map{|ns| ns['oid']}, <<-SQL
+        SELECT atttypid, attname AS name, attndims, attnotnull, atttypmod, attrelid, atthasdef, attnum
+        FROM pg_attribute
+        WHERE attrelid IN (?)
+        AND attnum > 0       -- No system columns
+        AND NOT attisdropped -- Still active
+      SQL
+
+      @pg_type = execute <<-SQL
+        SELECT oid, typname AS name
+        FROM pg_type
+      SQL
+
+      @pg_index = load_table @pg_class.map{|ns| ns['oid']}, <<-SQL
+        SELECT c.relname AS name, i.indrelid, i.indkey, indisunique, indisprimary,
+          pg_get_expr(i.indpred, i.indexrelid) AS filter,
+          pg_get_expr(i.indexprs, i.indrelid) AS expression
+        FROM pg_index i
+        JOIN pg_class c ON c.oid = i.indexrelid
+        WHERE c.oid IN (?)
+      SQL
+
+      @pg_constraint = load_table @pg_class.map{|ns| ns['oid']}, <<-SQL
+        SELECT oid, conname AS name, conrelid,
+          pg_get_constraintdef(oid) AS definition
+        FROM pg_constraint c
+        WHERE conrelid IN (?)
+      SQL
+
+      @pg_trigger = load_table @pg_class.map{|ns| ns['oid']}, <<-SQL
+        SELECT oid, tgname AS name, tgrelid, tgtype, tgfoid
+        FROM pg_trigger
+        WHERE tgrelid IN (?)
+        AND tgconstrrelid = '0' -- Ignore foreign key triggers, which have unpredictable names.
+      SQL
+
+      @pg_attrdef = execute <<-SQL
+        SELECT oid, adrelid, pg_get_expr(adbin, adrelid) AS default
+        FROM pg_attrdef
+      SQL
+
+      @pg_proc = load_table @pg_namespace.map{|ns| ns['oid']}, <<-SQL
+        SELECT oid, proname AS name, pronamespace, proargtypes, prorettype, proargmodes, prolang, pg_get_functiondef(oid) AS definition
+        FROM pg_proc
+        WHERE pronamespace IN (?)
+        AND NOT proisagg -- prevent pg_get_functiondef() from throwing errors on aggregate functions.
+      SQL
+
+      @pg_extension = execute <<-SQL
+        SELECT extname AS name, extnamespace, extversion
+        FROM pg_extension
+      SQL
+
+      @pg_language = execute <<-SQL
+        SELECT oid, lanname AS name
+        FROM pg_language
+      SQL
+    end
+
+    def load_table(oids, sql)
+      if oids.any?
+        execute sql.gsub(/\?/, oids.map{|oid| "'#{oid}'"}.join(', '))
+      else
+        []
+      end
+    end
+  end
+end

data/lib/pg_examiner/version.rb

@@ -0,0 +1,3 @@
+module PGExaminer
+  VERSION = '0.1.0'
+end

data/lib/pg_examiner.rb

@@ -0,0 +1,10 @@
+require 'pg_examiner/result'
+require 'pg_examiner/version'
+
+module PGExaminer
+  class << self
+    def examine(connection)
+      Result.new(connection)
+    end
+  end
+end

data/pg_examiner.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_examiner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pg_examiner'
+  spec.version       = PGExaminer::VERSION
+  spec.authors       = ["Chris Hanks"]
+  spec.email         = ["christopher.m.hanks@gmail.com"]
+  spec.summary       = %q{Parse the schemas of Postgres databases in detail}
+  spec.description   = %q{Examine and compare the tables, columns, constraints and other information that makes up the schema of a PG database}
+  spec.homepage      = 'https://github.com/chanks/pg_examiner'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+end