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 3660 of file ruleutils.c.

3661 {
3662  deparse_namespace *dpns;
3663  RangeTblEntry *rte;
3664 
3665  dpns = (deparse_namespace *) palloc0(sizeof(deparse_namespace));
3666 
3667  /* Build a minimal RTE for the rel */
3668  rte = makeNode(RangeTblEntry);
3669  rte->rtekind = RTE_RELATION;
3670  rte->relid = relid;
3671  rte->relkind = RELKIND_RELATION; /* no need for exactness here */
3673  rte->alias = makeAlias(aliasname, NIL);
3674  rte->eref = rte->alias;
3675  rte->lateral = false;
3676  rte->inh = false;
3677  rte->inFromCl = true;
3678 
3679  /* Build one-element rtable */
3680  dpns->rtable = list_make1(rte);
3681  dpns->subplans = NIL;
3682  dpns->ctes = NIL;
3683  dpns->appendrels = NULL;
3684  set_rtable_names(dpns, NIL, NULL);
3686 
3687  /* Return a one-deep namespace stack */
3688  return list_make1(dpns);
3689 }
#define AccessShareLock
Definition: lockdefs.h:36
Alias * makeAlias(const char *aliasname, List *colnames)
Definition: makefuncs.c:390
void * palloc0(Size size)
Definition: mcxt.c:1257
#define makeNode(_type_)
Definition: nodes.h:176
@ RTE_RELATION
Definition: parsenodes.h:1006
#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:4036
static void set_rtable_names(deparse_namespace *dpns, List *parent_namespaces, Bitmapset *rels_used)
Definition: ruleutils.c:3826
Alias * eref
Definition: parsenodes.h:1192
Alias * alias
Definition: parsenodes.h:1191
RTEKind rtekind
Definition: parsenodes.h:1025
AppendRelInfo ** appendrels
Definition: ruleutils.c:169

References AccessShareLock, RangeTblEntry::alias, deparse_namespace::appendrels, deparse_namespace::ctes, RangeTblEntry::eref, RangeTblEntry::inFromCl, RangeTblEntry::inh, RangeTblEntry::lateral, list_make1, makeAlias(), makeNode, NIL, palloc0(), RangeTblEntry::relid, RangeTblEntry::relkind, RangeTblEntry::rellockmode, 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 3705 of file ruleutils.c.

3706 {
3707  deparse_namespace *dpns;
3708 
3709  dpns = (deparse_namespace *) palloc0(sizeof(deparse_namespace));
3710 
3711  /* Initialize fields that stay the same across the whole plan tree */
3712  dpns->rtable = pstmt->rtable;
3713  dpns->rtable_names = rtable_names;
3714  dpns->subplans = pstmt->subplans;
3715  dpns->ctes = NIL;
3716  if (pstmt->appendRelations)
3717  {
3718  /* Set up the array, indexed by child relid */
3719  int ntables = list_length(dpns->rtable);
3720  ListCell *lc;
3721 
3722  dpns->appendrels = (AppendRelInfo **)
3723  palloc0((ntables + 1) * sizeof(AppendRelInfo *));
3724  foreach(lc, pstmt->appendRelations)
3725  {
3726  AppendRelInfo *appinfo = lfirst_node(AppendRelInfo, lc);
3727  Index crelid = appinfo->child_relid;
3728 
3729  Assert(crelid > 0 && crelid <= ntables);
3730  Assert(dpns->appendrels[crelid] == NULL);
3731  dpns->appendrels[crelid] = appinfo;
3732  }
3733  }
3734  else
3735  dpns->appendrels = NULL; /* don't need it */
3736 
3737  /*
3738  * Set up column name aliases. We will get rather bogus results for join
3739  * RTEs, but that doesn't matter because plan trees don't contain any join
3740  * alias Vars.
3741  */
3743 
3744  /* Return a one-deep namespace stack */
3745  return list_make1(dpns);
3746 }
unsigned int Index
Definition: c.h:603
Assert(fmt[strlen(fmt) - 1] !='\n')
#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:2929
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 3600 of file ruleutils.c.

3602 {
3603  return deparse_expression_pretty(expr, dpcontext, forceprefix,
3604  showimplicit, 0, 0);
3605 }
static char * deparse_expression_pretty(Node *expr, List *dpcontext, bool forceprefix, bool showimplicit, int prettyFlags, int startIndent)
Definition: ruleutils.c:3627

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 12487 of file ruleutils.c.

