Add ability to set query plan formats on the run

Author: kovmir

pg_show_plans--1.0.sql

@@ -14,35 +14,47 @@ RETURNS void
 AS 'MODULE_PATHNAME'
 LANGUAGE C;
 
+CREATE FUNCTION pgsp_format_text()
+RETURNS void
+AS 'MODULE_PATHNAME'
+LANGUAGE C;
+
 CREATE FUNCTION pgsp_format_json()
 RETURNS void
 AS 'MODULE_PATHNAME'
 LANGUAGE C;
 
-CREATE FUNCTION pgsp_format_text()
+CREATE FUNCTION pgsp_format_yaml()
+RETURNS void
+AS 'MODULE_PATHNAME'
+LANGUAGE C;
+
+CREATE FUNCTION pgsp_format_xml()
 RETURNS void
 AS 'MODULE_PATHNAME'
 LANGUAGE C;
 
 CREATE FUNCTION pg_show_plans(
-    OUT pid int8,
-    OUT level int8,
-    OUT userid oid,
-    OUT dbid oid,
-    OUT plan text
+	OUT pid int8,
+	OUT level int8,
+	OUT userid oid,
+	OUT dbid oid,
+	OUT plan text
 )
 RETURNS SETOF record
 AS 'MODULE_PATHNAME'
 LANGUAGE C;
 
 -- Register a view on the function for ease of use.
 CREATE VIEW pg_show_plans AS
-  SELECT * FROM pg_show_plans();
+	SELECT * FROM pg_show_plans();
 
 GRANT SELECT ON pg_show_plans TO PUBLIC;
 
 -- Don't want this to be available to non-superusers.
 REVOKE ALL ON FUNCTION pg_show_plans_enable() FROM PUBLIC;
 REVOKE ALL ON FUNCTION pg_show_plans_disable() FROM PUBLIC;
-REVOKE ALL ON FUNCTION pgsp_format_json() FROM PUBLIC;
 REVOKE ALL ON FUNCTION pgsp_format_text() FROM PUBLIC;
+REVOKE ALL ON FUNCTION pgsp_format_json() FROM PUBLIC;
+REVOKE ALL ON FUNCTION pgsp_format_yaml() FROM PUBLIC;
+REVOKE ALL ON FUNCTION pgsp_format_xml() FROM PUBLIC;

pg_show_plans.c

@@ -95,16 +95,24 @@ static void pgsp_ExecutorStart(QueryDesc *queryDesc, int eflags);
 static void pgsp_ExecutorRun(QueryDesc *queryDesc, ScanDirection direction,
                              uint64 count, bool execute_once);
 
-/* Enables the extension. */
+/* Enables/Disables the extension. */
 Datum pg_show_plans_enable(PG_FUNCTION_ARGS);
-/* Disables the extension. */
 Datum pg_show_plans_disable(PG_FUNCTION_ARGS);
+/* Sets query plan output format. */
+Datum pgsp_format_text(PG_FUNCTION_ARGS);
+Datum pgsp_format_json(PG_FUNCTION_ARGS);
+Datum pgsp_format_yaml(PG_FUNCTION_ARGS);
+Datum pgsp_format_xml(PG_FUNCTION_ARGS);
 /* Show query plans of all the currently running statements. */
 Datum pg_show_plans(PG_FUNCTION_ARGS);
 
-PG_FUNCTION_INFO_V1(pg_show_plans);
 PG_FUNCTION_INFO_V1(pg_show_plans_enable);
 PG_FUNCTION_INFO_V1(pg_show_plans_disable);
+PG_FUNCTION_INFO_V1(pgsp_format_text);
+PG_FUNCTION_INFO_V1(pgsp_format_json);
+PG_FUNCTION_INFO_V1(pgsp_format_yaml);
+PG_FUNCTION_INFO_V1(pgsp_format_xml);
+PG_FUNCTION_INFO_V1(pg_show_plans);
 
 /* Global Variables */
 /* Shared extension state. */
@@ -433,6 +441,35 @@ pg_show_plans_disable(PG_FUNCTION_ARGS)
 	pgsp->is_enabled = false;
 	PG_RETURN_VOID();
 }
+
+Datum
+pgsp_format_text(PG_FUNCTION_ARGS)
+{
+	pgsp->plan_format = EXPLAIN_FORMAT_TEXT;
+	PG_RETURN_VOID();
+}
+
+Datum
+pgsp_format_json(PG_FUNCTION_ARGS)
+{
+	pgsp->plan_format = EXPLAIN_FORMAT_JSON;
+	PG_RETURN_VOID();
+}
+
+Datum
+pgsp_format_yaml(PG_FUNCTION_ARGS)
+{
+	pgsp->plan_format = EXPLAIN_FORMAT_YAML;
+	PG_RETURN_VOID();
+}
+
+Datum
+pgsp_format_xml(PG_FUNCTION_ARGS)
+{
+	pgsp->plan_format = EXPLAIN_FORMAT_XML;
+	PG_RETURN_VOID();
+}
+
 Datum
 pg_show_plans(PG_FUNCTION_ARGS)
 {