pg_query 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2003b8ff36a429c1dc6dd4e03104971ccca6671
-  data.tar.gz: 77271fe0ac1d22f96949c48775279782cb400539
+  metadata.gz: 5f0df7ee01a2554fa3035b89da592b08aa486d9e
+  data.tar.gz: e1dcd57c5189a191cc33d8964e777db63cf43c75
 SHA512:
-  metadata.gz: 4f3cfb7076a1fe2377205a9aca86b7d4d934c60b1b276e3a9bf06e140d61e3aeaa3fab86db3aef55bd00266b837a8290a459cd4c33b016c61d639fb2e4a74c3c
-  data.tar.gz: 2d94d792fc9fd3627f42a31a4f8f6341a618ed92ed95b25d45bdef17dcfa962a67bde3b934a60088044d57d759bf82e39ce0253e61992e51e96faad6700a97ef
+  metadata.gz: 7c71b98b9786a4910d2386ce1a6251e367465be747a66d698487f140f407ee749e3a2c3a0a2d7e1a71fe6a2074eda4f06eea2de59adf60c527e3a107f2a7dfc4
+  data.tar.gz: 8f47e665e94b53bf80c1d9cfb434145ce2f7a0d01ebf190698d1340a35848dc02ed4f6782dede20833832634d9d60799209013b58e78ffb694436184549a22d7

data/CHANGELOG.md

@@ -1,9 +1,22 @@
 # Changelog
 