12488 {
12489  HeapTuple tp;
12490  Form_pg_collation colltup;
12491  char *collname;
12492  char *nspname;
12493  char *result;
12494 
12496  if (!HeapTupleIsValid(tp))
12497  elog(ERROR, "cache lookup failed for collation %u", collid);
12498  colltup = (Form_pg_collation) GETSTRUCT(tp);
12499  collname = NameStr(colltup->collname);
12500 
12501  if (!CollationIsVisible(collid))
12502  nspname = get_namespace_name_or_temp(colltup->collnamespace);
12503  else
12504  nspname = NULL;
12505 
12506  result = quote_qualified_identifier(nspname, collname);
12507 
12508  ReleaseSysCache(tp);
12509 
12510  return result;
12511 }
#define NameStr(name)
Definition: c.h:735
Oid collid
#define ERROR
Definition: elog.h:39
#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:3372
bool CollationIsVisible(Oid collid)
Definition: namespace.c:2348
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:12059
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:868
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:820
@ COLLOID
Definition: syscache.h:50

References CollationIsVisible(), collid, COLLOID, 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 11845 of file ruleutils.c.

11846 {
11848 
11849  initStringInfo(&buf);
11850  get_opclass_name(opclass, InvalidOid, &buf);
11851 
11852  return &buf.data[1]; /* get_opclass_name() prepends space */
11853 }
static char * buf
Definition: pg_test_fsync.c:73
#define InvalidOid
Definition: postgres_ext.h:36
static void get_opclass_name(Oid opclass, Oid actual_datatype, StringInfo buf)
Definition: ruleutils.c:11807
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59

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 12620 of file ruleutils.c.

12621 {
12622  deparse_context context;
12624  ListCell *cell;
12625  char *sep;
12626 
12627  memset(&context, 0, sizeof(deparse_context));
12628  context.buf = buf;
12629 
12630  appendStringInfoChar(buf, '(');
12631  sep = "";
12632  foreach(cell, bound_datums)
12633  {
12634  PartitionRangeDatum *datum =
12636 
12638  if (datum->kind == PARTITION_RANGE_DATUM_MINVALUE)
12639  appendStringInfoString(buf, "MINVALUE");
12640  else if (datum->kind == PARTITION_RANGE_DATUM_MAXVALUE)
12641  appendStringInfoString(buf, "MAXVALUE");
12642  else
12643  {
12644  Const *val = castNode(Const, datum->value);
12645 
12646  get_const_expr(val, &context, -1);
12647  }
12648  sep = ", ";
12649  }
12650  appendStringInfoChar(buf, ')');
12651 
12652  return buf->data;
12653 }
long val
Definition: informix.c:664
#define castNode(_type_, nodeptr)
Definition: nodes.h:197
@ PARTITION_RANGE_DATUM_MAXVALUE
Definition: parsenodes.h:913
@ PARTITION_RANGE_DATUM_MINVALUE
Definition: parsenodes.h:911
static void get_const_expr(Const *constval, deparse_context *context, int showtype)
Definition: ruleutils.c:10643
StringInfo makeStringInfo(void)
Definition: stringinfo.c:41
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:182
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:194
PartitionRangeDatumKind kind
Definition: parsenodes.h:920
StringInfo buf
Definition: ruleutils.c:116

References appendStringInfoChar(), appendStringInfoString(), deparse_context::buf, buf, castNode, 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 2155 of file ruleutils.c.

2156 {
2157  return pg_get_constraintdef_worker(constraintId, true, 0, false);
2158 }
static char * pg_get_constraintdef_worker(Oid constraintId, bool fullCommand, int prettyFlags, bool missing_ok)
Definition: ruleutils.c:2164

References pg_get_constraintdef_worker().

Referenced by RememberConstraintForRebuilding().

◆ pg_get_indexdef_columns()

char* pg_get_indexdef_columns ( Oid  indexrelid,
bool  pretty 
)

Definition at line 1206 of file ruleutils.c.

1207 {
1208  int prettyFlags;
1209 
1210  prettyFlags = GET_PRETTY_FLAGS(pretty);
1211 
1212  return pg_get_indexdef_worker(indexrelid, 0, NULL,
1213  true, true,
1214  false, false,
1215  prettyFlags, false);
1216 }
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:1241
#define GET_PRETTY_FLAGS(pretty)
Definition: ruleutils.c:95

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 1220 of file ruleutils.c.

