PostgreSQL Source Code  git master
ruleutils.h File Reference
#include "nodes/nodes.h"
#include "nodes/parsenodes.h"
#include "nodes/pg_list.h"
Include dependency graph for ruleutils.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define RULE_INDEXDEF_PRETTY   0x01
 
#define RULE_INDEXDEF_KEYS_ONLY   0x02 /* ignore included attributes */
 

Functions

char * pg_get_indexdef_string (Oid indexrelid)
 
char * pg_get_indexdef_columns (Oid indexrelid, bool pretty)
 
char * pg_get_indexdef_columns_extended (Oid indexrelid, bits16 flags)
 
char * pg_get_querydef (Query *query, bool pretty)
 
char * pg_get_partkeydef_columns (Oid relid, bool pretty)
 
char * pg_get_partconstrdef_string (Oid partitionId, char *aliasname)
 
char * pg_get_constraintdef_command (Oid constraintId)
 
char * deparse_expression (Node *expr, List *dpcontext, bool forceprefix, bool showimplicit)
 
Listdeparse_context_for (const char *aliasname, Oid relid)
 
Listdeparse_context_for_plan_tree (struct PlannedStmt *pstmt, List *rtable_names)
 
Listset_deparse_context_plan (List *dpcontext, struct Plan *plan, List *ancestors)
 
Listselect_rtable_names_for_explain (List *rtable, Bitmapset *rels_used)
 
char * generate_collation_name (Oid collid)
 
char * generate_opclass_name (Oid opclass)
 
char * get_range_partbound_string (List *bound_datums)
 
char * pg_get_statisticsobjdef_string (Oid statextid)
 

Macro Definition Documentation

◆ RULE_INDEXDEF_KEYS_ONLY

#define RULE_INDEXDEF_KEYS_ONLY   0x02 /* ignore included attributes */

Definition at line 25 of file ruleutils.h.

◆ RULE_INDEXDEF_PRETTY

#define RULE_INDEXDEF_PRETTY   0x01

Definition at line 24 of file ruleutils.h.

Function Documentation

◆ deparse_context_for()

List* deparse_context_for ( const char *  aliasname,
Oid  relid 
)

Definition at line 3698 of file ruleutils.c.

3699 {
3700  deparse_namespace *dpns;
3701  RangeTblEntry *rte;
3702 
3703  dpns = (deparse_namespace *) palloc0(sizeof(deparse_namespace));
3704 
3705  /* Build a minimal RTE for the rel */
3706  rte = makeNode(RangeTblEntry);
3707  rte->rtekind = RTE_RELATION;
3708  rte->relid = relid;
3709  rte->relkind = RELKIND_RELATION; /* no need for exactness here */
3710  rte->rellockmode = AccessShareLock;
3711  rte->alias = makeAlias(aliasname, NIL);
3712  rte->eref = rte->alias;
3713  rte->lateral = false;
3714  rte->inh = false;
3715  rte->inFromCl = true;
3716 
3717  /* Build one-element rtable */
3718  dpns->rtable = list_make1(rte);
3719  dpns->subplans = NIL;
3720  dpns->ctes = NIL;
3721  dpns->appendrels = NULL;
3722  set_rtable_names(dpns, NIL, NULL);
3724 
3725  /* Return a one-deep namespace stack */
3726  return list_make1(dpns);
3727 }
#define AccessShareLock
Definition: lockdefs.h:36
Alias * makeAlias(const char *aliasname, List *colnames)
Definition: makefuncs.c:389
void * palloc0(Size size)
Definition: mcxt.c:1347
#define makeNode(_type_)
Definition: nodes.h:155
@ RTE_RELATION
Definition: parsenodes.h:1017
#define NIL
Definition: pg_list.h:68
#define list_make1(x1)
Definition: pg_list.h:212
static void set_simple_column_names(deparse_namespace *dpns)
Definition: ruleutils.c:4074
static void set_rtable_names(deparse_namespace *dpns, List *parent_namespaces, Bitmapset *rels_used)
Definition: ruleutils.c:3864
RTEKind rtekind
Definition: parsenodes.h:1047
AppendRelInfo ** appendrels
Definition: ruleutils.c:169

