pg_query 0.8.0 → 0.9.0

data/lib/pg_query/node_types.rb

@@ -0,0 +1,218 @@
+# rubocop:disable Style/ConstantName
+class PgQuery
+  # NODE TYPES
+
+  A_ARRAY_EXPR = 'A_ArrayExpr'.freeze
+  A_CONST = 'A_Const'.freeze
+  A_EXPR = 'A_Expr'.freeze
+  A_INDICES = 'A_Indices'.freeze
+  A_INDIRECTION = 'A_Indirection'.freeze
+  A_STAR = 'A_Star'.freeze
+  ACCESS_PRIV = 'AccessPriv'.freeze
+  ALIAS = 'Alias'.freeze
+  ALTER_TABLE_CMD = 'AlterTableCmd'.freeze
+  ALTER_TABLE_STMT = 'AlterTableStmt'.freeze
+  BIT_STRING = 'BitString'.freeze
+  BOOL_EXPR = 'BoolExpr'.freeze
+  CASE_EXPR = 'CaseExpr'.freeze
+  CASE_WHEN = 'CaseWhen'.freeze
+  CHECK_POINT_STMT = 'CheckPointStmt'.freeze
+  COALESCE_EXPR = 'CoalesceExpr'.freeze
+  COLUMN_DEF = 'ColumnDef'.freeze
+  COLUMN_REF = 'ColumnRef'.freeze
+  COMMON_TABLE_EXPR = 'CommonTableExpr'.freeze
+  CONSTRAINT = 'Constraint'.freeze
+  COPY_STMT = 'CopyStmt'.freeze
+  CREATE_FUNCTION_STMT = 'CreateFunctionStmt'.freeze
+  CREATE_SCHEMA_STMT = 'CreateSchemaStmt'.freeze
+  CREATE_STMT = 'CreateStmt'.freeze
+  CREATE_TABLE_AS_STMT = 'CreateTableAsStmt'.freeze
+  CREATE_TRIG_STMT = 'CreateTrigStmt'.freeze
+  DEF_ELEM = 'DefElem'.freeze
+  DELETE_STMT = 'DeleteStmt'.freeze
+  DROP_STMT = 'DropStmt'.freeze
+  EXPLAIN_STMT = 'ExplainStmt'.freeze
+  FLOAT = 'Float'.freeze
+  FUNC_CALL = 'FuncCall'.freeze
+  FUNCTION_PARAMETER = 'FunctionParameter'.freeze
+  GRANT_STMT = 'GrantStmt'.freeze
+  GRANT_ROLE_STMT = 'GrantRoleStmt'.freeze
+  INDEX_ELEM = 'IndexElem'.freeze
+  INDEX_STMT = 'IndexStmt'.freeze
+  INSERT_STMT = 'InsertStmt'.freeze
+  INTO_CLAUSE = 'IntoClause'.freeze
+  JOIN_EXPR = 'JoinExpr'.freeze
+  LOCK_STMT = 'LockStmt'.freeze
+  LOCKING_CLAUSE = 'LockingClause'.freeze
+  NULL_TEST = 'NullTest'.freeze
+  RANGE_FUNCTION = 'RangeFunction'.freeze
+  PARAM_REF = 'ParamRef'.freeze
+  RANGE_SUBSELECT = 'RangeSubselect'.freeze
+  RANGE_VAR = 'RangeVar'.freeze
+  REFRESH_MAT_VIEW_STMT = 'RefreshMatViewStmt'.freeze
+  RENAME_STMT = 'RenameStmt'.freeze
+  RES_TARGET = 'ResTarget'.freeze
+  ROW_EXPR = 'RowExpr'.freeze
+  RULE_STMT = 'RuleStmt'.freeze
+  ROLE_SPEC = 'RoleSpec'.freeze
+  SELECT_STMT = 'SelectStmt'.freeze
+  SORT_BY = 'SortBy'.freeze
+  SUB_LINK = 'SubLink'.freeze
+  TRANSACTION_STMT = 'TransactionStmt'.freeze
+  TRUNCATE_STMT = 'TruncateStmt'.freeze
+  TYPE_CAST = 'TypeCast'.freeze
+  TYPE_NAME = 'TypeName'.freeze
+  UPDATE_STMT = 'UpdateStmt'.freeze
+  VACUUM_STMT = 'VacuumStmt'.freeze
+  VARIABLE_SET_STMT = 'VariableSetStmt'.freeze
+  VARIABLE_SHOW_STMT = 'VariableShowStmt'.freeze
+  VIEW_STMT = 'ViewStmt'.freeze
+  WINDOW_DEF = 'WindowDef'.freeze
+  WITH_CLAUSE = 'WithClause'.freeze
+  STRING = 'String'.freeze
+  INTEGER = 'Integer'.freeze
+  SET_TO_DEFAULT = 'SetToDefault'.freeze
+  PREPARE_STMT = 'PrepareStmt'.freeze
+  EXECUTE_STMT = 'ExecuteStmt'.freeze
+  DEALLOCATE_STMT = 'DeallocateStmt'.freeze
+  NULL = 'Null'.freeze
+  INT_LIST = 'IntList'.freeze
+  OID_LIST = 'OidList'.freeze
+
+  # FIELDS
+
+  FROM_CLAUSE_FIELD = 'fromClause'.freeze
+  TARGET_LIST_FIELD = 'targetList'.freeze
+  COLS_FIELD = 'cols'.freeze
+  REXPR_FIELD = 'rexpr'.freeze
+
+  # ENUMS
+
+  CONSTR_TYPE_NULL = 0 # not standard SQL, but a lot of people expect it
+  CONSTR_TYPE_NOTNULL = 1
+  CONSTR_TYPE_DEFAULT = 2
+  CONSTR_TYPE_CHECK = 3
+  CONSTR_TYPE_PRIMARY = 4
+  CONSTR_TYPE_UNIQUE = 5
+  CONSTR_TYPE_EXCLUSION = 6
+  CONSTR_TYPE_FOREIGN = 7
+  CONSTR_TYPE_ATTR_DEFERRABLE = 8 # attributes for previous constraint node
+  CONSTR_TYPE_ATTR_NOT_DEFERRABLE = 9
+  CONSTR_TYPE_ATTR_DEFERRED = 10
+  CONSTR_TYPE_ATTR_IMMEDIATE = 11
+
+  OBJECT_TYPE_INDEX = 19
+  OBJECT_TYPE_RULE = 28
+  OBJECT_TYPE_SCHEMA = 29
+  OBJECT_TYPE_TABLE = 32
+  OBJECT_TYPE_TRIGGER = 35
+  OBJECT_TYPE_VIEW = 42
+
+  BOOL_EXPR_AND = 0
+  BOOL_EXPR_OR = 1
+  BOOL_EXPR_NOT = 2
+
+  AEXPR_OP = 0               # normal operator
+  AEXPR_OP_ANY = 1           # scalar op ANY (array)
+  AEXPR_OP_ALL = 2           # scalar op ALL (array)
+  AEXPR_DISTINCT = 3         # IS DISTINCT FROM - name must be "="
+  AEXPR_NULLIF = 4           # NULLIF - name must be "="
+  AEXPR_OF = 5               # IS [NOT] OF - name must be "=" or "<>"
+  AEXPR_IN = 6               # [NOT] IN - name must be "=" or "<>"
+  AEXPR_LIKE = 7             # [NOT] LIKE - name must be "~~" or "!~~"
+  AEXPR_ILIKE = 8            # [NOT] ILIKE - name must be "~~*" or "!~~*"
+  AEXPR_SIMILAR = 9          # [NOT] SIMILAR - name must be "~" or "!~"
+  AEXPR_BETWEEN = 10         # name must be "BETWEEN"
+  AEXPR_NOT_BETWEEN = 11     # name must be "NOT BETWEEN"
+  AEXPR_BETWEEN_SYM = 12     # name must be "BETWEEN SYMMETRIC"
+  AEXPR_NOT_BETWEEN_SYM = 13 # name must be "NOT BETWEEN SYMMETRIC"
+  AEXPR_PAREN = 14           # nameless dummy node for parentheses
+
+  TRANS_STMT_BEGIN = 0
+  TRANS_STMT_START = 1 # semantically identical to BEGIN
+  TRANS_STMT_COMMIT = 2
+  TRANS_STMT_ROLLBACK = 3
+  TRANS_STMT_SAVEPOINT = 4
+  TRANS_STMT_RELEASE = 5
+  TRANS_STMT_ROLLBACK_TO = 6
+  TRANS_STMT_PREPARE = 7
+  TRANS_STMT_COMMIT_PREPARED = 8
+  TRANS_STMT_ROLLBACK_PREPARED = 9
+
+  SUBLINK_TYPE_EXISTS = 0     # EXISTS(SELECT ...)
+  SUBLINK_TYPE_ALL = 1        # (lefthand) op ALL (SELECT ...)
+  SUBLINK_TYPE_ANY = 2        # (lefthand) op ANY (SELECT ...)
+  SUBLINK_TYPE_ROWCOMPARE = 3 # (lefthand) op (SELECT ...)
+  SUBLINK_TYPE_EXPR = 4       # (SELECT with single targetlist item ...)
+  SUBLINK_TYPE_MULTIEXPR = 5  # (SELECT with multiple targetlist items ...)
+  SUBLINK_TYPE_ARRAY = 6      # ARRAY(SELECT with single targetlist item ...)
+  SUBLINK_TYPE_CTE = 7        # WITH query (never actually part of an expression), for SubPlans only
+
+  LCS_NONE = 0           # no such clause - only used in PlanRowMark
+  LCS_FORKEYSHARE = 1    # FOR KEY SHARE
+  LCS_FORSHARE = 2       # FOR SHARE
+  LCS_FORNOKEYUPDATE = 3 # FOR NO KEY UPDATE
+  LCS_FORUPDATE = 4      # FOR UPDATE
+
+  AT_AddColumn = 0                  # add column
+  AT_AddColumnRecurse = 1           # internal to commands/tablecmds.c
+  AT_AddColumnToView = 2            # implicitly via CREATE OR REPLACE VIEW
+  AT_ColumnDefault = 3              # alter column default
+  AT_DropNotNull = 4                # alter column drop not null
+  AT_SetNotNull = 5                 # alter column set not null
+  AT_SetStatistics = 6              # alter column set statistics
+  AT_SetOptions = 7                 # alter column set ( options )
+  AT_ResetOptions = 8               # alter column reset ( options )
+  AT_SetStorage = 9                 # alter column set storage
+  AT_DropColumn = 10                # drop column
+  AT_DropColumnRecurse = 11         # internal to commands/tablecmds.c
+  AT_AddIndex = 12                  # add index
+  AT_ReAddIndex = 13                # internal to commands/tablecmds.c
+  AT_AddConstraint = 14             # add constraint
+  AT_AddConstraintRecurse = 15      # internal to commands/tablecmds.c
+  AT_ReAddConstraint = 16           # internal to commands/tablecmds.c
+  AT_AlterConstraint = 17           # alter constraint
+  AT_ValidateConstraint = 18        # validate constraint
+  AT_ValidateConstraintRecurse = 19 # internal to commands/tablecmds.c
+  AT_ProcessedConstraint = 20       # pre-processed add constraint (local in parser/parse_utilcmd.c)
+  AT_AddIndexConstraint = 21        # add constraint using existing index
+  AT_DropConstraint = 22            # drop constraint
+  AT_DropConstraintRecurse = 23     # internal to commands/tablecmds.c
+  AT_ReAddComment = 24              # internal to commands/tablecmds.c
+  AT_AlterColumnType = 25           # alter column type
+  AT_AlterColumnGenericOptions = 26 # alter column OPTIONS (...)
+  AT_ChangeOwner = 27               # change owner
+  AT_ClusterOn = 28                 # CLUSTER ON
+  AT_DropCluster = 29               # SET WITHOUT CLUSTER
+  AT_SetLogged = 30                 # SET LOGGED
+  AT_SetUnLogged = 31               # SET UNLOGGED
+  AT_AddOids = 32                   # SET WITH OIDS
+  AT_AddOidsRecurse = 33            # internal to commands/tablecmds.c
+  AT_DropOids = 34                  # SET WITHOUT OIDS
+  AT_SetTableSpace = 35             # SET TABLESPACE
+  AT_SetRelOptions = 36             # SET (...) -- AM specific parameters
+  AT_ResetRelOptions = 37           # RESET (...) -- AM specific parameters
+  AT_ReplaceRelOptions = 38         # replace reloption list in its entirety
+  AT_EnableTrig = 39                # ENABLE TRIGGER name
+  AT_EnableAlwaysTrig = 40          # ENABLE ALWAYS TRIGGER name
+  AT_EnableReplicaTrig = 41         # ENABLE REPLICA TRIGGER name
+  AT_DisableTrig = 42               # DISABLE TRIGGER name
+  AT_EnableTrigAll = 43             # ENABLE TRIGGER ALL
+  AT_DisableTrigAll = 44            #  DISABLE TRIGGER ALL
+  AT_EnableTrigUser = 45            # ENABLE TRIGGER USER
+  AT_DisableTrigUser = 46           # DISABLE TRIGGER USER
+  AT_EnableRule = 47                # ENABLE RULE name
+  AT_EnableAlwaysRule = 48          # ENABLE ALWAYS RULE name
+  AT_EnableReplicaRule = 49         # ENABLE REPLICA RULE name
+  AT_DisableRule = 50               # DISABLE RULE name
+  AT_AddInherit = 51                # INHERIT parent
+  AT_DropInherit = 52               # NO INHERIT parent
+  AT_AddOf = 53                     # OF <type_name>
+  AT_DropOf = 54                    # NOT OF
+  AT_ReplicaIdentity = 55           # REPLICA IDENTITY
+  AT_EnableRowSecurity = 56         # ENABLE ROW SECURITY
+  AT_DisableRowSecurity = 57        # DISABLE ROW SECURITY
+  AT_ForceRowSecurity = 58          # FORCE ROW SECURITY
+  AT_NoForceRowSecurity = 59        # NO FORCE ROW SECURITY
+  AT_GenericOptions = 60            # OPTIONS (...)
+end

