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 */

Typedefs
typedef struct Plan	Plan
typedef struct PlannedStmt	PlannedStmt

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)
List *	deparse_context_for (const char *aliasname, Oid relid)
List *	deparse_context_for_plan_tree (PlannedStmt *pstmt, List *rtable_names)
List *	set_deparse_context_plan (List *dpcontext, Plan *plan, List *ancestors)
List *	select_rtable_names_for_explain (List *rtable, Bitmapset *rels_used)
char *	get_window_frame_options_for_explain (int frameOptions, Node *startOffset, Node *endOffset, List *dpcontext, bool forceprefix)
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.

Typedef Documentation

Plan

typedef struct Plan Plan

Definition at line 20 of file ruleutils.h.

PlannedStmt

typedef struct PlannedStmt PlannedStmt

Definition at line 21 of file ruleutils.h.

Function Documentation

deparse_context_for()

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

Definition at line 3711 of file ruleutils.c.

{
    deparse_namespace *dpns;
    RangeTblEntry *rte;
 
    dpns = (deparse_namespace *) palloc0(sizeof(deparse_namespace));
 
    /* Build a minimal RTE for the rel */
    rte = makeNode(RangeTblEntry);
    rte->rtekind = RTE_RELATION;
    rte->relid = relid;
    rte->relkind = RELKIND_RELATION;    /* no need for exactness here */
    rte->rellockmode = AccessShareLock;
    rte->alias = makeAlias(aliasname, NIL);
    rte->eref = rte->alias;
    rte->lateral = false;
    rte->inh = false;
    rte->inFromCl = true;
 
    /* Build one-element rtable */
    dpns->rtable = list_make1(rte);
    dpns->subplans = NIL;
    dpns->ctes = NIL;
    dpns->appendrels = NULL;
    set_rtable_names(dpns, NIL, NULL);
    set_simple_column_names(dpns);
 
    /* Return a one-deep namespace stack */
    return list_make1(dpns);
}

References AccessShareLock, deparse_namespace::appendrels, deparse_namespace::ctes, RangeTblEntry::inh, list_make1, makeAlias(), makeNode, NIL, palloc0(), 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	(	PlannedStmt *	pstmt,
		List *	rtable_names
	)

Definition at line 3756 of file ruleutils.c.

{
    deparse_namespace *dpns;
 
    dpns = (deparse_namespace *) palloc0(sizeof(deparse_namespace));
 
    /* Initialize fields that stay the same across the whole plan tree */
    dpns->rtable = pstmt->rtable;
    dpns->rtable_names = rtable_names;
    dpns->subplans = pstmt->subplans;
    dpns->ctes = NIL;
    if (pstmt->appendRelations)
    {
        /* Set up the array, indexed by child relid */
        int         ntables = list_length(dpns->rtable);
        ListCell   *lc;
 
        dpns->appendrels = (AppendRelInfo **)
            palloc0((ntables + 1) * sizeof(AppendRelInfo *));
        foreach(lc, pstmt->appendRelations)
        {
            AppendRelInfo *appinfo = lfirst_node(AppendRelInfo, lc);
            Index       crelid = appinfo->child_relid;
 
            Assert(crelid > 0 && crelid <= ntables);
            Assert(dpns->appendrels[crelid] == NULL);
            dpns->appendrels[crelid] = appinfo;
        }
    }
    else
        dpns->appendrels = NULL;    /* don't need it */
 
    /*
     * Set up column name aliases, ignoring any join RTEs; they don't matter
     * because plan trees don't contain any join alias Vars.
     */
    set_simple_column_names(dpns);
 
    /* Return a one-deep namespace stack */
    return list_make1(dpns);
}

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

{
    return deparse_expression_pretty(expr, dpcontext, forceprefix,
                                     showimplicit, 0, 0);
}

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(), show_window_keys(), transformPartitionBound(), and transformPartitionRangeBounds().

generate_collation_name()

char * generate_collation_name

(

Oid

collid

)

Definition at line 13578 of file ruleutils.c.

{
    HeapTuple   tp;
    Form_pg_collation colltup;
    char       *collname;
    char       *nspname;
    char       *result;
 
    tp = SearchSysCache1(COLLOID, ObjectIdGetDatum(collid));
    if (!HeapTupleIsValid(tp))
        elog(ERROR, "cache lookup failed for collation %u", collid);
    colltup = (Form_pg_collation) GETSTRUCT(tp);
    collname = NameStr(colltup->collname);
 
    if (!CollationIsVisible(collid))
        nspname = get_namespace_name_or_temp(colltup->collnamespace);
    else
        nspname = NULL;
 
    result = quote_qualified_identifier(nspname, collname);
 
    ReleaseSysCache(tp);
 
    return result;
}

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

{
    StringInfoData buf;
 
    initStringInfo(&buf);
    get_opclass_name(opclass, InvalidOid, &buf);
 
    return &buf.data[1];        /* get_opclass_name() prepends space */
}

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

{
    deparse_context context;
    StringInfoData buf;
    ListCell   *cell;
    char       *sep;
 
    initStringInfo(&buf);
    memset(&context, 0, sizeof(deparse_context));
    context.buf = &buf;
 
    appendStringInfoChar(&buf, '(');
    sep = "";
    foreach(cell, bound_datums)
    {
        PartitionRangeDatum *datum =
            lfirst_node(PartitionRangeDatum, cell);
 
        appendStringInfoString(&buf, sep);
        if (datum->kind == PARTITION_RANGE_DATUM_MINVALUE)
            appendStringInfoString(&buf, "MINVALUE");
        else if (datum->kind == PARTITION_RANGE_DATUM_MAXVALUE)
            appendStringInfoString(&buf, "MAXVALUE");
        else
        {
            Const      *val = castNode(Const, datum->value);
 
            get_const_expr(val, &context, -1);
        }
        sep = ", ";
    }
    appendStringInfoChar(&buf, ')');
 
    return buf.data;
}

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

Referenced by check_new_partition_bound(), and get_rule_expr().

get_window_frame_options_for_explain()

char * get_window_frame_options_for_explain	(	int	frameOptions,
		Node *	startOffset,
		Node *	endOffset,
		List *	dpcontext,
		bool	forceprefix
	)

Definition at line 6912 of file ruleutils.c.

{
    StringInfoData buf;
    deparse_context context;
 
    initStringInfo(&buf);
    context.buf = &buf;
    context.namespaces = dpcontext;
    context.resultDesc = NULL;
    context.targetList = NIL;
    context.windowClause = NIL;
    context.varprefix = forceprefix;
    context.prettyFlags = 0;
    context.wrapColumn = WRAP_COLUMN_DEFAULT;
    context.indentLevel = 0;
    context.colNamesVisible = true;
    context.inGroupBy = false;
    context.varInOrderBy = false;
    context.appendparents = NULL;
 
    get_window_frame_options(frameOptions, startOffset, endOffset, &context);
 
    return buf.data;
}

References deparse_context::appendparents, deparse_context::buf, buf, deparse_context::colNamesVisible, get_window_frame_options(), deparse_context::indentLevel, deparse_context::inGroupBy, initStringInfo(), deparse_context::namespaces, NIL, deparse_context::prettyFlags, deparse_context::resultDesc, deparse_context::targetList, deparse_context::varInOrderBy, deparse_context::varprefix, deparse_context::windowClause, WRAP_COLUMN_DEFAULT, and deparse_context::wrapColumn.

Referenced by show_window_def().

pg_get_constraintdef_command()

char * pg_get_constraintdef_command

(

Oid

constraintId

)

Definition at line 2183 of file ruleutils.c.

{
    return pg_get_constraintdef_worker(constraintId, true, 0, false);
}

References pg_get_constraintdef_worker().

Referenced by RememberConstraintForRebuilding().

pg_get_indexdef_columns()

char * pg_get_indexdef_columns	(	Oid	indexrelid,
		bool	pretty
	)

Definition at line 1235 of file ruleutils.c.

{
    int         prettyFlags;
 
    prettyFlags = GET_PRETTY_FLAGS(pretty);
 
    return pg_get_indexdef_worker(indexrelid, 0, NULL,
                                  true, true,
                                  false, false,
                                  prettyFlags, false);
}

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

{
    bool        pretty = ((flags & RULE_INDEXDEF_PRETTY) != 0);
    bool        keys_only = ((flags & RULE_INDEXDEF_KEYS_ONLY) != 0);
    int         prettyFlags;
 
    prettyFlags = GET_PRETTY_FLAGS(pretty);
 
    return pg_get_indexdef_worker(indexrelid, 0, NULL,
                                  true, keys_only,
                                  false, false,
                                  prettyFlags, false);
}

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

{
    return pg_get_indexdef_worker(indexrelid, 0, NULL,
                                  false, false,
                                  true, true,
                                  0, false);
}

References pg_get_indexdef_worker().

Referenced by RememberIndexForRebuilding().

pg_get_partconstrdef_string()

char * pg_get_partconstrdef_string	(	Oid	partitionId,
		char *	aliasname
	)

Definition at line 2127 of file ruleutils.c.

{
    Expr       *constr_expr;
    List       *context;
 
    constr_expr = get_partition_qual_relid(partitionId);
    context = deparse_context_for(aliasname, partitionId);
 
    return deparse_expression((Node *) constr_expr, context, true, false);
}

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

{
    int         prettyFlags;
 
    prettyFlags = GET_PRETTY_FLAGS(pretty);
 
    return pg_get_partkeydef_worker(relid, prettyFlags, true, false);
}

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

{
    StringInfoData buf;
    int         prettyFlags;
 
    prettyFlags = GET_PRETTY_FLAGS(pretty);
 
    initStringInfo(&buf);
 
    get_query_def(query, &buf, NIL, NULL, true,
                  prettyFlags, WRAP_COLUMN_DEFAULT, 0);
 
    return buf.data;
}

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

{
    return pg_get_statisticsobj_worker(statextid, false, false);
}

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

{
    deparse_namespace dpns;
 
    memset(&dpns, 0, sizeof(dpns));
    dpns.rtable = rtable;
    dpns.subplans = NIL;
    dpns.ctes = NIL;
    dpns.appendrels = NULL;
    set_rtable_names(&dpns, NIL, rels_used);
    /* We needn't bother computing column aliases yet */
 
    return dpns.rtable_names;
}

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,
		Plan *	plan,
		List *	ancestors
	)

Definition at line 3828 of file ruleutils.c.

{
    deparse_namespace *dpns;
 
    /* Should always have one-entry namespace list for Plan deparsing */
    Assert(list_length(dpcontext) == 1);
    dpns = (deparse_namespace *) linitial(dpcontext);
 
    /* Set our attention on the specific plan node passed in */
    dpns->ancestors = ancestors;
    set_deparse_plan(dpns, plan);
 
    /* For ModifyTable, set aliases for OLD and NEW in RETURNING */
    if (IsA(plan, ModifyTable))
    {
        dpns->ret_old_alias = ((ModifyTable *) plan)->returningOldAlias;
        dpns->ret_new_alias = ((ModifyTable *) plan)->returningNewAlias;
    }
 
    return dpcontext;
}

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(), show_tablesample(), show_window_def(), and show_window_keys().