References AccessShareLock, deparse_namespace::appendrels, deparse_namespace::ctes, RangeTblEntry::inh, list_make1, makeAlias(), makeNode, NIL, palloc0(), RangeTblEntry::relid, deparse_namespace::rtable, RTE_RELATION, RangeTblEntry::rtekind, set_rtable_names(), set_simple_column_names(), and deparse_namespace::subplans.

Referenced by pg_get_constraintdef_worker(), pg_get_expr_worker(), pg_get_indexdef_worker(), pg_get_partconstrdef_string(), pg_get_partition_constraintdef(), pg_get_partkeydef_worker(), pg_get_statisticsobj_worker(), pg_get_statisticsobjdef_expressions(), transformPartitionBound(), and transformPartitionRangeBounds().

◆ deparse_context_for_plan_tree()

List* deparse_context_for_plan_tree ( struct PlannedStmt pstmt,
List rtable_names 
)

Definition at line 3743 of file ruleutils.c.

3744 {
3745  deparse_namespace *dpns;
3746 
3747  dpns = (deparse_namespace *) palloc0(sizeof(deparse_namespace));
3748 
3749  /* Initialize fields that stay the same across the whole plan tree */
3750  dpns->rtable = pstmt->rtable;
3751  dpns->rtable_names = rtable_names;
3752  dpns->subplans = pstmt->subplans;
3753  dpns->ctes = NIL;
3754  if (pstmt->appendRelations)
3755  {
3756  /* Set up the array, indexed by child relid */
3757  int ntables = list_length(dpns->rtable);
3758  ListCell *lc;
3759 
3760  dpns->appendrels = (AppendRelInfo **)
3761  palloc0((ntables + 1) * sizeof(AppendRelInfo *));
3762  foreach(lc, pstmt->appendRelations)
3763  {
3764  AppendRelInfo *appinfo = lfirst_node(AppendRelInfo, lc);
3765  Index crelid = appinfo->child_relid;
3766 
3767  Assert(crelid > 0 && crelid <= ntables);
3768  Assert(dpns->appendrels[crelid] == NULL);
3769  dpns->appendrels[crelid] = appinfo;
3770  }
3771  }
3772  else
3773  dpns->appendrels = NULL; /* don't need it */
3774 
3775  /*
3776  * Set up column name aliases. We will get rather bogus results for join
3777  * RTEs, but that doesn't matter because plan trees don't contain any join
3778  * alias Vars.
3779  */
3781 
3782  /* Return a one-deep namespace stack */
3783  return list_make1(dpns);
3784 }
#define Assert(condition)
Definition: c.h:837
unsigned int Index
Definition: c.h:593
#define lfirst_node(type, lc)
Definition: pg_list.h:176
static int list_length(const List *l)
Definition: pg_list.h:152
Index child_relid
Definition: pathnodes.h:2980
List * appendRelations
Definition: plannodes.h:80
List * subplans
Definition: plannodes.h:82
List * rtable
Definition: plannodes.h:72
List * rtable_names
Definition: ruleutils.c:165

References PlannedStmt::appendRelations, deparse_namespace::appendrels, Assert, AppendRelInfo::child_relid, deparse_namespace::ctes, lfirst_node, list_length(), list_make1, NIL, palloc0(), deparse_namespace::rtable, PlannedStmt::rtable, deparse_namespace::rtable_names, set_simple_column_names(), deparse_namespace::subplans, and PlannedStmt::subplans.

Referenced by ExplainPrintPlan().

◆ deparse_expression()

char* deparse_expression ( Node expr,
List dpcontext,
bool  forceprefix,
bool  showimplicit 
)

Definition at line 3635 of file ruleutils.c.

3637 {
3638  return deparse_expression_pretty(expr, dpcontext, forceprefix,
3639  showimplicit, 0, 0);
3640 }
static char * deparse_expression_pretty(Node *expr, List *dpcontext, bool forceprefix, bool showimplicit, int prettyFlags, int startIndent)
Definition: ruleutils.c:3662

References deparse_expression_pretty().

Referenced by AlterDomainDefault(), DefineDomain(), pg_get_function_arg_default(), pg_get_partconstrdef_string(), print_function_arguments(), show_expression(), show_grouping_set_keys(), show_memoize_info(), show_plan_tlist(), show_sort_group_keys(), show_tablesample(), transformPartitionBound(), and transformPartitionRangeBounds().

◆ generate_collation_name()

char* generate_collation_name ( Oid  collid)

Definition at line 13382 of file ruleutils.c.

