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.

Functions

char * pg_get_indexdef_string (Oid indexrelid)
 
char * pg_get_indexdef_columns (Oid indexrelid, bool pretty)
 
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)
 

Function Documentation

◆ deparse_context_for()

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

Definition at line 3656 of file ruleutils.c.

3657 {
3658  deparse_namespace *dpns;
3659  RangeTblEntry *rte;
3660 
3661  dpns = (deparse_namespace *) palloc0(sizeof(deparse_namespace));
3662 
3663  /* Build a minimal RTE for the rel */
3664  rte = makeNode(RangeTblEntry);
3665  rte->rtekind = RTE_RELATION;
3666  rte->relid = relid;
3667  rte->relkind = RELKIND_RELATION; /* no need for exactness here */
3669  rte->alias = makeAlias(aliasname, NIL);
3670  rte->eref = rte->alias;
3671  rte->lateral = false;
3672  rte->inh = false;
3673  rte->inFromCl = true;
3674 
3675  /* Build one-element rtable */
3676  dpns->rtable = list_make1(rte);
3677  dpns->subplans = NIL;
3678  dpns->ctes = NIL;
3679  dpns->appendrels = NULL;
3680  set_rtable_names(dpns, NIL, NULL);
3682 
3683  /* Return a one-deep namespace stack */
3684  return list_make1(dpns);
3685 }
#define AccessShareLock
Definition: lockdefs.h:36
Alias * makeAlias(const char *aliasname, List *colnames)
Definition: makefuncs.c:389
void * palloc0(Size size)
Definition: mcxt.c:1241
#define makeNode(_type_)
Definition: nodes.h:176
@ RTE_RELATION
Definition: parsenodes.h:1013
#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:4032
static void set_rtable_names(deparse_namespace *dpns, List *parent_namespaces, Bitmapset *rels_used)
Definition: ruleutils.c:3822
Alias * eref
Definition: parsenodes.h:1199
Alias * alias
Definition: parsenodes.h:1198
RTEKind rtekind
Definition: parsenodes.h:1032
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 3701 of file ruleutils.c.

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

3598 {
3599  return deparse_expression_pretty(expr, dpcontext, forceprefix,
3600  showimplicit, 0, 0);
3601 }
static char * deparse_expression_pretty(Node *expr, List *dpcontext, bool forceprefix, bool showimplicit, int prettyFlags, int startIndent)
Definition: ruleutils.c:3623

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

12042 {
12043  HeapTuple tp;
12044  Form_pg_collation colltup;
12045  char *collname;
12046  char *nspname;
12047  char *result;
12048 
12050  if (!HeapTupleIsValid(tp))
12051  elog(ERROR, "cache lookup failed for collation %u", collid);
12052  colltup = (Form_pg_collation) GETSTRUCT(tp);
12053  collname = NameStr(colltup->collname);
12054 
12055  if (!CollationIsVisible(collid))
12056  nspname = get_namespace_name_or_temp(colltup->collnamespace);
12057  else
12058  nspname = NULL;
12059 
12060  result = quote_qualified_identifier(nspname, collname);
12061 
12062  ReleaseSysCache(tp);
12063 
12064  return result;
12065 }
#define NameStr(name)
Definition: c.h:730
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:3355
bool CollationIsVisible(Oid collid)
Definition: namespace.c:2091
FormData_pg_collation * Form_pg_collation
Definition: pg_collation.h:57
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:252
char * quote_qualified_identifier(const char *qualifier, const char *ident)
Definition: ruleutils.c:11613
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:865
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:817
@ 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 11399 of file ruleutils.c.

11400 {
11402 
11403  initStringInfo(&buf);
11404  get_opclass_name(opclass, InvalidOid, &buf);
11405 
11406  return &buf.data[1]; /* get_opclass_name() prepends space */
11407 }
static char * buf
Definition: pg_test_fsync.c:67
#define InvalidOid
Definition: postgres_ext.h:36
static void get_opclass_name(Oid opclass, Oid actual_datatype, StringInfo buf)
Definition: ruleutils.c:11361
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 12174 of file ruleutils.c.

12175 {
12176  deparse_context context;
12178  ListCell *cell;
12179  char *sep;
12180 
12181  memset(&context, 0, sizeof(deparse_context));
12182  context.buf = buf;
12183 
12184  appendStringInfoChar(buf, '(');
12185  sep = "";
12186  foreach(cell, bound_datums)
12187  {
12188  PartitionRangeDatum *datum =
12190 
12192  if (datum->kind == PARTITION_RANGE_DATUM_MINVALUE)
12193  appendStringInfoString(buf, "MINVALUE");
12194  else if (datum->kind == PARTITION_RANGE_DATUM_MAXVALUE)
12195  appendStringInfoString(buf, "MAXVALUE");
12196  else
12197  {
12198  Const *val = castNode(Const, datum->value);
12199 
12200  get_const_expr(val, &context, -1);
12201  }
12202  sep = ", ";
12203  }
12204  appendStringInfoChar(buf, ')');
12205 
12206  return buf->data;
12207 }
long val
Definition: informix.c:664
#define castNode(_type_, nodeptr)
Definition: nodes.h:197
@ PARTITION_RANGE_DATUM_MAXVALUE
Definition: parsenodes.h:920
@ PARTITION_RANGE_DATUM_MINVALUE
Definition: parsenodes.h:918
static void get_const_expr(Const *constval, deparse_context *context, int showtype)
Definition: ruleutils.c:10380
StringInfo makeStringInfo(void)
Definition: stringinfo.c:41
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:176
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:188
PartitionRangeDatumKind kind
Definition: parsenodes.h:927
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 2138 of file ruleutils.c.

2139 {
2140  return pg_get_constraintdef_worker(constraintId, true, 0, false);
2141 }
static char * pg_get_constraintdef_worker(Oid constraintId, bool fullCommand, int prettyFlags, bool missing_ok)
Definition: ruleutils.c:2147

References pg_get_constraintdef_worker().

Referenced by RememberConstraintForRebuilding().

◆ pg_get_indexdef_columns()

char* pg_get_indexdef_columns ( Oid  indexrelid,
bool  pretty 
)

Definition at line 1187 of file ruleutils.c.

1188 {
1189  int prettyFlags;
1190 
1191  prettyFlags = GET_PRETTY_FLAGS(pretty);
1192 
1193  return pg_get_indexdef_worker(indexrelid, 0, NULL,
1194  true, true,
1195  false, false,
1196  prettyFlags, false);
1197 }
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:1206
#define GET_PRETTY_FLAGS(pretty)
Definition: ruleutils.c:95

References GET_PRETTY_FLAGS, and pg_get_indexdef_worker().

Referenced by BuildIndexValueDescription().

◆ pg_get_indexdef_string()

char* pg_get_indexdef_string ( Oid  indexrelid)

Definition at line 1177 of file ruleutils.c.

1178 {
1179  return pg_get_indexdef_worker(indexrelid, 0, NULL,
1180  false, false,
1181  true, true,
1182  0, false);
1183 }

References pg_get_indexdef_worker().

Referenced by RememberIndexForRebuilding().

◆ pg_get_partconstrdef_string()

char* pg_get_partconstrdef_string ( Oid  partitionId,
char *  aliasname 
)

Definition at line 2082 of file ruleutils.c.

2083 {
2084  Expr *constr_expr;
2085  List *context;
2086 
2087  constr_expr = get_partition_qual_relid(partitionId);
2088  context = deparse_context_for(aliasname, partitionId);
2089 
2090  return deparse_expression((Node *) constr_expr, context, true, false);
2091 }
Expr * get_partition_qual_relid(Oid relid)
Definition: partcache.c:304
char * deparse_expression(Node *expr, List *dpcontext, bool forceprefix, bool showimplicit)
Definition: ruleutils.c:3596
List * deparse_context_for(const char *aliasname, Oid relid)
Definition: ruleutils.c:3656
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 1874 of file ruleutils.c.

1875 {
1876  int prettyFlags;
1877 
1878  prettyFlags = GET_PRETTY_FLAGS(pretty);
1879 
1880  return pg_get_partkeydef_worker(relid, prettyFlags, true, false);
1881 }
static char * pg_get_partkeydef_worker(Oid relid, int prettyFlags, bool attrsOnly, bool missing_ok)
Definition: ruleutils.c:1887

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

1531 {
1533  int prettyFlags;
1534 
1535  prettyFlags = GET_PRETTY_FLAGS(pretty);
1536 
1537  initStringInfo(&buf);
1538 
1539  get_query_def(query, &buf, NIL, NULL, true,
1540  prettyFlags, WRAP_COLUMN_DEFAULT, 0);
1541 
1542  return buf.data;
1543 }
static void get_query_def(Query *query, StringInfo buf, List *parentnamespace, TupleDesc resultDesc, bool colNamesVisible, int prettyFlags, int wrapColumn, int startIndent)
Definition: ruleutils.c:5425
#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 1569 of file ruleutils.c.

1570 {
1571  return pg_get_statisticsobj_worker(statextid, false, false);
1572 }
static char * pg_get_statisticsobj_worker(Oid statextid, bool columns_only, bool missing_ok)
Definition: ruleutils.c:1596

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

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

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

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

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

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