pg_query 2.0.0 → 2.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (375) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/ext/pg_query/include/access/amapi.h +246 -0
  4. data/ext/pg_query/include/access/attmap.h +52 -0
  5. data/ext/pg_query/include/access/attnum.h +64 -0
  6. data/ext/pg_query/include/access/clog.h +61 -0
  7. data/ext/pg_query/include/access/commit_ts.h +77 -0
  8. data/ext/pg_query/include/access/detoast.h +92 -0
  9. data/ext/pg_query/include/access/genam.h +228 -0
  10. data/ext/pg_query/include/access/gin.h +78 -0
  11. data/ext/pg_query/include/access/htup.h +89 -0
  12. data/ext/pg_query/include/access/htup_details.h +819 -0
  13. data/ext/pg_query/include/access/itup.h +161 -0
  14. data/ext/pg_query/include/access/parallel.h +82 -0
  15. data/ext/pg_query/include/access/printtup.h +35 -0
  16. data/ext/pg_query/include/access/relation.h +28 -0
  17. data/ext/pg_query/include/access/relscan.h +176 -0
  18. data/ext/pg_query/include/access/rmgr.h +35 -0
  19. data/ext/pg_query/include/access/rmgrlist.h +49 -0
  20. data/ext/pg_query/include/access/sdir.h +58 -0
  21. data/ext/pg_query/include/access/skey.h +151 -0
  22. data/ext/pg_query/include/access/stratnum.h +83 -0
  23. data/ext/pg_query/include/access/sysattr.h +29 -0
  24. data/ext/pg_query/include/access/table.h +27 -0
  25. data/ext/pg_query/include/access/tableam.h +1825 -0
  26. data/ext/pg_query/include/access/transam.h +265 -0
  27. data/ext/pg_query/include/access/tupconvert.h +51 -0
  28. data/ext/pg_query/include/access/tupdesc.h +154 -0
  29. data/ext/pg_query/include/access/tupmacs.h +247 -0
  30. data/ext/pg_query/include/access/twophase.h +61 -0
  31. data/ext/pg_query/include/access/xact.h +463 -0
  32. data/ext/pg_query/include/access/xlog.h +398 -0
  33. data/ext/pg_query/include/access/xlog_internal.h +330 -0
  34. data/ext/pg_query/include/access/xlogdefs.h +109 -0
  35. data/ext/pg_query/include/access/xloginsert.h +64 -0
  36. data/ext/pg_query/include/access/xlogreader.h +327 -0
  37. data/ext/pg_query/include/access/xlogrecord.h +227 -0
  38. data/ext/pg_query/include/bootstrap/bootstrap.h +62 -0
  39. data/ext/pg_query/include/c.h +1322 -0
  40. data/ext/pg_query/include/catalog/catalog.h +42 -0
  41. data/ext/pg_query/include/catalog/catversion.h +58 -0
  42. data/ext/pg_query/include/catalog/dependency.h +275 -0
  43. data/ext/pg_query/include/catalog/genbki.h +64 -0
  44. data/ext/pg_query/include/catalog/index.h +199 -0
  45. data/ext/pg_query/include/catalog/indexing.h +366 -0
  46. data/ext/pg_query/include/catalog/namespace.h +188 -0
  47. data/ext/pg_query/include/catalog/objectaccess.h +197 -0
  48. data/ext/pg_query/include/catalog/objectaddress.h +84 -0
  49. data/ext/pg_query/include/catalog/pg_aggregate.h +176 -0
  50. data/ext/pg_query/include/catalog/pg_aggregate_d.h +77 -0
  51. data/ext/pg_query/include/catalog/pg_am.h +60 -0
  52. data/ext/pg_query/include/catalog/pg_am_d.h +45 -0
  53. data/ext/pg_query/include/catalog/pg_attribute.h +204 -0
  54. data/ext/pg_query/include/catalog/pg_attribute_d.h +59 -0
  55. data/ext/pg_query/include/catalog/pg_authid.h +58 -0
  56. data/ext/pg_query/include/catalog/pg_authid_d.h +49 -0
  57. data/ext/pg_query/include/catalog/pg_class.h +200 -0
  58. data/ext/pg_query/include/catalog/pg_class_d.h +103 -0
  59. data/ext/pg_query/include/catalog/pg_collation.h +73 -0
  60. data/ext/pg_query/include/catalog/pg_collation_d.h +45 -0
  61. data/ext/pg_query/include/catalog/pg_constraint.h +247 -0
  62. data/ext/pg_query/include/catalog/pg_constraint_d.h +67 -0
  63. data/ext/pg_query/include/catalog/pg_control.h +250 -0
  64. data/ext/pg_query/include/catalog/pg_conversion.h +72 -0
  65. data/ext/pg_query/include/catalog/pg_conversion_d.h +35 -0
  66. data/ext/pg_query/include/catalog/pg_depend.h +73 -0
  67. data/ext/pg_query/include/catalog/pg_depend_d.h +34 -0
  68. data/ext/pg_query/include/catalog/pg_event_trigger.h +51 -0
  69. data/ext/pg_query/include/catalog/pg_event_trigger_d.h +34 -0
  70. data/ext/pg_query/include/catalog/pg_index.h +80 -0
  71. data/ext/pg_query/include/catalog/pg_index_d.h +56 -0
  72. data/ext/pg_query/include/catalog/pg_language.h +67 -0
  73. data/ext/pg_query/include/catalog/pg_language_d.h +39 -0
  74. data/ext/pg_query/include/catalog/pg_namespace.h +59 -0
  75. data/ext/pg_query/include/catalog/pg_namespace_d.h +34 -0
  76. data/ext/pg_query/include/catalog/pg_opclass.h +85 -0
  77. data/ext/pg_query/include/catalog/pg_opclass_d.h +49 -0
  78. data/ext/pg_query/include/catalog/pg_operator.h +102 -0
  79. data/ext/pg_query/include/catalog/pg_operator_d.h +106 -0
  80. data/ext/pg_query/include/catalog/pg_opfamily.h +60 -0
  81. data/ext/pg_query/include/catalog/pg_opfamily_d.h +47 -0
  82. data/ext/pg_query/include/catalog/pg_partitioned_table.h +63 -0
  83. data/ext/pg_query/include/catalog/pg_partitioned_table_d.h +35 -0
  84. data/ext/pg_query/include/catalog/pg_proc.h +211 -0
  85. data/ext/pg_query/include/catalog/pg_proc_d.h +99 -0
  86. data/ext/pg_query/include/catalog/pg_publication.h +115 -0
  87. data/ext/pg_query/include/catalog/pg_publication_d.h +36 -0
  88. data/ext/pg_query/include/catalog/pg_replication_origin.h +57 -0
  89. data/ext/pg_query/include/catalog/pg_replication_origin_d.h +29 -0
  90. data/ext/pg_query/include/catalog/pg_statistic.h +275 -0
  91. data/ext/pg_query/include/catalog/pg_statistic_d.h +194 -0
  92. data/ext/pg_query/include/catalog/pg_statistic_ext.h +74 -0
  93. data/ext/pg_query/include/catalog/pg_statistic_ext_d.h +40 -0
  94. data/ext/pg_query/include/catalog/pg_transform.h +45 -0
  95. data/ext/pg_query/include/catalog/pg_transform_d.h +32 -0
  96. data/ext/pg_query/include/catalog/pg_trigger.h +137 -0
  97. data/ext/pg_query/include/catalog/pg_trigger_d.h +106 -0
  98. data/ext/pg_query/include/catalog/pg_ts_config.h +50 -0
  99. data/ext/pg_query/include/catalog/pg_ts_config_d.h +32 -0
  100. data/ext/pg_query/include/catalog/pg_ts_dict.h +54 -0
  101. data/ext/pg_query/include/catalog/pg_ts_dict_d.h +33 -0
  102. data/ext/pg_query/include/catalog/pg_ts_parser.h +57 -0
  103. data/ext/pg_query/include/catalog/pg_ts_parser_d.h +35 -0
  104. data/ext/pg_query/include/catalog/pg_ts_template.h +48 -0
  105. data/ext/pg_query/include/catalog/pg_ts_template_d.h +32 -0
  106. data/ext/pg_query/include/catalog/pg_type.h +372 -0
  107. data/ext/pg_query/include/catalog/pg_type_d.h +285 -0
  108. data/ext/pg_query/include/catalog/storage.h +48 -0
  109. data/ext/pg_query/include/commands/async.h +54 -0
  110. data/ext/pg_query/include/commands/dbcommands.h +35 -0
  111. data/ext/pg_query/include/commands/defrem.h +173 -0
  112. data/ext/pg_query/include/commands/event_trigger.h +88 -0
  113. data/ext/pg_query/include/commands/explain.h +127 -0
  114. data/ext/pg_query/include/commands/prepare.h +61 -0
  115. data/ext/pg_query/include/commands/tablespace.h +67 -0
  116. data/ext/pg_query/include/commands/trigger.h +277 -0
  117. data/ext/pg_query/include/commands/user.h +37 -0
  118. data/ext/pg_query/include/commands/vacuum.h +293 -0
  119. data/ext/pg_query/include/commands/variable.h +38 -0
  120. data/ext/pg_query/include/common/file_perm.h +56 -0
  121. data/ext/pg_query/include/common/hashfn.h +104 -0
  122. data/ext/pg_query/include/common/ip.h +37 -0
  123. data/ext/pg_query/include/common/keywords.h +33 -0
  124. data/ext/pg_query/include/common/kwlookup.h +44 -0
  125. data/ext/pg_query/include/common/relpath.h +90 -0
  126. data/ext/pg_query/include/common/string.h +19 -0
  127. data/ext/pg_query/include/common/unicode_combining_table.h +196 -0
  128. data/ext/pg_query/include/datatype/timestamp.h +197 -0
  129. data/ext/pg_query/include/executor/execdesc.h +70 -0
  130. data/ext/pg_query/include/executor/executor.h +614 -0
  131. data/ext/pg_query/include/executor/functions.h +41 -0
  132. data/ext/pg_query/include/executor/instrument.h +101 -0
  133. data/ext/pg_query/include/executor/spi.h +175 -0
  134. data/ext/pg_query/include/executor/tablefunc.h +67 -0
  135. data/ext/pg_query/include/executor/tuptable.h +487 -0
  136. data/ext/pg_query/include/fmgr.h +775 -0
  137. data/ext/pg_query/include/funcapi.h +348 -0
  138. data/ext/pg_query/include/getaddrinfo.h +162 -0
  139. data/ext/pg_query/include/jit/jit.h +105 -0
  140. data/ext/pg_query/include/kwlist_d.h +1072 -0
  141. data/ext/pg_query/include/lib/ilist.h +727 -0
  142. data/ext/pg_query/include/lib/pairingheap.h +102 -0
  143. data/ext/pg_query/include/lib/simplehash.h +1059 -0
  144. data/ext/pg_query/include/lib/stringinfo.h +161 -0
  145. data/ext/pg_query/include/libpq/auth.h +29 -0
  146. data/ext/pg_query/include/libpq/crypt.h +46 -0
  147. data/ext/pg_query/include/libpq/hba.h +140 -0
  148. data/ext/pg_query/include/libpq/libpq-be.h +326 -0
  149. data/ext/pg_query/include/libpq/libpq.h +133 -0
  150. data/ext/pg_query/include/libpq/pqcomm.h +208 -0
  151. data/ext/pg_query/include/libpq/pqformat.h +210 -0
  152. data/ext/pg_query/include/libpq/pqsignal.h +42 -0
  153. data/ext/pg_query/include/mb/pg_wchar.h +672 -0
  154. data/ext/pg_query/include/mb/stringinfo_mb.h +24 -0
  155. data/ext/pg_query/include/miscadmin.h +476 -0
  156. data/ext/pg_query/include/nodes/bitmapset.h +122 -0
  157. data/ext/pg_query/include/nodes/execnodes.h +2520 -0
  158. data/ext/pg_query/include/nodes/extensible.h +160 -0
  159. data/ext/pg_query/include/nodes/lockoptions.h +61 -0
  160. data/ext/pg_query/include/nodes/makefuncs.h +108 -0
  161. data/ext/pg_query/include/nodes/memnodes.h +108 -0
  162. data/ext/pg_query/include/nodes/nodeFuncs.h +162 -0
  163. data/ext/pg_query/include/nodes/nodes.h +842 -0
  164. data/ext/pg_query/include/nodes/params.h +170 -0
  165. data/ext/pg_query/include/nodes/parsenodes.h +3579 -0
  166. data/ext/pg_query/include/nodes/pathnodes.h +2556 -0
  167. data/ext/pg_query/include/nodes/pg_list.h +605 -0
  168. data/ext/pg_query/include/nodes/plannodes.h +1251 -0
  169. data/ext/pg_query/include/nodes/primnodes.h +1541 -0
  170. data/ext/pg_query/include/nodes/print.h +34 -0
  171. data/ext/pg_query/include/nodes/tidbitmap.h +75 -0
  172. data/ext/pg_query/include/nodes/value.h +61 -0
  173. data/ext/pg_query/include/optimizer/cost.h +206 -0
  174. data/ext/pg_query/include/optimizer/geqo.h +88 -0
  175. data/ext/pg_query/include/optimizer/geqo_gene.h +45 -0
  176. data/ext/pg_query/include/optimizer/optimizer.h +199 -0
  177. data/ext/pg_query/include/optimizer/paths.h +249 -0
  178. data/ext/pg_query/include/optimizer/planmain.h +119 -0
  179. data/ext/pg_query/include/parser/analyze.h +49 -0
  180. data/ext/pg_query/include/parser/gram.h +1067 -0
  181. data/ext/pg_query/include/parser/gramparse.h +75 -0
  182. data/ext/pg_query/include/parser/kwlist.h +477 -0
  183. data/ext/pg_query/include/parser/parse_agg.h +68 -0
  184. data/ext/pg_query/include/parser/parse_clause.h +54 -0
  185. data/ext/pg_query/include/parser/parse_coerce.h +97 -0
  186. data/ext/pg_query/include/parser/parse_collate.h +27 -0
  187. data/ext/pg_query/include/parser/parse_expr.h +26 -0
  188. data/ext/pg_query/include/parser/parse_func.h +73 -0
  189. data/ext/pg_query/include/parser/parse_node.h +327 -0
  190. data/ext/pg_query/include/parser/parse_oper.h +67 -0
  191. data/ext/pg_query/include/parser/parse_relation.h +123 -0
  192. data/ext/pg_query/include/parser/parse_target.h +46 -0
  193. data/ext/pg_query/include/parser/parse_type.h +60 -0
  194. data/ext/pg_query/include/parser/parser.h +41 -0
  195. data/ext/pg_query/include/parser/parsetree.h +61 -0
  196. data/ext/pg_query/include/parser/scanner.h +152 -0
  197. data/ext/pg_query/include/parser/scansup.h +30 -0
  198. data/ext/pg_query/include/partitioning/partdefs.h +26 -0
  199. data/ext/pg_query/include/pg_config.h +988 -0
  200. data/ext/pg_query/include/pg_config_ext.h +8 -0
  201. data/ext/pg_query/include/pg_config_manual.h +350 -0
  202. data/ext/pg_query/include/pg_config_os.h +8 -0
  203. data/ext/pg_query/include/pg_getopt.h +56 -0
  204. data/ext/pg_query/include/pg_query.h +121 -0
  205. data/ext/pg_query/include/pg_query_enum_defs.c +2454 -0
  206. data/ext/pg_query/include/pg_query_fingerprint_conds.c +875 -0
  207. data/ext/pg_query/include/pg_query_fingerprint_defs.c +12413 -0
  208. data/ext/pg_query/include/pg_query_json_helper.c +61 -0
  209. data/ext/pg_query/include/pg_query_outfuncs_conds.c +686 -0
  210. data/ext/pg_query/include/pg_query_outfuncs_defs.c +2437 -0
  211. data/ext/pg_query/include/pg_query_readfuncs_conds.c +222 -0
  212. data/ext/pg_query/include/pg_query_readfuncs_defs.c +2878 -0
  213. data/ext/pg_query/include/pg_trace.h +17 -0
  214. data/ext/pg_query/include/pgstat.h +1487 -0
  215. data/ext/pg_query/include/pgtime.h +84 -0
  216. data/ext/pg_query/include/pl_gram.h +385 -0
  217. data/ext/pg_query/include/pl_reserved_kwlist.h +52 -0
  218. data/ext/pg_query/include/pl_reserved_kwlist_d.h +114 -0
  219. data/ext/pg_query/include/pl_unreserved_kwlist.h +112 -0
  220. data/ext/pg_query/include/pl_unreserved_kwlist_d.h +246 -0
  221. data/ext/pg_query/include/plerrcodes.h +990 -0
  222. data/ext/pg_query/include/plpgsql.h +1347 -0
  223. data/ext/pg_query/include/port.h +524 -0
  224. data/ext/pg_query/include/port/atomics.h +524 -0
  225. data/ext/pg_query/include/port/atomics/arch-arm.h +26 -0
  226. data/ext/pg_query/include/port/atomics/arch-ppc.h +254 -0
  227. data/ext/pg_query/include/port/atomics/arch-x86.h +252 -0
  228. data/ext/pg_query/include/port/atomics/fallback.h +170 -0
  229. data/ext/pg_query/include/port/atomics/generic-gcc.h +286 -0
  230. data/ext/pg_query/include/port/atomics/generic.h +401 -0
  231. data/ext/pg_query/include/port/pg_bitutils.h +226 -0
  232. data/ext/pg_query/include/port/pg_bswap.h +161 -0
  233. data/ext/pg_query/include/port/pg_crc32c.h +101 -0
  234. data/ext/pg_query/include/portability/instr_time.h +256 -0
  235. data/ext/pg_query/include/postgres.h +764 -0
  236. data/ext/pg_query/include/postgres_ext.h +74 -0
  237. data/ext/pg_query/include/postmaster/autovacuum.h +83 -0
  238. data/ext/pg_query/include/postmaster/bgworker.h +161 -0
  239. data/ext/pg_query/include/postmaster/bgworker_internals.h +64 -0
  240. data/ext/pg_query/include/postmaster/bgwriter.h +45 -0
  241. data/ext/pg_query/include/postmaster/fork_process.h +17 -0
  242. data/ext/pg_query/include/postmaster/interrupt.h +32 -0
  243. data/ext/pg_query/include/postmaster/pgarch.h +39 -0
  244. data/ext/pg_query/include/postmaster/postmaster.h +77 -0
  245. data/ext/pg_query/include/postmaster/syslogger.h +98 -0
  246. data/ext/pg_query/include/postmaster/walwriter.h +21 -0
  247. data/ext/pg_query/include/protobuf-c.h +1106 -0
  248. data/ext/pg_query/include/protobuf-c/protobuf-c.h +1106 -0
  249. data/ext/pg_query/include/protobuf/pg_query.pb-c.h +10846 -0
  250. data/ext/pg_query/include/protobuf/pg_query.pb.h +124718 -0
  251. data/ext/pg_query/include/regex/regex.h +184 -0
  252. data/ext/pg_query/include/replication/logicallauncher.h +31 -0
  253. data/ext/pg_query/include/replication/logicalproto.h +110 -0
  254. data/ext/pg_query/include/replication/logicalworker.h +19 -0
  255. data/ext/pg_query/include/replication/origin.h +73 -0
  256. data/ext/pg_query/include/replication/reorderbuffer.h +467 -0
  257. data/ext/pg_query/include/replication/slot.h +219 -0
  258. data/ext/pg_query/include/replication/syncrep.h +115 -0
  259. data/ext/pg_query/include/replication/walreceiver.h +340 -0
  260. data/ext/pg_query/include/replication/walsender.h +74 -0
  261. data/ext/pg_query/include/rewrite/prs2lock.h +46 -0
  262. data/ext/pg_query/include/rewrite/rewriteHandler.h +40 -0
  263. data/ext/pg_query/include/rewrite/rewriteManip.h +87 -0
  264. data/ext/pg_query/include/rewrite/rewriteSupport.h +26 -0
  265. data/ext/pg_query/include/storage/backendid.h +37 -0
  266. data/ext/pg_query/include/storage/block.h +121 -0
  267. data/ext/pg_query/include/storage/buf.h +46 -0
  268. data/ext/pg_query/include/storage/bufmgr.h +292 -0
  269. data/ext/pg_query/include/storage/bufpage.h +459 -0
  270. data/ext/pg_query/include/storage/condition_variable.h +62 -0
  271. data/ext/pg_query/include/storage/dsm.h +61 -0
  272. data/ext/pg_query/include/storage/dsm_impl.h +75 -0
  273. data/ext/pg_query/include/storage/fd.h +168 -0
  274. data/ext/pg_query/include/storage/ipc.h +81 -0
  275. data/ext/pg_query/include/storage/item.h +19 -0
  276. data/ext/pg_query/include/storage/itemid.h +184 -0
  277. data/ext/pg_query/include/storage/itemptr.h +206 -0
  278. data/ext/pg_query/include/storage/large_object.h +100 -0
  279. data/ext/pg_query/include/storage/latch.h +190 -0
  280. data/ext/pg_query/include/storage/lmgr.h +114 -0
  281. data/ext/pg_query/include/storage/lock.h +612 -0
  282. data/ext/pg_query/include/storage/lockdefs.h +59 -0
  283. data/ext/pg_query/include/storage/lwlock.h +232 -0
  284. data/ext/pg_query/include/storage/lwlocknames.h +51 -0
  285. data/ext/pg_query/include/storage/off.h +57 -0
  286. data/ext/pg_query/include/storage/pg_sema.h +61 -0
  287. data/ext/pg_query/include/storage/pg_shmem.h +90 -0
  288. data/ext/pg_query/include/storage/pmsignal.h +94 -0
  289. data/ext/pg_query/include/storage/predicate.h +87 -0
  290. data/ext/pg_query/include/storage/proc.h +333 -0
  291. data/ext/pg_query/include/storage/proclist_types.h +51 -0
  292. data/ext/pg_query/include/storage/procsignal.h +75 -0
  293. data/ext/pg_query/include/storage/relfilenode.h +99 -0
  294. data/ext/pg_query/include/storage/s_lock.h +1047 -0
  295. data/ext/pg_query/include/storage/sharedfileset.h +45 -0
  296. data/ext/pg_query/include/storage/shm_mq.h +85 -0
  297. data/ext/pg_query/include/storage/shm_toc.h +58 -0
  298. data/ext/pg_query/include/storage/shmem.h +81 -0
  299. data/ext/pg_query/include/storage/sinval.h +153 -0
  300. data/ext/pg_query/include/storage/sinvaladt.h +43 -0
  301. data/ext/pg_query/include/storage/smgr.h +109 -0
  302. data/ext/pg_query/include/storage/spin.h +77 -0
  303. data/ext/pg_query/include/storage/standby.h +91 -0
  304. data/ext/pg_query/include/storage/standbydefs.h +74 -0
  305. data/ext/pg_query/include/storage/sync.h +62 -0
  306. data/ext/pg_query/include/tcop/cmdtag.h +58 -0
  307. data/ext/pg_query/include/tcop/cmdtaglist.h +217 -0
  308. data/ext/pg_query/include/tcop/deparse_utility.h +108 -0
  309. data/ext/pg_query/include/tcop/dest.h +149 -0
  310. data/ext/pg_query/include/tcop/fastpath.h +21 -0
  311. data/ext/pg_query/include/tcop/pquery.h +45 -0
  312. data/ext/pg_query/include/tcop/tcopprot.h +89 -0
  313. data/ext/pg_query/include/tcop/utility.h +108 -0
  314. data/ext/pg_query/include/tsearch/ts_cache.h +98 -0
  315. data/ext/pg_query/include/utils/acl.h +312 -0
  316. data/ext/pg_query/include/utils/aclchk_internal.h +45 -0
  317. data/ext/pg_query/include/utils/array.h +458 -0
  318. data/ext/pg_query/include/utils/builtins.h +127 -0
  319. data/ext/pg_query/include/utils/bytea.h +27 -0
  320. data/ext/pg_query/include/utils/catcache.h +231 -0
  321. data/ext/pg_query/include/utils/date.h +90 -0
  322. data/ext/pg_query/include/utils/datetime.h +343 -0
  323. data/ext/pg_query/include/utils/datum.h +68 -0
  324. data/ext/pg_query/include/utils/dsa.h +123 -0
  325. data/ext/pg_query/include/utils/dynahash.h +19 -0
  326. data/ext/pg_query/include/utils/elog.h +439 -0
  327. data/ext/pg_query/include/utils/errcodes.h +352 -0
  328. data/ext/pg_query/include/utils/expandeddatum.h +159 -0
  329. data/ext/pg_query/include/utils/expandedrecord.h +231 -0
  330. data/ext/pg_query/include/utils/float.h +356 -0
  331. data/ext/pg_query/include/utils/fmgroids.h +2657 -0
  332. data/ext/pg_query/include/utils/fmgrprotos.h +2646 -0
  333. data/ext/pg_query/include/utils/fmgrtab.h +48 -0
  334. data/ext/pg_query/include/utils/guc.h +443 -0
  335. data/ext/pg_query/include/utils/guc_tables.h +272 -0
  336. data/ext/pg_query/include/utils/hsearch.h +149 -0
  337. data/ext/pg_query/include/utils/inval.h +64 -0
  338. data/ext/pg_query/include/utils/lsyscache.h +197 -0
  339. data/ext/pg_query/include/utils/memdebug.h +82 -0
  340. data/ext/pg_query/include/utils/memutils.h +225 -0
  341. data/ext/pg_query/include/utils/numeric.h +76 -0
  342. data/ext/pg_query/include/utils/palloc.h +136 -0
  343. data/ext/pg_query/include/utils/partcache.h +102 -0
  344. data/ext/pg_query/include/utils/pg_locale.h +119 -0
  345. data/ext/pg_query/include/utils/pg_lsn.h +29 -0
  346. data/ext/pg_query/include/utils/pidfile.h +56 -0
  347. data/ext/pg_query/include/utils/plancache.h +235 -0
  348. data/ext/pg_query/include/utils/portal.h +241 -0
  349. data/ext/pg_query/include/utils/probes.h +114 -0
  350. data/ext/pg_query/include/utils/ps_status.h +25 -0
  351. data/ext/pg_query/include/utils/queryenvironment.h +74 -0
  352. data/ext/pg_query/include/utils/regproc.h +28 -0
  353. data/ext/pg_query/include/utils/rel.h +644 -0
  354. data/ext/pg_query/include/utils/relcache.h +151 -0
  355. data/ext/pg_query/include/utils/reltrigger.h +81 -0
  356. data/ext/pg_query/include/utils/resowner.h +86 -0
  357. data/ext/pg_query/include/utils/rls.h +50 -0
  358. data/ext/pg_query/include/utils/ruleutils.h +44 -0
  359. data/ext/pg_query/include/utils/sharedtuplestore.h +61 -0
  360. data/ext/pg_query/include/utils/snapmgr.h +158 -0
  361. data/ext/pg_query/include/utils/snapshot.h +206 -0
  362. data/ext/pg_query/include/utils/sortsupport.h +276 -0
  363. data/ext/pg_query/include/utils/syscache.h +219 -0
  364. data/ext/pg_query/include/utils/timeout.h +88 -0
  365. data/ext/pg_query/include/utils/timestamp.h +116 -0
  366. data/ext/pg_query/include/utils/tuplesort.h +277 -0
  367. data/ext/pg_query/include/utils/tuplestore.h +91 -0
  368. data/ext/pg_query/include/utils/typcache.h +202 -0
  369. data/ext/pg_query/include/utils/tzparser.h +39 -0
  370. data/ext/pg_query/include/utils/varlena.h +39 -0
  371. data/ext/pg_query/include/utils/xml.h +84 -0
  372. data/ext/pg_query/include/xxhash.h +5445 -0
  373. data/ext/pg_query/include/xxhash/xxhash.h +5445 -0
  374. data/lib/pg_query/version.rb +1 -1
  375. metadata +372 -1