13383 {
13384  HeapTuple tp;
13385  Form_pg_collation colltup;
13386  char *collname;
13387  char *nspname;
13388  char *result;
13389 
13390  tp = SearchSysCache1(COLLOID, ObjectIdGetDatum(collid));
13391  if (!HeapTupleIsValid(tp))
13392  elog(ERROR, "cache lookup failed for collation %u", collid);
13393  colltup = (Form_pg_collation) GETSTRUCT(tp);
13394  collname = NameStr(colltup->collname);
13395 
13396  if (!CollationIsVisible(collid))
13397  nspname = get_namespace_name_or_temp(colltup->collnamespace);
13398  else
13399  nspname = NULL;
13400 
13401  result = quote_qualified_identifier(nspname, collname);
13402 
13403  ReleaseSysCache(tp);
13404 
13405  return result;
13406 }
#define NameStr(name)
Definition: c.h:725
Oid collid
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:225
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define GETSTRUCT(TUP)
Definition: htup_details.h:653
char * get_namespace_name_or_temp(Oid nspid)
Definition: lsyscache.c:3390
bool CollationIsVisible(Oid collid)
Definition: namespace.c:2407
FormData_pg_collation * Form_pg_collation
Definition: pg_collation.h:58
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:252
char * quote_qualified_identifier(const char *qualifier, const char *ident)
Definition: ruleutils.c:12952
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:269
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:221

References CollationIsVisible(), collid, elog, ERROR, get_namespace_name_or_temp(), GETSTRUCT, HeapTupleIsValid, NameStr, ObjectIdGetDatum(), quote_qualified_identifier(), ReleaseSysCache(), and SearchSysCache1().

Referenced by get_const_collation(), get_from_clause_coldeflist(), get_rule_expr(), pg_collation_for(), pg_get_indexdef_worker(), and pg_get_partkeydef_worker().

◆ generate_opclass_name()

char* generate_opclass_name ( Oid  opclass)

Definition at line 12738 of file ruleutils.c.

12739 {
12741 
12742  initStringInfo(&buf);
12743  get_opclass_name(opclass, InvalidOid, &buf);
12744 
12745  return &buf.data[1]; /* get_opclass_name() prepends space */
12746 }
static char * buf
Definition: pg_test_fsync.c:72
#define InvalidOid
Definition: postgres_ext.h:36
static void get_opclass_name(Oid opclass, Oid actual_datatype, StringInfo buf)
Definition: ruleutils.c:12700
void initStringInfo(StringInfo str)
Definition: stringinfo.c:56

References buf, get_opclass_name(), initStringInfo(), and InvalidOid.

Referenced by index_opclass_options().

◆ get_range_partbound_string()

char* get_range_partbound_string ( List bound_datums)

Definition at line 13515 of file ruleutils.c.

13516 {
13519  ListCell *cell;
13520  char *sep;
13521 
13522  memset(&context, 0, sizeof(deparse_context));
13523  context.buf = buf;
13524 
13525  appendStringInfoChar(buf, '(');
13526  sep = "";
13527  foreach(cell, bound_datums)
13528  {
13529  PartitionRangeDatum *datum =
13531 
13533  if (datum->kind == PARTITION_RANGE_DATUM_MINVALUE)
13534  appendStringInfoString(buf, "MINVALUE");
13535  else if (datum->kind == PARTITION_RANGE_DATUM_MAXVALUE)
13536  appendStringInfoString(buf, "MAXVALUE");
13537  else
13538  {
13539  Const *val = castNode(Const, datum->value);
13540 
13541  get_const_expr(val, &context, -1);
13542  }
13543  sep = ", ";
13544  }
13545  appendStringInfoChar(buf, ')');
13546 
13547  return buf->data;
13548 }
long val
Definition: informix.c:689
#define castNode(_type_, nodeptr)
Definition: nodes.h:176
@ PARTITION_RANGE_DATUM_MAXVALUE
Definition: parsenodes.h:928
@ PARTITION_RANGE_DATUM_MINVALUE
Definition: parsenodes.h:926
tree context
Definition: radixtree.h:1835
static void get_const_expr(Const *constval, deparse_context *context, int showtype)
Definition: ruleutils.c:11305
StringInfo makeStringInfo(void)
Definition: stringinfo.c:38
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:179
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:191
PartitionRangeDatumKind kind
Definition: parsenodes.h:935