data/lib/pg_query/param_refs.rb

@@ -2,22 +2,22 @@ class PgQuery
   def param_refs # rubocop:disable Metrics/CyclomaticComplexity
     results = []
 
-    treewalker! parsetree do |_, _, v|
+    treewalker! @tree do |_, _, v|
       next unless v.is_a?(Hash)
 
-      if v['PARAMREF']
-        results << { 'location' => v['PARAMREF']['location'],
-                     'length' => param_ref_length(v['PARAMREF']) }
-      elsif v['TYPECAST']
-        next unless v['TYPECAST']['arg'] && v['TYPECAST']['typeName']
+      if v[PARAM_REF]
+        results << { 'location' => v[PARAM_REF]['location'],
+                     'length' => param_ref_length(v[PARAM_REF]) }
+      elsif v[TYPE_CAST]
+        next unless v[TYPE_CAST]['arg'] && v[TYPE_CAST]['typeName']
 
-        p = v['TYPECAST']['arg'].delete('PARAMREF')
-        t = v['TYPECAST']['typeName'].delete('TYPENAME')
+        p = v[TYPE_CAST]['arg'].delete(PARAM_REF)
+        t = v[TYPE_CAST]['typeName'].delete(TYPE_NAME)
         next unless p && t
 
         location = p['location']
         typeloc  = t['location']
