mirror of
https://git.postgresql.org/git/postgresql.git
synced 2026-02-18 20:36:58 +08:00
21c09e99dc
The heapam XLog functions are used by other modules, not all of which are interested in the rest of the heapam API. With this, we let them get just the XLog stuff in which they are interested and not pollute them with unrelated includes. Also, since heapam.h no longer requires xlog.h, many files that do include heapam.h no longer get xlog.h automatically, including a few headers. This is useful because heapam.h is getting pulled in by execnodes.h, which is in turn included by a lot of files.
92 lines
3.0 KiB
C
92 lines
3.0 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* explain.h
|
|
* prototypes for explain.c
|
|
*
|
|
* Portions Copyright (c) 1996-2012, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994-5, Regents of the University of California
|
|
*
|
|
* src/include/commands/explain.h
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef EXPLAIN_H
|
|
#define EXPLAIN_H
|
|
|
|
#include "executor/executor.h"
|
|
#include "lib/stringinfo.h"
|
|
|
|
typedef enum ExplainFormat
|
|
{
|
|
EXPLAIN_FORMAT_TEXT,
|
|
EXPLAIN_FORMAT_XML,
|
|
EXPLAIN_FORMAT_JSON,
|
|
EXPLAIN_FORMAT_YAML
|
|
} ExplainFormat;
|
|
|
|
typedef struct ExplainState
|
|
{
|
|
StringInfo str; /* output buffer */
|
|
/* options */
|
|
bool verbose; /* be verbose */
|
|
bool analyze; /* print actual times */
|
|
bool costs; /* print costs */
|
|
bool buffers; /* print buffer usage */
|
|
bool timing; /* print timing */
|
|
ExplainFormat format; /* output format */
|
|
/* other states */
|
|
PlannedStmt *pstmt; /* top of plan */
|
|
List *rtable; /* range table */
|
|
int indent; /* current indentation level */
|
|
List *grouping_stack; /* format-specific grouping state */
|
|
} ExplainState;
|
|
|
|
/* Hook for plugins to get control in ExplainOneQuery() */
|
|
typedef void (*ExplainOneQuery_hook_type) (Query *query,
|
|
IntoClause *into,
|
|
ExplainState *es,
|
|
const char *queryString,
|
|
ParamListInfo params);
|
|
extern PGDLLIMPORT ExplainOneQuery_hook_type ExplainOneQuery_hook;
|
|
|
|
/* Hook for plugins to get control in explain_get_index_name() */
|
|
typedef const char *(*explain_get_index_name_hook_type) (Oid indexId);
|
|
extern PGDLLIMPORT explain_get_index_name_hook_type explain_get_index_name_hook;
|
|
|
|
|
|
extern void ExplainQuery(ExplainStmt *stmt, const char *queryString,
|
|
ParamListInfo params, DestReceiver *dest);
|
|
|
|
extern void ExplainInitState(ExplainState *es);
|
|
|
|
extern TupleDesc ExplainResultDesc(ExplainStmt *stmt);
|
|
|
|
extern void ExplainOneUtility(Node *utilityStmt, IntoClause *into,
|
|
ExplainState *es,
|
|
const char *queryString, ParamListInfo params);
|
|
|
|
extern void ExplainOnePlan(PlannedStmt *plannedstmt, IntoClause *into,
|
|
ExplainState *es,
|
|
const char *queryString, ParamListInfo params);
|
|
|
|
extern void ExplainPrintPlan(ExplainState *es, QueryDesc *queryDesc);
|
|
|
|
extern void ExplainQueryText(ExplainState *es, QueryDesc *queryDesc);
|
|
|
|
extern void ExplainBeginOutput(ExplainState *es);
|
|
extern void ExplainEndOutput(ExplainState *es);
|
|
extern void ExplainSeparatePlans(ExplainState *es);
|
|
|
|
extern void ExplainPropertyList(const char *qlabel, List *data,
|
|
ExplainState *es);
|
|
extern void ExplainPropertyText(const char *qlabel, const char *value,
|
|
ExplainState *es);
|
|
extern void ExplainPropertyInteger(const char *qlabel, int value,
|
|
ExplainState *es);
|
|
extern void ExplainPropertyLong(const char *qlabel, long value,
|
|
ExplainState *es);
|
|
extern void ExplainPropertyFloat(const char *qlabel, double value, int ndigits,
|
|
ExplainState *es);
|
|
|
|
#endif /* EXPLAIN_H */
|