postgresql/contrib/pg_plan_advice/pgpa_identifier.h
Robert Haas 5883ff30b0 Add pg_plan_advice contrib module.
Provide a facility that (1) can be used to stabilize certain plan choices
so that the planner cannot reverse course without authorization and
(2) can be used by knowledgeable users to insist on plan choices contrary
to what the planner believes best. In both cases, terrible outcomes are
possible: users should think twice and perhaps three times before
constraining the planner's ability to do as it thinks best; nevertheless,
there are problems that are much more easily solved with these facilities
than without them.

This patch takes the approach of analyzing a finished plan to produce
textual output, which we call "plan advice", that describes key
decisions made during plan; if that plan advice is provided during
future planning cycles, it will force those key decisions to be made in
the same way.  Not all planner decisions can be controlled using advice;
for example, decisions about how to perform aggregation are currently
out of scope, as is choice of sort order. Plan advice can also be edited
by the user, or even written from scratch in simple cases, making it
possible to generate outcomes that the planner would not have produced.
Partial advice can be provided to control some planner outcomes but not
others.

Currently, plan advice is focused only on specific outcomes, such as
the choice to use a sequential scan for a particular relation, and not
on estimates that might contribute to those outcomes, such as a
possibly-incorrect selectivity estimate. While it would be useful to
users to be able to provide plan advice that affects selectivity
estimates or other aspects of costing, that is out of scope for this
commit.

Reviewed-by: Lukas Fittl <lukas@fittl.com>
Reviewed-by: Jakub Wartak <jakub.wartak@enterprisedb.com>
Reviewed-by: Greg Burd <greg@burd.me>
Reviewed-by: Jacob Champion <jacob.champion@enterprisedb.com>
Reviewed-by: Haibo Yan <tristan.yim@gmail.com>
Reviewed-by: Dian Fay <di@nmfay.com>
Reviewed-by: Ajay Pal <ajay.pal.k@gmail.com>
Reviewed-by: John Naylor <johncnaylorls@gmail.com>
Reviewed-by: Alexandra Wang <alexandra.wang.oss@gmail.com>
Discussion: http://postgr.es/m/CA+TgmoZ-Jh1T6QyWoCODMVQdhTUPYkaZjWztzP1En4=ZHoKPzw@mail.gmail.com
2026-03-12 13:00:43 -04:00

52 lines
1.4 KiB
C

/*-------------------------------------------------------------------------
*
* pgpa_identifier.h
* create appropriate identifiers for range table entries
*
* Copyright (c) 2016-2026, PostgreSQL Global Development Group
*
* contrib/pg_plan_advice/pgpa_identifier.h
*
*-------------------------------------------------------------------------
*/
#ifndef PGPA_IDENTIFIER_H
#define PGPA_IDENTIFIER_H
#include "nodes/pathnodes.h"
#include "nodes/plannodes.h"
typedef struct pgpa_identifier
{
const char *alias_name;
int occurrence;
const char *partnsp;
const char *partrel;
const char *plan_name;
} pgpa_identifier;
/* Convenience function for comparing possibly-NULL strings. */
static inline bool
strings_equal_or_both_null(const char *a, const char *b)
{
if (a == b)
return true;
else if (a == NULL || b == NULL)
return false;
else
return strcmp(a, b) == 0;
}
extern const char *pgpa_identifier_string(const pgpa_identifier *rid);
extern void pgpa_compute_identifier_by_rti(PlannerInfo *root, Index rti,
pgpa_identifier *rid);
extern int pgpa_compute_identifiers_by_relids(PlannerInfo *root,
Bitmapset *relids,
pgpa_identifier *rids);
extern pgpa_identifier *pgpa_create_identifiers_for_planned_stmt(PlannedStmt *pstmt);
extern Index pgpa_compute_rti_from_identifier(int rtable_length,
pgpa_identifier *rt_identifiers,
pgpa_identifier *rid);
#endif