pg_query 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27667deffca50f6c8efc514a644d951e5129e5a7ff5fdf472ad39501adda12f0
-  data.tar.gz: 3398f333de65ba7fdc637d9746805525b4a22933cbd9d6889c1d68643a780dca
+  metadata.gz: 9625ed6fd4d8f67673ee922f191996d2c157addf6d97aa092af682a21bf96ce7
+  data.tar.gz: 9a20dedc0420e5a7f2162c642c2ddee60cd98fd6bbfeff1b1affc181f6dcbc27
 SHA512:
-  metadata.gz: c30bfcab9a142efc9c0fa8f12a18c157daa2074baf5b792cb832c2a214676f62aa558be69de2d5a0e15f87e3b4818b78d733844ada15fd0e96ba35fbe3b075da
-  data.tar.gz: 1292be5ffdf9021997514e2a8175a4fae4058fbf4ece99c1a49de09b2490d9244947d35b46ecb0574c32a61d4cbb86eee518372b8b20496d47fd86ae264b8489
+  metadata.gz: 7f4633dd45e1530cebc92731315a238f22e4111ba23e10ea6991b6466f444ce2b974ffd858aaf5c93c5b6597e004e0b2334ac1832c24851956e34dd629fe58ff
+  data.tar.gz: 36d225dc15a58db4336cdbdd571a385308403b93d5507ec25b0deb5179be87b8a00fb029b1e5b77bdf62f79861fedd39ba350a50897bcfec4d61e266b2cdf639

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 * ...
 
+## 2.2.1     2022-01-20
+
+* Detect tables used in the query of a PREPARE statement ([#273](https://github.com/pganalyze/pg_query/pull/273))
+* Expose recursive walk functionality via walk! ([#268](https://github.com/pganalyze/pg_query/pull/268))
+* Retain schema in name when parsing out functions ([#272](https://github.com/pganalyze/pg_query/pull/272))
 
 ## 2.2.0     2022-11-02
 

data/README.md

@@ -72,6 +72,8 @@ PgQuery.parse("SELECT 1")
 
 ### Modifying a parsed query and turning it into SQL again
 
+This is a simple example for `deparse`, for more complex modification, use `walk!`.
+
 ```ruby
 parsed_query = PgQuery.parse("SELECT * FROM users")
 
@@ -145,6 +147,36 @@ PgQuery.scan('SELECT 1 --comment')
  []]
 ```
 
+### Walking the parse tree
+
+For generalized use, PgQuery provides `walk!` as a means to recursively work with the parsed query.
+
+This can be used to create a bespoke pretty printer:
+
+```ruby
+parsed_query = PgQuery.parse "SELECT * FROM tbl"
+parsed_query.walk! { |node, k, v, location| puts k }
+```
+
+More usefully, this can be used to rewrite a query. For example:
+
+```ruby
+parsed_query.walk! do |node, k, v, location| puts k
+  next unless k.eql?(:range_var) || k.eql?(:relation)
+  next if v.relname.nil?
+  v.relname = "X_" + v.relname
+end
+
+parsed_query.deparse
+```
+
+There are some caveats, and limitations, in this example.
+
+First, some of the tree nodes are frozen. You can replace them, but you cannot modify in place.
+
+Second, table rewriting is a bit more nuanced than this example. While this will rewrite the table names, it will
+not correctly handle all CTEs, or rewrite columns with explicit table names.
+
 ## Differences from Upstream PostgreSQL
 
 This gem is based on [libpg_query](https://github.com/pganalyze/libpg_query),

data/lib/pg_query/parse.rb

@@ -216,7 +216,7 @@ module PgQuery
             when :OBJECT_FUNCTION
               # Only one function can be dropped in a statement
               obj = statement.drop_stmt.objects[0].object_with_args
-              @functions << { function: obj.objname[0].string.str, type: :ddl }
+              @functions << { function: obj.objname.map { |f| f.string.str }.join('.'), type: :ddl }
             end
           when :grant_stmt
             objects = statement.grant_stmt.objects
@@ -235,18 +235,20 @@ module PgQuery
             statements << statement.explain_stmt.query
           when :create_function_stmt
             @functions << {
-              function: statement.create_function_stmt.funcname[0].string.str,
+              function: statement.create_function_stmt.funcname.map { |f| f.string.str }.join('.'),
               type: :ddl
             }
           when :rename_stmt
             if statement.rename_stmt.rename_type == :OBJECT_FUNCTION
-              original_name = statement.rename_stmt.object.object_with_args.objname[0].string.str
+              original_name = statement.rename_stmt.object.object_with_args.objname.map { |f| f.string.str }.join('.')
               new_name = statement.rename_stmt.newname
               @functions += [
                 { function: original_name, type: :ddl },
                 { function: new_name, type: :ddl }
               ]
             end
+          when :prepare_stmt
+            statements << statement.prepare_stmt.query
           end
         end
 

data/lib/pg_query/treewalker.rb

@@ -1,5 +1,11 @@
 module PgQuery
   class ParserResult
+    def walk!
+      treewalker!(@tree) do |parent_node, parent_field, node, location|
+        yield(parent_node, parent_field, node, location)
+      end
+    end
+
     private
 
     def treewalker!(tree) # rubocop:disable Metrics/CyclomaticComplexity

data/lib/pg_query/version.rb

@@ -1,3 +1,3 @@
 module PgQuery
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_query
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Lukas Fittl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -585,7 +585,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: PostgreSQL query parsing and normalization library