-        typename = t['names'].join('.')
+        typename = t['names']
         length   = param_ref_length(p)
 
         if typeloc < location

data/lib/pg_query/parse.rb

@@ -2,10 +2,10 @@ require 'json'
 
 class PgQuery
   def self.parse(query)
-    parsetree, stderr = _raw_parse(query)
+    tree, stderr = _raw_parse(query)
 
     begin
-      parsetree = JSON.parse(parsetree, max_nesting: 1000)
+      tree = JSON.parse(tree, max_nesting: 1000)
     rescue JSON::ParserError
       raise ParseError.new('Failed to parse JSON', __FILE__, __LINE__, -1)
     end
@@ -16,16 +16,16 @@ class PgQuery
       warnings << line.strip
     end
 
-    PgQuery.new(query, parsetree, warnings)
+    PgQuery.new(query, tree, warnings)
   end
 
   attr_reader :query
-  attr_reader :parsetree
+  attr_reader :tree
   attr_reader :warnings
 
-  def initialize(query, parsetree, warnings = [])
+  def initialize(query, tree, warnings = [])
     @query = query
-    @parsetree = parsetree
+    @tree = tree
     @warnings = warnings
   end
 
@@ -45,7 +45,7 @@ class PgQuery
     @tables = []
     @aliases = {}
 