References appendStringInfoChar(), appendStringInfoString(), buf, castNode, context, get_const_expr(), PartitionRangeDatum::kind, lfirst_node, makeStringInfo(), PARTITION_RANGE_DATUM_MAXVALUE, PARTITION_RANGE_DATUM_MINVALUE, val, and PartitionRangeDatum::value.

Referenced by check_new_partition_bound(), and get_rule_expr().

◆ pg_get_constraintdef_command()

char* pg_get_constraintdef_command ( Oid  constraintId)

Definition at line 2178 of file ruleutils.c.

2179 {
2180  return pg_get_constraintdef_worker(constraintId, true, 0, false);
2181 }
static char * pg_get_constraintdef_worker(Oid constraintId, bool fullCommand, int prettyFlags, bool missing_ok)
Definition: ruleutils.c:2187

References pg_get_constraintdef_worker().

Referenced by RememberConstraintForRebuilding().

◆ pg_get_indexdef_columns()

char* pg_get_indexdef_columns ( Oid  indexrelid,
bool  pretty 
)

Definition at line 1229 of file ruleutils.c.

1230 {
1231  int prettyFlags;
1232 
1233  prettyFlags = GET_PRETTY_FLAGS(pretty);
1234 
1235  return pg_get_indexdef_worker(indexrelid, 0, NULL,
1236  true, true,
1237  false, false,
1238  prettyFlags, false);
1239 }
static char * pg_get_indexdef_worker(Oid indexrelid, int colno, const Oid *excludeOps, bool attrsOnly, bool keysOnly, bool showTblSpc, bool inherits, int prettyFlags, bool missing_ok)
Definition: ruleutils.c:1264
#define GET_PRETTY_FLAGS(pretty)
Definition: ruleutils.c:93

References GET_PRETTY_FLAGS, and pg_get_indexdef_worker().

Referenced by BuildIndexValueDescription().

◆ pg_get_indexdef_columns_extended()

char* pg_get_indexdef_columns_extended ( Oid  indexrelid,
bits16  flags 
)

Definition at line 1243 of file ruleutils.c.

1244 {
1245  bool pretty = ((flags & RULE_INDEXDEF_PRETTY) != 0);
1246  bool keys_only = ((flags & RULE_INDEXDEF_KEYS_ONLY) != 0);
1247  int prettyFlags;
1248 
1249  prettyFlags = GET_PRETTY_FLAGS(pretty);
1250 
1251  return pg_get_indexdef_worker(indexrelid, 0, NULL,
1252  true, keys_only,
1253  false, false,
1254  prettyFlags, false);
1255 }
#define RULE_INDEXDEF_PRETTY
Definition: ruleutils.h:24
#define RULE_INDEXDEF_KEYS_ONLY
Definition: ruleutils.h:25

References GET_PRETTY_FLAGS, pg_get_indexdef_worker(), RULE_INDEXDEF_KEYS_ONLY, and RULE_INDEXDEF_PRETTY.

Referenced by gist_page_items().

◆ pg_get_indexdef_string()

char* pg_get_indexdef_string ( Oid  indexrelid)

Definition at line 1219 of file ruleutils.c.

1220 {
1221  return pg_get_indexdef_worker(indexrelid, 0, NULL,
1222  false, false,
1223  true, true,
1224  0, false);
1225 }

References pg_get_indexdef_worker().

Referenced by RememberIndexForRebuilding().

◆ pg_get_partconstrdef_string()

char* pg_get_partconstrdef_string ( Oid  partitionId,
char *  aliasname 
)

Definition at line 2122 of file ruleutils.c.

2123 {
2124  Expr *constr_expr;
2125  List *context;
2126 
2127  constr_expr = get_partition_qual_relid(partitionId);
2128  context = deparse_context_for(aliasname, partitionId);
2129 
2130  return deparse_expression((Node *) constr_expr, context, true, false);
2131 }
Expr * get_partition_qual_relid(Oid relid)
Definition: partcache.c:299
char * deparse_expression(Node *expr, List *dpcontext, bool forceprefix, bool showimplicit)
Definition: ruleutils.c:3635
List * deparse_context_for(const char *aliasname, Oid relid)
Definition: ruleutils.c:3698
Definition: pg_list.h:54
Definition: nodes.h:129