1221 {
1222  bool pretty = ((flags & RULE_INDEXDEF_PRETTY) != 0);
1223  bool keys_only = ((flags & RULE_INDEXDEF_KEYS_ONLY) != 0);
1224  int prettyFlags;
1225 
1226  prettyFlags = GET_PRETTY_FLAGS(pretty);
1227 
1228  return pg_get_indexdef_worker(indexrelid, 0, NULL,
1229  true, keys_only,
1230  false, false,
1231  prettyFlags, false);
1232 }
#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 1196 of file ruleutils.c.

1197 {
1198  return pg_get_indexdef_worker(indexrelid, 0, NULL,
1199  false, false,
1200  true, true,
1201  0, false);
1202 }

References pg_get_indexdef_worker().

Referenced by RememberIndexForRebuilding().

◆ pg_get_partconstrdef_string()

char* pg_get_partconstrdef_string ( Oid  partitionId,
char *  aliasname 
)

Definition at line 2099 of file ruleutils.c.

2100 {
2101  Expr *constr_expr;
2102  List *context;
2103 
2104  constr_expr = get_partition_qual_relid(partitionId);
2105  context = deparse_context_for(aliasname, partitionId);
2106 
2107  return deparse_expression((Node *) constr_expr, context, true, false);
2108 }
Expr * get_partition_qual_relid(Oid relid)
Definition: partcache.c:302
char * deparse_expression(Node *expr, List *dpcontext, bool forceprefix, bool showimplicit)
Definition: ruleutils.c:3600
List * deparse_context_for(const char *aliasname, Oid relid)
Definition: ruleutils.c:3660
Definition: pg_list.h:54
Definition: nodes.h:129

References 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 1895 of file ruleutils.c.

1896 {
1897  int prettyFlags;
1898 
1899  prettyFlags = GET_PRETTY_FLAGS(pretty);
1900 
1901  return pg_get_partkeydef_worker(relid, prettyFlags, true, false);
1902 }
static char * pg_get_partkeydef_worker(Oid relid, int prettyFlags, bool attrsOnly, bool missing_ok)
Definition: ruleutils.c:1908

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 1559 of file ruleutils.c.

1560 {
1562  int prettyFlags;
1563 
1564  prettyFlags = GET_PRETTY_FLAGS(pretty);
1565 
1566  initStringInfo(&buf);
1567 
1568  get_query_def(query, &buf, NIL, NULL, true,
1569  prettyFlags, WRAP_COLUMN_DEFAULT, 0);
1570 
1571  return buf.data;
1572 }
static void get_query_def(Query *query, StringInfo buf, List *parentnamespace, TupleDesc resultDesc, bool colNamesVisible, int prettyFlags, int wrapColumn, int startIndent)
Definition: ruleutils.c:5429
#define WRAP_COLUMN_DEFAULT
Definition: ruleutils.c:100

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 1598 of file ruleutils.c.

1599 {
1600  return pg_get_statisticsobj_worker(statextid, false, false);
1601 }
static char * pg_get_statisticsobj_worker(Oid statextid, bool columns_only, bool missing_ok)
Definition: ruleutils.c:1625

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 3797 of file ruleutils.c.

3798 {
3799  deparse_namespace dpns;
3800 
3801  memset(&dpns, 0, sizeof(dpns));
3802  dpns.rtable = rtable;
3803  dpns.subplans = NIL;
3804  dpns.ctes = NIL;
3805  dpns.appendrels = NULL;
3806  set_rtable_names(&dpns, NIL, rels_used);
3807  /* We needn't bother computing column aliases yet */
3808 
3809  return dpns.rtable_names;
3810 }

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 3774 of file ruleutils.c.

3775 {
3776  deparse_namespace *dpns;
3777 
3778  /* Should always have one-entry namespace list for Plan deparsing */
3779  Assert(list_length(dpcontext) == 1);
3780  dpns = (deparse_namespace *) linitial(dpcontext);
3781 
3782  /* Set our attention on the specific plan node passed in */
3783  dpns->ancestors = ancestors;
3784  set_deparse_plan(dpns, plan);
3785 
3786  return dpcontext;
3787 }
#define linitial(l)
Definition: pg_list.h:178
#define plan(x)
Definition: pg_regress.c:162
static void set_deparse_plan(deparse_namespace *dpns, Plan *plan)
Definition: ruleutils.c:4963

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().