-    statements = @parsetree.dup
+    statements = @tree.dup
     from_clause_items = []
     where_clause_items = []
 
@@ -53,44 +53,44 @@ class PgQuery
       statement = statements.shift
       if statement
         case statement.keys[0]
-        when 'SELECT'
-          if statement['SELECT']['op'] == 0
-            (statement['SELECT']['fromClause'] || []).each do |item|
-              if item['RANGESUBSELECT']
-                statements << item['RANGESUBSELECT']['subquery']
+        when SELECT_STMT
+          if statement[SELECT_STMT]['op'] == 0
+            (statement[SELECT_STMT][FROM_CLAUSE_FIELD] || []).each do |item|
+              if item[RANGE_SUBSELECT]
+                statements << item[RANGE_SUBSELECT]['subquery']
               else
                 from_clause_items << item
               end
             end
 
             # CTEs
-            if statement['SELECT']['withClause']
-              statement['SELECT']['withClause']['WITHCLAUSE']['ctes'].each do |item|
-                statements << item['COMMONTABLEEXPR']['ctequery'] if item['COMMONTABLEEXPR']
+            if statement[SELECT_STMT]['withClause']
+              statement[SELECT_STMT]['withClause'][WITH_CLAUSE]['ctes'].each do |item|
+                statements << item[COMMON_TABLE_EXPR]['ctequery'] if item[COMMON_TABLE_EXPR]
               end
             end
