pgpa_planner.h File Reference

#include "pgpa_identifier.h"

Include dependency graph for pgpa_planner.h:

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

Go to the source code of this file.

Data Structures
struct	pgpa_planner_info

Typedefs
typedef struct pgpa_planner_info	pgpa_planner_info

Functions
void	pgpa_planner_install_hooks (void)
PGDLLEXPORT void	pgpa_planner_feedback_warning (List *feedback)

Variables
int	pgpa_planner_generate_advice

Typedef Documentation

pgpa_planner_info

typedef struct pgpa_planner_info pgpa_planner_info

Function Documentation

pgpa_planner_feedback_warning()

PGDLLEXPORT void pgpa_planner_feedback_warning ( List *  feedback )

extern

Definition at line 1908 of file pgpa_planner.c.

{
    StringInfoData detailbuf;
    StringInfoData flagbuf;
 
    /* Quick exit if there's no feedback. */
    if (feedback == NIL)
        return;
 
    /* Initialize buffers. */
    initStringInfo(&detailbuf);
    initStringInfo(&flagbuf);
 
    /* Main loop. */
    foreach_node(DefElem, item, feedback)
    {
        int         flags = defGetInt32(item);
 
        /*
         * Don't emit anything if it was fully matched with no problems found.
         *
         * NB: Feedback should never be marked fully matched without also
         * being marked partially matched.
         */
        if (flags == (PGPA_FB_MATCH_PARTIAL | PGPA_FB_MATCH_FULL))
            continue;
 
        /*
         * Terminate each detail line except the last with a newline. This is
         * also a convenient place to reset flagbuf.
         */
        if (detailbuf.len > 0)
        {
            appendStringInfoChar(&detailbuf, '\n');
            resetStringInfo(&flagbuf);
        }
 
        /* Generate output. */
        pgpa_trove_append_flags(&flagbuf, flags);
        appendStringInfo(&detailbuf, "advice %s feedback is \"%s\"",
                         item->defname, flagbuf.data);
    }
 
    /* Emit the warning, if any problems were found. */
    if (detailbuf.len > 0)
        ereport(WARNING,
                errmsg("supplied plan advice was not enforced"),
                errdetail("%s", detailbuf.data));
}

References appendStringInfo(), appendStringInfoChar(), defGetInt32(), ereport, errdetail(), errmsg, fb(), foreach_node, initStringInfo(), NIL, PGPA_FB_MATCH_FULL, PGPA_FB_MATCH_PARTIAL, pgpa_trove_append_flags(), resetStringInfo(), and WARNING.

Referenced by pgpa_planner_shutdown().

pgpa_planner_install_hooks()

void pgpa_planner_install_hooks ( void  )

extern

Definition at line 181 of file pgpa_planner.c.

{
    planner_extension_id = GetPlannerExtensionId("pg_plan_advice");
    prev_planner_setup = planner_setup_hook;
    planner_setup_hook = pgpa_planner_setup;
    prev_planner_shutdown = planner_shutdown_hook;
    planner_shutdown_hook = pgpa_planner_shutdown;
    prev_build_simple_rel = build_simple_rel_hook;
    build_simple_rel_hook = pgpa_build_simple_rel;
    prev_joinrel_setup = joinrel_setup_hook;
    joinrel_setup_hook = pgpa_joinrel_setup;
    prev_join_path_setup = join_path_setup_hook;
    join_path_setup_hook = pgpa_join_path_setup;
}

References build_simple_rel_hook, GetPlannerExtensionId(), join_path_setup_hook, joinrel_setup_hook, pgpa_build_simple_rel(), pgpa_join_path_setup(), pgpa_joinrel_setup(), pgpa_planner_setup(), pgpa_planner_shutdown(), planner_extension_id, planner_setup_hook, planner_shutdown_hook, prev_build_simple_rel, prev_join_path_setup, prev_joinrel_setup, prev_planner_setup, and prev_planner_shutdown.

Referenced by _PG_init().

Variable Documentation

pgpa_planner_generate_advice

int pgpa_planner_generate_advice

extern

Definition at line 97 of file pgpa_planner.c.

Referenced by pg_plan_advice_request_advice_generation(), and pgpa_planner_setup().