References context, deparse_context_for(), deparse_expression(), and get_partition_qual_relid().

Referenced by RI_PartitionRemove_Check().

◆ pg_get_partkeydef_columns()

char* pg_get_partkeydef_columns ( Oid  relid,
bool  pretty 
)

Definition at line 1918 of file ruleutils.c.

1919 {
1920  int prettyFlags;
1921 
1922  prettyFlags = GET_PRETTY_FLAGS(pretty);
1923 
1924  return pg_get_partkeydef_worker(relid, prettyFlags, true, false);
1925 }
static char * pg_get_partkeydef_worker(Oid relid, int prettyFlags, bool attrsOnly, bool missing_ok)
Definition: ruleutils.c:1931

References GET_PRETTY_FLAGS, and pg_get_partkeydef_worker().

Referenced by ExecBuildSlotPartitionKeyDescription().

◆ pg_get_querydef()

char* pg_get_querydef ( Query query,
bool  pretty 
)

Definition at line 1582 of file ruleutils.c.

1583 {
1585  int prettyFlags;
1586 
1587  prettyFlags = GET_PRETTY_FLAGS(pretty);
1588 
1589  initStringInfo(&buf);
1590 
1591  get_query_def(query, &buf, NIL, NULL, true,
1592  prettyFlags, WRAP_COLUMN_DEFAULT, 0);
1593 
1594  return buf.data;
1595 }
static void get_query_def(Query *query, StringInfo buf, List *parentnamespace, TupleDesc resultDesc, bool colNamesVisible, int prettyFlags, int wrapColumn, int startIndent)
Definition: ruleutils.c:5599
#define WRAP_COLUMN_DEFAULT
Definition: ruleutils.c:98

References buf, GET_PRETTY_FLAGS, get_query_def(), initStringInfo(), NIL, and WRAP_COLUMN_DEFAULT.

◆ pg_get_statisticsobjdef_string()

char* pg_get_statisticsobjdef_string ( Oid  statextid)

Definition at line 1621 of file ruleutils.c.

1622 {
1623  return pg_get_statisticsobj_worker(statextid, false, false);
1624 }
static char * pg_get_statisticsobj_worker(Oid statextid, bool columns_only, bool missing_ok)
Definition: ruleutils.c:1648

References pg_get_statisticsobj_worker().

Referenced by RememberStatisticsForRebuilding().

◆ select_rtable_names_for_explain()

List* select_rtable_names_for_explain ( List rtable,
Bitmapset rels_used 
)

Definition at line 3835 of file ruleutils.c.

3836 {
3837  deparse_namespace dpns;
3838 
3839  memset(&dpns, 0, sizeof(dpns));
3840  dpns.rtable = rtable;
3841  dpns.subplans = NIL;
3842  dpns.ctes = NIL;
3843  dpns.appendrels = NULL;
3844  set_rtable_names(&dpns, NIL, rels_used);
3845  /* We needn't bother computing column aliases yet */
3846 
3847  return dpns.rtable_names;
3848 }

References deparse_namespace::appendrels, deparse_namespace::ctes, NIL, deparse_namespace::rtable, deparse_namespace::rtable_names, set_rtable_names(), and deparse_namespace::subplans.

Referenced by ExplainPrintPlan().

◆ set_deparse_context_plan()

List* set_deparse_context_plan ( List dpcontext,
struct Plan plan,
List ancestors 
)

Definition at line 3812 of file ruleutils.c.

3813 {
3814  deparse_namespace *dpns;
3815 
3816  /* Should always have one-entry namespace list for Plan deparsing */
3817  Assert(list_length(dpcontext) == 1);
3818  dpns = (deparse_namespace *) linitial(dpcontext);
3819 
3820  /* Set our attention on the specific plan node passed in */
3821  dpns->ancestors = ancestors;
3822  set_deparse_plan(dpns, plan);
3823 
3824  return dpcontext;
3825 }
#define linitial(l)
Definition: pg_list.h:178
#define plan(x)
Definition: pg_regress.c:161
static void set_deparse_plan(deparse_namespace *dpns, Plan *plan)
Definition: ruleutils.c:5127

References deparse_namespace::ancestors, Assert, linitial, list_length(), plan, and set_deparse_plan().

Referenced by show_expression(), show_grouping_sets(), show_memoize_info(), show_plan_tlist(), show_sort_group_keys(), and show_tablesample().