+## 0.13.0    2017-07-30
+
+* Introduce split between SELECT/DML/DDL for tables method [#65](https://github.com/lfittl/pg_query/pull/65) [@chrisfrommann](https://github.com/chrisfrommann)
+  * Backwards compatible, use the new select_tables/dml_tables/ddl_tables to
+    access the categorized table references
+* Update libpg_query to 9.5-1.6.2
+  * Update to Fingerprinting Version 1.3
+    * Attributes to be ignored:
+      * RangeVar.relname (if node also has RangeVar.relpersistence = "t")
+    * Special cases: List nodes where parent field name is valuesLists
+      * Follow same logic described for fromClause/targetList/cols/rexpr
+
+
 ## 0.12.1    2017-07-29
 
 * Update libpg_query to 9.5-1.6.1
-  * Update Fingerprinting Version 1.2
+  * Update to Fingerprinting Version 1.2
     * Ignore portalname in DeclareCursorStmt, FetchStmt and ClosePortalStmt
 
 

data/README.md

@@ -75,12 +75,12 @@ Note: The deparsing feature is experimental and does not support outputting all
 ### Parsing a normalized query
 
 ```ruby
-# Normalizing a query (like pg_stat_statements)
+# Normalizing a query (like pg_stat_statements in Postgres 10+)
 PgQuery.normalize("SELECT 1 FROM x WHERE y = 'foo'")
 
-=> "SELECT ? FROM x WHERE y = ?"
+=> "SELECT $1 FROM x WHERE y = $2"
 
-# Parsing a normalized query
+# Parsing a normalized query (pre-Postgres 10 style)
 PgQuery.parse("SELECT ? FROM x WHERE y = ?")
 
 => #<PgQuery:0x007fb99455a438
@@ -151,12 +151,10 @@ to support parsing normalized queries containing `?` replacement characters.
 
 Currently tested and officially supported Ruby versions:
 
-* MRI 1.9
-* MRI 2.0
 * MRI 2.1
 * MRI 2.2
 * MRI 2.3
-* Rubinius 3.20
+* MRI 2.4
 
 
 ## Resources
@@ -167,12 +165,15 @@ Products, tools and libraries built on pg_query:
 * [hsql](https://github.com/JackDanger/hsql)
 * [sqlint](https://github.com/purcell/sqlint)
 * [pghero](https://github.com/ankane/pghero)
+* [dexter](https://github.com/ankane/dexter)
 
 pg_query for other languages:
 
 * C: [libpg_query](https://github.com/lfittl/libpg_query)
 * Go: [pg_query_go](https://github.com/lfittl/pg_query_go)
-* Javascript: [pg-query-parser](https://github.com/zhm/pg-query-parser)
+* Javascript (Node): [pg-query-parser](https://github.com/zhm/pg-query-parser)
+* Javascript (Browser): [pg-query-emscripten](https://github.com/lfittl/pg-query-emscripten)
+* Python: [psqlparse](https://github.com/alculquicondor/psqlparse)
 
 Please feel free to [open a PR](https://github.com/lfittl/pg_query/pull/new/master) to add yours! :)
 

data/ext/pg_query/extconf.rb

@@ -3,7 +3,7 @@
 require 'mkmf'
 require 'open-uri'
 
-LIB_PG_QUERY_TAG = '9.5-1.6.1'.freeze
+LIB_PG_QUERY_TAG = '9.5-1.6.2'.freeze
 
 workdir = Dir.pwd
 libdir = File.join(workdir, 'libpg_query-' + LIB_PG_QUERY_TAG)

data/lib/pg_query/fingerprint.rb

@@ -58,7 +58,8 @@ class PgQuery
 
     hash.update node_name
 
-    node.values.first.sort_by { |k, _| k }.each do |field_name, val|
+    fields = node.values.first
+    fields.sort_by { |k, _| k }.each do |field_name, val|
       next if ignored_fingerprint_value?(val)
 
       case field_name
@@ -73,6 +74,8 @@ class PgQuery
         next if node_name == TRANSACTION_STMT
       when 'portalname'
         next if [DECLARE_CURSOR_STMT, FETCH_STMT, CLOSE_PORTAL_STMT].include?(node_name)
+      when 'relname'
+        next if node_name == RANGE_VAR && fields[RELPERSISTENCE_FIELD] == 't'
       end
 
       fingerprint_value(val, hash, node_name, field_name, true)
@@ -80,7 +83,7 @@ class PgQuery
   end
 
   def fingerprint_list(values, hash, parent_node_name, parent_field_name)
-    if [FROM_CLAUSE_FIELD, TARGET_LIST_FIELD, COLS_FIELD, REXPR_FIELD].include?(parent_field_name)
+    if [FROM_CLAUSE_FIELD, TARGET_LIST_FIELD, COLS_FIELD, REXPR_FIELD, VALUES_LISTS_FIELD].include?(parent_field_name)
       values_subhashes = values.map do |val|
         subhash = FingerprintSubHash.new
         fingerprint_value(val, subhash, parent_node_name, parent_field_name, false)

data/lib/pg_query/node_types.rb

@@ -85,10 +85,12 @@ class PgQuery
 
   # FIELDS
 
-  FROM_CLAUSE_FIELD = 'fromClause'.freeze
-  TARGET_LIST_FIELD = 'targetList'.freeze
   COLS_FIELD = 'cols'.freeze
+  FROM_CLAUSE_FIELD = 'fromClause'.freeze
+  RELPERSISTENCE_FIELD = 'relpersistence'.freeze
   REXPR_FIELD = 'rexpr'.freeze
+  TARGET_LIST_FIELD = 'targetList'.freeze
+  VALUES_LISTS_FIELD = 'valuesLists'.freeze
 
   # ENUMS
 

data/lib/pg_query/parse.rb

@@ -30,8 +30,19 @@ class PgQuery
   end
 
   def tables
-    load_tables_and_aliases! if @tables.nil?
-    @tables
+    tables_with_types.map { |t| t[:table] }
+  end
+
+  def select_tables
+    tables_with_types.select { |t| t[:type] == :select }.map { |t| t[:table] }
+  end
+
+  def dml_tables
+    tables_with_types.select { |t| t[:type] == :dml }.map { |t| t[:table] }
+  end
+
+  def ddl_tables
+    tables_with_types.select { |t| t[:type] == :ddl }.map { |t| t[:table] }
   end
 
   def cte_names
@@ -44,21 +55,28 @@ class PgQuery
     @aliases
   end
 
+  def tables_with_types
+    load_tables_and_aliases! if @tables.nil?
+    @tables
+  end
+
   protected
 
   def load_tables_and_aliases! # rubocop:disable Metrics/CyclomaticComplexity
-    @tables = []
+    @tables = [] # types: select, dml, ddl
     @cte_names = []
     @aliases = {}
 
     statements = @tree.dup
-    from_clause_items = []
+    from_clause_items = [] # types: select, dml, ddl
     subselect_items = []
 
     loop do
       statement = statements.shift
       if statement
         case statement.keys[0]
+        # The following statement types do not modify tables and are added to from_clause_items
+        # (and subsequently @tables)
         when SELECT_STMT
           case statement[SELECT_STMT]['op']
           when 0
@@ -66,7 +84,7 @@ class PgQuery
               if item[RANGE_SUBSELECT]
                 statements << item[RANGE_SUBSELECT]['subquery']
               else
-                from_clause_items << item
+                from_clause_items << { item: item, type: :select }
               end
             end
 
@@ -83,39 +101,48 @@ class PgQuery
             statements << statement[SELECT_STMT]['larg'] if statement[SELECT_STMT]['larg']
             statements << statement[SELECT_STMT]['rarg'] if statement[SELECT_STMT]['rarg']
           end
-        when INSERT_STMT, UPDATE_STMT, DELETE_STMT, VACUUM_STMT, COPY_STMT, ALTER_TABLE_STMT, CREATE_STMT, INDEX_STMT, RULE_STMT, CREATE_TRIG_STMT
-          from_clause_items << statement.values[0]['relation']
+        # The following statements modify the contents of a table
+        when INSERT_STMT, UPDATE_STMT, DELETE_STMT, COPY_STMT
+          from_clause_items << { item: statement.values[0]['relation'], type: :dml }
+        # The following statement types are DDL (changing table structure)
+        when ALTER_TABLE_STMT, CREATE_STMT
+          from_clause_items << { item: statement.values[0]['relation'], type: :ddl }
+        when CREATE_TABLE_AS_STMT
+          if statement[CREATE_TABLE_AS_STMT]['into'] && statement[CREATE_TABLE_AS_STMT]['into'][INTO_CLAUSE]['rel']
+            from_clause_items << { item: statement[CREATE_TABLE_AS_STMT]['into'][INTO_CLAUSE]['rel'], type: :ddl }
+          end
+        when TRUNCATE_STMT
+          from_clause_items += statement.values[0]['relations'].map { |r| { item: r, type: :ddl } }
         when VIEW_STMT
-          from_clause_items << statement[VIEW_STMT]['view']
+          from_clause_items << { item: statement[VIEW_STMT]['view'], type: :ddl }
           statements << statement[VIEW_STMT]['query']
+        when VACUUM_STMT, INDEX_STMT, CREATE_TRIG_STMT, RULE_STMT
+          from_clause_items << { item: statement.values[0]['relation'], type: :ddl }
         when REFRESH_MAT_VIEW_STMT
-          from_clause_items << statement[REFRESH_MAT_VIEW_STMT]['relation']
-        when EXPLAIN_STMT
-          statements << statement[EXPLAIN_STMT]['query']
-        when CREATE_TABLE_AS_STMT
-          if statement[CREATE_TABLE_AS_STMT]['into'] && statement[CREATE_TABLE_AS_STMT]['into'][INTO_CLAUSE]['rel']
-            from_clause_items << statement[CREATE_TABLE_AS_STMT]['into'][INTO_CLAUSE]['rel']
+          from_clause_items << { item: statement[REFRESH_MAT_VIEW_STMT]['relation'], type: :ddl }
+        when DROP_STMT
+          objects = statement[DROP_STMT]['objects'].map { |list| list.map { |obj| obj['String'] && obj['String']['str'] } }
+          case statement[DROP_STMT]['removeType']
+          when OBJECT_TYPE_TABLE
+            @tables += objects.map { |r| { table: r.join('.'), type: :ddl } }
+          when OBJECT_TYPE_RULE, OBJECT_TYPE_TRIGGER
+            @tables += objects.map { |r| { table: r[0..-2].join('.'), type: :ddl } }
           end
-        when LOCK_STMT, TRUNCATE_STMT
-          from_clause_items += statement.values[0]['relations']
         when GRANT_STMT
           objects = statement[GRANT_STMT]['objects']
           case statement[GRANT_STMT]['objtype']
           when 0 # Column # rubocop:disable Lint/EmptyWhen
             # FIXME
           when 1 # Table
-            from_clause_items += objects
+            from_clause_items += objects.map { |o| { item: o, type: :ddl } }
           when 2 # Sequence # rubocop:disable Lint/EmptyWhen
             # FIXME
           end
-        when DROP_STMT
-          objects = statement[DROP_STMT]['objects'].map { |list| list.map { |obj| obj['String'] && obj['String']['str'] } }
-          case statement[DROP_STMT]['removeType']
-          when OBJECT_TYPE_TABLE
-            @tables += objects.map { |r| r.join('.') }
-          when OBJECT_TYPE_RULE, OBJECT_TYPE_TRIGGER
-            @tables += objects.map { |r| r[0..-2].join('.') }
-          end
+        when LOCK_STMT
+          from_clause_items += statement.values[0]['relations'].map { |r| { item: r, type: :ddl } }
+        # The following are other statements that don't fit into query/DML/DDL
+        when EXPLAIN_STMT
+          statements << statement[EXPLAIN_STMT]['query']
         end
 
         statement_value = statement.values[0]
@@ -157,19 +184,19 @@ class PgQuery
       next_item = from_clause_items.shift
       break unless next_item
 
-      case next_item.keys[0]
+      case next_item[:item].keys[0]
       when JOIN_EXPR
         %w[larg rarg].each do |side|
-          from_clause_items << next_item[JOIN_EXPR][side]
+          from_clause_items << { item: next_item[:item][JOIN_EXPR][side], type: next_item[:type] }
         end
       when ROW_EXPR
-        from_clause_items += next_item[ROW_EXPR]['args']
+        from_clause_items += next_item[:item][ROW_EXPR]['args'].map { |a| { item: a, type: next_item[:type] } }
       when RANGE_VAR
-        rangevar = next_item[RANGE_VAR]
+        rangevar = next_item[:item][RANGE_VAR]
         next if !rangevar['schemaname'] && @cte_names.include?(rangevar['relname'])
 
         table = [rangevar['schemaname'], rangevar['relname']].compact.join('.')
-        @tables << table
+        @tables << { table: table, type: next_item[:type] }
         @aliases[rangevar['alias'][ALIAS]['aliasname']] = table if rangevar['alias']
       end
     end

data/lib/pg_query/version.rb

@@ -1,3 +1,3 @@
 class PgQuery
-  VERSION = '0.12.1'.freeze
+  VERSION = '0.13.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_query
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Lukas Fittl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-30 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler