PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 3705 of file ruleutils.c.

3706{
3707 deparse_namespace *dpns;
3708 RangeTblEntry *rte;
3709
3710 dpns = (deparse_namespace *) palloc0(sizeof(deparse_namespace));
3711
3712 /* Build a minimal RTE for the rel */
3713 rte = makeNode(RangeTblEntry);
3714 rte->rtekind = RTE_RELATION;
3715 rte->relid = relid;
3716 rte->relkind = RELKIND_RELATION; /* no need for exactness here */
3717 rte->rellockmode = AccessShareLock;
3718 rte->alias = makeAlias(aliasname, NIL);
3719 rte->eref = rte->alias;
3720 rte->lateral = false;
3721 rte->inh = false;
3722 rte->inFromCl = true;
3723
3724 /* Build one-element rtable */
3725 dpns->rtable = list_make1(rte);
3726 dpns->subplans = NIL;
3727 dpns->ctes = NIL;
3728 dpns->appendrels = NULL;
3729 set_rtable_names(dpns, NIL, NULL);
3731
3732 /* Return a one-deep namespace stack */
3733 return list_make1(dpns);
3734}
#define AccessShareLock
Definition: lockdefs.h:36
Alias * makeAlias(const char *aliasname, List *colnames)
Definition: makefuncs.c:391
void * palloc0(Size size)
Definition: mcxt.c:1347
#define makeNode(_type_)
Definition: nodes.h:155
@ RTE_RELATION
Definition: parsenodes.h:1026
#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:4095
static void set_rtable_names(deparse_namespace *dpns, List *parent_namespaces, Bitmapset *rels_used)
Definition: ruleutils.c:3881
RTEKind rtekind
Definition: parsenodes.h:1056
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 3750 of file ruleutils.c.

3751{
3752 deparse_namespace *dpns;
3753
3754 dpns = (deparse_namespace *) palloc0(sizeof(deparse_namespace));
3755
3756 /* Initialize fields that stay the same across the whole plan tree */
3757 dpns->rtable = pstmt->rtable;
3758 dpns->rtable_names = rtable_names;
3759 dpns->subplans = pstmt->subplans;
3760 dpns->ctes = NIL;
3761 if (pstmt->appendRelations)
3762 {
3763 /* Set up the array, indexed by child relid */
3764 int ntables = list_length(dpns->rtable);
3765 ListCell *lc;
3766
3767 dpns->appendrels = (AppendRelInfo **)
3768 palloc0((ntables + 1) * sizeof(AppendRelInfo *));
3769 foreach(lc, pstmt->appendRelations)
3770 {
3771 AppendRelInfo *appinfo = lfirst_node(AppendRelInfo, lc);
3772 Index crelid = appinfo->child_relid;
3773
3774 Assert(crelid > 0 && crelid <= ntables);
3775 Assert(dpns->appendrels[crelid] == NULL);
3776 dpns->appendrels[crelid] = appinfo;
3777 }
3778 }
3779 else
3780 dpns->appendrels = NULL; /* don't need it */
3781
3782 /*
3783 * Set up column name aliases, ignoring any join RTEs; they don't matter
3784 * because plan trees don't contain any join alias Vars.
3785 */
3787
3788 /* Return a one-deep namespace stack */
3789 return list_make1(dpns);
3790}
#define Assert(condition)
Definition: c.h:815
unsigned int Index
Definition: c.h:571
#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:2981
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 3642 of file ruleutils.c.

3644{
3645 return deparse_expression_pretty(expr, dpcontext, forceprefix,
3646 showimplicit, 0, 0);
3647}
static char * deparse_expression_pretty(Node *expr, List *dpcontext, bool forceprefix, bool showimplicit, int prettyFlags, int startIndent)
Definition: ruleutils.c:3669

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

13455{
13456 HeapTuple tp;
13457 Form_pg_collation colltup;
13458 char *collname;
13459 char *nspname;
13460 char *result;
13461
13462 tp = SearchSysCache1(COLLOID, ObjectIdGetDatum(collid));
13463 if (!HeapTupleIsValid(tp))
13464 elog(ERROR, "cache lookup failed for collation %u", collid);
13465 colltup = (Form_pg_collation) GETSTRUCT(tp);
13466 collname = NameStr(colltup->collname);
13467
13469 nspname = get_namespace_name_or_temp(colltup->collnamespace);
13470 else
13471 nspname = NULL;
13472
13473 result = quote_qualified_identifier(nspname, collname);
13474
13475 ReleaseSysCache(tp);
13476
13477 return result;
13478}
#define NameStr(name)
Definition: c.h:703
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:257
char * quote_qualified_identifier(const char *qualifier, const char *ident)
Definition: ruleutils.c:13024
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 12810 of file ruleutils.c.

12811{
12813
12815 get_opclass_name(opclass, InvalidOid, &buf);
12816
12817 return &buf.data[1]; /* get_opclass_name() prepends space */
12818}
static char * buf
Definition: pg_test_fsync.c:72
#define InvalidOid
Definition: postgres_ext.h:37
static void get_opclass_name(Oid opclass, Oid actual_datatype, StringInfo buf)
Definition: ruleutils.c:12772
void initStringInfo(StringInfo str)
Definition: stringinfo.c:97

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

13588{
13589 deparse_context context;
13591 ListCell *cell;
13592 char *sep;
13593
13594 memset(&context, 0, sizeof(deparse_context));
13595 context.buf = buf;
13596
13598 sep = "";
13599 foreach(cell, bound_datums)
13600 {
13601 PartitionRangeDatum *datum =
13603
13606 appendStringInfoString(buf, "MINVALUE");
13607 else if (datum->kind == PARTITION_RANGE_DATUM_MAXVALUE)
13608 appendStringInfoString(buf, "MAXVALUE");
13609 else
13610 {
13611 Const *val = castNode(Const, datum->value);
13612
13613 get_const_expr(val, &context, -1);
13614 }
13615 sep = ", ";
13616 }
13618
13619 return buf->data;
13620}
long val
Definition: informix.c:689
#define castNode(_type_, nodeptr)
Definition: nodes.h:176
@ PARTITION_RANGE_DATUM_MAXVALUE
Definition: parsenodes.h:937
@ PARTITION_RANGE_DATUM_MINVALUE
Definition: parsenodes.h:935
static void get_const_expr(Const *constval, deparse_context *context, int showtype)
Definition: ruleutils.c:11376
StringInfo makeStringInfo(void)
Definition: stringinfo.c:72
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:230
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:242
PartitionRangeDatumKind kind
Definition: parsenodes.h:944
StringInfo buf
Definition: ruleutils.c:114

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

2182{
2183 return pg_get_constraintdef_worker(constraintId, true, 0, false);
2184}
static char * pg_get_constraintdef_worker(Oid constraintId, bool fullCommand, int prettyFlags, bool missing_ok)
Definition: ruleutils.c:2190

References pg_get_constraintdef_worker().

Referenced by RememberConstraintForRebuilding().

◆ pg_get_indexdef_columns()

char * pg_get_indexdef_columns ( Oid  indexrelid,
bool  pretty 
)

Definition at line 1232 of file ruleutils.c.

1233{
1234 int prettyFlags;
1235
1236 prettyFlags = GET_PRETTY_FLAGS(pretty);
1237
1238 return pg_get_indexdef_worker(indexrelid, 0, NULL,
1239 true, true,
1240 false, false,
1241 prettyFlags, false);
1242}
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:1267
#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 1246 of file ruleutils.c.

1247{
1248 bool pretty = ((flags & RULE_INDEXDEF_PRETTY) != 0);
1249 bool keys_only = ((flags & RULE_INDEXDEF_KEYS_ONLY) != 0);
1250 int prettyFlags;
1251
1252 prettyFlags = GET_PRETTY_FLAGS(pretty);
1253
1254 return pg_get_indexdef_worker(indexrelid, 0, NULL,
1255 true, keys_only,
1256 false, false,
1257 prettyFlags, false);
1258}
#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 1222 of file ruleutils.c.

1223{
1224 return pg_get_indexdef_worker(indexrelid, 0, NULL,
1225 false, false,
1226 true, true,
1227 0, false);
1228}

References pg_get_indexdef_worker().

Referenced by RememberIndexForRebuilding().

◆ pg_get_partconstrdef_string()

char * pg_get_partconstrdef_string ( Oid  partitionId,
char *  aliasname 
)

Definition at line 2125 of file ruleutils.c.

2126{
2127 Expr *constr_expr;
2128 List *context;
2129
2130 constr_expr = get_partition_qual_relid(partitionId);
2131 context = deparse_context_for(aliasname, partitionId);
2132
2133 return deparse_expression((Node *) constr_expr, context, true, false);
2134}
Expr * get_partition_qual_relid(Oid relid)
Definition: partcache.c:299
List * deparse_context_for(const char *aliasname, Oid relid)
Definition: ruleutils.c:3705
char * deparse_expression(Node *expr, List *dpcontext, bool forceprefix, bool showimplicit)
Definition: ruleutils.c:3642
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 1921 of file ruleutils.c.

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

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

1586{
1588 int prettyFlags;
1589
1590 prettyFlags = GET_PRETTY_FLAGS(pretty);
1591
1593
1594 get_query_def(query, &buf, NIL, NULL, true,
1595 prettyFlags, WRAP_COLUMN_DEFAULT, 0);
1596
1597 return buf.data;
1598}
static void get_query_def(Query *query, StringInfo buf, List *parentnamespace, TupleDesc resultDesc, bool colNamesVisible, int prettyFlags, int wrapColumn, int startIndent)
Definition: ruleutils.c:5621
#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 1624 of file ruleutils.c.

1625{
1626 return pg_get_statisticsobj_worker(statextid, false, false);
1627}
static char * pg_get_statisticsobj_worker(Oid statextid, bool columns_only, bool missing_ok)
Definition: ruleutils.c:1651

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

3853{
3854 deparse_namespace dpns;
3855
3856 memset(&dpns, 0, sizeof(dpns));
3857 dpns.rtable = rtable;
3858 dpns.subplans = NIL;
3859 dpns.ctes = NIL;
3860 dpns.appendrels = NULL;
3861 set_rtable_names(&dpns, NIL, rels_used);
3862 /* We needn't bother computing column aliases yet */
3863
3864 return dpns.rtable_names;
3865}

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

3823{
3824 deparse_namespace *dpns;
3825
3826 /* Should always have one-entry namespace list for Plan deparsing */
3827 Assert(list_length(dpcontext) == 1);
3828 dpns = (deparse_namespace *) linitial(dpcontext);
3829
3830 /* Set our attention on the specific plan node passed in */
3831 dpns->ancestors = ancestors;
3832 set_deparse_plan(dpns, plan);
3833
3834 /* For ModifyTable, set aliases for OLD and NEW in RETURNING */
3835 if (IsA(plan, ModifyTable))
3836 {
3837 dpns->ret_old_alias = ((ModifyTable *) plan)->returningOldAlias;
3838 dpns->ret_new_alias = ((ModifyTable *) plan)->returningNewAlias;
3839 }
3840
3841 return dpcontext;
3842}
#define IsA(nodeptr, _type_)
Definition: nodes.h:158
#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:5149
char * ret_old_alias
Definition: ruleutils.c:170
char * ret_new_alias
Definition: ruleutils.c:171

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

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