-          elsif statement['SELECT']['op'] == 1
-            statements << statement['SELECT']['larg'] if statement['SELECT']['larg']
-            statements << statement['SELECT']['rarg'] if statement['SELECT']['rarg']
+          elsif statement[SELECT_STMT]['op'] == 1
+            statements << statement[SELECT_STMT]['larg'] if statement[SELECT_STMT]['larg']
+            statements << statement[SELECT_STMT]['rarg'] if statement[SELECT_STMT]['rarg']
           end
-        when 'INSERT INTO', 'UPDATE', 'DELETE FROM', 'VACUUM', 'COPY', 'ALTER TABLE', 'CREATESTMT', 'INDEXSTMT', 'RULESTMT', 'CREATETRIGSTMT'
+        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']
-        when 'VIEWSTMT'
-          from_clause_items << statement['VIEWSTMT']['view']
-          statements << statement['VIEWSTMT']['query']
-        when 'REFRESHMATVIEWSTMT'
-          from_clause_items << statement['REFRESHMATVIEWSTMT']['relation']
-        when 'EXPLAIN'
-          statements << statement['EXPLAIN']['query']
-        when 'CREATE TABLE AS'
-          if statement['CREATE TABLE AS']['into'] && statement['CREATE TABLE AS']['into']['INTOCLAUSE']['rel']
-            from_clause_items << statement['CREATE TABLE AS']['into']['INTOCLAUSE']['rel']
+        when VIEW_STMT
+          from_clause_items << statement[VIEW_STMT]['view']
+          statements << statement[VIEW_STMT]['query']
+        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']
           end
