#include "commands/explain_state.h"
#include "nodes/pathnodes.h"

Include dependency graph for pg_plan_advice.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef char (	pg_plan_advice_advisor_hook) (PlannerGlobal glob, Query parse, const char query_string, int cursorOptions, ExplainState es)

Functions
MemoryContext	pg_plan_advice_get_mcxt (void)

bool	pg_plan_advice_should_explain (ExplainState *es)

char *	pg_plan_advice_get_supplied_query_advice (PlannerGlobal glob, Query parse, const char query_string, int cursorOptions, ExplainState es)

PGDLLEXPORT void	pg_plan_advice_add_advisor (pg_plan_advice_advisor_hook hook)

PGDLLEXPORT void	pg_plan_advice_remove_advisor (pg_plan_advice_advisor_hook hook)

PGDLLEXPORT void	pg_plan_advice_request_advice_generation (bool activate)

Variables
char *	pg_plan_advice_advice

bool	pg_plan_advice_always_store_advice_details

bool	pg_plan_advice_feedback_warnings

bool	pg_plan_advice_trace_mask

Typedef Documentation

◆ pg_plan_advice_advisor_hook

typedef char *(* pg_plan_advice_advisor_hook) (PlannerGlobal *glob, Query *parse, const char *query_string, int cursorOptions, ExplainState *es)

Definition at line 19 of file pg_plan_advice.h.

Function Documentation

◆ pg_plan_advice_add_advisor()

PGDLLEXPORT void pg_plan_advice_add_advisor ( pg_plan_advice_advisor_hook hook )

extern

Definition at line 204 of file pg_plan_advice.c.

{
    MemoryContext oldcontext;
 
    oldcontext = MemoryContextSwitchTo(pg_plan_advice_get_mcxt());
    advisor_hook_list = lappend(advisor_hook_list, hook);
    MemoryContextSwitchTo(oldcontext);
}

References advisor_hook_list, lappend(), MemoryContextSwitchTo(), and pg_plan_advice_get_mcxt().

◆ pg_plan_advice_get_mcxt()

MemoryContext pg_plan_advice_get_mcxt ( void )

extern

Definition at line 142 of file pg_plan_advice.c.

{
    if (pgpa_memory_context == NULL)
        pgpa_memory_context = AllocSetContextCreate(TopMemoryContext,
                                                    "pg_plan_advice",
                                                    ALLOCSET_DEFAULT_SIZES);
 
    return pgpa_memory_context;
}

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, fb(), pgpa_memory_context, and TopMemoryContext.

Referenced by pg_plan_advice_add_advisor(), and pg_plan_advice_remove_advisor().

◆ pg_plan_advice_get_supplied_query_advice()

char * pg_plan_advice_get_supplied_query_advice	(	PlannerGlobal *	glob,
		Query *	parse,
		const char *	query_string,
		int	cursorOptions,
		ExplainState *	es
	)

extern

Definition at line 169 of file pg_plan_advice.c.

{
    ListCell   *lc;
 
    /*
     * If any advisors are loaded, consult them. The first one that produces a
     * non-NULL string wins.
     */
    foreach(lc, advisor_hook_list)
    {
        pg_plan_advice_advisor_hook hook = lfirst(lc);
        char       *advice_string;
 
        advice_string = (*hook) (glob, parse, query_string, cursorOptions, es);
        if (advice_string != NULL)
            return advice_string;
    }
 
    /* Otherwise, just use the value of the GUC. */
    return pg_plan_advice_advice;
}

References advisor_hook_list, fb(), lfirst, parse(), and pg_plan_advice_advice.

Referenced by pgpa_planner_setup().

◆ pg_plan_advice_remove_advisor()

PGDLLEXPORT void pg_plan_advice_remove_advisor ( pg_plan_advice_advisor_hook hook )

extern

Definition at line 217 of file pg_plan_advice.c.

{
    MemoryContext oldcontext;
 
    oldcontext = MemoryContextSwitchTo(pg_plan_advice_get_mcxt());
    advisor_hook_list = list_delete_ptr(advisor_hook_list, hook);
    MemoryContextSwitchTo(oldcontext);
}

References advisor_hook_list, list_delete_ptr(), MemoryContextSwitchTo(), and pg_plan_advice_get_mcxt().

◆ pg_plan_advice_request_advice_generation()

PGDLLEXPORT void pg_plan_advice_request_advice_generation ( bool activate )

extern

Definition at line 241 of file pg_plan_advice.c.

{
    if (activate)
        pgpa_planner_generate_advice++;
    else
    {
        Assert(pgpa_planner_generate_advice > 0);
        pgpa_planner_generate_advice--;
    }
}

References Assert, fb(), and pgpa_planner_generate_advice.

◆ pg_plan_advice_should_explain()

bool pg_plan_advice_should_explain ( ExplainState * es )

extern

Definition at line 156 of file pg_plan_advice.c.

{
    bool       *plan_advice = NULL;
 
    if (es != NULL)
        plan_advice = GetExplainExtensionState(es, es_extension_id);
    return plan_advice != NULL && *plan_advice;
}