1996-07-09 08:22:35 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
|
|
|
* explain.c--
|
|
|
|
* Explain the query execution plan
|
|
|
|
*
|
|
|
|
* Copyright (c) 1994-5, Regents of the University of California
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* IDENTIFICATION
|
1997-08-18 22:53:48 +02:00
|
|
|
* $Header: /cvsroot/pgsql/src/backend/commands/explain.c,v 1.10 1997/08/18 20:52:17 momjian Exp $
|
1996-07-09 08:22:35 +02:00
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
1996-10-23 09:42:13 +02:00
|
|
|
#include <stdio.h>
|
1996-11-04 00:57:43 +01:00
|
|
|
#include <string.h>
|
1996-10-23 09:42:13 +02:00
|
|
|
|
1996-11-06 09:21:43 +01:00
|
|
|
#include <postgres.h>
|
|
|
|
|
|
|
|
#include <parser/catalog_utils.h>
|
|
|
|
#include <parser/parse_query.h> /* for MakeTimeRange() */
|
|
|
|
#include <nodes/plannodes.h>
|
|
|
|
#include <tcop/tcopprot.h>
|
|
|
|
#include <lib/stringinfo.h>
|
|
|
|
#include <commands/explain.h>
|
|
|
|
#include <optimizer/planner.h>
|
|
|
|
#include <access/xact.h>
|
1996-07-09 08:22:35 +02:00
|
|
|
|
|
|
|
typedef struct ExplainState {
|
|
|
|
/* options */
|
1996-12-29 20:31:16 +01:00
|
|
|
bool printCost; /* print cost */
|
|
|
|
bool printNodes; /* do nodeToString() instead */
|
1996-07-09 08:22:35 +02:00
|
|
|
/* other states */
|
|
|
|
List *rtable; /* range table */
|
|
|
|
} ExplainState;
|
|
|
|
|
|
|
|
static char *Explain_PlanToString(Plan *plan, ExplainState *es);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ExplainQuery -
|
|
|
|
* print out the execution plan for a given query
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
void
|
1997-01-16 15:56:59 +01:00
|
|
|
ExplainQuery(Query *query, bool verbose, CommandDest dest)
|
1996-07-09 08:22:35 +02:00
|
|
|
{
|
1996-12-29 01:53:20 +01:00
|
|
|
char *s = NULL, *s2;
|
1996-07-09 08:22:35 +02:00
|
|
|
Plan *plan;
|
|
|
|
ExplainState *es;
|
|
|
|
int len;
|
|
|
|
|
|
|
|
if (IsAbortedTransactionBlockState()) {
|
|
|
|
char *tag = "*ABORT STATE*";
|
|
|
|
EndCommand(tag, dest);
|
|
|
|
|
|
|
|
elog(NOTICE, "(transaction aborted): %s",
|
|
|
|
"queries ignored until END");
|
|
|
|
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* plan the queries (XXX we've ignored rewrite!!) */
|
|
|
|
plan = planner(query);
|
|
|
|
|
|
|
|
/* pg_plan could have failed */
|
|
|
|
if (plan == NULL)
|
|
|
|
return;
|
|
|
|
|
|
|
|
es = (ExplainState*)malloc(sizeof(ExplainState));
|
|
|
|
memset(es, 0, sizeof(ExplainState));
|
|
|
|
|
1997-01-16 15:56:59 +01:00
|
|
|
es->printCost = true; /* default */
|
1996-12-29 20:31:16 +01:00
|
|
|
|
1997-01-16 15:56:59 +01:00
|
|
|
if (verbose)
|
|
|
|
es->printNodes = true;
|
1996-12-29 20:31:16 +01:00
|
|
|
|
1996-07-09 08:22:35 +02:00
|
|
|
es->rtable = query->rtable;
|
|
|
|
|
1996-12-29 01:53:20 +01:00
|
|
|
if (es->printNodes)
|
1996-07-09 08:22:35 +02:00
|
|
|
s = nodeToString(plan);
|
1996-12-29 01:53:20 +01:00
|
|
|
|
|
|
|
if (es->printCost) {
|
|
|
|
s2 = Explain_PlanToString(plan, es);
|
|
|
|
if (s == NULL)
|
|
|
|
s = s2;
|
|
|
|
else {
|
|
|
|
strcat(s, "\n\n");
|
|
|
|
strcat(s, s2);
|
|
|
|
}
|
1996-07-09 08:22:35 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/* output the plan */
|
|
|
|
len = strlen(s);
|
|
|
|
elog(NOTICE, "QUERY PLAN:\n\n%.*s", ELOG_MAXLEN-64, s);
|
|
|
|
len -= ELOG_MAXLEN-64;
|
|
|
|
while (len > 0) {
|
|
|
|
s += ELOG_MAXLEN-64;
|
|
|
|
elog(NOTICE, "%.*s", ELOG_MAXLEN-64, s);
|
|
|
|
len -= ELOG_MAXLEN-64;
|
|
|
|
}
|
|
|
|
free(es);
|
|
|
|
}
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
*
|
|
|
|
*****************************************************************************/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* explain_outNode -
|
|
|
|
* converts a Node into ascii string and append it to 'str'
|
|
|
|
*/
|
|
|
|
static void
|
|
|
|
explain_outNode(StringInfo str, Plan *plan, int indent, ExplainState *es)
|
|
|
|
{
|
|
|
|
char *pname;
|
|
|
|
char buf[1000];
|
|
|
|
int i;
|
|
|
|
|
|
|
|
if (plan==NULL) {
|
|
|
|
appendStringInfo(str, "\n");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
switch(nodeTag(plan)) {
|
|
|
|
case T_Result:
|
|
|
|
pname = "Result";
|
|
|
|
break;
|
|
|
|
case T_Append:
|
|
|
|
pname = "Append";
|
|
|
|
break;
|
|
|
|
case T_NestLoop:
|
|
|
|
pname = "Nested Loop";
|
|
|
|
break;
|
|
|
|
case T_MergeJoin:
|
|
|
|
pname = "Merge Join";
|
|
|
|
break;
|
|
|
|
case T_HashJoin:
|
|
|
|
pname = "Hash Join";
|
|
|
|
break;
|
|
|
|
case T_SeqScan:
|
|
|
|
pname = "Seq Scan";
|
|
|
|
break;
|
|
|
|
case T_IndexScan:
|
|
|
|
pname = "Index Scan";
|
|
|
|
break;
|
|
|
|
case T_Temp:
|
|
|
|
pname = "Temp Scan";
|
|
|
|
break;
|
|
|
|
case T_Sort:
|
|
|
|
pname = "Sort";
|
|
|
|
break;
|
1997-04-05 08:42:32 +02:00
|
|
|
case T_Group:
|
|
|
|
pname = "Group";
|
|
|
|
break;
|
1996-07-09 08:22:35 +02:00
|
|
|
case T_Agg:
|
|
|
|
pname = "Aggregate";
|
|
|
|
break;
|
|
|
|
case T_Unique:
|
|
|
|
pname = "Unique";
|
|
|
|
break;
|
|
|
|
case T_Hash:
|
|
|
|
pname = "Hash";
|
|
|
|
break;
|
|
|
|
case T_Tee:
|
|
|
|
pname = "Tee";
|
|
|
|
break;
|
|
|
|
default:
|
1996-12-03 06:50:11 +01:00
|
|
|
pname = "";
|
1996-07-09 08:22:35 +02:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
for(i=0; i < indent; i++)
|
|
|
|
appendStringInfo(str, " ");
|
|
|
|
|
|
|
|
appendStringInfo(str, pname);
|
|
|
|
switch(nodeTag(plan)) {
|
|
|
|
case T_SeqScan:
|
|
|
|
case T_IndexScan:
|
|
|
|
if (((Scan*)plan)->scanrelid > 0) {
|
|
|
|
RangeTblEntry *rte = nth(((Scan*)plan)->scanrelid-1, es->rtable);
|
1997-08-18 22:53:48 +02:00
|
|
|
sprintf(buf, " on %s", rte->refname);
|
1996-07-09 08:22:35 +02:00
|
|
|
appendStringInfo(str, buf);
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
if (es->printCost) {
|
|
|
|
sprintf(buf, " (cost=%.2f size=%d width=%d)",
|
|
|
|
plan->cost, plan->plan_size, plan->plan_width);
|
|
|
|
appendStringInfo(str, buf);
|
|
|
|
}
|
|
|
|
appendStringInfo(str, "\n");
|
|
|
|
|
|
|
|
/* lefttree */
|
|
|
|
if (outerPlan(plan)) {
|
|
|
|
for(i=0; i < indent; i++)
|
|
|
|
appendStringInfo(str, " ");
|
|
|
|
appendStringInfo(str, " -> ");
|
|
|
|
explain_outNode(str, outerPlan(plan), indent+1, es);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* righttree */
|
|
|
|
if (innerPlan(plan)) {
|
|
|
|
for(i=0; i < indent; i++)
|
|
|
|
appendStringInfo(str, " ");
|
|
|
|
appendStringInfo(str, " -> ");
|
|
|
|
explain_outNode(str, innerPlan(plan), indent+1, es);
|
|
|
|
}
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
static char *
|
|
|
|
Explain_PlanToString(Plan *plan, ExplainState *es)
|
|
|
|
{
|
|
|
|
StringInfo str;
|
|
|
|
char *s;
|
|
|
|
|
|
|
|
if (plan==NULL)
|
|
|
|
return "";
|
|
|
|
Assert(plan!=NULL);
|
|
|
|
str = makeStringInfo();
|
|
|
|
explain_outNode(str, plan, 0, es);
|
|
|
|
s = str->data;
|
|
|
|
pfree(str);
|
|
|
|
|
|
|
|
return s;
|
|
|
|
}
|