-        when 'LOCK', 'TRUNCATE'
+        when LOCK_STMT, TRUNCATE_STMT
           from_clause_items += statement.values[0]['relations']
-        when 'GRANTSTMT'
-          objects = statement['GRANTSTMT']['objects']
-          case statement['GRANTSTMT']['objtype']
+        when GRANT_STMT
+          objects = statement[GRANT_STMT]['objects']
+          case statement[GRANT_STMT]['objtype']
           when 0 # Column
             # FIXME
           when 1 # Table
@@ -98,14 +98,12 @@ class PgQuery
           when 2 # Sequence
             # FIXME
           end
-        when 'DROP'
-          objects = statement['DROP']['objects']
-          case statement['DROP']['removeType']
-          when 26 # Table
+        when DROP_STMT
+          objects = statement[DROP_STMT]['objects'].map { |list| list.map { |obj| obj['String']['str'] } }
+          case statement[DROP_STMT]['removeType']
+          when OBJECT_TYPE_TABLE
             @tables += objects.map { |r| r.join('.') }
-          when 23 # Rule
-            @tables += objects.map { |r| r[0..-2].join('.') }
-          when 28 # Trigger
+          when OBJECT_TYPE_RULE, OBJECT_TYPE_TRIGGER
             @tables += objects.map { |r| r[0..-2].join('.') }
           end
         end
@@ -117,7 +115,7 @@ class PgQuery
       next_item = where_clause_items.shift
       if next_item
         case next_item.keys[0]
-        when /^AEXPR/, 'ANY'
+        when A_EXPR
           %w(lexpr rexpr).each do |side|
             elem = next_item.values[0][side]
             next unless elem
@@ -127,8 +125,8 @@ class PgQuery
               where_clause_items << elem
             end
           end
-        when 'SUBLINK'
-          statements << next_item['SUBLINK']['subselect']
+        when SUB_LINK
+          statements << next_item[SUB_LINK]['subselect']
         end
       end
 
@@ -140,17 +138,17 @@ class PgQuery
       break unless next_item
 
       case next_item.keys[0]
-      when 'JOINEXPR'
+      when JOIN_EXPR
         %w(larg rarg).each do |side|
-          from_clause_items << next_item['JOINEXPR'][side]
+          from_clause_items << next_item[JOIN_EXPR][side]
         end
-      when 'ROW'
-        from_clause_items += next_item['ROW']['args']
-      when 'RANGEVAR'
-        rangevar = next_item['RANGEVAR']
+      when ROW_EXPR
+        from_clause_items += next_item[ROW_EXPR]['args']
+      when RANGE_VAR
+        rangevar = next_item[RANGE_VAR]
         table = [rangevar['schemaname'], rangevar['relname']].compact.join('.')
         @tables << table
-        @aliases[rangevar['alias']['ALIAS']['aliasname']] = table if rangevar['alias']
+        @aliases[rangevar['alias'][ALIAS]['aliasname']] = table if rangevar['alias']
       end
     end
 

data/lib/pg_query/treewalker.rb

@@ -30,18 +30,24 @@ class PgQuery
     end
   end
 
-  def deep_dup(obj)
-    case obj
-    when Hash
-      obj.each_with_object(obj.dup) do |(key, value), hash|
-        hash[deep_dup(key)] = deep_dup(value)
+  def transform_nodes!(parsetree, &block)
+    result = deep_dup(parsetree)
+    exprs = result.dup
+
+    loop do
+      expr = exprs.shift
+
+      if expr.is_a?(Hash)
+        block.call(expr) if expr.size == 1 && expr.keys[0][/^[A-Z]+/]
+
+        exprs += expr.values.compact
+      elsif expr.is_a?(Array)
+        exprs += expr
       end
-    when Array
-      obj.map { |it| deep_dup(it) }
-    when NilClass, FalseClass, TrueClass, Symbol, Numeric
-      obj # Can't be duplicated
-    else
-      obj.dup
+
+      break if exprs.empty?
     end
+
+    result
   end
 end