@@ -0,0 +1,170 @@
1
+ /*-------------------------------------------------------------------------
2
+ *
3
+ * params.h
4
+ * Support for finding the values associated with Param nodes.
5
+ *
6
+ *
7
+ * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
8
+ * Portions Copyright (c) 1994, Regents of the University of California
9
+ *
10
+ * src/include/nodes/params.h
11
+ *
12
+ *-------------------------------------------------------------------------
13
+ */
14
+ #ifndef PARAMS_H
15
+ #define PARAMS_H
16
+
17
+ /* Forward declarations, to avoid including other headers */
18
+ struct Bitmapset;
19
+ struct ExprState;
20
+ struct Param;
21
+ struct ParseState;
22
+
23
+
24
+ /*
25
+ * ParamListInfo
26
+ *
27
+ * ParamListInfo structures are used to pass parameters into the executor
28
+ * for parameterized plans. We support two basic approaches to supplying
29
+ * parameter values, the "static" way and the "dynamic" way.
30
+ *
31
+ * In the static approach, per-parameter data is stored in an array of
32
+ * ParamExternData structs appended to the ParamListInfo struct.
33
+ * Each entry in the array defines the value to be substituted for a
34
+ * PARAM_EXTERN parameter. The "paramid" of a PARAM_EXTERN Param
35
+ * can range from 1 to numParams.
36
+ *
37
+ * Although parameter numbers are normally consecutive, we allow
38
+ * ptype == InvalidOid to signal an unused array entry.
39
+ *
40
+ * pflags is a flags field. Currently the only used bit is:
41
+ * PARAM_FLAG_CONST signals the planner that it may treat this parameter
42
+ * as a constant (i.e., generate a plan that works only for this value
43
+ * of the parameter).
44
+ *
45
+ * In the dynamic approach, all access to parameter values is done through
46
+ * hook functions found in the ParamListInfo struct. In this case,
47
+ * the ParamExternData array is typically unused and not allocated;
48
+ * but the legal range of paramid is still 1 to numParams.
49
+ *
50
+ * Although the data structure is really an array, not a list, we keep
51
+ * the old typedef name to avoid unnecessary code changes.
52
+ *
53
+ * There are 3 hook functions that can be associated with a ParamListInfo
54
+ * structure:
55
+ *
56
+ * If paramFetch isn't null, it is called to fetch the ParamExternData
57
+ * for a particular param ID, rather than accessing the relevant element
58
+ * of the ParamExternData array. This supports the case where the array
59
+ * isn't there at all, as well as cases where the data in the array
60
+ * might be obsolete or lazily evaluated. paramFetch must return the
61
+ * address of a ParamExternData struct describing the specified param ID;
62
+ * the convention above about ptype == InvalidOid signaling an invalid
63
+ * param ID still applies. The returned struct can either be placed in
64
+ * the "workspace" supplied by the caller, or it can be in storage
65
+ * controlled by the paramFetch hook if that's more convenient.
66
+ * (In either case, the struct is not expected to be long-lived.)
67
+ * If "speculative" is true, the paramFetch hook should not risk errors
68
+ * in trying to fetch the parameter value, and should report an invalid
69
+ * parameter instead.
70
+ *
71
+ * If paramCompile isn't null, then it controls what execExpr.c compiles
72
+ * for PARAM_EXTERN Param nodes --- typically, this hook would emit a
73
+ * EEOP_PARAM_CALLBACK step. This allows unnecessary work to be
74
+ * optimized away in compiled expressions.
75
+ *
76
+ * If parserSetup isn't null, then it is called to re-instantiate the
77
+ * original parsing hooks when a query needs to be re-parsed/planned.
78
+ * This is especially useful if the types of parameters might change
79
+ * from time to time, since it can replace the need to supply a fixed
80
+ * list of parameter types to the parser.
81
+ *
82
+ * Notice that the paramFetch and paramCompile hooks are actually passed
83
+ * the ParamListInfo struct's address; they can therefore access all
84
+ * three of the "arg" fields, and the distinction between paramFetchArg
85
+ * and paramCompileArg is rather arbitrary.
86
+ */
87
+
88
+ #define PARAM_FLAG_CONST 0x0001 /* parameter is constant */
89
+
90
+ typedef struct ParamExternData
91
+ {
92
+ Datum value; /* parameter value */
93
+ bool isnull; /* is it NULL? */
94
+ uint16 pflags; /* flag bits, see above */
95
+ Oid ptype; /* parameter's datatype, or 0 */
96
+ } ParamExternData;
97
+
98
+ typedef struct ParamListInfoData *ParamListInfo;
99
+
100
+ typedef ParamExternData *(*ParamFetchHook) (ParamListInfo params,
101
+ int paramid, bool speculative,
102
+ ParamExternData *workspace);
103
+
104
+ typedef void (*ParamCompileHook) (ParamListInfo params, struct Param *param,
105
+ struct ExprState *state,
106
+ Datum *resv, bool *resnull);
107
+
108
+ typedef void (*ParserSetupHook) (struct ParseState *pstate, void *arg);
109
+
110
+ typedef struct ParamListInfoData
111
+ {
112
+ ParamFetchHook paramFetch; /* parameter fetch hook */
113
+ void *paramFetchArg;
114
+ ParamCompileHook paramCompile; /* parameter compile hook */
115
+ void *paramCompileArg;
116
+ ParserSetupHook parserSetup; /* parser setup hook */
117
+ void *parserSetupArg;
118
+ char *paramValuesStr; /* params as a single string for errors */
119
+ int numParams; /* nominal/maximum # of Params represented */
120
+
121
+ /*
122
+ * params[] may be of length zero if paramFetch is supplied; otherwise it
123
+ * must be of length numParams.
124
+ */
125
+ ParamExternData params[FLEXIBLE_ARRAY_MEMBER];
126
+ } ParamListInfoData;
127
+
128
+
129
+ /* ----------------
130
+ * ParamExecData
131
+ *
132
+ * ParamExecData entries are used for executor internal parameters
133
+ * (that is, values being passed into or out of a sub-query). The
134
+ * paramid of a PARAM_EXEC Param is a (zero-based) index into an
135
+ * array of ParamExecData records, which is referenced through
136
+ * es_param_exec_vals or ecxt_param_exec_vals.
137
+ *
138
+ * If execPlan is not NULL, it points to a SubPlanState node that needs
139
+ * to be executed to produce the value. (This is done so that we can have
140
+ * lazy evaluation of InitPlans: they aren't executed until/unless a
141
+ * result value is needed.) Otherwise the value is assumed to be valid
142
+ * when needed.
143
+ * ----------------
144
+ */
145
+
146
+ typedef struct ParamExecData
147
+ {
148
+ void *execPlan; /* should be "SubPlanState *" */
149
+ Datum value;
150
+ bool isnull;
151
+ } ParamExecData;
152
+
153
+ /* type of argument for ParamsErrorCallback */
154
+ typedef struct ParamsErrorCbData
155
+ {
156
+ const char *portalName;
157
+ ParamListInfo params;
158
+ } ParamsErrorCbData;
159
+
160
+ /* Functions found in src/backend/nodes/params.c */
161
+ extern ParamListInfo makeParamList(int numParams);
162
+ extern ParamListInfo copyParamList(ParamListInfo from);
163
+ extern Size EstimateParamListSpace(ParamListInfo paramLI);
164
+ extern void SerializeParamList(ParamListInfo paramLI, char **start_address);
165
+ extern ParamListInfo RestoreParamList(char **start_address);
166
+ extern char *BuildParamLogString(ParamListInfo params, char **paramTextValues,
167
+ int valueLen);
168
+ extern void ParamsErrorCallback(void *arg);
169
+
170
+ #endif /* PARAMS_H */
@@ -0,0 +1,3579 @@
1
+ /*-------------------------------------------------------------------------
2
+ *
3
+ * parsenodes.h
4
+ * definitions for parse tree nodes
5
+ *
6
+ * Many of the node types used in parsetrees include a "location" field.
7
+ * This is a byte (not character) offset in the original source text, to be
8
+ * used for positioning an error cursor when there is an error related to
9
+ * the node. Access to the original source text is needed to make use of
10
+ * the location. At the topmost (statement) level, we also provide a
11
+ * statement length, likewise measured in bytes, for convenience in
12
+ * identifying statement boundaries in multi-statement source strings.
13
+ *
14
+ *
15
+ * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
16
+ * Portions Copyright (c) 1994, Regents of the University of California
17
+ *
18
+ * src/include/nodes/parsenodes.h
19
+ *
20
+ *-------------------------------------------------------------------------
21
+ */
22
+ #ifndef PARSENODES_H
23
+ #define PARSENODES_H
24
+
25
+ #include "nodes/bitmapset.h"
26
+ #include "nodes/lockoptions.h"
27
+ #include "nodes/primnodes.h"
28
+ #include "nodes/value.h"
29
+ #include "partitioning/partdefs.h"
30
+
31
+
32
+ typedef enum OverridingKind
33
+ {
34
+ OVERRIDING_NOT_SET = 0,
35
+ OVERRIDING_USER_VALUE,
36
+ OVERRIDING_SYSTEM_VALUE
37
+ } OverridingKind;
38
+
39
+ /* Possible sources of a Query */
40
+ typedef enum QuerySource
41
+ {
42
+ QSRC_ORIGINAL, /* original parsetree (explicit query) */
43
+ QSRC_PARSER, /* added by parse analysis (now unused) */
44
+ QSRC_INSTEAD_RULE, /* added by unconditional INSTEAD rule */
45
+ QSRC_QUAL_INSTEAD_RULE, /* added by conditional INSTEAD rule */
46
+ QSRC_NON_INSTEAD_RULE /* added by non-INSTEAD rule */
47
+ } QuerySource;
48
+
49
+ /* Sort ordering options for ORDER BY and CREATE INDEX */
50
+ typedef enum SortByDir
51
+ {
52
+ SORTBY_DEFAULT,
53
+ SORTBY_ASC,
54
+ SORTBY_DESC,
55
+ SORTBY_USING /* not allowed in CREATE INDEX ... */
56
+ } SortByDir;
57
+
58
+ typedef enum SortByNulls
59
+ {
60
+ SORTBY_NULLS_DEFAULT,
61
+ SORTBY_NULLS_FIRST,
62
+ SORTBY_NULLS_LAST
63
+ } SortByNulls;
64
+
65
+ /*
66
+ * Grantable rights are encoded so that we can OR them together in a bitmask.
67
+ * The present representation of AclItem limits us to 16 distinct rights,
68
+ * even though AclMode is defined as uint32. See utils/acl.h.
69
+ *
70
+ * Caution: changing these codes breaks stored ACLs, hence forces initdb.
71
+ */
72
+ typedef uint32 AclMode; /* a bitmask of privilege bits */
73
+
74
+ #define ACL_INSERT (1<<0) /* for relations */
75
+ #define ACL_SELECT (1<<1)
76
+ #define ACL_UPDATE (1<<2)
77
+ #define ACL_DELETE (1<<3)
78
+ #define ACL_TRUNCATE (1<<4)
79
+ #define ACL_REFERENCES (1<<5)
80
+ #define ACL_TRIGGER (1<<6)
81
+ #define ACL_EXECUTE (1<<7) /* for functions */
82
+ #define ACL_USAGE (1<<8) /* for languages, namespaces, FDWs, and
83
+ * servers */
84
+ #define ACL_CREATE (1<<9) /* for namespaces and databases */
85
+ #define ACL_CREATE_TEMP (1<<10) /* for databases */
86
+ #define ACL_CONNECT (1<<11) /* for databases */
87
+ #define N_ACL_RIGHTS 12 /* 1 plus the last 1<<x */
88
+ #define ACL_NO_RIGHTS 0
89
+ /* Currently, SELECT ... FOR [KEY] UPDATE/SHARE requires UPDATE privileges */
90
+ #define ACL_SELECT_FOR_UPDATE ACL_UPDATE
91
+
92
+
93
+ /*****************************************************************************
94
+ * Query Tree
95
+ *****************************************************************************/
96
+
97
+ /*
98
+ * Query -
99
+ * Parse analysis turns all statements into a Query tree
100
+ * for further processing by the rewriter and planner.
101
+ *
102
+ * Utility statements (i.e. non-optimizable statements) have the
103
+ * utilityStmt field set, and the rest of the Query is mostly dummy.
104
+ *
105
+ * Planning converts a Query tree into a Plan tree headed by a PlannedStmt
106
+ * node --- the Query structure is not used by the executor.
107
+ */
108
+ typedef struct Query
109
+ {
110
+ NodeTag type;
111
+
112
+ CmdType commandType; /* select|insert|update|delete|utility */
113
+
114
+ QuerySource querySource; /* where did I come from? */
115
+
116
+ uint64 queryId; /* query identifier (can be set by plugins) */
117
+
118
+ bool canSetTag; /* do I set the command result tag? */
119
+
120
+ Node *utilityStmt; /* non-null if commandType == CMD_UTILITY */
121
+
122
+ int resultRelation; /* rtable index of target relation for
123
+ * INSERT/UPDATE/DELETE; 0 for SELECT */
124
+
125
+ bool hasAggs; /* has aggregates in tlist or havingQual */
126
+ bool hasWindowFuncs; /* has window functions in tlist */
127
+ bool hasTargetSRFs; /* has set-returning functions in tlist */
128
+ bool hasSubLinks; /* has subquery SubLink */
129
+ bool hasDistinctOn; /* distinctClause is from DISTINCT ON */
130
+ bool hasRecursive; /* WITH RECURSIVE was specified */
131
+ bool hasModifyingCTE; /* has INSERT/UPDATE/DELETE in WITH */
132
+ bool hasForUpdate; /* FOR [KEY] UPDATE/SHARE was specified */
133
+ bool hasRowSecurity; /* rewriter has applied some RLS policy */
134
+
135
+ List *cteList; /* WITH list (of CommonTableExpr's) */
136
+
137
+ List *rtable; /* list of range table entries */
138
+ FromExpr *jointree; /* table join tree (FROM and WHERE clauses) */
139
+
140
+ List *targetList; /* target list (of TargetEntry) */
141
+
142
+ OverridingKind override; /* OVERRIDING clause */
143
+
144
+ OnConflictExpr *onConflict; /* ON CONFLICT DO [NOTHING | UPDATE] */
145
+
146
+ List *returningList; /* return-values list (of TargetEntry) */
147
+
148
+ List *groupClause; /* a list of SortGroupClause's */
149
+
150
+ List *groupingSets; /* a list of GroupingSet's if present */
151
+
152
+ Node *havingQual; /* qualifications applied to groups */
153
+
154
+ List *windowClause; /* a list of WindowClause's */
155
+
156
+ List *distinctClause; /* a list of SortGroupClause's */
157
+
158
+ List *sortClause; /* a list of SortGroupClause's */
159
+
160
+ Node *limitOffset; /* # of result tuples to skip (int8 expr) */
161
+ Node *limitCount; /* # of result tuples to return (int8 expr) */
162
+ LimitOption limitOption; /* limit type */
163
+
164
+ List *rowMarks; /* a list of RowMarkClause's */
165
+
166
+ Node *setOperations; /* set-operation tree if this is top level of
167
+ * a UNION/INTERSECT/EXCEPT query */
168
+
169
+ List *constraintDeps; /* a list of pg_constraint OIDs that the query
170
+ * depends on to be semantically valid */
171
+
172
+ List *withCheckOptions; /* a list of WithCheckOption's (added
173
+ * during rewrite) */
174
+
175
+ /*
176
+ * The following two fields identify the portion of the source text string
177
+ * containing this query. They are typically only populated in top-level
178
+ * Queries, not in sub-queries. When not set, they might both be zero, or
179
+ * both be -1 meaning "unknown".
180
+ */
181
+ int stmt_location; /* start location, or -1 if unknown */
182
+ int stmt_len; /* length in bytes; 0 means "rest of string" */
183
+ } Query;
184
+
185
+
186
+ /****************************************************************************
187
+ * Supporting data structures for Parse Trees
188
+ *
189
+ * Most of these node types appear in raw parsetrees output by the grammar,
190
+ * and get transformed to something else by the analyzer. A few of them
191
+ * are used as-is in transformed querytrees.
192
+ ****************************************************************************/
193
+
194
+ /*
195
+ * TypeName - specifies a type in definitions
196
+ *
197
+ * For TypeName structures generated internally, it is often easier to
198
+ * specify the type by OID than by name. If "names" is NIL then the
199
+ * actual type OID is given by typeOid, otherwise typeOid is unused.
200
+ * Similarly, if "typmods" is NIL then the actual typmod is expected to
201
+ * be prespecified in typemod, otherwise typemod is unused.
202
+ *
203
+ * If pct_type is true, then names is actually a field name and we look up
204
+ * the type of that field. Otherwise (the normal case), names is a type
205
+ * name possibly qualified with schema and database name.
206
+ */
207
+ typedef struct TypeName
208
+ {
209
+ NodeTag type;
210
+ List *names; /* qualified name (list of Value strings) */
211
+ Oid typeOid; /* type identified by OID */
212
+ bool setof; /* is a set? */
213
+ bool pct_type; /* %TYPE specified? */
214
+ List *typmods; /* type modifier expression(s) */
215
+ int32 typemod; /* prespecified type modifier */
216
+ List *arrayBounds; /* array bounds */
217
+ int location; /* token location, or -1 if unknown */
218
+ } TypeName;
219
+
220
+ /*
221
+ * ColumnRef - specifies a reference to a column, or possibly a whole tuple
222
+ *
223
+ * The "fields" list must be nonempty. It can contain string Value nodes
224
+ * (representing names) and A_Star nodes (representing occurrence of a '*').
225
+ * Currently, A_Star must appear only as the last list element --- the grammar
226
+ * is responsible for enforcing this!
227
+ *
228
+ * Note: any container subscripting or selection of fields from composite columns
229
+ * is represented by an A_Indirection node above the ColumnRef. However,
230
+ * for simplicity in the normal case, initial field selection from a table
231
+ * name is represented within ColumnRef and not by adding A_Indirection.
232
+ */
233
+ typedef struct ColumnRef
234
+ {
235
+ NodeTag type;
236
+ List *fields; /* field names (Value strings) or A_Star */
237
+ int location; /* token location, or -1 if unknown */
238
+ } ColumnRef;
239
+
240
+ /*
241
+ * ParamRef - specifies a $n parameter reference
242
+ */
243
+ typedef struct ParamRef
244
+ {
245
+ NodeTag type;
246
+ int number; /* the number of the parameter */
247
+ int location; /* token location, or -1 if unknown */
248
+ } ParamRef;
249
+
250
+ /*
251
+ * A_Expr - infix, prefix, and postfix expressions
252
+ */
253
+ typedef enum A_Expr_Kind
254
+ {
255
+ AEXPR_OP, /* normal operator */
256
+ AEXPR_OP_ANY, /* scalar op ANY (array) */
257
+ AEXPR_OP_ALL, /* scalar op ALL (array) */
258
+ AEXPR_DISTINCT, /* IS DISTINCT FROM - name must be "=" */
259
+ AEXPR_NOT_DISTINCT, /* IS NOT DISTINCT FROM - name must be "=" */
260
+ AEXPR_NULLIF, /* NULLIF - name must be "=" */
261
+ AEXPR_OF, /* IS [NOT] OF - name must be "=" or "<>" */
262
+ AEXPR_IN, /* [NOT] IN - name must be "=" or "<>" */
263
+ AEXPR_LIKE, /* [NOT] LIKE - name must be "~~" or "!~~" */
264
+ AEXPR_ILIKE, /* [NOT] ILIKE - name must be "~~*" or "!~~*" */
265
+ AEXPR_SIMILAR, /* [NOT] SIMILAR - name must be "~" or "!~" */
266
+ AEXPR_BETWEEN, /* name must be "BETWEEN" */
267
+ AEXPR_NOT_BETWEEN, /* name must be "NOT BETWEEN" */
268
+ AEXPR_BETWEEN_SYM, /* name must be "BETWEEN SYMMETRIC" */
269
+ AEXPR_NOT_BETWEEN_SYM, /* name must be "NOT BETWEEN SYMMETRIC" */
270
+ AEXPR_PAREN /* nameless dummy node for parentheses */
271
+ } A_Expr_Kind;
272
+
273
+ typedef struct A_Expr
274
+ {
275
+ NodeTag type;
276
+ A_Expr_Kind kind; /* see above */
277
+ List *name; /* possibly-qualified name of operator */
278
+ Node *lexpr; /* left argument, or NULL if none */
279
+ Node *rexpr; /* right argument, or NULL if none */
280
+ int location; /* token location, or -1 if unknown */
281
+ } A_Expr;
282
+
283
+ /*
284
+ * A_Const - a literal constant
285
+ */
286
+ typedef struct A_Const
287
+ {
288
+ NodeTag type;
289
+ Value val; /* value (includes type info, see value.h) */
290
+ int location; /* token location, or -1 if unknown */
291
+ } A_Const;
292
+
293
+ /*
294
+ * TypeCast - a CAST expression
295
+ */
296
+ typedef struct TypeCast
297
+ {
298
+ NodeTag type;
299
+ Node *arg; /* the expression being casted */
300
+ TypeName *typeName; /* the target type */
301
+ int location; /* token location, or -1 if unknown */
302
+ } TypeCast;
303
+
304
+ /*
305
+ * CollateClause - a COLLATE expression
306
+ */
307
+ typedef struct CollateClause
308
+ {
309
+ NodeTag type;
310
+ Node *arg; /* input expression */
311
+ List *collname; /* possibly-qualified collation name */
312
+ int location; /* token location, or -1 if unknown */
313
+ } CollateClause;
314
+
315
+ /*
316
+ * RoleSpec - a role name or one of a few special values.
317
+ */
318
+ typedef enum RoleSpecType
319
+ {
320
+ ROLESPEC_CSTRING, /* role name is stored as a C string */
321
+ ROLESPEC_CURRENT_USER, /* role spec is CURRENT_USER */
322
+ ROLESPEC_SESSION_USER, /* role spec is SESSION_USER */
323
+ ROLESPEC_PUBLIC /* role name is "public" */
324
+ } RoleSpecType;
325
+
326
+ typedef struct RoleSpec
327
+ {
328
+ NodeTag type;
329
+ RoleSpecType roletype; /* Type of this rolespec */
330
+ char *rolename; /* filled only for ROLESPEC_CSTRING */
331
+ int location; /* token location, or -1 if unknown */
332
+ } RoleSpec;
333
+
334
+ /*
335
+ * FuncCall - a function or aggregate invocation
336
+ *
337
+ * agg_order (if not NIL) indicates we saw 'foo(... ORDER BY ...)', or if
338
+ * agg_within_group is true, it was 'foo(...) WITHIN GROUP (ORDER BY ...)'.
339
+ * agg_star indicates we saw a 'foo(*)' construct, while agg_distinct
340
+ * indicates we saw 'foo(DISTINCT ...)'. In any of these cases, the
341
+ * construct *must* be an aggregate call. Otherwise, it might be either an
342
+ * aggregate or some other kind of function. However, if FILTER or OVER is
343
+ * present it had better be an aggregate or window function.
344
+ *
345
+ * Normally, you'd initialize this via makeFuncCall() and then only change the
346
+ * parts of the struct its defaults don't match afterwards, as needed.
347
+ */
348
+ typedef struct FuncCall
349
+ {
350
+ NodeTag type;
351
+ List *funcname; /* qualified name of function */
352
+ List *args; /* the arguments (list of exprs) */
353
+ List *agg_order; /* ORDER BY (list of SortBy) */
354
+ Node *agg_filter; /* FILTER clause, if any */
355
+ bool agg_within_group; /* ORDER BY appeared in WITHIN GROUP */
356
+ bool agg_star; /* argument was really '*' */
357
+ bool agg_distinct; /* arguments were labeled DISTINCT */
358
+ bool func_variadic; /* last argument was labeled VARIADIC */
359
+ struct WindowDef *over; /* OVER clause, if any */
360
+ int location; /* token location, or -1 if unknown */
361
+ } FuncCall;
362
+
363
+ /*
364
+ * A_Star - '*' representing all columns of a table or compound field
365
+ *
366
+ * This can appear within ColumnRef.fields, A_Indirection.indirection, and
367
+ * ResTarget.indirection lists.
368
+ */
369
+ typedef struct A_Star
370
+ {
371
+ NodeTag type;
372
+ } A_Star;
373
+
374
+ /*
375
+ * A_Indices - array subscript or slice bounds ([idx] or [lidx:uidx])
376
+ *
377
+ * In slice case, either or both of lidx and uidx can be NULL (omitted).
378
+ * In non-slice case, uidx holds the single subscript and lidx is always NULL.
379
+ */
380
+ typedef struct A_Indices
381
+ {
382
+ NodeTag type;
383
+ bool is_slice; /* true if slice (i.e., colon present) */
384
+ Node *lidx; /* slice lower bound, if any */
385
+ Node *uidx; /* subscript, or slice upper bound if any */
386
+ } A_Indices;
387
+
388
+ /*
389
+ * A_Indirection - select a field and/or array element from an expression
390
+ *
391
+ * The indirection list can contain A_Indices nodes (representing
392
+ * subscripting), string Value nodes (representing field selection --- the
393
+ * string value is the name of the field to select), and A_Star nodes
394
+ * (representing selection of all fields of a composite type).
395
+ * For example, a complex selection operation like
396
+ * (foo).field1[42][7].field2
397
+ * would be represented with a single A_Indirection node having a 4-element
398
+ * indirection list.
399
+ *
400
+ * Currently, A_Star must appear only as the last list element --- the grammar
401
+ * is responsible for enforcing this!
402
+ */
403
+ typedef struct A_Indirection
404
+ {
405
+ NodeTag type;
406
+ Node *arg; /* the thing being selected from */
407
+ List *indirection; /* subscripts and/or field names and/or * */
408
+ } A_Indirection;
409
+
410
+ /*
411
+ * A_ArrayExpr - an ARRAY[] construct
412
+ */
413
+ typedef struct A_ArrayExpr
414
+ {
415
+ NodeTag type;
416
+ List *elements; /* array element expressions */
417
+ int location; /* token location, or -1 if unknown */
418
+ } A_ArrayExpr;
419
+
420
+ /*
421
+ * ResTarget -
422
+ * result target (used in target list of pre-transformed parse trees)
423
+ *
424
+ * In a SELECT target list, 'name' is the column label from an
425
+ * 'AS ColumnLabel' clause, or NULL if there was none, and 'val' is the
426
+ * value expression itself. The 'indirection' field is not used.
427
+ *
428
+ * INSERT uses ResTarget in its target-column-names list. Here, 'name' is
429
+ * the name of the destination column, 'indirection' stores any subscripts
430
+ * attached to the destination, and 'val' is not used.
431
+ *
432
+ * In an UPDATE target list, 'name' is the name of the destination column,
433
+ * 'indirection' stores any subscripts attached to the destination, and
434
+ * 'val' is the expression to assign.
435
+ *
436
+ * See A_Indirection for more info about what can appear in 'indirection'.
437
+ */
438
+ typedef struct ResTarget
439
+ {
440
+ NodeTag type;
441
+ char *name; /* column name or NULL */
442
+ List *indirection; /* subscripts, field names, and '*', or NIL */
443
+ Node *val; /* the value expression to compute or assign */
444
+ int location; /* token location, or -1 if unknown */
445
+ } ResTarget;
446
+
447
+ /*
448
+ * MultiAssignRef - element of a row source expression for UPDATE
449
+ *
450
+ * In an UPDATE target list, when we have SET (a,b,c) = row-valued-expression,
451
+ * we generate separate ResTarget items for each of a,b,c. Their "val" trees
452
+ * are MultiAssignRef nodes numbered 1..n, linking to a common copy of the
453
+ * row-valued-expression (which parse analysis will process only once, when
454
+ * handling the MultiAssignRef with colno=1).
455
+ */
456
+ typedef struct MultiAssignRef
457
+ {
458
+ NodeTag type;
459
+ Node *source; /* the row-valued expression */
460
+ int colno; /* column number for this target (1..n) */
461
+ int ncolumns; /* number of targets in the construct */
462
+ } MultiAssignRef;
463
+
464
+ /*
465
+ * SortBy - for ORDER BY clause
466
+ */
467
+ typedef struct SortBy
468
+ {
469
+ NodeTag type;
470
+ Node *node; /* expression to sort on */
471
+ SortByDir sortby_dir; /* ASC/DESC/USING/default */
472
+ SortByNulls sortby_nulls; /* NULLS FIRST/LAST */
473
+ List *useOp; /* name of op to use, if SORTBY_USING */
474
+ int location; /* operator location, or -1 if none/unknown */
475
+ } SortBy;
476
+
477
+ /*
478
+ * WindowDef - raw representation of WINDOW and OVER clauses
479
+ *
480
+ * For entries in a WINDOW list, "name" is the window name being defined.
481
+ * For OVER clauses, we use "name" for the "OVER window" syntax, or "refname"
482
+ * for the "OVER (window)" syntax, which is subtly different --- the latter
483
+ * implies overriding the window frame clause.
484
+ */
485
+ typedef struct WindowDef
486
+ {
487
+ NodeTag type;
488
+ char *name; /* window's own name */
489
+ char *refname; /* referenced window name, if any */
490
+ List *partitionClause; /* PARTITION BY expression list */
491
+ List *orderClause; /* ORDER BY (list of SortBy) */
492
+ int frameOptions; /* frame_clause options, see below */
493
+ Node *startOffset; /* expression for starting bound, if any */
494
+ Node *endOffset; /* expression for ending bound, if any */
495
+ int location; /* parse location, or -1 if none/unknown */
496
+ } WindowDef;
497
+
498
+ /*
499
+ * frameOptions is an OR of these bits. The NONDEFAULT and BETWEEN bits are
500
+ * used so that ruleutils.c can tell which properties were specified and
501
+ * which were defaulted; the correct behavioral bits must be set either way.
502
+ * The START_foo and END_foo options must come in pairs of adjacent bits for
503
+ * the convenience of gram.y, even though some of them are useless/invalid.
504
+ */
505
+ #define FRAMEOPTION_NONDEFAULT 0x00001 /* any specified? */
506
+ #define FRAMEOPTION_RANGE 0x00002 /* RANGE behavior */
507
+ #define FRAMEOPTION_ROWS 0x00004 /* ROWS behavior */
508
+ #define FRAMEOPTION_GROUPS 0x00008 /* GROUPS behavior */
509
+ #define FRAMEOPTION_BETWEEN 0x00010 /* BETWEEN given? */
510
+ #define FRAMEOPTION_START_UNBOUNDED_PRECEDING 0x00020 /* start is U. P. */
511
+ #define FRAMEOPTION_END_UNBOUNDED_PRECEDING 0x00040 /* (disallowed) */
512
+ #define FRAMEOPTION_START_UNBOUNDED_FOLLOWING 0x00080 /* (disallowed) */
513
+ #define FRAMEOPTION_END_UNBOUNDED_FOLLOWING 0x00100 /* end is U. F. */
514
+ #define FRAMEOPTION_START_CURRENT_ROW 0x00200 /* start is C. R. */
515
+ #define FRAMEOPTION_END_CURRENT_ROW 0x00400 /* end is C. R. */
516
+ #define FRAMEOPTION_START_OFFSET_PRECEDING 0x00800 /* start is O. P. */
517
+ #define FRAMEOPTION_END_OFFSET_PRECEDING 0x01000 /* end is O. P. */
518
+ #define FRAMEOPTION_START_OFFSET_FOLLOWING 0x02000 /* start is O. F. */
519
+ #define FRAMEOPTION_END_OFFSET_FOLLOWING 0x04000 /* end is O. F. */
520
+ #define FRAMEOPTION_EXCLUDE_CURRENT_ROW 0x08000 /* omit C.R. */
521
+ #define FRAMEOPTION_EXCLUDE_GROUP 0x10000 /* omit C.R. & peers */
522
+ #define FRAMEOPTION_EXCLUDE_TIES 0x20000 /* omit C.R.'s peers */
523
+
524
+ #define FRAMEOPTION_START_OFFSET \
525
+ (FRAMEOPTION_START_OFFSET_PRECEDING | FRAMEOPTION_START_OFFSET_FOLLOWING)
526
+ #define FRAMEOPTION_END_OFFSET \
527
+ (FRAMEOPTION_END_OFFSET_PRECEDING | FRAMEOPTION_END_OFFSET_FOLLOWING)
528
+ #define FRAMEOPTION_EXCLUSION \
529
+ (FRAMEOPTION_EXCLUDE_CURRENT_ROW | FRAMEOPTION_EXCLUDE_GROUP | \
530
+ FRAMEOPTION_EXCLUDE_TIES)
531
+
532
+ #define FRAMEOPTION_DEFAULTS \
533
+ (FRAMEOPTION_RANGE | FRAMEOPTION_START_UNBOUNDED_PRECEDING | \
534
+ FRAMEOPTION_END_CURRENT_ROW)
535
+
536
+ /*
537
+ * RangeSubselect - subquery appearing in a FROM clause
538
+ */
539
+ typedef struct RangeSubselect
540
+ {
541
+ NodeTag type;
542
+ bool lateral; /* does it have LATERAL prefix? */
543
+ Node *subquery; /* the untransformed sub-select clause */
544
+ Alias *alias; /* table alias & optional column aliases */
545
+ } RangeSubselect;
546
+
547
+ /*
548
+ * RangeFunction - function call appearing in a FROM clause
549
+ *
550
+ * functions is a List because we use this to represent the construct
551
+ * ROWS FROM(func1(...), func2(...), ...). Each element of this list is a
552
+ * two-element sublist, the first element being the untransformed function
553
+ * call tree, and the second element being a possibly-empty list of ColumnDef
554
+ * nodes representing any columndef list attached to that function within the
555
+ * ROWS FROM() syntax.
556
+ *
557
+ * alias and coldeflist represent any alias and/or columndef list attached
558
+ * at the top level. (We disallow coldeflist appearing both here and
559
+ * per-function, but that's checked in parse analysis, not by the grammar.)
560
+ */
561
+ typedef struct RangeFunction
562
+ {
563
+ NodeTag type;
564
+ bool lateral; /* does it have LATERAL prefix? */
565
+ bool ordinality; /* does it have WITH ORDINALITY suffix? */
566
+ bool is_rowsfrom; /* is result of ROWS FROM() syntax? */
567
+ List *functions; /* per-function information, see above */
568
+ Alias *alias; /* table alias & optional column aliases */
569
+ List *coldeflist; /* list of ColumnDef nodes to describe result
570
+ * of function returning RECORD */
571
+ } RangeFunction;
572
+
573
+ /*
574
+ * RangeTableFunc - raw form of "table functions" such as XMLTABLE
575
+ */
576
+ typedef struct RangeTableFunc
577
+ {
578
+ NodeTag type;
579
+ bool lateral; /* does it have LATERAL prefix? */
580
+ Node *docexpr; /* document expression */
581
+ Node *rowexpr; /* row generator expression */
582
+ List *namespaces; /* list of namespaces as ResTarget */
583
+ List *columns; /* list of RangeTableFuncCol */
584
+ Alias *alias; /* table alias & optional column aliases */
585
+ int location; /* token location, or -1 if unknown */
586
+ } RangeTableFunc;
587
+
588
+ /*
589
+ * RangeTableFuncCol - one column in a RangeTableFunc->columns
590
+ *
591
+ * If for_ordinality is true (FOR ORDINALITY), then the column is an int4
592
+ * column and the rest of the fields are ignored.
593
+ */
594
+ typedef struct RangeTableFuncCol
595
+ {
596
+ NodeTag type;
597
+ char *colname; /* name of generated column */
598
+ TypeName *typeName; /* type of generated column */
599
+ bool for_ordinality; /* does it have FOR ORDINALITY? */
600
+ bool is_not_null; /* does it have NOT NULL? */
601
+ Node *colexpr; /* column filter expression */
602
+ Node *coldefexpr; /* column default value expression */
603
+ int location; /* token location, or -1 if unknown */
604
+ } RangeTableFuncCol;
605
+
606
+ /*
607
+ * RangeTableSample - TABLESAMPLE appearing in a raw FROM clause
608
+ *
609
+ * This node, appearing only in raw parse trees, represents
610
+ * <relation> TABLESAMPLE <method> (<params>) REPEATABLE (<num>)
611
+ * Currently, the <relation> can only be a RangeVar, but we might in future
612
+ * allow RangeSubselect and other options. Note that the RangeTableSample
613
+ * is wrapped around the node representing the <relation>, rather than being
614
+ * a subfield of it.
615
+ */
616
+ typedef struct RangeTableSample
617
+ {
618
+ NodeTag type;
619
+ Node *relation; /* relation to be sampled */
620
+ List *method; /* sampling method name (possibly qualified) */
621
+ List *args; /* argument(s) for sampling method */
622
+ Node *repeatable; /* REPEATABLE expression, or NULL if none */
623
+ int location; /* method name location, or -1 if unknown */
624
+ } RangeTableSample;
625
+
626
+ /*
627
+ * ColumnDef - column definition (used in various creates)
628
+ *
629
+ * If the column has a default value, we may have the value expression
630
+ * in either "raw" form (an untransformed parse tree) or "cooked" form
631
+ * (a post-parse-analysis, executable expression tree), depending on
632
+ * how this ColumnDef node was created (by parsing, or by inheritance
633
+ * from an existing relation). We should never have both in the same node!
634
+ *
635
+ * Similarly, we may have a COLLATE specification in either raw form
636
+ * (represented as a CollateClause with arg==NULL) or cooked form
637
+ * (the collation's OID).
638
+ *
639
+ * The constraints list may contain a CONSTR_DEFAULT item in a raw
640
+ * parsetree produced by gram.y, but transformCreateStmt will remove
641
+ * the item and set raw_default instead. CONSTR_DEFAULT items
642
+ * should not appear in any subsequent processing.
643
+ */
644
+ typedef struct ColumnDef
645
+ {
646
+ NodeTag type;
647
+ char *colname; /* name of column */
648
+ TypeName *typeName; /* type of column */
649
+ int inhcount; /* number of times column is inherited */
650
+ bool is_local; /* column has local (non-inherited) def'n */
651
+ bool is_not_null; /* NOT NULL constraint specified? */
652
+ bool is_from_type; /* column definition came from table type */
653
+ char storage; /* attstorage setting, or 0 for default */
654
+ Node *raw_default; /* default value (untransformed parse tree) */
655
+ Node *cooked_default; /* default value (transformed expr tree) */
656
+ char identity; /* attidentity setting */
657
+ RangeVar *identitySequence; /* to store identity sequence name for
658
+ * ALTER TABLE ... ADD COLUMN */
659
+ char generated; /* attgenerated setting */
660
+ CollateClause *collClause; /* untransformed COLLATE spec, if any */
661
+ Oid collOid; /* collation OID (InvalidOid if not set) */
662
+ List *constraints; /* other constraints on column */
663
+ List *fdwoptions; /* per-column FDW options */
664
+ int location; /* parse location, or -1 if none/unknown */
665
+ } ColumnDef;
666
+
667
+ /*
668
+ * TableLikeClause - CREATE TABLE ( ... LIKE ... ) clause
669
+ */
670
+ typedef struct TableLikeClause
671
+ {
672
+ NodeTag type;
673
+ RangeVar *relation;
674
+ bits32 options; /* OR of TableLikeOption flags */
675
+ Oid relationOid; /* If table has been looked up, its OID */
676
+ } TableLikeClause;
677
+
678
+ typedef enum TableLikeOption
679
+ {
680
+ CREATE_TABLE_LIKE_COMMENTS = 1 << 0,
681
+ CREATE_TABLE_LIKE_CONSTRAINTS = 1 << 1,
682
+ CREATE_TABLE_LIKE_DEFAULTS = 1 << 2,
683
+ CREATE_TABLE_LIKE_GENERATED = 1 << 3,
684
+ CREATE_TABLE_LIKE_IDENTITY = 1 << 4,
685
+ CREATE_TABLE_LIKE_INDEXES = 1 << 5,
686
+ CREATE_TABLE_LIKE_STATISTICS = 1 << 6,
687
+ CREATE_TABLE_LIKE_STORAGE = 1 << 7,
688
+ CREATE_TABLE_LIKE_ALL = PG_INT32_MAX
689
+ } TableLikeOption;
690
+
691
+ /*
692
+ * IndexElem - index parameters (used in CREATE INDEX, and in ON CONFLICT)
693
+ *
694
+ * For a plain index attribute, 'name' is the name of the table column to
695
+ * index, and 'expr' is NULL. For an index expression, 'name' is NULL and
696
+ * 'expr' is the expression tree.
697
+ */
698
+ typedef struct IndexElem
699
+ {
700
+ NodeTag type;
701
+ char *name; /* name of attribute to index, or NULL */
702
+ Node *expr; /* expression to index, or NULL */
703
+ char *indexcolname; /* name for index column; NULL = default */
704
+ List *collation; /* name of collation; NIL = default */
705
+ List *opclass; /* name of desired opclass; NIL = default */
706
+ List *opclassopts; /* opclass-specific options, or NIL */
707
+ SortByDir ordering; /* ASC/DESC/default */
708
+ SortByNulls nulls_ordering; /* FIRST/LAST/default */
709
+ } IndexElem;
710
+
711
+ /*
712
+ * DefElem - a generic "name = value" option definition
713
+ *
714
+ * In some contexts the name can be qualified. Also, certain SQL commands
715
+ * allow a SET/ADD/DROP action to be attached to option settings, so it's
716
+ * convenient to carry a field for that too. (Note: currently, it is our
717
+ * practice that the grammar allows namespace and action only in statements
718
+ * where they are relevant; C code can just ignore those fields in other
719
+ * statements.)
720
+ */
721
+ typedef enum DefElemAction
722
+ {
723
+ DEFELEM_UNSPEC, /* no action given */
724
+ DEFELEM_SET,
725
+ DEFELEM_ADD,
726
+ DEFELEM_DROP
727
+ } DefElemAction;
728
+
729
+ typedef struct DefElem
730
+ {
731
+ NodeTag type;
732
+ char *defnamespace; /* NULL if unqualified name */
733
+ char *defname;
734
+ Node *arg; /* a (Value *) or a (TypeName *) */
735
+ DefElemAction defaction; /* unspecified action, or SET/ADD/DROP */
736
+ int location; /* token location, or -1 if unknown */
737
+ } DefElem;
738
+
739
+ /*
740
+ * LockingClause - raw representation of FOR [NO KEY] UPDATE/[KEY] SHARE
741
+ * options
742
+ *
743
+ * Note: lockedRels == NIL means "all relations in query". Otherwise it
744
+ * is a list of RangeVar nodes. (We use RangeVar mainly because it carries
745
+ * a location field --- currently, parse analysis insists on unqualified
746
+ * names in LockingClause.)
747
+ */
748
+ typedef struct LockingClause
749
+ {
750
+ NodeTag type;
751
+ List *lockedRels; /* FOR [KEY] UPDATE/SHARE relations */
752
+ LockClauseStrength strength;
753
+ LockWaitPolicy waitPolicy; /* NOWAIT and SKIP LOCKED */
754
+ } LockingClause;
755
+
756
+ /*
757
+ * XMLSERIALIZE (in raw parse tree only)
758
+ */
759
+ typedef struct XmlSerialize
760
+ {
761
+ NodeTag type;
762
+ XmlOptionType xmloption; /* DOCUMENT or CONTENT */
763
+ Node *expr;
764
+ TypeName *typeName;
765
+ int location; /* token location, or -1 if unknown */
766
+ } XmlSerialize;
767
+
768
+ /* Partitioning related definitions */
769
+
770
+ /*
771
+ * PartitionElem - parse-time representation of a single partition key
772
+ *
773
+ * expr can be either a raw expression tree or a parse-analyzed expression.
774
+ * We don't store these on-disk, though.
775
+ */
776
+ typedef struct PartitionElem
777
+ {
778
+ NodeTag type;
779
+ char *name; /* name of column to partition on, or NULL */
780
+ Node *expr; /* expression to partition on, or NULL */
781
+ List *collation; /* name of collation; NIL = default */
782
+ List *opclass; /* name of desired opclass; NIL = default */
783
+ int location; /* token location, or -1 if unknown */
784
+ } PartitionElem;
785
+
786
+ /*
787
+ * PartitionSpec - parse-time representation of a partition key specification
788
+ *
789
+ * This represents the key space we will be partitioning on.
790
+ */
791
+ typedef struct PartitionSpec
792
+ {
793
+ NodeTag type;
794
+ char *strategy; /* partitioning strategy ('hash', 'list' or
795
+ * 'range') */
796
+ List *partParams; /* List of PartitionElems */
797
+ int location; /* token location, or -1 if unknown */
798
+ } PartitionSpec;
799
+
800
+ /* Internal codes for partitioning strategies */
801
+ #define PARTITION_STRATEGY_HASH 'h'
802
+ #define PARTITION_STRATEGY_LIST 'l'
803
+ #define PARTITION_STRATEGY_RANGE 'r'
804
+
805
+ /*
806
+ * PartitionBoundSpec - a partition bound specification
807
+ *
808
+ * This represents the portion of the partition key space assigned to a
809
+ * particular partition. These are stored on disk in pg_class.relpartbound.
810
+ */
811
+ struct PartitionBoundSpec
812
+ {
813
+ NodeTag type;
814
+
815
+ char strategy; /* see PARTITION_STRATEGY codes above */
816
+ bool is_default; /* is it a default partition bound? */
817
+
818
+ /* Partitioning info for HASH strategy: */
819
+ int modulus;
820
+ int remainder;
821
+
822
+ /* Partitioning info for LIST strategy: */
823
+ List *listdatums; /* List of Consts (or A_Consts in raw tree) */
824
+
825
+ /* Partitioning info for RANGE strategy: */
826
+ List *lowerdatums; /* List of PartitionRangeDatums */
827
+ List *upperdatums; /* List of PartitionRangeDatums */
828
+
829
+ int location; /* token location, or -1 if unknown */
830
+ };
831
+
832
+ /*
833
+ * PartitionRangeDatum - one of the values in a range partition bound
834
+ *
835
+ * This can be MINVALUE, MAXVALUE or a specific bounded value.
836
+ */
837
+ typedef enum PartitionRangeDatumKind
838
+ {
839
+ PARTITION_RANGE_DATUM_MINVALUE = -1, /* less than any other value */
840
+ PARTITION_RANGE_DATUM_VALUE = 0, /* a specific (bounded) value */
841
+ PARTITION_RANGE_DATUM_MAXVALUE = 1 /* greater than any other value */
842
+ } PartitionRangeDatumKind;
843
+
844
+ typedef struct PartitionRangeDatum
845
+ {
846
+ NodeTag type;
847
+
848
+ PartitionRangeDatumKind kind;
849
+ Node *value; /* Const (or A_Const in raw tree), if kind is
850
+ * PARTITION_RANGE_DATUM_VALUE, else NULL */
851
+
852
+ int location; /* token location, or -1 if unknown */
853
+ } PartitionRangeDatum;
854
+
855
+ /*
856
+ * PartitionCmd - info for ALTER TABLE/INDEX ATTACH/DETACH PARTITION commands
857
+ */
858
+ typedef struct PartitionCmd
859
+ {
860
+ NodeTag type;
861
+ RangeVar *name; /* name of partition to attach/detach */
862
+ PartitionBoundSpec *bound; /* FOR VALUES, if attaching */
863
+ } PartitionCmd;
864
+
865
+ /****************************************************************************
866
+ * Nodes for a Query tree
867
+ ****************************************************************************/
868
+
869
+ /*--------------------
870
+ * RangeTblEntry -
871
+ * A range table is a List of RangeTblEntry nodes.
872
+ *
873
+ * A range table entry may represent a plain relation, a sub-select in
874
+ * FROM, or the result of a JOIN clause. (Only explicit JOIN syntax
875
+ * produces an RTE, not the implicit join resulting from multiple FROM
876
+ * items. This is because we only need the RTE to deal with SQL features
877
+ * like outer joins and join-output-column aliasing.) Other special
878
+ * RTE types also exist, as indicated by RTEKind.
879
+ *
880
+ * Note that we consider RTE_RELATION to cover anything that has a pg_class
881
+ * entry. relkind distinguishes the sub-cases.
882
+ *
883
+ * alias is an Alias node representing the AS alias-clause attached to the
884
+ * FROM expression, or NULL if no clause.
885
+ *
886
+ * eref is the table reference name and column reference names (either
887
+ * real or aliases). Note that system columns (OID etc) are not included
888
+ * in the column list.
889
+ * eref->aliasname is required to be present, and should generally be used
890
+ * to identify the RTE for error messages etc.
891
+ *
892
+ * In RELATION RTEs, the colnames in both alias and eref are indexed by
893
+ * physical attribute number; this means there must be colname entries for
894
+ * dropped columns. When building an RTE we insert empty strings ("") for
895
+ * dropped columns. Note however that a stored rule may have nonempty
896
+ * colnames for columns dropped since the rule was created (and for that
897
+ * matter the colnames might be out of date due to column renamings).
898
+ * The same comments apply to FUNCTION RTEs when a function's return type
899
+ * is a named composite type.
900
+ *
901
+ * In JOIN RTEs, the colnames in both alias and eref are one-to-one with
902
+ * joinaliasvars entries. A JOIN RTE will omit columns of its inputs when
903
+ * those columns are known to be dropped at parse time. Again, however,
904
+ * a stored rule might contain entries for columns dropped since the rule
905
+ * was created. (This is only possible for columns not actually referenced
906
+ * in the rule.) When loading a stored rule, we replace the joinaliasvars
907
+ * items for any such columns with null pointers. (We can't simply delete
908
+ * them from the joinaliasvars list, because that would affect the attnums
909
+ * of Vars referencing the rest of the list.)
910
+ *
911
+ * inh is true for relation references that should be expanded to include
912
+ * inheritance children, if the rel has any. This *must* be false for
913
+ * RTEs other than RTE_RELATION entries.
914
+ *
915
+ * inFromCl marks those range variables that are listed in the FROM clause.
916
+ * It's false for RTEs that are added to a query behind the scenes, such
917
+ * as the NEW and OLD variables for a rule, or the subqueries of a UNION.
918
+ * This flag is not used anymore during parsing, since the parser now uses
919
+ * a separate "namespace" data structure to control visibility, but it is
920
+ * needed by ruleutils.c to determine whether RTEs should be shown in
921
+ * decompiled queries.
922
+ *
923
+ * requiredPerms and checkAsUser specify run-time access permissions
924
+ * checks to be performed at query startup. The user must have *all*
925
+ * of the permissions that are OR'd together in requiredPerms (zero
926
+ * indicates no permissions checking). If checkAsUser is not zero,
927
+ * then do the permissions checks using the access rights of that user,
928
+ * not the current effective user ID. (This allows rules to act as
929
+ * setuid gateways.) Permissions checks only apply to RELATION RTEs.
930
+ *
931
+ * For SELECT/INSERT/UPDATE permissions, if the user doesn't have
932
+ * table-wide permissions then it is sufficient to have the permissions
933
+ * on all columns identified in selectedCols (for SELECT) and/or
934
+ * insertedCols and/or updatedCols (INSERT with ON CONFLICT DO UPDATE may
935
+ * have all 3). selectedCols, insertedCols and updatedCols are bitmapsets,
936
+ * which cannot have negative integer members, so we subtract
937
+ * FirstLowInvalidHeapAttributeNumber from column numbers before storing
938
+ * them in these fields. A whole-row Var reference is represented by
939
+ * setting the bit for InvalidAttrNumber.
940
+ *
941
+ * updatedCols is also used in some other places, for example, to determine
942
+ * which triggers to fire and in FDWs to know which changed columns they
943
+ * need to ship off.
944
+ *
945
+ * Generated columns that are caused to be updated by an update to a base
946
+ * column are listed in extraUpdatedCols. This is not considered for
947
+ * permission checking, but it is useful in those places that want to know
948
+ * the full set of columns being updated as opposed to only the ones the
949
+ * user explicitly mentioned in the query. (There is currently no need for
950
+ * an extraInsertedCols, but it could exist.) Note that extraUpdatedCols
951
+ * is populated during query rewrite, NOT in the parser, since generated
952
+ * columns could be added after a rule has been parsed and stored.
953
+ *
954
+ * securityQuals is a list of security barrier quals (boolean expressions),
955
+ * to be tested in the listed order before returning a row from the
956
+ * relation. It is always NIL in parser output. Entries are added by the
957
+ * rewriter to implement security-barrier views and/or row-level security.
958
+ * Note that the planner turns each boolean expression into an implicitly
959
+ * AND'ed sublist, as is its usual habit with qualification expressions.
960
+ *--------------------
961
+ */
962
+ typedef enum RTEKind
963
+ {
964
+ RTE_RELATION, /* ordinary relation reference */
965
+ RTE_SUBQUERY, /* subquery in FROM */
966
+ RTE_JOIN, /* join */
967
+ RTE_FUNCTION, /* function in FROM */
968
+ RTE_TABLEFUNC, /* TableFunc(.., column list) */
969
+ RTE_VALUES, /* VALUES (<exprlist>), (<exprlist>), ... */
970
+ RTE_CTE, /* common table expr (WITH list element) */
971
+ RTE_NAMEDTUPLESTORE, /* tuplestore, e.g. for AFTER triggers */
972
+ RTE_RESULT /* RTE represents an empty FROM clause; such
973
+ * RTEs are added by the planner, they're not
974
+ * present during parsing or rewriting */
975
+ } RTEKind;
976
+
977
+ typedef struct RangeTblEntry
978
+ {
979
+ NodeTag type;
980
+
981
+ RTEKind rtekind; /* see above */
982
+
983
+ /*
984
+ * XXX the fields applicable to only some rte kinds should be merged into
985
+ * a union. I didn't do this yet because the diffs would impact a lot of
986
+ * code that is being actively worked on. FIXME someday.
987
+ */
988
+
989
+ /*
990
+ * Fields valid for a plain relation RTE (else zero):
991
+ *
992
+ * As a special case, RTE_NAMEDTUPLESTORE can also set relid to indicate
993
+ * that the tuple format of the tuplestore is the same as the referenced
994
+ * relation. This allows plans referencing AFTER trigger transition
995
+ * tables to be invalidated if the underlying table is altered.
996
+ *
997
+ * rellockmode is really LOCKMODE, but it's declared int to avoid having
998
+ * to include lock-related headers here. It must be RowExclusiveLock if
999
+ * the RTE is an INSERT/UPDATE/DELETE target, else RowShareLock if the RTE
1000
+ * is a SELECT FOR UPDATE/FOR SHARE target, else AccessShareLock.
1001
+ *
1002
+ * Note: in some cases, rule expansion may result in RTEs that are marked
1003
+ * with RowExclusiveLock even though they are not the target of the
1004
+ * current query; this happens if a DO ALSO rule simply scans the original
1005
+ * target table. We leave such RTEs with their original lockmode so as to
1006
+ * avoid getting an additional, lesser lock.
1007
+ */
1008
+ Oid relid; /* OID of the relation */
1009
+ char relkind; /* relation kind (see pg_class.relkind) */
1010
+ int rellockmode; /* lock level that query requires on the rel */
1011
+ struct TableSampleClause *tablesample; /* sampling info, or NULL */
1012
+
1013
+ /*
1014
+ * Fields valid for a subquery RTE (else NULL):
1015
+ */
1016
+ Query *subquery; /* the sub-query */
1017
+ bool security_barrier; /* is from security_barrier view? */
1018
+
1019
+ /*
1020
+ * Fields valid for a join RTE (else NULL/zero):
1021
+ *
1022
+ * joinaliasvars is a list of (usually) Vars corresponding to the columns
1023
+ * of the join result. An alias Var referencing column K of the join
1024
+ * result can be replaced by the K'th element of joinaliasvars --- but to
1025
+ * simplify the task of reverse-listing aliases correctly, we do not do
1026
+ * that until planning time. In detail: an element of joinaliasvars can
1027
+ * be a Var of one of the join's input relations, or such a Var with an
1028
+ * implicit coercion to the join's output column type, or a COALESCE
1029
+ * expression containing the two input column Vars (possibly coerced).
1030
+ * Elements beyond the first joinmergedcols entries are always just Vars,
1031
+ * and are never referenced from elsewhere in the query (that is, join
1032
+ * alias Vars are generated only for merged columns). We keep these
1033
+ * entries only because they're needed in expandRTE() and similar code.
1034
+ *
1035
+ * Within a Query loaded from a stored rule, it is possible for non-merged
1036
+ * joinaliasvars items to be null pointers, which are placeholders for
1037
+ * (necessarily unreferenced) columns dropped since the rule was made.
1038
+ * Also, once planning begins, joinaliasvars items can be almost anything,
1039
+ * as a result of subquery-flattening substitutions.
1040
+ *
1041
+ * joinleftcols is an integer list of physical column numbers of the left
1042
+ * join input rel that are included in the join; likewise joinrighttcols
1043
+ * for the right join input rel. (Which rels those are can be determined
1044
+ * from the associated JoinExpr.) If the join is USING/NATURAL, then the
1045
+ * first joinmergedcols entries in each list identify the merged columns.
1046
+ * The merged columns come first in the join output, then remaining
1047
+ * columns of the left input, then remaining columns of the right.
1048
+ *
1049
+ * Note that input columns could have been dropped after creation of a
1050
+ * stored rule, if they are not referenced in the query (in particular,
1051
+ * merged columns could not be dropped); this is not accounted for in
1052
+ * joinleftcols/joinrighttcols.
1053
+ */
1054
+ JoinType jointype; /* type of join */
1055
+ int joinmergedcols; /* number of merged (JOIN USING) columns */
1056
+ List *joinaliasvars; /* list of alias-var expansions */
1057
+ List *joinleftcols; /* left-side input column numbers */
1058
+ List *joinrightcols; /* right-side input column numbers */
1059
+
1060
+ /*
1061
+ * Fields valid for a function RTE (else NIL/zero):
1062
+ *
1063
+ * When funcordinality is true, the eref->colnames list includes an alias
1064
+ * for the ordinality column. The ordinality column is otherwise
1065
+ * implicit, and must be accounted for "by hand" in places such as
1066
+ * expandRTE().
1067
+ */
1068
+ List *functions; /* list of RangeTblFunction nodes */
1069
+ bool funcordinality; /* is this called WITH ORDINALITY? */
1070
+
1071
+ /*
1072
+ * Fields valid for a TableFunc RTE (else NULL):
1073
+ */
1074
+ TableFunc *tablefunc;
1075
+
1076
+ /*
1077
+ * Fields valid for a values RTE (else NIL):
1078
+ */
1079
+ List *values_lists; /* list of expression lists */
1080
+
1081
+ /*
1082
+ * Fields valid for a CTE RTE (else NULL/zero):
1083
+ */
1084
+ char *ctename; /* name of the WITH list item */
1085
+ Index ctelevelsup; /* number of query levels up */
1086
+ bool self_reference; /* is this a recursive self-reference? */
1087
+
1088
+ /*
1089
+ * Fields valid for CTE, VALUES, ENR, and TableFunc RTEs (else NIL):
1090
+ *
1091
+ * We need these for CTE RTEs so that the types of self-referential
1092
+ * columns are well-defined. For VALUES RTEs, storing these explicitly
1093
+ * saves having to re-determine the info by scanning the values_lists. For
1094
+ * ENRs, we store the types explicitly here (we could get the information
1095
+ * from the catalogs if 'relid' was supplied, but we'd still need these
1096
+ * for TupleDesc-based ENRs, so we might as well always store the type
1097
+ * info here). For TableFuncs, these fields are redundant with data in
1098
+ * the TableFunc node, but keeping them here allows some code sharing with
1099
+ * the other cases.
1100
+ *
1101
+ * For ENRs only, we have to consider the possibility of dropped columns.
1102
+ * A dropped column is included in these lists, but it will have zeroes in
1103
+ * all three lists (as well as an empty-string entry in eref). Testing
1104
+ * for zero coltype is the standard way to detect a dropped column.
1105
+ */
1106
+ List *coltypes; /* OID list of column type OIDs */
1107
+ List *coltypmods; /* integer list of column typmods */
1108
+ List *colcollations; /* OID list of column collation OIDs */
1109
+
1110
+ /*
1111
+ * Fields valid for ENR RTEs (else NULL/zero):
1112
+ */
1113
+ char *enrname; /* name of ephemeral named relation */
1114
+ double enrtuples; /* estimated or actual from caller */
1115
+
1116
+ /*
1117
+ * Fields valid in all RTEs:
1118
+ */
1119
+ Alias *alias; /* user-written alias clause, if any */
1120
+ Alias *eref; /* expanded reference names */
1121
+ bool lateral; /* subquery, function, or values is LATERAL? */
1122
+ bool inh; /* inheritance requested? */
1123
+ bool inFromCl; /* present in FROM clause? */
1124
+ AclMode requiredPerms; /* bitmask of required access permissions */
1125
+ Oid checkAsUser; /* if valid, check access as this role */
1126
+ Bitmapset *selectedCols; /* columns needing SELECT permission */
1127
+ Bitmapset *insertedCols; /* columns needing INSERT permission */
1128
+ Bitmapset *updatedCols; /* columns needing UPDATE permission */
1129
+ Bitmapset *extraUpdatedCols; /* generated columns being updated */
1130
+ List *securityQuals; /* security barrier quals to apply, if any */
1131
+ } RangeTblEntry;
1132
+
1133
+ /*
1134
+ * RangeTblFunction -
1135
+ * RangeTblEntry subsidiary data for one function in a FUNCTION RTE.
1136
+ *
1137
+ * If the function had a column definition list (required for an
1138
+ * otherwise-unspecified RECORD result), funccolnames lists the names given
1139
+ * in the definition list, funccoltypes lists their declared column types,
1140
+ * funccoltypmods lists their typmods, funccolcollations their collations.
1141
+ * Otherwise, those fields are NIL.
1142
+ *
1143
+ * Notice we don't attempt to store info about the results of functions
1144
+ * returning named composite types, because those can change from time to
1145
+ * time. We do however remember how many columns we thought the type had
1146
+ * (including dropped columns!), so that we can successfully ignore any
1147
+ * columns added after the query was parsed.
1148
+ */
1149
+ typedef struct RangeTblFunction
1150
+ {
1151
+ NodeTag type;
1152
+
1153
+ Node *funcexpr; /* expression tree for func call */
1154
+ int funccolcount; /* number of columns it contributes to RTE */
1155
+ /* These fields record the contents of a column definition list, if any: */
1156
+ List *funccolnames; /* column names (list of String) */
1157
+ List *funccoltypes; /* OID list of column type OIDs */
1158
+ List *funccoltypmods; /* integer list of column typmods */
1159
+ List *funccolcollations; /* OID list of column collation OIDs */
1160
+ /* This is set during planning for use by the executor: */
1161
+ Bitmapset *funcparams; /* PARAM_EXEC Param IDs affecting this func */
1162
+ } RangeTblFunction;
1163
+
1164
+ /*
1165
+ * TableSampleClause - TABLESAMPLE appearing in a transformed FROM clause
1166
+ *
1167
+ * Unlike RangeTableSample, this is a subnode of the relevant RangeTblEntry.
1168
+ */
1169
+ typedef struct TableSampleClause
1170
+ {
1171
+ NodeTag type;
1172
+ Oid tsmhandler; /* OID of the tablesample handler function */
1173
+ List *args; /* tablesample argument expression(s) */
1174
+ Expr *repeatable; /* REPEATABLE expression, or NULL if none */
1175
+ } TableSampleClause;
1176
+
1177
+ /*
1178
+ * WithCheckOption -
1179
+ * representation of WITH CHECK OPTION checks to be applied to new tuples
1180
+ * when inserting/updating an auto-updatable view, or RLS WITH CHECK
1181
+ * policies to be applied when inserting/updating a relation with RLS.
1182
+ */
1183
+ typedef enum WCOKind
1184
+ {
1185
+ WCO_VIEW_CHECK, /* WCO on an auto-updatable view */
1186
+ WCO_RLS_INSERT_CHECK, /* RLS INSERT WITH CHECK policy */
1187
+ WCO_RLS_UPDATE_CHECK, /* RLS UPDATE WITH CHECK policy */
1188
+ WCO_RLS_CONFLICT_CHECK /* RLS ON CONFLICT DO UPDATE USING policy */
1189
+ } WCOKind;
1190
+
1191
+ typedef struct WithCheckOption
1192
+ {
1193
+ NodeTag type;
1194
+ WCOKind kind; /* kind of WCO */
1195
+ char *relname; /* name of relation that specified the WCO */
1196
+ char *polname; /* name of RLS policy being checked */
1197
+ Node *qual; /* constraint qual to check */
1198
+ bool cascaded; /* true for a cascaded WCO on a view */
1199
+ } WithCheckOption;
1200
+
1201
+ /*
1202
+ * SortGroupClause -
1203
+ * representation of ORDER BY, GROUP BY, PARTITION BY,
1204
+ * DISTINCT, DISTINCT ON items
1205
+ *
1206
+ * You might think that ORDER BY is only interested in defining ordering,
1207
+ * and GROUP/DISTINCT are only interested in defining equality. However,
1208
+ * one way to implement grouping is to sort and then apply a "uniq"-like
1209
+ * filter. So it's also interesting to keep track of possible sort operators
1210
+ * for GROUP/DISTINCT, and in particular to try to sort for the grouping
1211
+ * in a way that will also yield a requested ORDER BY ordering. So we need
1212
+ * to be able to compare ORDER BY and GROUP/DISTINCT lists, which motivates
1213
+ * the decision to give them the same representation.
1214
+ *
1215
+ * tleSortGroupRef must match ressortgroupref of exactly one entry of the
1216
+ * query's targetlist; that is the expression to be sorted or grouped by.
1217
+ * eqop is the OID of the equality operator.
1218
+ * sortop is the OID of the ordering operator (a "<" or ">" operator),
1219
+ * or InvalidOid if not available.
1220
+ * nulls_first means about what you'd expect. If sortop is InvalidOid
1221
+ * then nulls_first is meaningless and should be set to false.
1222
+ * hashable is true if eqop is hashable (note this condition also depends
1223
+ * on the datatype of the input expression).
1224
+ *
1225
+ * In an ORDER BY item, all fields must be valid. (The eqop isn't essential
1226
+ * here, but it's cheap to get it along with the sortop, and requiring it
1227
+ * to be valid eases comparisons to grouping items.) Note that this isn't
1228
+ * actually enough information to determine an ordering: if the sortop is
1229
+ * collation-sensitive, a collation OID is needed too. We don't store the
1230
+ * collation in SortGroupClause because it's not available at the time the
1231
+ * parser builds the SortGroupClause; instead, consult the exposed collation
1232
+ * of the referenced targetlist expression to find out what it is.
1233
+ *
1234
+ * In a grouping item, eqop must be valid. If the eqop is a btree equality
1235
+ * operator, then sortop should be set to a compatible ordering operator.
1236
+ * We prefer to set eqop/sortop/nulls_first to match any ORDER BY item that
1237
+ * the query presents for the same tlist item. If there is none, we just
1238
+ * use the default ordering op for the datatype.
1239
+ *
1240
+ * If the tlist item's type has a hash opclass but no btree opclass, then
1241
+ * we will set eqop to the hash equality operator, sortop to InvalidOid,
1242
+ * and nulls_first to false. A grouping item of this kind can only be
1243
+ * implemented by hashing, and of course it'll never match an ORDER BY item.
1244
+ *
1245
+ * The hashable flag is provided since we generally have the requisite
1246
+ * information readily available when the SortGroupClause is constructed,
1247
+ * and it's relatively expensive to get it again later. Note there is no
1248
+ * need for a "sortable" flag since OidIsValid(sortop) serves the purpose.
1249
+ *
1250
+ * A query might have both ORDER BY and DISTINCT (or DISTINCT ON) clauses.
1251
+ * In SELECT DISTINCT, the distinctClause list is as long or longer than the
1252
+ * sortClause list, while in SELECT DISTINCT ON it's typically shorter.
1253
+ * The two lists must match up to the end of the shorter one --- the parser
1254
+ * rearranges the distinctClause if necessary to make this true. (This
1255
+ * restriction ensures that only one sort step is needed to both satisfy the
1256
+ * ORDER BY and set up for the Unique step. This is semantically necessary
1257
+ * for DISTINCT ON, and presents no real drawback for DISTINCT.)
1258
+ */
1259
+ typedef struct SortGroupClause
1260
+ {
1261
+ NodeTag type;
1262
+ Index tleSortGroupRef; /* reference into targetlist */
1263
+ Oid eqop; /* the equality operator ('=' op) */
1264
+ Oid sortop; /* the ordering operator ('<' op), or 0 */
1265
+ bool nulls_first; /* do NULLs come before normal values? */
1266
+ bool hashable; /* can eqop be implemented by hashing? */
1267
+ } SortGroupClause;
1268
+
1269
+ /*
1270
+ * GroupingSet -
1271
+ * representation of CUBE, ROLLUP and GROUPING SETS clauses
1272
+ *
1273
+ * In a Query with grouping sets, the groupClause contains a flat list of
1274
+ * SortGroupClause nodes for each distinct expression used. The actual
1275
+ * structure of the GROUP BY clause is given by the groupingSets tree.
1276
+ *
1277
+ * In the raw parser output, GroupingSet nodes (of all types except SIMPLE
1278
+ * which is not used) are potentially mixed in with the expressions in the
1279
+ * groupClause of the SelectStmt. (An expression can't contain a GroupingSet,
1280
+ * but a list may mix GroupingSet and expression nodes.) At this stage, the
1281
+ * content of each node is a list of expressions, some of which may be RowExprs
1282
+ * which represent sublists rather than actual row constructors, and nested
1283
+ * GroupingSet nodes where legal in the grammar. The structure directly
1284
+ * reflects the query syntax.
1285
+ *
1286
+ * In parse analysis, the transformed expressions are used to build the tlist
1287
+ * and groupClause list (of SortGroupClause nodes), and the groupingSets tree
1288
+ * is eventually reduced to a fixed format:
1289
+ *
1290
+ * EMPTY nodes represent (), and obviously have no content
1291
+ *
1292
+ * SIMPLE nodes represent a list of one or more expressions to be treated as an
1293
+ * atom by the enclosing structure; the content is an integer list of
1294
+ * ressortgroupref values (see SortGroupClause)
1295
+ *
1296
+ * CUBE and ROLLUP nodes contain a list of one or more SIMPLE nodes.
1297
+ *
1298
+ * SETS nodes contain a list of EMPTY, SIMPLE, CUBE or ROLLUP nodes, but after
1299
+ * parse analysis they cannot contain more SETS nodes; enough of the syntactic
1300
+ * transforms of the spec have been applied that we no longer have arbitrarily
1301
+ * deep nesting (though we still preserve the use of cube/rollup).
1302
+ *
1303
+ * Note that if the groupingSets tree contains no SIMPLE nodes (only EMPTY
1304
+ * nodes at the leaves), then the groupClause will be empty, but this is still
1305
+ * an aggregation query (similar to using aggs or HAVING without GROUP BY).
1306
+ *
1307
+ * As an example, the following clause:
1308
+ *
1309
+ * GROUP BY GROUPING SETS ((a,b), CUBE(c,(d,e)))
1310
+ *
1311
+ * looks like this after raw parsing:
1312
+ *
1313
+ * SETS( RowExpr(a,b) , CUBE( c, RowExpr(d,e) ) )
1314
+ *
1315
+ * and parse analysis converts it to:
1316
+ *
1317
+ * SETS( SIMPLE(1,2), CUBE( SIMPLE(3), SIMPLE(4,5) ) )
1318
+ */
1319
+ typedef enum
1320
+ {
1321
+ GROUPING_SET_EMPTY,
1322
+ GROUPING_SET_SIMPLE,
1323
+ GROUPING_SET_ROLLUP,
1324
+ GROUPING_SET_CUBE,
1325
+ GROUPING_SET_SETS
1326
+ } GroupingSetKind;
1327
+
1328
+ typedef struct GroupingSet
1329
+ {
1330
+ NodeTag type;
1331
+ GroupingSetKind kind;
1332
+ List *content;
1333
+ int location;
1334
+ } GroupingSet;
1335
+
1336
+ /*
1337
+ * WindowClause -
1338
+ * transformed representation of WINDOW and OVER clauses
1339
+ *
1340
+ * A parsed Query's windowClause list contains these structs. "name" is set
1341
+ * if the clause originally came from WINDOW, and is NULL if it originally
1342
+ * was an OVER clause (but note that we collapse out duplicate OVERs).
1343
+ * partitionClause and orderClause are lists of SortGroupClause structs.
1344
+ * If we have RANGE with offset PRECEDING/FOLLOWING, the semantics of that are
1345
+ * specified by startInRangeFunc/inRangeColl/inRangeAsc/inRangeNullsFirst
1346
+ * for the start offset, or endInRangeFunc/inRange* for the end offset.
1347
+ * winref is an ID number referenced by WindowFunc nodes; it must be unique
1348
+ * among the members of a Query's windowClause list.
1349
+ * When refname isn't null, the partitionClause is always copied from there;
1350
+ * the orderClause might or might not be copied (see copiedOrder); the framing
1351
+ * options are never copied, per spec.
1352
+ */
1353
+ typedef struct WindowClause
1354
+ {
1355
+ NodeTag type;
1356
+ char *name; /* window name (NULL in an OVER clause) */
1357
+ char *refname; /* referenced window name, if any */
1358
+ List *partitionClause; /* PARTITION BY list */
1359
+ List *orderClause; /* ORDER BY list */
1360
+ int frameOptions; /* frame_clause options, see WindowDef */
1361
+ Node *startOffset; /* expression for starting bound, if any */
1362
+ Node *endOffset; /* expression for ending bound, if any */
1363
+ Oid startInRangeFunc; /* in_range function for startOffset */
1364
+ Oid endInRangeFunc; /* in_range function for endOffset */
1365
+ Oid inRangeColl; /* collation for in_range tests */
1366
+ bool inRangeAsc; /* use ASC sort order for in_range tests? */
1367
+ bool inRangeNullsFirst; /* nulls sort first for in_range tests? */
1368
+ Index winref; /* ID referenced by window functions */
1369
+ bool copiedOrder; /* did we copy orderClause from refname? */
1370
+ } WindowClause;
1371
+
1372
+ /*
1373
+ * RowMarkClause -
1374
+ * parser output representation of FOR [KEY] UPDATE/SHARE clauses
1375
+ *
1376
+ * Query.rowMarks contains a separate RowMarkClause node for each relation
1377
+ * identified as a FOR [KEY] UPDATE/SHARE target. If one of these clauses
1378
+ * is applied to a subquery, we generate RowMarkClauses for all normal and
1379
+ * subquery rels in the subquery, but they are marked pushedDown = true to
1380
+ * distinguish them from clauses that were explicitly written at this query
1381
+ * level. Also, Query.hasForUpdate tells whether there were explicit FOR
1382
+ * UPDATE/SHARE/KEY SHARE clauses in the current query level.
1383
+ */
1384
+ typedef struct RowMarkClause
1385
+ {
1386
+ NodeTag type;
1387
+ Index rti; /* range table index of target relation */
1388
+ LockClauseStrength strength;
1389
+ LockWaitPolicy waitPolicy; /* NOWAIT and SKIP LOCKED */
1390
+ bool pushedDown; /* pushed down from higher query level? */
1391
+ } RowMarkClause;
1392
+
1393
+ /*
1394
+ * WithClause -
1395
+ * representation of WITH clause
1396
+ *
1397
+ * Note: WithClause does not propagate into the Query representation;
1398
+ * but CommonTableExpr does.
1399
+ */
1400
+ typedef struct WithClause
1401
+ {
1402
+ NodeTag type;
1403
+ List *ctes; /* list of CommonTableExprs */
1404
+ bool recursive; /* true = WITH RECURSIVE */
1405
+ int location; /* token location, or -1 if unknown */
1406
+ } WithClause;
1407
+
1408
+ /*
1409
+ * InferClause -
1410
+ * ON CONFLICT unique index inference clause
1411
+ *
1412
+ * Note: InferClause does not propagate into the Query representation.
1413
+ */
1414
+ typedef struct InferClause
1415
+ {
1416
+ NodeTag type;
1417
+ List *indexElems; /* IndexElems to infer unique index */
1418
+ Node *whereClause; /* qualification (partial-index predicate) */
1419
+ char *conname; /* Constraint name, or NULL if unnamed */
1420
+ int location; /* token location, or -1 if unknown */
1421
+ } InferClause;
1422
+
1423
+ /*
1424
+ * OnConflictClause -
1425
+ * representation of ON CONFLICT clause
1426
+ *
1427
+ * Note: OnConflictClause does not propagate into the Query representation.
1428
+ */
1429
+ typedef struct OnConflictClause
1430
+ {
1431
+ NodeTag type;
1432
+ OnConflictAction action; /* DO NOTHING or UPDATE? */
1433
+ InferClause *infer; /* Optional index inference clause */
1434
+ List *targetList; /* the target list (of ResTarget) */
1435
+ Node *whereClause; /* qualifications */
1436
+ int location; /* token location, or -1 if unknown */
1437
+ } OnConflictClause;
1438
+
1439
+ /*
1440
+ * CommonTableExpr -
1441
+ * representation of WITH list element
1442
+ *
1443
+ * We don't currently support the SEARCH or CYCLE clause.
1444
+ */
1445
+ typedef enum CTEMaterialize
1446
+ {
1447
+ CTEMaterializeDefault, /* no option specified */
1448
+ CTEMaterializeAlways, /* MATERIALIZED */
1449
+ CTEMaterializeNever /* NOT MATERIALIZED */
1450
+ } CTEMaterialize;
1451
+
1452
+ typedef struct CommonTableExpr
1453
+ {
1454
+ NodeTag type;
1455
+ char *ctename; /* query name (never qualified) */
1456
+ List *aliascolnames; /* optional list of column names */
1457
+ CTEMaterialize ctematerialized; /* is this an optimization fence? */
1458
+ /* SelectStmt/InsertStmt/etc before parse analysis, Query afterwards: */
1459
+ Node *ctequery; /* the CTE's subquery */
1460
+ int location; /* token location, or -1 if unknown */
1461
+ /* These fields are set during parse analysis: */
1462
+ bool cterecursive; /* is this CTE actually recursive? */
1463
+ int cterefcount; /* number of RTEs referencing this CTE
1464
+ * (excluding internal self-references) */
1465
+ List *ctecolnames; /* list of output column names */
1466
+ List *ctecoltypes; /* OID list of output column type OIDs */
1467
+ List *ctecoltypmods; /* integer list of output column typmods */
1468
+ List *ctecolcollations; /* OID list of column collation OIDs */
1469
+ } CommonTableExpr;
1470
+
1471
+ /* Convenience macro to get the output tlist of a CTE's query */
1472
+ #define GetCTETargetList(cte) \
1473
+ (AssertMacro(IsA((cte)->ctequery, Query)), \
1474
+ ((Query *) (cte)->ctequery)->commandType == CMD_SELECT ? \
1475
+ ((Query *) (cte)->ctequery)->targetList : \
1476
+ ((Query *) (cte)->ctequery)->returningList)
1477
+
1478
+ /*
1479
+ * TriggerTransition -
1480
+ * representation of transition row or table naming clause
1481
+ *
1482
+ * Only transition tables are initially supported in the syntax, and only for
1483
+ * AFTER triggers, but other permutations are accepted by the parser so we can
1484
+ * give a meaningful message from C code.
1485
+ */
1486
+ typedef struct TriggerTransition
1487
+ {
1488
+ NodeTag type;
1489
+ char *name;
1490
+ bool isNew;
1491
+ bool isTable;
1492
+ } TriggerTransition;
1493
+
1494
+ /*****************************************************************************
1495
+ * Raw Grammar Output Statements
1496
+ *****************************************************************************/
1497
+
1498
+ /*
1499
+ * RawStmt --- container for any one statement's raw parse tree
1500
+ *
1501
+ * Parse analysis converts a raw parse tree headed by a RawStmt node into
1502
+ * an analyzed statement headed by a Query node. For optimizable statements,
1503
+ * the conversion is complex. For utility statements, the parser usually just
1504
+ * transfers the raw parse tree (sans RawStmt) into the utilityStmt field of
1505
+ * the Query node, and all the useful work happens at execution time.
1506
+ *
1507
+ * stmt_location/stmt_len identify the portion of the source text string
1508
+ * containing this raw statement (useful for multi-statement strings).
1509
+ */
1510
+ typedef struct RawStmt
1511
+ {
1512
+ NodeTag type;
1513
+ Node *stmt; /* raw parse tree */
1514
+ int stmt_location; /* start location, or -1 if unknown */
1515
+ int stmt_len; /* length in bytes; 0 means "rest of string" */
1516
+ } RawStmt;
1517
+
1518
+ /*****************************************************************************
1519
+ * Optimizable Statements
1520
+ *****************************************************************************/
1521
+
1522
+ /* ----------------------
1523
+ * Insert Statement
1524
+ *
1525
+ * The source expression is represented by SelectStmt for both the
1526
+ * SELECT and VALUES cases. If selectStmt is NULL, then the query
1527
+ * is INSERT ... DEFAULT VALUES.
1528
+ * ----------------------
1529
+ */
1530
+ typedef struct InsertStmt
1531
+ {
1532
+ NodeTag type;
1533
+ RangeVar *relation; /* relation to insert into */
1534
+ List *cols; /* optional: names of the target columns */
1535
+ Node *selectStmt; /* the source SELECT/VALUES, or NULL */
1536
+ OnConflictClause *onConflictClause; /* ON CONFLICT clause */
1537
+ List *returningList; /* list of expressions to return */
1538
+ WithClause *withClause; /* WITH clause */
1539
+ OverridingKind override; /* OVERRIDING clause */
1540
+ } InsertStmt;
1541
+
1542
+ /* ----------------------
1543
+ * Delete Statement
1544
+ * ----------------------
1545
+ */
1546
+ typedef struct DeleteStmt
1547
+ {
1548
+ NodeTag type;
1549
+ RangeVar *relation; /* relation to delete from */
1550
+ List *usingClause; /* optional using clause for more tables */
1551
+ Node *whereClause; /* qualifications */
1552
+ List *returningList; /* list of expressions to return */
1553
+ WithClause *withClause; /* WITH clause */
1554
+ } DeleteStmt;
1555
+
1556
+ /* ----------------------
1557
+ * Update Statement
1558
+ * ----------------------
1559
+ */
1560
+ typedef struct UpdateStmt
1561
+ {
1562
+ NodeTag type;
1563
+ RangeVar *relation; /* relation to update */
1564
+ List *targetList; /* the target list (of ResTarget) */
1565
+ Node *whereClause; /* qualifications */
1566
+ List *fromClause; /* optional from clause for more tables */
1567
+ List *returningList; /* list of expressions to return */
1568
+ WithClause *withClause; /* WITH clause */
1569
+ } UpdateStmt;
1570
+
1571
+ /* ----------------------
1572
+ * Select Statement
1573
+ *
1574
+ * A "simple" SELECT is represented in the output of gram.y by a single
1575
+ * SelectStmt node; so is a VALUES construct. A query containing set
1576
+ * operators (UNION, INTERSECT, EXCEPT) is represented by a tree of SelectStmt
1577
+ * nodes, in which the leaf nodes are component SELECTs and the internal nodes
1578
+ * represent UNION, INTERSECT, or EXCEPT operators. Using the same node
1579
+ * type for both leaf and internal nodes allows gram.y to stick ORDER BY,
1580
+ * LIMIT, etc, clause values into a SELECT statement without worrying
1581
+ * whether it is a simple or compound SELECT.
1582
+ * ----------------------
1583
+ */
1584
+ typedef enum SetOperation
1585
+ {
1586
+ SETOP_NONE = 0,
1587
+ SETOP_UNION,
1588
+ SETOP_INTERSECT,
1589
+ SETOP_EXCEPT
1590
+ } SetOperation;
1591
+
1592
+ typedef struct SelectStmt
1593
+ {
1594
+ NodeTag type;
1595
+
1596
+ /*
1597
+ * These fields are used only in "leaf" SelectStmts.
1598
+ */
1599
+ List *distinctClause; /* NULL, list of DISTINCT ON exprs, or
1600
+ * lcons(NIL,NIL) for all (SELECT DISTINCT) */
1601
+ IntoClause *intoClause; /* target for SELECT INTO */
1602
+ List *targetList; /* the target list (of ResTarget) */
1603
+ List *fromClause; /* the FROM clause */
1604
+ Node *whereClause; /* WHERE qualification */
1605
+ List *groupClause; /* GROUP BY clauses */
1606
+ Node *havingClause; /* HAVING conditional-expression */
1607
+ List *windowClause; /* WINDOW window_name AS (...), ... */
1608
+
1609
+ /*
1610
+ * In a "leaf" node representing a VALUES list, the above fields are all
1611
+ * null, and instead this field is set. Note that the elements of the
1612
+ * sublists are just expressions, without ResTarget decoration. Also note
1613
+ * that a list element can be DEFAULT (represented as a SetToDefault
1614
+ * node), regardless of the context of the VALUES list. It's up to parse
1615
+ * analysis to reject that where not valid.
1616
+ */
1617
+ List *valuesLists; /* untransformed list of expression lists */
1618
+
1619
+ /*
1620
+ * These fields are used in both "leaf" SelectStmts and upper-level
1621
+ * SelectStmts.
1622
+ */
1623
+ List *sortClause; /* sort clause (a list of SortBy's) */
1624
+ Node *limitOffset; /* # of result tuples to skip */
1625
+ Node *limitCount; /* # of result tuples to return */
1626
+ LimitOption limitOption; /* limit type */
1627
+ List *lockingClause; /* FOR UPDATE (list of LockingClause's) */
1628
+ WithClause *withClause; /* WITH clause */
1629
+
1630
+ /*
1631
+ * These fields are used only in upper-level SelectStmts.
1632
+ */
1633
+ SetOperation op; /* type of set op */
1634
+ bool all; /* ALL specified? */
1635
+ struct SelectStmt *larg; /* left child */
1636
+ struct SelectStmt *rarg; /* right child */
1637
+ /* Eventually add fields for CORRESPONDING spec here */
1638
+ } SelectStmt;
1639
+
1640
+
1641
+ /* ----------------------
1642
+ * Set Operation node for post-analysis query trees
1643
+ *
1644
+ * After parse analysis, a SELECT with set operations is represented by a
1645
+ * top-level Query node containing the leaf SELECTs as subqueries in its
1646
+ * range table. Its setOperations field shows the tree of set operations,
1647
+ * with leaf SelectStmt nodes replaced by RangeTblRef nodes, and internal
1648
+ * nodes replaced by SetOperationStmt nodes. Information about the output
1649
+ * column types is added, too. (Note that the child nodes do not necessarily
1650
+ * produce these types directly, but we've checked that their output types
1651
+ * can be coerced to the output column type.) Also, if it's not UNION ALL,
1652
+ * information about the types' sort/group semantics is provided in the form
1653
+ * of a SortGroupClause list (same representation as, eg, DISTINCT).
1654
+ * The resolved common column collations are provided too; but note that if
1655
+ * it's not UNION ALL, it's okay for a column to not have a common collation,
1656
+ * so a member of the colCollations list could be InvalidOid even though the
1657
+ * column has a collatable type.
1658
+ * ----------------------
1659
+ */
1660
+ typedef struct SetOperationStmt
1661
+ {
1662
+ NodeTag type;
1663
+ SetOperation op; /* type of set op */
1664
+ bool all; /* ALL specified? */
1665
+ Node *larg; /* left child */
1666
+ Node *rarg; /* right child */
1667
+ /* Eventually add fields for CORRESPONDING spec here */
1668
+
1669
+ /* Fields derived during parse analysis: */
1670
+ List *colTypes; /* OID list of output column type OIDs */
1671
+ List *colTypmods; /* integer list of output column typmods */
1672
+ List *colCollations; /* OID list of output column collation OIDs */
1673
+ List *groupClauses; /* a list of SortGroupClause's */
1674
+ /* groupClauses is NIL if UNION ALL, but must be set otherwise */
1675
+ } SetOperationStmt;
1676
+
1677
+
1678
+ /*****************************************************************************
1679
+ * Other Statements (no optimizations required)
1680
+ *
1681
+ * These are not touched by parser/analyze.c except to put them into
1682
+ * the utilityStmt field of a Query. This is eventually passed to
1683
+ * ProcessUtility (by-passing rewriting and planning). Some of the
1684
+ * statements do need attention from parse analysis, and this is
1685
+ * done by routines in parser/parse_utilcmd.c after ProcessUtility
1686
+ * receives the command for execution.
1687
+ * DECLARE CURSOR, EXPLAIN, and CREATE TABLE AS are special cases:
1688
+ * they contain optimizable statements, which get processed normally
1689
+ * by parser/analyze.c.
1690
+ *****************************************************************************/
1691
+
1692
+ /*
1693
+ * When a command can act on several kinds of objects with only one
1694
+ * parse structure required, use these constants to designate the
1695
+ * object type. Note that commands typically don't support all the types.
1696
+ */
1697
+
1698
+ typedef enum ObjectType
1699
+ {
1700
+ OBJECT_ACCESS_METHOD,
1701
+ OBJECT_AGGREGATE,
1702
+ OBJECT_AMOP,
1703
+ OBJECT_AMPROC,
1704
+ OBJECT_ATTRIBUTE, /* type's attribute, when distinct from column */
1705
+ OBJECT_CAST,
1706
+ OBJECT_COLUMN,
1707
+ OBJECT_COLLATION,
1708
+ OBJECT_CONVERSION,
1709
+ OBJECT_DATABASE,
1710
+ OBJECT_DEFAULT,
1711
+ OBJECT_DEFACL,
1712
+ OBJECT_DOMAIN,
1713
+ OBJECT_DOMCONSTRAINT,
1714
+ OBJECT_EVENT_TRIGGER,
1715
+ OBJECT_EXTENSION,
1716
+ OBJECT_FDW,
1717
+ OBJECT_FOREIGN_SERVER,
1718
+ OBJECT_FOREIGN_TABLE,
1719
+ OBJECT_FUNCTION,
1720
+ OBJECT_INDEX,
1721
+ OBJECT_LANGUAGE,
1722
+ OBJECT_LARGEOBJECT,
1723
+ OBJECT_MATVIEW,
1724
+ OBJECT_OPCLASS,
1725
+ OBJECT_OPERATOR,
1726
+ OBJECT_OPFAMILY,
1727
+ OBJECT_POLICY,
1728
+ OBJECT_PROCEDURE,
1729
+ OBJECT_PUBLICATION,
1730
+ OBJECT_PUBLICATION_REL,
1731
+ OBJECT_ROLE,
1732
+ OBJECT_ROUTINE,
1733
+ OBJECT_RULE,
1734
+ OBJECT_SCHEMA,
1735
+ OBJECT_SEQUENCE,
1736
+ OBJECT_SUBSCRIPTION,
1737
+ OBJECT_STATISTIC_EXT,
1738
+ OBJECT_TABCONSTRAINT,
1739
+ OBJECT_TABLE,
1740
+ OBJECT_TABLESPACE,
1741
+ OBJECT_TRANSFORM,
1742
+ OBJECT_TRIGGER,
1743
+ OBJECT_TSCONFIGURATION,
1744
+ OBJECT_TSDICTIONARY,
1745
+ OBJECT_TSPARSER,
1746
+ OBJECT_TSTEMPLATE,
1747
+ OBJECT_TYPE,
1748
+ OBJECT_USER_MAPPING,
1749
+ OBJECT_VIEW
1750
+ } ObjectType;
1751
+
1752
+ /* ----------------------
1753
+ * Create Schema Statement
1754
+ *
1755
+ * NOTE: the schemaElts list contains raw parsetrees for component statements
1756
+ * of the schema, such as CREATE TABLE, GRANT, etc. These are analyzed and
1757
+ * executed after the schema itself is created.
1758
+ * ----------------------
1759
+ */
1760
+ typedef struct CreateSchemaStmt
1761
+ {
1762
+ NodeTag type;
1763
+ char *schemaname; /* the name of the schema to create */
1764
+ RoleSpec *authrole; /* the owner of the created schema */
1765
+ List *schemaElts; /* schema components (list of parsenodes) */
1766
+ bool if_not_exists; /* just do nothing if schema already exists? */
1767
+ } CreateSchemaStmt;
1768
+
1769
+ typedef enum DropBehavior
1770
+ {
1771
+ DROP_RESTRICT, /* drop fails if any dependent objects */
1772
+ DROP_CASCADE /* remove dependent objects too */
1773
+ } DropBehavior;
1774
+
1775
+ /* ----------------------
1776
+ * Alter Table
1777
+ * ----------------------
1778
+ */
1779
+ typedef struct AlterTableStmt
1780
+ {
1781
+ NodeTag type;
1782
+ RangeVar *relation; /* table to work on */
1783
+ List *cmds; /* list of subcommands */
1784
+ ObjectType relkind; /* type of object */
1785
+ bool missing_ok; /* skip error if table missing */
1786
+ } AlterTableStmt;
1787
+
1788
+ typedef enum AlterTableType
1789
+ {
1790
+ AT_AddColumn, /* add column */
1791
+ AT_AddColumnRecurse, /* internal to commands/tablecmds.c */
1792
+ AT_AddColumnToView, /* implicitly via CREATE OR REPLACE VIEW */
1793
+ AT_ColumnDefault, /* alter column default */
1794
+ AT_CookedColumnDefault, /* add a pre-cooked column default */
1795
+ AT_DropNotNull, /* alter column drop not null */
1796
+ AT_SetNotNull, /* alter column set not null */
1797
+ AT_DropExpression, /* alter column drop expression */
1798
+ AT_CheckNotNull, /* check column is already marked not null */
1799
+ AT_SetStatistics, /* alter column set statistics */
1800
+ AT_SetOptions, /* alter column set ( options ) */
1801
+ AT_ResetOptions, /* alter column reset ( options ) */
1802
+ AT_SetStorage, /* alter column set storage */
1803
+ AT_DropColumn, /* drop column */
1804
+ AT_DropColumnRecurse, /* internal to commands/tablecmds.c */
1805
+ AT_AddIndex, /* add index */
1806
+ AT_ReAddIndex, /* internal to commands/tablecmds.c */
1807
+ AT_AddConstraint, /* add constraint */
1808
+ AT_AddConstraintRecurse, /* internal to commands/tablecmds.c */
1809
+ AT_ReAddConstraint, /* internal to commands/tablecmds.c */
1810
+ AT_ReAddDomainConstraint, /* internal to commands/tablecmds.c */
1811
+ AT_AlterConstraint, /* alter constraint */
1812
+ AT_ValidateConstraint, /* validate constraint */
1813
+ AT_ValidateConstraintRecurse, /* internal to commands/tablecmds.c */
1814
+ AT_AddIndexConstraint, /* add constraint using existing index */
1815
+ AT_DropConstraint, /* drop constraint */
1816
+ AT_DropConstraintRecurse, /* internal to commands/tablecmds.c */
1817
+ AT_ReAddComment, /* internal to commands/tablecmds.c */
1818
+ AT_AlterColumnType, /* alter column type */
1819
+ AT_AlterColumnGenericOptions, /* alter column OPTIONS (...) */
1820
+ AT_ChangeOwner, /* change owner */
1821
+ AT_ClusterOn, /* CLUSTER ON */
1822
+ AT_DropCluster, /* SET WITHOUT CLUSTER */
1823
+ AT_SetLogged, /* SET LOGGED */
1824
+ AT_SetUnLogged, /* SET UNLOGGED */
1825
+ AT_DropOids, /* SET WITHOUT OIDS */
1826
+ AT_SetTableSpace, /* SET TABLESPACE */
1827
+ AT_SetRelOptions, /* SET (...) -- AM specific parameters */
1828
+ AT_ResetRelOptions, /* RESET (...) -- AM specific parameters */
1829
+ AT_ReplaceRelOptions, /* replace reloption list in its entirety */
1830
+ AT_EnableTrig, /* ENABLE TRIGGER name */
1831
+ AT_EnableAlwaysTrig, /* ENABLE ALWAYS TRIGGER name */
1832
+ AT_EnableReplicaTrig, /* ENABLE REPLICA TRIGGER name */
1833
+ AT_DisableTrig, /* DISABLE TRIGGER name */
1834
+ AT_EnableTrigAll, /* ENABLE TRIGGER ALL */
1835
+ AT_DisableTrigAll, /* DISABLE TRIGGER ALL */
1836
+ AT_EnableTrigUser, /* ENABLE TRIGGER USER */
1837
+ AT_DisableTrigUser, /* DISABLE TRIGGER USER */
1838
+ AT_EnableRule, /* ENABLE RULE name */
1839
+ AT_EnableAlwaysRule, /* ENABLE ALWAYS RULE name */
1840
+ AT_EnableReplicaRule, /* ENABLE REPLICA RULE name */
1841
+ AT_DisableRule, /* DISABLE RULE name */
1842
+ AT_AddInherit, /* INHERIT parent */
1843
+ AT_DropInherit, /* NO INHERIT parent */
1844
+ AT_AddOf, /* OF <type_name> */
1845
+ AT_DropOf, /* NOT OF */
1846
+ AT_ReplicaIdentity, /* REPLICA IDENTITY */
1847
+ AT_EnableRowSecurity, /* ENABLE ROW SECURITY */
1848
+ AT_DisableRowSecurity, /* DISABLE ROW SECURITY */
1849
+ AT_ForceRowSecurity, /* FORCE ROW SECURITY */
1850
+ AT_NoForceRowSecurity, /* NO FORCE ROW SECURITY */
1851
+ AT_GenericOptions, /* OPTIONS (...) */
1852
+ AT_AttachPartition, /* ATTACH PARTITION */
1853
+ AT_DetachPartition, /* DETACH PARTITION */
1854
+ AT_AddIdentity, /* ADD IDENTITY */
1855
+ AT_SetIdentity, /* SET identity column options */
1856
+ AT_DropIdentity /* DROP IDENTITY */
1857
+ } AlterTableType;
1858
+
1859
+ typedef struct ReplicaIdentityStmt
1860
+ {
1861
+ NodeTag type;
1862
+ char identity_type;
1863
+ char *name;
1864
+ } ReplicaIdentityStmt;
1865
+
1866
+ typedef struct AlterTableCmd /* one subcommand of an ALTER TABLE */
1867
+ {
1868
+ NodeTag type;
1869
+ AlterTableType subtype; /* Type of table alteration to apply */
1870
+ char *name; /* column, constraint, or trigger to act on,
1871
+ * or tablespace */
1872
+ int16 num; /* attribute number for columns referenced by
1873
+ * number */
1874
+ RoleSpec *newowner;
1875
+ Node *def; /* definition of new column, index,
1876
+ * constraint, or parent table */
1877
+ DropBehavior behavior; /* RESTRICT or CASCADE for DROP cases */
1878
+ bool missing_ok; /* skip error if missing? */
1879
+ } AlterTableCmd;
1880
+
1881
+
1882
+ /* ----------------------
1883
+ * Alter Collation
1884
+ * ----------------------
1885
+ */
1886
+ typedef struct AlterCollationStmt
1887
+ {
1888
+ NodeTag type;
1889
+ List *collname;
1890
+ } AlterCollationStmt;
1891
+
1892
+
1893
+ /* ----------------------
1894
+ * Alter Domain
1895
+ *
1896
+ * The fields are used in different ways by the different variants of
1897
+ * this command.
1898
+ * ----------------------
1899
+ */
1900
+ typedef struct AlterDomainStmt
1901
+ {
1902
+ NodeTag type;
1903
+ char subtype; /*------------
1904
+ * T = alter column default
1905
+ * N = alter column drop not null
1906
+ * O = alter column set not null
1907
+ * C = add constraint
1908
+ * X = drop constraint
1909
+ *------------
1910
+ */
1911
+ List *typeName; /* domain to work on */
1912
+ char *name; /* column or constraint name to act on */
1913
+ Node *def; /* definition of default or constraint */
1914
+ DropBehavior behavior; /* RESTRICT or CASCADE for DROP cases */
1915
+ bool missing_ok; /* skip error if missing? */
1916
+ } AlterDomainStmt;
1917
+
1918
+
1919
+ /* ----------------------
1920
+ * Grant|Revoke Statement
1921
+ * ----------------------
1922
+ */
1923
+ typedef enum GrantTargetType
1924
+ {
1925
+ ACL_TARGET_OBJECT, /* grant on specific named object(s) */
1926
+ ACL_TARGET_ALL_IN_SCHEMA, /* grant on all objects in given schema(s) */
1927
+ ACL_TARGET_DEFAULTS /* ALTER DEFAULT PRIVILEGES */
1928
+ } GrantTargetType;
1929
+
1930
+ typedef struct GrantStmt
1931
+ {
1932
+ NodeTag type;
1933
+ bool is_grant; /* true = GRANT, false = REVOKE */
1934
+ GrantTargetType targtype; /* type of the grant target */
1935
+ ObjectType objtype; /* kind of object being operated on */
1936
+ List *objects; /* list of RangeVar nodes, ObjectWithArgs
1937
+ * nodes, or plain names (as Value strings) */
1938
+ List *privileges; /* list of AccessPriv nodes */
1939
+ /* privileges == NIL denotes ALL PRIVILEGES */
1940
+ List *grantees; /* list of RoleSpec nodes */
1941
+ bool grant_option; /* grant or revoke grant option */
1942
+ DropBehavior behavior; /* drop behavior (for REVOKE) */
1943
+ } GrantStmt;
1944
+
1945
+ /*
1946
+ * Note: ObjectWithArgs carries only the types of the input parameters of the
1947
+ * function. So it is sufficient to identify an existing function, but it
1948
+ * is not enough info to define a function nor to call it.
1949
+ */
1950
+ typedef struct ObjectWithArgs
1951
+ {
1952
+ NodeTag type;
1953
+ List *objname; /* qualified name of function/operator */
1954
+ List *objargs; /* list of Typename nodes */
1955
+ bool args_unspecified; /* argument list was omitted, so name must
1956
+ * be unique (note that objargs == NIL
1957
+ * means zero args) */
1958
+ } ObjectWithArgs;
1959
+
1960
+ /*
1961
+ * An access privilege, with optional list of column names
1962
+ * priv_name == NULL denotes ALL PRIVILEGES (only used with a column list)
1963
+ * cols == NIL denotes "all columns"
1964
+ * Note that simple "ALL PRIVILEGES" is represented as a NIL list, not
1965
+ * an AccessPriv with both fields null.
1966
+ */
1967
+ typedef struct AccessPriv
1968
+ {
1969
+ NodeTag type;
1970
+ char *priv_name; /* string name of privilege */
1971
+ List *cols; /* list of Value strings */
1972
+ } AccessPriv;
1973
+
1974
+ /* ----------------------
1975
+ * Grant/Revoke Role Statement
1976
+ *
1977
+ * Note: because of the parsing ambiguity with the GRANT <privileges>
1978
+ * statement, granted_roles is a list of AccessPriv; the execution code
1979
+ * should complain if any column lists appear. grantee_roles is a list
1980
+ * of role names, as Value strings.
1981
+ * ----------------------
1982
+ */
1983
+ typedef struct GrantRoleStmt
1984
+ {
1985
+ NodeTag type;
1986
+ List *granted_roles; /* list of roles to be granted/revoked */
1987
+ List *grantee_roles; /* list of member roles to add/delete */
1988
+ bool is_grant; /* true = GRANT, false = REVOKE */
1989
+ bool admin_opt; /* with admin option */
1990
+ RoleSpec *grantor; /* set grantor to other than current role */
1991
+ DropBehavior behavior; /* drop behavior (for REVOKE) */
1992
+ } GrantRoleStmt;
1993
+
1994
+ /* ----------------------
1995
+ * Alter Default Privileges Statement
1996
+ * ----------------------
1997
+ */
1998
+ typedef struct AlterDefaultPrivilegesStmt
1999
+ {
2000
+ NodeTag type;
2001
+ List *options; /* list of DefElem */
2002
+ GrantStmt *action; /* GRANT/REVOKE action (with objects=NIL) */
2003
+ } AlterDefaultPrivilegesStmt;
2004
+
2005
+ /* ----------------------
2006
+ * Copy Statement
2007
+ *
2008
+ * We support "COPY relation FROM file", "COPY relation TO file", and
2009
+ * "COPY (query) TO file". In any given CopyStmt, exactly one of "relation"
2010
+ * and "query" must be non-NULL.
2011
+ * ----------------------
2012
+ */
2013
+ typedef struct CopyStmt
2014
+ {
2015
+ NodeTag type;
2016
+ RangeVar *relation; /* the relation to copy */
2017
+ Node *query; /* the query (SELECT or DML statement with
2018
+ * RETURNING) to copy, as a raw parse tree */
2019
+ List *attlist; /* List of column names (as Strings), or NIL
2020
+ * for all columns */
2021
+ bool is_from; /* TO or FROM */
2022
+ bool is_program; /* is 'filename' a program to popen? */
2023
+ char *filename; /* filename, or NULL for STDIN/STDOUT */
2024
+ List *options; /* List of DefElem nodes */
2025
+ Node *whereClause; /* WHERE condition (or NULL) */
2026
+ } CopyStmt;
2027
+
2028
+ /* ----------------------
2029
+ * SET Statement (includes RESET)
2030
+ *
2031
+ * "SET var TO DEFAULT" and "RESET var" are semantically equivalent, but we
2032
+ * preserve the distinction in VariableSetKind for CreateCommandTag().
2033
+ * ----------------------
2034
+ */
2035
+ typedef enum
2036
+ {
2037
+ VAR_SET_VALUE, /* SET var = value */
2038
+ VAR_SET_DEFAULT, /* SET var TO DEFAULT */
2039
+ VAR_SET_CURRENT, /* SET var FROM CURRENT */
2040
+ VAR_SET_MULTI, /* special case for SET TRANSACTION ... */
2041
+ VAR_RESET, /* RESET var */
2042
+ VAR_RESET_ALL /* RESET ALL */
2043
+ } VariableSetKind;
2044
+
2045
+ typedef struct VariableSetStmt
2046
+ {
2047
+ NodeTag type;
2048
+ VariableSetKind kind;
2049
+ char *name; /* variable to be set */
2050
+ List *args; /* List of A_Const nodes */
2051
+ bool is_local; /* SET LOCAL? */
2052
+ } VariableSetStmt;
2053
+
2054
+ /* ----------------------
2055
+ * Show Statement
2056
+ * ----------------------
2057
+ */
2058
+ typedef struct VariableShowStmt
2059
+ {
2060
+ NodeTag type;
2061
+ char *name;
2062
+ } VariableShowStmt;
2063
+
2064
+ /* ----------------------
2065
+ * Create Table Statement
2066
+ *
2067
+ * NOTE: in the raw gram.y output, ColumnDef and Constraint nodes are
2068
+ * intermixed in tableElts, and constraints is NIL. After parse analysis,
2069
+ * tableElts contains just ColumnDefs, and constraints contains just
2070
+ * Constraint nodes (in fact, only CONSTR_CHECK nodes, in the present
2071
+ * implementation).
2072
+ * ----------------------
2073
+ */
2074
+
2075
+ typedef struct CreateStmt
2076
+ {
2077
+ NodeTag type;
2078
+ RangeVar *relation; /* relation to create */
2079
+ List *tableElts; /* column definitions (list of ColumnDef) */
2080
+ List *inhRelations; /* relations to inherit from (list of
2081
+ * inhRelation) */
2082
+ PartitionBoundSpec *partbound; /* FOR VALUES clause */
2083
+ PartitionSpec *partspec; /* PARTITION BY clause */
2084
+ TypeName *ofTypename; /* OF typename */
2085
+ List *constraints; /* constraints (list of Constraint nodes) */
2086
+ List *options; /* options from WITH clause */
2087
+ OnCommitAction oncommit; /* what do we do at COMMIT? */
2088
+ char *tablespacename; /* table space to use, or NULL */
2089
+ char *accessMethod; /* table access method */
2090
+ bool if_not_exists; /* just do nothing if it already exists? */
2091
+ } CreateStmt;
2092
+
2093
+ /* ----------
2094
+ * Definitions for constraints in CreateStmt
2095
+ *
2096
+ * Note that column defaults are treated as a type of constraint,
2097
+ * even though that's a bit odd semantically.
2098
+ *
2099
+ * For constraints that use expressions (CONSTR_CHECK, CONSTR_DEFAULT)
2100
+ * we may have the expression in either "raw" form (an untransformed
2101
+ * parse tree) or "cooked" form (the nodeToString representation of
2102
+ * an executable expression tree), depending on how this Constraint
2103
+ * node was created (by parsing, or by inheritance from an existing
2104
+ * relation). We should never have both in the same node!
2105
+ *
2106
+ * FKCONSTR_ACTION_xxx values are stored into pg_constraint.confupdtype
2107
+ * and pg_constraint.confdeltype columns; FKCONSTR_MATCH_xxx values are
2108
+ * stored into pg_constraint.confmatchtype. Changing the code values may
2109
+ * require an initdb!
2110
+ *
2111
+ * If skip_validation is true then we skip checking that the existing rows
2112
+ * in the table satisfy the constraint, and just install the catalog entries
2113
+ * for the constraint. A new FK constraint is marked as valid iff
2114
+ * initially_valid is true. (Usually skip_validation and initially_valid
2115
+ * are inverses, but we can set both true if the table is known empty.)
2116
+ *
2117
+ * Constraint attributes (DEFERRABLE etc) are initially represented as
2118
+ * separate Constraint nodes for simplicity of parsing. parse_utilcmd.c makes
2119
+ * a pass through the constraints list to insert the info into the appropriate
2120
+ * Constraint node.
2121
+ * ----------
2122
+ */
2123
+
2124
+ typedef enum ConstrType /* types of constraints */
2125
+ {
2126
+ CONSTR_NULL, /* not standard SQL, but a lot of people
2127
+ * expect it */
2128
+ CONSTR_NOTNULL,
2129
+ CONSTR_DEFAULT,
2130
+ CONSTR_IDENTITY,
2131
+ CONSTR_GENERATED,
2132
+ CONSTR_CHECK,
2133
+ CONSTR_PRIMARY,
2134
+ CONSTR_UNIQUE,
2135
+ CONSTR_EXCLUSION,
2136
+ CONSTR_FOREIGN,
2137
+ CONSTR_ATTR_DEFERRABLE, /* attributes for previous constraint node */
2138
+ CONSTR_ATTR_NOT_DEFERRABLE,
2139
+ CONSTR_ATTR_DEFERRED,
2140
+ CONSTR_ATTR_IMMEDIATE
2141
+ } ConstrType;
2142
+
2143
+ /* Foreign key action codes */
2144
+ #define FKCONSTR_ACTION_NOACTION 'a'
2145
+ #define FKCONSTR_ACTION_RESTRICT 'r'
2146
+ #define FKCONSTR_ACTION_CASCADE 'c'
2147
+ #define FKCONSTR_ACTION_SETNULL 'n'
2148
+ #define FKCONSTR_ACTION_SETDEFAULT 'd'
2149
+
2150
+ /* Foreign key matchtype codes */
2151
+ #define FKCONSTR_MATCH_FULL 'f'
2152
+ #define FKCONSTR_MATCH_PARTIAL 'p'
2153
+ #define FKCONSTR_MATCH_SIMPLE 's'
2154
+
2155
+ typedef struct Constraint
2156
+ {
2157
+ NodeTag type;
2158
+ ConstrType contype; /* see above */
2159
+
2160
+ /* Fields used for most/all constraint types: */
2161
+ char *conname; /* Constraint name, or NULL if unnamed */
2162
+ bool deferrable; /* DEFERRABLE? */
2163
+ bool initdeferred; /* INITIALLY DEFERRED? */
2164
+ int location; /* token location, or -1 if unknown */
2165
+
2166
+ /* Fields used for constraints with expressions (CHECK and DEFAULT): */
2167
+ bool is_no_inherit; /* is constraint non-inheritable? */
2168
+ Node *raw_expr; /* expr, as untransformed parse tree */
2169
+ char *cooked_expr; /* expr, as nodeToString representation */
2170
+ char generated_when; /* ALWAYS or BY DEFAULT */
2171
+
2172
+ /* Fields used for unique constraints (UNIQUE and PRIMARY KEY): */
2173
+ List *keys; /* String nodes naming referenced key
2174
+ * column(s) */
2175
+ List *including; /* String nodes naming referenced nonkey
2176
+ * column(s) */
2177
+
2178
+ /* Fields used for EXCLUSION constraints: */
2179
+ List *exclusions; /* list of (IndexElem, operator name) pairs */
2180
+
2181
+ /* Fields used for index constraints (UNIQUE, PRIMARY KEY, EXCLUSION): */
2182
+ List *options; /* options from WITH clause */
2183
+ char *indexname; /* existing index to use; otherwise NULL */
2184
+ char *indexspace; /* index tablespace; NULL for default */
2185
+ bool reset_default_tblspc; /* reset default_tablespace prior to
2186
+ * creating the index */
2187
+ /* These could be, but currently are not, used for UNIQUE/PKEY: */
2188
+ char *access_method; /* index access method; NULL for default */
2189
+ Node *where_clause; /* partial index predicate */
2190
+
2191
+ /* Fields used for FOREIGN KEY constraints: */
2192
+ RangeVar *pktable; /* Primary key table */
2193
+ List *fk_attrs; /* Attributes of foreign key */
2194
+ List *pk_attrs; /* Corresponding attrs in PK table */
2195
+ char fk_matchtype; /* FULL, PARTIAL, SIMPLE */
2196
+ char fk_upd_action; /* ON UPDATE action */
2197
+ char fk_del_action; /* ON DELETE action */
2198
+ List *old_conpfeqop; /* pg_constraint.conpfeqop of my former self */
2199
+ Oid old_pktable_oid; /* pg_constraint.confrelid of my former
2200
+ * self */
2201
+
2202
+ /* Fields used for constraints that allow a NOT VALID specification */
2203
+ bool skip_validation; /* skip validation of existing rows? */
2204
+ bool initially_valid; /* mark the new constraint as valid? */
2205
+ } Constraint;
2206
+
2207
+ /* ----------------------
2208
+ * Create/Drop Table Space Statements
2209
+ * ----------------------
2210
+ */
2211
+
2212
+ typedef struct CreateTableSpaceStmt
2213
+ {
2214
+ NodeTag type;
2215
+ char *tablespacename;
2216
+ RoleSpec *owner;
2217
+ char *location;
2218
+ List *options;
2219
+ } CreateTableSpaceStmt;
2220
+
2221
+ typedef struct DropTableSpaceStmt
2222
+ {
2223
+ NodeTag type;
2224
+ char *tablespacename;
2225
+ bool missing_ok; /* skip error if missing? */
2226
+ } DropTableSpaceStmt;
2227
+
2228
+ typedef struct AlterTableSpaceOptionsStmt
2229
+ {
2230
+ NodeTag type;
2231
+ char *tablespacename;
2232
+ List *options;
2233
+ bool isReset;
2234
+ } AlterTableSpaceOptionsStmt;
2235
+
2236
+ typedef struct AlterTableMoveAllStmt
2237
+ {
2238
+ NodeTag type;
2239
+ char *orig_tablespacename;
2240
+ ObjectType objtype; /* Object type to move */
2241
+ List *roles; /* List of roles to move objects of */
2242
+ char *new_tablespacename;
2243
+ bool nowait;
2244
+ } AlterTableMoveAllStmt;
2245
+
2246
+ /* ----------------------
2247
+ * Create/Alter Extension Statements
2248
+ * ----------------------
2249
+ */
2250
+
2251
+ typedef struct CreateExtensionStmt
2252
+ {
2253
+ NodeTag type;
2254
+ char *extname;
2255
+ bool if_not_exists; /* just do nothing if it already exists? */
2256
+ List *options; /* List of DefElem nodes */
2257
+ } CreateExtensionStmt;
2258
+
2259
+ /* Only used for ALTER EXTENSION UPDATE; later might need an action field */
2260
+ typedef struct AlterExtensionStmt
2261
+ {
2262
+ NodeTag type;
2263
+ char *extname;
2264
+ List *options; /* List of DefElem nodes */
2265
+ } AlterExtensionStmt;
2266
+
2267
+ typedef struct AlterExtensionContentsStmt
2268
+ {
2269
+ NodeTag type;
2270
+ char *extname; /* Extension's name */
2271
+ int action; /* +1 = add object, -1 = drop object */
2272
+ ObjectType objtype; /* Object's type */
2273
+ Node *object; /* Qualified name of the object */
2274
+ } AlterExtensionContentsStmt;
2275
+
2276
+ /* ----------------------
2277
+ * Create/Alter FOREIGN DATA WRAPPER Statements
2278
+ * ----------------------
2279
+ */
2280
+
2281
+ typedef struct CreateFdwStmt
2282
+ {
2283
+ NodeTag type;
2284
+ char *fdwname; /* foreign-data wrapper name */
2285
+ List *func_options; /* HANDLER/VALIDATOR options */
2286
+ List *options; /* generic options to FDW */
2287
+ } CreateFdwStmt;
2288
+
2289
+ typedef struct AlterFdwStmt
2290
+ {
2291
+ NodeTag type;
2292
+ char *fdwname; /* foreign-data wrapper name */
2293
+ List *func_options; /* HANDLER/VALIDATOR options */
2294
+ List *options; /* generic options to FDW */
2295
+ } AlterFdwStmt;
2296
+
2297
+ /* ----------------------
2298
+ * Create/Alter FOREIGN SERVER Statements
2299
+ * ----------------------
2300
+ */
2301
+
2302
+ typedef struct CreateForeignServerStmt
2303
+ {
2304
+ NodeTag type;
2305
+ char *servername; /* server name */
2306
+ char *servertype; /* optional server type */
2307
+ char *version; /* optional server version */
2308
+ char *fdwname; /* FDW name */
2309
+ bool if_not_exists; /* just do nothing if it already exists? */
2310
+ List *options; /* generic options to server */
2311
+ } CreateForeignServerStmt;
2312
+
2313
+ typedef struct AlterForeignServerStmt
2314
+ {
2315
+ NodeTag type;
2316
+ char *servername; /* server name */
2317
+ char *version; /* optional server version */
2318
+ List *options; /* generic options to server */
2319
+ bool has_version; /* version specified */
2320
+ } AlterForeignServerStmt;
2321
+
2322
+ /* ----------------------
2323
+ * Create FOREIGN TABLE Statement
2324
+ * ----------------------
2325
+ */
2326
+
2327
+ typedef struct CreateForeignTableStmt
2328
+ {
2329
+ CreateStmt base;
2330
+ char *servername;
2331
+ List *options;
2332
+ } CreateForeignTableStmt;
2333
+
2334
+ /* ----------------------
2335
+ * Create/Drop USER MAPPING Statements
2336
+ * ----------------------
2337
+ */
2338
+
2339
+ typedef struct CreateUserMappingStmt
2340
+ {
2341
+ NodeTag type;
2342
+ RoleSpec *user; /* user role */
2343
+ char *servername; /* server name */
2344
+ bool if_not_exists; /* just do nothing if it already exists? */
2345
+ List *options; /* generic options to server */
2346
+ } CreateUserMappingStmt;
2347
+
2348
+ typedef struct AlterUserMappingStmt
2349
+ {
2350
+ NodeTag type;
2351
+ RoleSpec *user; /* user role */
2352
+ char *servername; /* server name */
2353
+ List *options; /* generic options to server */
2354
+ } AlterUserMappingStmt;
2355
+
2356
+ typedef struct DropUserMappingStmt
2357
+ {
2358
+ NodeTag type;
2359
+ RoleSpec *user; /* user role */
2360
+ char *servername; /* server name */
2361
+ bool missing_ok; /* ignore missing mappings */
2362
+ } DropUserMappingStmt;
2363
+
2364
+ /* ----------------------
2365
+ * Import Foreign Schema Statement
2366
+ * ----------------------
2367
+ */
2368
+
2369
+ typedef enum ImportForeignSchemaType
2370
+ {
2371
+ FDW_IMPORT_SCHEMA_ALL, /* all relations wanted */
2372
+ FDW_IMPORT_SCHEMA_LIMIT_TO, /* include only listed tables in import */
2373
+ FDW_IMPORT_SCHEMA_EXCEPT /* exclude listed tables from import */
2374
+ } ImportForeignSchemaType;
2375
+
2376
+ typedef struct ImportForeignSchemaStmt
2377
+ {
2378
+ NodeTag type;
2379
+ char *server_name; /* FDW server name */
2380
+ char *remote_schema; /* remote schema name to query */
2381
+ char *local_schema; /* local schema to create objects in */
2382
+ ImportForeignSchemaType list_type; /* type of table list */
2383
+ List *table_list; /* List of RangeVar */
2384
+ List *options; /* list of options to pass to FDW */
2385
+ } ImportForeignSchemaStmt;
2386
+
2387
+ /*----------------------
2388
+ * Create POLICY Statement
2389
+ *----------------------
2390
+ */
2391
+ typedef struct CreatePolicyStmt
2392
+ {
2393
+ NodeTag type;
2394
+ char *policy_name; /* Policy's name */
2395
+ RangeVar *table; /* the table name the policy applies to */
2396
+ char *cmd_name; /* the command name the policy applies to */
2397
+ bool permissive; /* restrictive or permissive policy */
2398
+ List *roles; /* the roles associated with the policy */
2399
+ Node *qual; /* the policy's condition */
2400
+ Node *with_check; /* the policy's WITH CHECK condition. */
2401
+ } CreatePolicyStmt;
2402
+
2403
+ /*----------------------
2404
+ * Alter POLICY Statement
2405
+ *----------------------
2406
+ */
2407
+ typedef struct AlterPolicyStmt
2408
+ {
2409
+ NodeTag type;
2410
+ char *policy_name; /* Policy's name */
2411
+ RangeVar *table; /* the table name the policy applies to */
2412
+ List *roles; /* the roles associated with the policy */
2413
+ Node *qual; /* the policy's condition */
2414
+ Node *with_check; /* the policy's WITH CHECK condition. */
2415
+ } AlterPolicyStmt;
2416
+
2417
+ /*----------------------
2418
+ * Create ACCESS METHOD Statement
2419
+ *----------------------
2420
+ */
2421
+ typedef struct CreateAmStmt
2422
+ {
2423
+ NodeTag type;
2424
+ char *amname; /* access method name */
2425
+ List *handler_name; /* handler function name */
2426
+ char amtype; /* type of access method */
2427
+ } CreateAmStmt;
2428
+
2429
+ /* ----------------------
2430
+ * Create TRIGGER Statement
2431
+ * ----------------------
2432
+ */
2433
+ typedef struct CreateTrigStmt
2434
+ {
2435
+ NodeTag type;
2436
+ char *trigname; /* TRIGGER's name */
2437
+ RangeVar *relation; /* relation trigger is on */
2438
+ List *funcname; /* qual. name of function to call */
2439
+ List *args; /* list of (T_String) Values or NIL */
2440
+ bool row; /* ROW/STATEMENT */
2441
+ /* timing uses the TRIGGER_TYPE bits defined in catalog/pg_trigger.h */
2442
+ int16 timing; /* BEFORE, AFTER, or INSTEAD */
2443
+ /* events uses the TRIGGER_TYPE bits defined in catalog/pg_trigger.h */
2444
+ int16 events; /* "OR" of INSERT/UPDATE/DELETE/TRUNCATE */
2445
+ List *columns; /* column names, or NIL for all columns */
2446
+ Node *whenClause; /* qual expression, or NULL if none */
2447
+ bool isconstraint; /* This is a constraint trigger */
2448
+ /* explicitly named transition data */
2449
+ List *transitionRels; /* TriggerTransition nodes, or NIL if none */
2450
+ /* The remaining fields are only used for constraint triggers */
2451
+ bool deferrable; /* [NOT] DEFERRABLE */
2452
+ bool initdeferred; /* INITIALLY {DEFERRED|IMMEDIATE} */
2453
+ RangeVar *constrrel; /* opposite relation, if RI trigger */
2454
+ } CreateTrigStmt;
2455
+
2456
+ /* ----------------------
2457
+ * Create EVENT TRIGGER Statement
2458
+ * ----------------------
2459
+ */
2460
+ typedef struct CreateEventTrigStmt
2461
+ {
2462
+ NodeTag type;
2463
+ char *trigname; /* TRIGGER's name */
2464
+ char *eventname; /* event's identifier */
2465
+ List *whenclause; /* list of DefElems indicating filtering */
2466
+ List *funcname; /* qual. name of function to call */
2467
+ } CreateEventTrigStmt;
2468
+
2469
+ /* ----------------------
2470
+ * Alter EVENT TRIGGER Statement
2471
+ * ----------------------
2472
+ */
2473
+ typedef struct AlterEventTrigStmt
2474
+ {
2475
+ NodeTag type;
2476
+ char *trigname; /* TRIGGER's name */
2477
+ char tgenabled; /* trigger's firing configuration WRT
2478
+ * session_replication_role */
2479
+ } AlterEventTrigStmt;
2480
+
2481
+ /* ----------------------
2482
+ * Create LANGUAGE Statements
2483
+ * ----------------------
2484
+ */
2485
+ typedef struct CreatePLangStmt
2486
+ {
2487
+ NodeTag type;
2488
+ bool replace; /* T => replace if already exists */
2489
+ char *plname; /* PL name */
2490
+ List *plhandler; /* PL call handler function (qual. name) */
2491
+ List *plinline; /* optional inline function (qual. name) */
2492
+ List *plvalidator; /* optional validator function (qual. name) */
2493
+ bool pltrusted; /* PL is trusted */
2494
+ } CreatePLangStmt;
2495
+
2496
+ /* ----------------------
2497
+ * Create/Alter/Drop Role Statements
2498
+ *
2499
+ * Note: these node types are also used for the backwards-compatible
2500
+ * Create/Alter/Drop User/Group statements. In the ALTER and DROP cases
2501
+ * there's really no need to distinguish what the original spelling was,
2502
+ * but for CREATE we mark the type because the defaults vary.
2503
+ * ----------------------
2504
+ */
2505
+ typedef enum RoleStmtType
2506
+ {
2507
+ ROLESTMT_ROLE,
2508
+ ROLESTMT_USER,
2509
+ ROLESTMT_GROUP
2510
+ } RoleStmtType;
2511
+
2512
+ typedef struct CreateRoleStmt
2513
+ {
2514
+ NodeTag type;
2515
+ RoleStmtType stmt_type; /* ROLE/USER/GROUP */
2516
+ char *role; /* role name */
2517
+ List *options; /* List of DefElem nodes */
2518
+ } CreateRoleStmt;
2519
+
2520
+ typedef struct AlterRoleStmt
2521
+ {
2522
+ NodeTag type;
2523
+ RoleSpec *role; /* role */
2524
+ List *options; /* List of DefElem nodes */
2525
+ int action; /* +1 = add members, -1 = drop members */
2526
+ } AlterRoleStmt;
2527
+
2528
+ typedef struct AlterRoleSetStmt
2529
+ {
2530
+ NodeTag type;
2531
+ RoleSpec *role; /* role */
2532
+ char *database; /* database name, or NULL */
2533
+ VariableSetStmt *setstmt; /* SET or RESET subcommand */
2534
+ } AlterRoleSetStmt;
2535
+
2536
+ typedef struct DropRoleStmt
2537
+ {
2538
+ NodeTag type;
2539
+ List *roles; /* List of roles to remove */
2540
+ bool missing_ok; /* skip error if a role is missing? */
2541
+ } DropRoleStmt;
2542
+
2543
+ /* ----------------------
2544
+ * {Create|Alter} SEQUENCE Statement
2545
+ * ----------------------
2546
+ */
2547
+
2548
+ typedef struct CreateSeqStmt
2549
+ {
2550
+ NodeTag type;
2551
+ RangeVar *sequence; /* the sequence to create */
2552
+ List *options;
2553
+ Oid ownerId; /* ID of owner, or InvalidOid for default */
2554
+ bool for_identity;
2555
+ bool if_not_exists; /* just do nothing if it already exists? */
2556
+ } CreateSeqStmt;
2557
+
2558
+ typedef struct AlterSeqStmt
2559
+ {
2560
+ NodeTag type;
2561
+ RangeVar *sequence; /* the sequence to alter */
2562
+ List *options;
2563
+ bool for_identity;
2564
+ bool missing_ok; /* skip error if a role is missing? */
2565
+ } AlterSeqStmt;
2566
+
2567
+ /* ----------------------
2568
+ * Create {Aggregate|Operator|Type} Statement
2569
+ * ----------------------
2570
+ */
2571
+ typedef struct DefineStmt
2572
+ {
2573
+ NodeTag type;
2574
+ ObjectType kind; /* aggregate, operator, type */
2575
+ bool oldstyle; /* hack to signal old CREATE AGG syntax */
2576
+ List *defnames; /* qualified name (list of Value strings) */
2577
+ List *args; /* a list of TypeName (if needed) */
2578
+ List *definition; /* a list of DefElem */
2579
+ bool if_not_exists; /* just do nothing if it already exists? */
2580
+ bool replace; /* replace if already exists? */
2581
+ } DefineStmt;
2582
+
2583
+ /* ----------------------
2584
+ * Create Domain Statement
2585
+ * ----------------------
2586
+ */
2587
+ typedef struct CreateDomainStmt
2588
+ {
2589
+ NodeTag type;
2590
+ List *domainname; /* qualified name (list of Value strings) */
2591
+ TypeName *typeName; /* the base type */
2592
+ CollateClause *collClause; /* untransformed COLLATE spec, if any */
2593
+ List *constraints; /* constraints (list of Constraint nodes) */
2594
+ } CreateDomainStmt;
2595
+
2596
+ /* ----------------------
2597
+ * Create Operator Class Statement
2598
+ * ----------------------
2599
+ */
2600
+ typedef struct CreateOpClassStmt
2601
+ {
2602
+ NodeTag type;
2603
+ List *opclassname; /* qualified name (list of Value strings) */
2604
+ List *opfamilyname; /* qualified name (ditto); NIL if omitted */
2605
+ char *amname; /* name of index AM opclass is for */
2606
+ TypeName *datatype; /* datatype of indexed column */
2607
+ List *items; /* List of CreateOpClassItem nodes */
2608
+ bool isDefault; /* Should be marked as default for type? */
2609
+ } CreateOpClassStmt;
2610
+
2611
+ #define OPCLASS_ITEM_OPERATOR 1
2612
+ #define OPCLASS_ITEM_FUNCTION 2
2613
+ #define OPCLASS_ITEM_STORAGETYPE 3
2614
+
2615
+ typedef struct CreateOpClassItem
2616
+ {
2617
+ NodeTag type;
2618
+ int itemtype; /* see codes above */
2619
+ ObjectWithArgs *name; /* operator or function name and args */
2620
+ int number; /* strategy num or support proc num */
2621
+ List *order_family; /* only used for ordering operators */
2622
+ List *class_args; /* amproclefttype/amprocrighttype or
2623
+ * amoplefttype/amoprighttype */
2624
+ /* fields used for a storagetype item: */
2625
+ TypeName *storedtype; /* datatype stored in index */
2626
+ } CreateOpClassItem;
2627
+
2628
+ /* ----------------------
2629
+ * Create Operator Family Statement
2630
+ * ----------------------
2631
+ */
2632
+ typedef struct CreateOpFamilyStmt
2633
+ {
2634
+ NodeTag type;
2635
+ List *opfamilyname; /* qualified name (list of Value strings) */
2636
+ char *amname; /* name of index AM opfamily is for */
2637
+ } CreateOpFamilyStmt;
2638
+
2639
+ /* ----------------------
2640
+ * Alter Operator Family Statement
2641
+ * ----------------------
2642
+ */
2643
+ typedef struct AlterOpFamilyStmt
2644
+ {
2645
+ NodeTag type;
2646
+ List *opfamilyname; /* qualified name (list of Value strings) */
2647
+ char *amname; /* name of index AM opfamily is for */
2648
+ bool isDrop; /* ADD or DROP the items? */
2649
+ List *items; /* List of CreateOpClassItem nodes */
2650
+ } AlterOpFamilyStmt;
2651
+
2652
+ /* ----------------------
2653
+ * Drop Table|Sequence|View|Index|Type|Domain|Conversion|Schema Statement
2654
+ * ----------------------
2655
+ */
2656
+
2657
+ typedef struct DropStmt
2658
+ {
2659
+ NodeTag type;
2660
+ List *objects; /* list of names */
2661
+ ObjectType removeType; /* object type */
2662
+ DropBehavior behavior; /* RESTRICT or CASCADE behavior */
2663
+ bool missing_ok; /* skip error if object is missing? */
2664
+ bool concurrent; /* drop index concurrently? */
2665
+ } DropStmt;
2666
+
2667
+ /* ----------------------
2668
+ * Truncate Table Statement
2669
+ * ----------------------
2670
+ */
2671
+ typedef struct TruncateStmt
2672
+ {
2673
+ NodeTag type;
2674
+ List *relations; /* relations (RangeVars) to be truncated */
2675
+ bool restart_seqs; /* restart owned sequences? */
2676
+ DropBehavior behavior; /* RESTRICT or CASCADE behavior */
2677
+ } TruncateStmt;
2678
+
2679
+ /* ----------------------
2680
+ * Comment On Statement
2681
+ * ----------------------
2682
+ */
2683
+ typedef struct CommentStmt
2684
+ {
2685
+ NodeTag type;
2686
+ ObjectType objtype; /* Object's type */
2687
+ Node *object; /* Qualified name of the object */
2688
+ char *comment; /* Comment to insert, or NULL to remove */
2689
+ } CommentStmt;
2690
+
2691
+ /* ----------------------
2692
+ * SECURITY LABEL Statement
2693
+ * ----------------------
2694
+ */
2695
+ typedef struct SecLabelStmt
2696
+ {
2697
+ NodeTag type;
2698
+ ObjectType objtype; /* Object's type */
2699
+ Node *object; /* Qualified name of the object */
2700
+ char *provider; /* Label provider (or NULL) */
2701
+ char *label; /* New security label to be assigned */
2702
+ } SecLabelStmt;
2703
+
2704
+ /* ----------------------
2705
+ * Declare Cursor Statement
2706
+ *
2707
+ * The "query" field is initially a raw parse tree, and is converted to a
2708
+ * Query node during parse analysis. Note that rewriting and planning
2709
+ * of the query are always postponed until execution.
2710
+ * ----------------------
2711
+ */
2712
+ #define CURSOR_OPT_BINARY 0x0001 /* BINARY */
2713
+ #define CURSOR_OPT_SCROLL 0x0002 /* SCROLL explicitly given */
2714
+ #define CURSOR_OPT_NO_SCROLL 0x0004 /* NO SCROLL explicitly given */
2715
+ #define CURSOR_OPT_INSENSITIVE 0x0008 /* INSENSITIVE */
2716
+ #define CURSOR_OPT_HOLD 0x0010 /* WITH HOLD */
2717
+ /* these planner-control flags do not correspond to any SQL grammar: */
2718
+ #define CURSOR_OPT_FAST_PLAN 0x0020 /* prefer fast-start plan */
2719
+ #define CURSOR_OPT_GENERIC_PLAN 0x0040 /* force use of generic plan */
2720
+ #define CURSOR_OPT_CUSTOM_PLAN 0x0080 /* force use of custom plan */
2721
+ #define CURSOR_OPT_PARALLEL_OK 0x0100 /* parallel mode OK */
2722
+
2723
+ typedef struct DeclareCursorStmt
2724
+ {
2725
+ NodeTag type;
2726
+ char *portalname; /* name of the portal (cursor) */
2727
+ int options; /* bitmask of options (see above) */
2728
+ Node *query; /* the query (see comments above) */
2729
+ } DeclareCursorStmt;
2730
+
2731
+ /* ----------------------
2732
+ * Close Portal Statement
2733
+ * ----------------------
2734
+ */
2735
+ typedef struct ClosePortalStmt
2736
+ {
2737
+ NodeTag type;
2738
+ char *portalname; /* name of the portal (cursor) */
2739
+ /* NULL means CLOSE ALL */
2740
+ } ClosePortalStmt;
2741
+
2742
+ /* ----------------------
2743
+ * Fetch Statement (also Move)
2744
+ * ----------------------
2745
+ */
2746
+ typedef enum FetchDirection
2747
+ {
2748
+ /* for these, howMany is how many rows to fetch; FETCH_ALL means ALL */
2749
+ FETCH_FORWARD,
2750
+ FETCH_BACKWARD,
2751
+ /* for these, howMany indicates a position; only one row is fetched */
2752
+ FETCH_ABSOLUTE,
2753
+ FETCH_RELATIVE
2754
+ } FetchDirection;
2755
+
2756
+ #define FETCH_ALL LONG_MAX
2757
+
2758
+ typedef struct FetchStmt
2759
+ {
2760
+ NodeTag type;
2761
+ FetchDirection direction; /* see above */
2762
+ long howMany; /* number of rows, or position argument */
2763
+ char *portalname; /* name of portal (cursor) */
2764
+ bool ismove; /* true if MOVE */
2765
+ } FetchStmt;
2766
+
2767
+ /* ----------------------
2768
+ * Create Index Statement
2769
+ *
2770
+ * This represents creation of an index and/or an associated constraint.
2771
+ * If isconstraint is true, we should create a pg_constraint entry along
2772
+ * with the index. But if indexOid isn't InvalidOid, we are not creating an
2773
+ * index, just a UNIQUE/PKEY constraint using an existing index. isconstraint
2774
+ * must always be true in this case, and the fields describing the index
2775
+ * properties are empty.
2776
+ * ----------------------
2777
+ */
2778
+ typedef struct IndexStmt
2779
+ {
2780
+ NodeTag type;
2781
+ char *idxname; /* name of new index, or NULL for default */
2782
+ RangeVar *relation; /* relation to build index on */
2783
+ char *accessMethod; /* name of access method (eg. btree) */
2784
+ char *tableSpace; /* tablespace, or NULL for default */
2785
+ List *indexParams; /* columns to index: a list of IndexElem */
2786
+ List *indexIncludingParams; /* additional columns to index: a list
2787
+ * of IndexElem */
2788
+ List *options; /* WITH clause options: a list of DefElem */
2789
+ Node *whereClause; /* qualification (partial-index predicate) */
2790
+ List *excludeOpNames; /* exclusion operator names, or NIL if none */
2791
+ char *idxcomment; /* comment to apply to index, or NULL */
2792
+ Oid indexOid; /* OID of an existing index, if any */
2793
+ Oid oldNode; /* relfilenode of existing storage, if any */
2794
+ SubTransactionId oldCreateSubid; /* rd_createSubid of oldNode */
2795
+ SubTransactionId oldFirstRelfilenodeSubid; /* rd_firstRelfilenodeSubid of
2796
+ * oldNode */
2797
+ bool unique; /* is index unique? */
2798
+ bool primary; /* is index a primary key? */
2799
+ bool isconstraint; /* is it for a pkey/unique constraint? */
2800
+ bool deferrable; /* is the constraint DEFERRABLE? */
2801
+ bool initdeferred; /* is the constraint INITIALLY DEFERRED? */
2802
+ bool transformed; /* true when transformIndexStmt is finished */
2803
+ bool concurrent; /* should this be a concurrent index build? */
2804
+ bool if_not_exists; /* just do nothing if index already exists? */
2805
+ bool reset_default_tblspc; /* reset default_tablespace prior to
2806
+ * executing */
2807
+ } IndexStmt;
2808
+
2809
+ /* ----------------------
2810
+ * Create Statistics Statement
2811
+ * ----------------------
2812
+ */
2813
+ typedef struct CreateStatsStmt
2814
+ {
2815
+ NodeTag type;
2816
+ List *defnames; /* qualified name (list of Value strings) */
2817
+ List *stat_types; /* stat types (list of Value strings) */
2818
+ List *exprs; /* expressions to build statistics on */
2819
+ List *relations; /* rels to build stats on (list of RangeVar) */
2820
+ char *stxcomment; /* comment to apply to stats, or NULL */
2821
+ bool if_not_exists; /* do nothing if stats name already exists */
2822
+ } CreateStatsStmt;
2823
+
2824
+ /* ----------------------
2825
+ * Alter Statistics Statement
2826
+ * ----------------------
2827
+ */
2828
+ typedef struct AlterStatsStmt
2829
+ {
2830
+ NodeTag type;
2831
+ List *defnames; /* qualified name (list of Value strings) */
2832
+ int stxstattarget; /* statistics target */
2833
+ bool missing_ok; /* skip error if statistics object is missing */
2834
+ } AlterStatsStmt;
2835
+
2836
+ /* ----------------------
2837
+ * Create Function Statement
2838
+ * ----------------------
2839
+ */
2840
+ typedef struct CreateFunctionStmt
2841
+ {
2842
+ NodeTag type;
2843
+ bool is_procedure; /* it's really CREATE PROCEDURE */
2844
+ bool replace; /* T => replace if already exists */
2845
+ List *funcname; /* qualified name of function to create */
2846
+ List *parameters; /* a list of FunctionParameter */
2847
+ TypeName *returnType; /* the return type */
2848
+ List *options; /* a list of DefElem */
2849
+ } CreateFunctionStmt;
2850
+
2851
+ typedef enum FunctionParameterMode
2852
+ {
2853
+ /* the assigned enum values appear in pg_proc, don't change 'em! */
2854
+ FUNC_PARAM_IN = 'i', /* input only */
2855
+ FUNC_PARAM_OUT = 'o', /* output only */
2856
+ FUNC_PARAM_INOUT = 'b', /* both */
2857
+ FUNC_PARAM_VARIADIC = 'v', /* variadic (always input) */
2858
+ FUNC_PARAM_TABLE = 't' /* table function output column */
2859
+ } FunctionParameterMode;
2860
+
2861
+ typedef struct FunctionParameter
2862
+ {
2863
+ NodeTag type;
2864
+ char *name; /* parameter name, or NULL if not given */
2865
+ TypeName *argType; /* TypeName for parameter type */
2866
+ FunctionParameterMode mode; /* IN/OUT/etc */
2867
+ Node *defexpr; /* raw default expr, or NULL if not given */
2868
+ } FunctionParameter;
2869
+
2870
+ typedef struct AlterFunctionStmt
2871
+ {
2872
+ NodeTag type;
2873
+ ObjectType objtype;
2874
+ ObjectWithArgs *func; /* name and args of function */
2875
+ List *actions; /* list of DefElem */
2876
+ } AlterFunctionStmt;
2877
+
2878
+ /* ----------------------
2879
+ * DO Statement
2880
+ *
2881
+ * DoStmt is the raw parser output, InlineCodeBlock is the execution-time API
2882
+ * ----------------------
2883
+ */
2884
+ typedef struct DoStmt
2885
+ {
2886
+ NodeTag type;
2887
+ List *args; /* List of DefElem nodes */
2888
+ } DoStmt;
2889
+
2890
+ typedef struct InlineCodeBlock
2891
+ {
2892
+ NodeTag type;
2893
+ char *source_text; /* source text of anonymous code block */
2894
+ Oid langOid; /* OID of selected language */
2895
+ bool langIsTrusted; /* trusted property of the language */
2896
+ bool atomic; /* atomic execution context */
2897
+ } InlineCodeBlock;
2898
+
2899
+ /* ----------------------
2900
+ * CALL statement
2901
+ * ----------------------
2902
+ */
2903
+ typedef struct CallStmt
2904
+ {
2905
+ NodeTag type;
2906
+ FuncCall *funccall; /* from the parser */
2907
+ FuncExpr *funcexpr; /* transformed */
2908
+ } CallStmt;
2909
+
2910
+ typedef struct CallContext
2911
+ {
2912
+ NodeTag type;
2913
+ bool atomic;
2914
+ } CallContext;
2915
+
2916
+ /* ----------------------
2917
+ * Alter Object Rename Statement
2918
+ * ----------------------
2919
+ */
2920
+ typedef struct RenameStmt
2921
+ {
2922
+ NodeTag type;
2923
+ ObjectType renameType; /* OBJECT_TABLE, OBJECT_COLUMN, etc */
2924
+ ObjectType relationType; /* if column name, associated relation type */
2925
+ RangeVar *relation; /* in case it's a table */
2926
+ Node *object; /* in case it's some other object */
2927
+ char *subname; /* name of contained object (column, rule,
2928
+ * trigger, etc) */
2929
+ char *newname; /* the new name */
2930
+ DropBehavior behavior; /* RESTRICT or CASCADE behavior */
2931
+ bool missing_ok; /* skip error if missing? */
2932
+ } RenameStmt;
2933
+
2934
+ /* ----------------------
2935
+ * ALTER object DEPENDS ON EXTENSION extname
2936
+ * ----------------------
2937
+ */
2938
+ typedef struct AlterObjectDependsStmt
2939
+ {
2940
+ NodeTag type;
2941
+ ObjectType objectType; /* OBJECT_FUNCTION, OBJECT_TRIGGER, etc */
2942
+ RangeVar *relation; /* in case a table is involved */
2943
+ Node *object; /* name of the object */
2944
+ Value *extname; /* extension name */
2945
+ bool remove; /* set true to remove dep rather than add */
2946
+ } AlterObjectDependsStmt;
2947
+
2948
+ /* ----------------------
2949
+ * ALTER object SET SCHEMA Statement
2950
+ * ----------------------
2951
+ */
2952
+ typedef struct AlterObjectSchemaStmt
2953
+ {
2954
+ NodeTag type;
2955
+ ObjectType objectType; /* OBJECT_TABLE, OBJECT_TYPE, etc */
2956
+ RangeVar *relation; /* in case it's a table */
2957
+ Node *object; /* in case it's some other object */
2958
+ char *newschema; /* the new schema */
2959
+ bool missing_ok; /* skip error if missing? */
2960
+ } AlterObjectSchemaStmt;
2961
+
2962
+ /* ----------------------
2963
+ * Alter Object Owner Statement
2964
+ * ----------------------
2965
+ */
2966
+ typedef struct AlterOwnerStmt
2967
+ {
2968
+ NodeTag type;
2969
+ ObjectType objectType; /* OBJECT_TABLE, OBJECT_TYPE, etc */
2970
+ RangeVar *relation; /* in case it's a table */
2971
+ Node *object; /* in case it's some other object */
2972
+ RoleSpec *newowner; /* the new owner */
2973
+ } AlterOwnerStmt;
2974
+
2975
+ /* ----------------------
2976
+ * Alter Operator Set ( this-n-that )
2977
+ * ----------------------
2978
+ */
2979
+ typedef struct AlterOperatorStmt
2980
+ {
2981
+ NodeTag type;
2982
+ ObjectWithArgs *opername; /* operator name and argument types */
2983
+ List *options; /* List of DefElem nodes */
2984
+ } AlterOperatorStmt;
2985
+
2986
+ /* ------------------------
2987
+ * Alter Type Set ( this-n-that )
2988
+ * ------------------------
2989
+ */
2990
+ typedef struct AlterTypeStmt
2991
+ {
2992
+ NodeTag type;
2993
+ List *typeName; /* type name (possibly qualified) */
2994
+ List *options; /* List of DefElem nodes */
2995
+ } AlterTypeStmt;
2996
+
2997
+ /* ----------------------
2998
+ * Create Rule Statement
2999
+ * ----------------------
3000
+ */
3001
+ typedef struct RuleStmt
3002
+ {
3003
+ NodeTag type;
3004
+ RangeVar *relation; /* relation the rule is for */
3005
+ char *rulename; /* name of the rule */
3006
+ Node *whereClause; /* qualifications */
3007
+ CmdType event; /* SELECT, INSERT, etc */
3008
+ bool instead; /* is a 'do instead'? */
3009
+ List *actions; /* the action statements */
3010
+ bool replace; /* OR REPLACE */
3011
+ } RuleStmt;
3012
+
3013
+ /* ----------------------
3014
+ * Notify Statement
3015
+ * ----------------------
3016
+ */
3017
+ typedef struct NotifyStmt
3018
+ {
3019
+ NodeTag type;
3020
+ char *conditionname; /* condition name to notify */
3021
+ char *payload; /* the payload string, or NULL if none */
3022
+ } NotifyStmt;
3023
+
3024
+ /* ----------------------
3025
+ * Listen Statement
3026
+ * ----------------------
3027
+ */
3028
+ typedef struct ListenStmt
3029
+ {
3030
+ NodeTag type;
3031
+ char *conditionname; /* condition name to listen on */
3032
+ } ListenStmt;
3033
+
3034
+ /* ----------------------
3035
+ * Unlisten Statement
3036
+ * ----------------------
3037
+ */
3038
+ typedef struct UnlistenStmt
3039
+ {
3040
+ NodeTag type;
3041
+ char *conditionname; /* name to unlisten on, or NULL for all */
3042
+ } UnlistenStmt;
3043
+
3044
+ /* ----------------------
3045
+ * {Begin|Commit|Rollback} Transaction Statement
3046
+ * ----------------------
3047
+ */
3048
+ typedef enum TransactionStmtKind
3049
+ {
3050
+ TRANS_STMT_BEGIN,
3051
+ TRANS_STMT_START, /* semantically identical to BEGIN */
3052
+ TRANS_STMT_COMMIT,
3053
+ TRANS_STMT_ROLLBACK,
3054
+ TRANS_STMT_SAVEPOINT,
3055
+ TRANS_STMT_RELEASE,
3056
+ TRANS_STMT_ROLLBACK_TO,
3057
+ TRANS_STMT_PREPARE,
3058
+ TRANS_STMT_COMMIT_PREPARED,
3059
+ TRANS_STMT_ROLLBACK_PREPARED
3060
+ } TransactionStmtKind;
3061
+
3062
+ typedef struct TransactionStmt
3063
+ {
3064
+ NodeTag type;
3065
+ TransactionStmtKind kind; /* see above */
3066
+ List *options; /* for BEGIN/START commands */
3067
+ char *savepoint_name; /* for savepoint commands */
3068
+ char *gid; /* for two-phase-commit related commands */
3069
+ bool chain; /* AND CHAIN option */
3070
+ } TransactionStmt;
3071
+
3072
+ /* ----------------------
3073
+ * Create Type Statement, composite types
3074
+ * ----------------------
3075
+ */
3076
+ typedef struct CompositeTypeStmt
3077
+ {
3078
+ NodeTag type;
3079
+ RangeVar *typevar; /* the composite type to be created */
3080
+ List *coldeflist; /* list of ColumnDef nodes */
3081
+ } CompositeTypeStmt;
3082
+
3083
+ /* ----------------------
3084
+ * Create Type Statement, enum types
3085
+ * ----------------------
3086
+ */
3087
+ typedef struct CreateEnumStmt
3088
+ {
3089
+ NodeTag type;
3090
+ List *typeName; /* qualified name (list of Value strings) */
3091
+ List *vals; /* enum values (list of Value strings) */
3092
+ } CreateEnumStmt;
3093
+
3094
+ /* ----------------------
3095
+ * Create Type Statement, range types
3096
+ * ----------------------
3097
+ */
3098
+ typedef struct CreateRangeStmt
3099
+ {
3100
+ NodeTag type;
3101
+ List *typeName; /* qualified name (list of Value strings) */
3102
+ List *params; /* range parameters (list of DefElem) */
3103
+ } CreateRangeStmt;
3104
+
3105
+ /* ----------------------
3106
+ * Alter Type Statement, enum types
3107
+ * ----------------------
3108
+ */
3109
+ typedef struct AlterEnumStmt
3110
+ {
3111
+ NodeTag type;
3112
+ List *typeName; /* qualified name (list of Value strings) */
3113
+ char *oldVal; /* old enum value's name, if renaming */
3114
+ char *newVal; /* new enum value's name */
3115
+ char *newValNeighbor; /* neighboring enum value, if specified */
3116
+ bool newValIsAfter; /* place new enum value after neighbor? */
3117
+ bool skipIfNewValExists; /* no error if new already exists? */
3118
+ } AlterEnumStmt;
3119
+
3120
+ /* ----------------------
3121
+ * Create View Statement
3122
+ * ----------------------
3123
+ */
3124
+ typedef enum ViewCheckOption
3125
+ {
3126
+ NO_CHECK_OPTION,
3127
+ LOCAL_CHECK_OPTION,
3128
+ CASCADED_CHECK_OPTION
3129
+ } ViewCheckOption;
3130
+
3131
+ typedef struct ViewStmt
3132
+ {
3133
+ NodeTag type;
3134
+ RangeVar *view; /* the view to be created */
3135
+ List *aliases; /* target column names */
3136
+ Node *query; /* the SELECT query (as a raw parse tree) */
3137
+ bool replace; /* replace an existing view? */
3138
+ List *options; /* options from WITH clause */
3139
+ ViewCheckOption withCheckOption; /* WITH CHECK OPTION */
3140
+ } ViewStmt;
3141
+
3142
+ /* ----------------------
3143
+ * Load Statement
3144
+ * ----------------------
3145
+ */
3146
+ typedef struct LoadStmt
3147
+ {
3148
+ NodeTag type;
3149
+ char *filename; /* file to load */
3150
+ } LoadStmt;
3151
+
3152
+ /* ----------------------
3153
+ * Createdb Statement
3154
+ * ----------------------
3155
+ */
3156
+ typedef struct CreatedbStmt
3157
+ {
3158
+ NodeTag type;
3159
+ char *dbname; /* name of database to create */
3160
+ List *options; /* List of DefElem nodes */
3161
+ } CreatedbStmt;
3162
+
3163
+ /* ----------------------
3164
+ * Alter Database
3165
+ * ----------------------
3166
+ */
3167
+ typedef struct AlterDatabaseStmt
3168
+ {
3169
+ NodeTag type;
3170
+ char *dbname; /* name of database to alter */
3171
+ List *options; /* List of DefElem nodes */
3172
+ } AlterDatabaseStmt;
3173
+
3174
+ typedef struct AlterDatabaseSetStmt
3175
+ {
3176
+ NodeTag type;
3177
+ char *dbname; /* database name */
3178
+ VariableSetStmt *setstmt; /* SET or RESET subcommand */
3179
+ } AlterDatabaseSetStmt;
3180
+
3181
+ /* ----------------------
3182
+ * Dropdb Statement
3183
+ * ----------------------
3184
+ */
3185
+ typedef struct DropdbStmt
3186
+ {
3187
+ NodeTag type;
3188
+ char *dbname; /* database to drop */
3189
+ bool missing_ok; /* skip error if db is missing? */
3190
+ List *options; /* currently only FORCE is supported */
3191
+ } DropdbStmt;
3192
+
3193
+ /* ----------------------
3194
+ * Alter System Statement
3195
+ * ----------------------
3196
+ */
3197
+ typedef struct AlterSystemStmt
3198
+ {
3199
+ NodeTag type;
3200
+ VariableSetStmt *setstmt; /* SET subcommand */
3201
+ } AlterSystemStmt;
3202
+
3203
+ /* ----------------------
3204
+ * Cluster Statement (support pbrown's cluster index implementation)
3205
+ * ----------------------
3206
+ */
3207
+ typedef enum ClusterOption
3208
+ {
3209
+ CLUOPT_RECHECK = 1 << 0, /* recheck relation state */
3210
+ CLUOPT_VERBOSE = 1 << 1 /* print progress info */
3211
+ } ClusterOption;
3212
+
3213
+ typedef struct ClusterStmt
3214
+ {
3215
+ NodeTag type;
3216
+ RangeVar *relation; /* relation being indexed, or NULL if all */
3217
+ char *indexname; /* original index defined */
3218
+ int options; /* OR of ClusterOption flags */
3219
+ } ClusterStmt;
3220
+
3221
+ /* ----------------------
3222
+ * Vacuum and Analyze Statements
3223
+ *
3224
+ * Even though these are nominally two statements, it's convenient to use
3225
+ * just one node type for both.
3226
+ * ----------------------
3227
+ */
3228
+ typedef struct VacuumStmt
3229
+ {
3230
+ NodeTag type;
3231
+ List *options; /* list of DefElem nodes */
3232
+ List *rels; /* list of VacuumRelation, or NIL for all */
3233
+ bool is_vacuumcmd; /* true for VACUUM, false for ANALYZE */
3234
+ } VacuumStmt;
3235
+
3236
+ /*
3237
+ * Info about a single target table of VACUUM/ANALYZE.
3238
+ *
3239
+ * If the OID field is set, it always identifies the table to process.
3240
+ * Then the relation field can be NULL; if it isn't, it's used only to report
3241
+ * failure to open/lock the relation.
3242
+ */
3243
+ typedef struct VacuumRelation
3244
+ {
3245
+ NodeTag type;
3246
+ RangeVar *relation; /* table name to process, or NULL */
3247
+ Oid oid; /* table's OID; InvalidOid if not looked up */
3248
+ List *va_cols; /* list of column names, or NIL for all */
3249
+ } VacuumRelation;
3250
+
3251
+ /* ----------------------
3252
+ * Explain Statement
3253
+ *
3254
+ * The "query" field is initially a raw parse tree, and is converted to a
3255
+ * Query node during parse analysis. Note that rewriting and planning
3256
+ * of the query are always postponed until execution.
3257
+ * ----------------------
3258
+ */
3259
+ typedef struct ExplainStmt
3260
+ {
3261
+ NodeTag type;
3262
+ Node *query; /* the query (see comments above) */
3263
+ List *options; /* list of DefElem nodes */
3264
+ } ExplainStmt;
3265
+
3266
+ /* ----------------------
3267
+ * CREATE TABLE AS Statement (a/k/a SELECT INTO)
3268
+ *
3269
+ * A query written as CREATE TABLE AS will produce this node type natively.
3270
+ * A query written as SELECT ... INTO will be transformed to this form during
3271
+ * parse analysis.
3272
+ * A query written as CREATE MATERIALIZED view will produce this node type,
3273
+ * during parse analysis, since it needs all the same data.
3274
+ *
3275
+ * The "query" field is handled similarly to EXPLAIN, though note that it
3276
+ * can be a SELECT or an EXECUTE, but not other DML statements.
3277
+ * ----------------------
3278
+ */
3279
+ typedef struct CreateTableAsStmt
3280
+ {
3281
+ NodeTag type;
3282
+ Node *query; /* the query (see comments above) */
3283
+ IntoClause *into; /* destination table */
3284
+ ObjectType relkind; /* OBJECT_TABLE or OBJECT_MATVIEW */
3285
+ bool is_select_into; /* it was written as SELECT INTO */
3286
+ bool if_not_exists; /* just do nothing if it already exists? */
3287
+ } CreateTableAsStmt;
3288
+
3289
+ /* ----------------------
3290
+ * REFRESH MATERIALIZED VIEW Statement
3291
+ * ----------------------
3292
+ */
3293
+ typedef struct RefreshMatViewStmt
3294
+ {
3295
+ NodeTag type;
3296
+ bool concurrent; /* allow concurrent access? */
3297
+ bool skipData; /* true for WITH NO DATA */
3298
+ RangeVar *relation; /* relation to insert into */
3299
+ } RefreshMatViewStmt;
3300
+
3301
+ /* ----------------------
3302
+ * Checkpoint Statement
3303
+ * ----------------------
3304
+ */
3305
+ typedef struct CheckPointStmt
3306
+ {
3307
+ NodeTag type;
3308
+ } CheckPointStmt;
3309
+
3310
+ /* ----------------------
3311
+ * Discard Statement
3312
+ * ----------------------
3313
+ */
3314
+
3315
+ typedef enum DiscardMode
3316
+ {
3317
+ DISCARD_ALL,
3318
+ DISCARD_PLANS,
3319
+ DISCARD_SEQUENCES,
3320
+ DISCARD_TEMP
3321
+ } DiscardMode;
3322
+
3323
+ typedef struct DiscardStmt
3324
+ {
3325
+ NodeTag type;
3326
+ DiscardMode target;
3327
+ } DiscardStmt;
3328
+
3329
+ /* ----------------------
3330
+ * LOCK Statement
3331
+ * ----------------------
3332
+ */
3333
+ typedef struct LockStmt
3334
+ {
3335
+ NodeTag type;
3336
+ List *relations; /* relations to lock */
3337
+ int mode; /* lock mode */
3338
+ bool nowait; /* no wait mode */
3339
+ } LockStmt;
3340
+
3341
+ /* ----------------------
3342
+ * SET CONSTRAINTS Statement
3343
+ * ----------------------
3344
+ */
3345
+ typedef struct ConstraintsSetStmt
3346
+ {
3347
+ NodeTag type;
3348
+ List *constraints; /* List of names as RangeVars */
3349
+ bool deferred;
3350
+ } ConstraintsSetStmt;
3351
+
3352
+ /* ----------------------
3353
+ * REINDEX Statement
3354
+ * ----------------------
3355
+ */
3356
+
3357
+ /* Reindex options */
3358
+ #define REINDEXOPT_VERBOSE (1 << 0) /* print progress info */
3359
+ #define REINDEXOPT_REPORT_PROGRESS (1 << 1) /* report pgstat progress */
3360
+
3361
+ typedef enum ReindexObjectType
3362
+ {
3363
+ REINDEX_OBJECT_INDEX, /* index */
3364
+ REINDEX_OBJECT_TABLE, /* table or materialized view */
3365
+ REINDEX_OBJECT_SCHEMA, /* schema */
3366
+ REINDEX_OBJECT_SYSTEM, /* system catalogs */
3367
+ REINDEX_OBJECT_DATABASE /* database */
3368
+ } ReindexObjectType;
3369
+
3370
+ typedef struct ReindexStmt
3371
+ {
3372
+ NodeTag type;
3373
+ ReindexObjectType kind; /* REINDEX_OBJECT_INDEX, REINDEX_OBJECT_TABLE,
3374
+ * etc. */
3375
+ RangeVar *relation; /* Table or index to reindex */
3376
+ const char *name; /* name of database to reindex */
3377
+ int options; /* Reindex options flags */
3378
+ bool concurrent; /* reindex concurrently? */
3379
+ } ReindexStmt;
3380
+
3381
+ /* ----------------------
3382
+ * CREATE CONVERSION Statement
3383
+ * ----------------------
3384
+ */
3385
+ typedef struct CreateConversionStmt
3386
+ {
3387
+ NodeTag type;
3388
+ List *conversion_name; /* Name of the conversion */
3389
+ char *for_encoding_name; /* source encoding name */
3390
+ char *to_encoding_name; /* destination encoding name */
3391
+ List *func_name; /* qualified conversion function name */
3392
+ bool def; /* is this a default conversion? */
3393
+ } CreateConversionStmt;
3394
+
3395
+ /* ----------------------
3396
+ * CREATE CAST Statement
3397
+ * ----------------------
3398
+ */
3399
+ typedef struct CreateCastStmt
3400
+ {
3401
+ NodeTag type;
3402
+ TypeName *sourcetype;
3403
+ TypeName *targettype;
3404
+ ObjectWithArgs *func;
3405
+ CoercionContext context;
3406
+ bool inout;
3407
+ } CreateCastStmt;
3408
+
3409
+ /* ----------------------
3410
+ * CREATE TRANSFORM Statement
3411
+ * ----------------------
3412
+ */
3413
+ typedef struct CreateTransformStmt
3414
+ {
3415
+ NodeTag type;
3416
+ bool replace;
3417
+ TypeName *type_name;
3418
+ char *lang;
3419
+ ObjectWithArgs *fromsql;
3420
+ ObjectWithArgs *tosql;
3421
+ } CreateTransformStmt;
3422
+
3423
+ /* ----------------------
3424
+ * PREPARE Statement
3425
+ * ----------------------
3426
+ */
3427
+ typedef struct PrepareStmt
3428
+ {
3429
+ NodeTag type;
3430
+ char *name; /* Name of plan, arbitrary */
3431
+ List *argtypes; /* Types of parameters (List of TypeName) */
3432
+ Node *query; /* The query itself (as a raw parsetree) */
3433
+ } PrepareStmt;
3434
+
3435
+
3436
+ /* ----------------------
3437
+ * EXECUTE Statement
3438
+ * ----------------------
3439
+ */
3440
+
3441
+ typedef struct ExecuteStmt
3442
+ {
3443
+ NodeTag type;
3444
+ char *name; /* The name of the plan to execute */
3445
+ List *params; /* Values to assign to parameters */
3446
+ } ExecuteStmt;
3447
+
3448
+
3449
+ /* ----------------------
3450
+ * DEALLOCATE Statement
3451
+ * ----------------------
3452
+ */
3453
+ typedef struct DeallocateStmt
3454
+ {
3455
+ NodeTag type;
3456
+ char *name; /* The name of the plan to remove */
3457
+ /* NULL means DEALLOCATE ALL */
3458
+ } DeallocateStmt;
3459
+
3460
+ /*
3461
+ * DROP OWNED statement
3462
+ */
3463
+ typedef struct DropOwnedStmt
3464
+ {
3465
+ NodeTag type;
3466
+ List *roles;
3467
+ DropBehavior behavior;
3468
+ } DropOwnedStmt;
3469
+
3470
+ /*
3471
+ * REASSIGN OWNED statement
3472
+ */
3473
+ typedef struct ReassignOwnedStmt
3474
+ {
3475
+ NodeTag type;
3476
+ List *roles;
3477
+ RoleSpec *newrole;
3478
+ } ReassignOwnedStmt;
3479
+
3480
+ /*
3481
+ * TS Dictionary stmts: DefineStmt, RenameStmt and DropStmt are default
3482
+ */
3483
+ typedef struct AlterTSDictionaryStmt
3484
+ {
3485
+ NodeTag type;
3486
+ List *dictname; /* qualified name (list of Value strings) */
3487
+ List *options; /* List of DefElem nodes */
3488
+ } AlterTSDictionaryStmt;
3489
+
3490
+ /*
3491
+ * TS Configuration stmts: DefineStmt, RenameStmt and DropStmt are default
3492
+ */
3493
+ typedef enum AlterTSConfigType
3494
+ {
3495
+ ALTER_TSCONFIG_ADD_MAPPING,
3496
+ ALTER_TSCONFIG_ALTER_MAPPING_FOR_TOKEN,
3497
+ ALTER_TSCONFIG_REPLACE_DICT,
3498
+ ALTER_TSCONFIG_REPLACE_DICT_FOR_TOKEN,
3499
+ ALTER_TSCONFIG_DROP_MAPPING
3500
+ } AlterTSConfigType;
3501
+
3502
+ typedef struct AlterTSConfigurationStmt
3503
+ {
3504
+ NodeTag type;
3505
+ AlterTSConfigType kind; /* ALTER_TSCONFIG_ADD_MAPPING, etc */
3506
+ List *cfgname; /* qualified name (list of Value strings) */
3507
+
3508
+ /*
3509
+ * dicts will be non-NIL if ADD/ALTER MAPPING was specified. If dicts is
3510
+ * NIL, but tokentype isn't, DROP MAPPING was specified.
3511
+ */
3512
+ List *tokentype; /* list of Value strings */
3513
+ List *dicts; /* list of list of Value strings */
3514
+ bool override; /* if true - remove old variant */
3515
+ bool replace; /* if true - replace dictionary by another */
3516
+ bool missing_ok; /* for DROP - skip error if missing? */
3517
+ } AlterTSConfigurationStmt;
3518
+
3519
+
3520
+ typedef struct CreatePublicationStmt
3521
+ {
3522
+ NodeTag type;
3523
+ char *pubname; /* Name of the publication */
3524
+ List *options; /* List of DefElem nodes */
3525
+ List *tables; /* Optional list of tables to add */
3526
+ bool for_all_tables; /* Special publication for all tables in db */
3527
+ } CreatePublicationStmt;
3528
+
3529
+ typedef struct AlterPublicationStmt
3530
+ {
3531
+ NodeTag type;
3532
+ char *pubname; /* Name of the publication */
3533
+
3534
+ /* parameters used for ALTER PUBLICATION ... WITH */
3535
+ List *options; /* List of DefElem nodes */
3536
+
3537
+ /* parameters used for ALTER PUBLICATION ... ADD/DROP TABLE */
3538
+ List *tables; /* List of tables to add/drop */
3539
+ bool for_all_tables; /* Special publication for all tables in db */
3540
+ DefElemAction tableAction; /* What action to perform with the tables */
3541
+ } AlterPublicationStmt;
3542
+
3543
+ typedef struct CreateSubscriptionStmt
3544
+ {
3545
+ NodeTag type;
3546
+ char *subname; /* Name of the subscription */
3547
+ char *conninfo; /* Connection string to publisher */
3548
+ List *publication; /* One or more publication to subscribe to */
3549
+ List *options; /* List of DefElem nodes */
3550
+ } CreateSubscriptionStmt;
3551
+
3552
+ typedef enum AlterSubscriptionType
3553
+ {
3554
+ ALTER_SUBSCRIPTION_OPTIONS,
3555
+ ALTER_SUBSCRIPTION_CONNECTION,
3556
+ ALTER_SUBSCRIPTION_PUBLICATION,
3557
+ ALTER_SUBSCRIPTION_REFRESH,
3558
+ ALTER_SUBSCRIPTION_ENABLED
3559
+ } AlterSubscriptionType;
3560
+
3561
+ typedef struct AlterSubscriptionStmt
3562
+ {
3563
+ NodeTag type;
3564
+ AlterSubscriptionType kind; /* ALTER_SUBSCRIPTION_OPTIONS, etc */
3565
+ char *subname; /* Name of the subscription */
3566
+ char *conninfo; /* Connection string to publisher */
3567
+ List *publication; /* One or more publication to subscribe to */
3568
+ List *options; /* List of DefElem nodes */
3569
+ } AlterSubscriptionStmt;
3570
+
3571
+ typedef struct DropSubscriptionStmt
3572
+ {
3573
+ NodeTag type;
3574
+ char *subname; /* Name of the subscription */
3575
+ bool missing_ok; /* Skip error if missing? */
3576
+ DropBehavior behavior; /* RESTRICT or CASCADE behavior */
3577
+ } DropSubscriptionStmt;
3578
+
3579
+ #endif /* PARSENODES_H */