diff options
author | Andrew Dunstan <andrew@dunslane.net> | 2009-12-11 01:33:35 +0000 |
---|---|---|
committer | Andrew Dunstan <andrew@dunslane.net> | 2009-12-11 01:33:35 +0000 |
commit | 324385d67fe87e182325decdef1756a8f76733a8 (patch) | |
tree | fd545c52c2f5218202570200ad13df1ad45670d5 /doc/src | |
parent | db7386187f78dfc45b86b6f4f382f6b12cdbc693 (diff) | |
download | postgresql-324385d67fe87e182325decdef1756a8f76733a8.tar.gz postgresql-324385d67fe87e182325decdef1756a8f76733a8.zip |
Add YAML to list of EXPLAIN formats. Greg Sabino Mullane, reviewed by Takahiro Itagaki.
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/auto-explain.sgml | 4 | ||||
-rw-r--r-- | doc/src/sgml/ref/explain.sgml | 8 | ||||
-rw-r--r-- | doc/src/sgml/release-8.5.sgml | 4 |
3 files changed, 8 insertions, 8 deletions
diff --git a/doc/src/sgml/auto-explain.sgml b/doc/src/sgml/auto-explain.sgml index 72487f944ce..39c7bc20f59 100644 --- a/doc/src/sgml/auto-explain.sgml +++ b/doc/src/sgml/auto-explain.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/auto-explain.sgml,v 1.4 2009/08/10 05:46:50 tgl Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/auto-explain.sgml,v 1.5 2009/12/11 01:33:35 adunstan Exp $ --> <sect1 id="auto-explain"> <title>auto_explain</title> @@ -114,7 +114,7 @@ LOAD 'auto_explain'; <varname>auto_explain.log_format</varname> selects the <command>EXPLAIN</> output format to be used. The allowed values are <literal>text</literal>, <literal>xml</literal>, - and <literal>json</literal>. The default is text. + <literal>json</literal>, and <literal>yaml</literal>. The default is text. Only superusers can change this setting. </para> </listitem> diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index 9670bd06f19..4de5a4aba63 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/ref/explain.sgml,v 1.46 2009/08/10 05:46:50 tgl Exp $ +$PostgreSQL: pgsql/doc/src/sgml/ref/explain.sgml,v 1.47 2009/12/11 01:33:35 adunstan Exp $ PostgreSQL documentation --> @@ -31,7 +31,7 @@ PostgreSQL documentation <refsynopsisdiv> <synopsis> -EXPLAIN [ ( { ANALYZE <replaceable class="parameter">boolean</replaceable> | VERBOSE <replaceable class="parameter">boolean</replaceable> | COSTS <replaceable class="parameter">boolean</replaceable> | FORMAT { TEXT | XML | JSON } } [, ...] ) ] <replaceable class="parameter">statement</replaceable> +EXPLAIN [ ( { ANALYZE <replaceable class="parameter">boolean</replaceable> | VERBOSE <replaceable class="parameter">boolean</replaceable> | COSTS <replaceable class="parameter">boolean</replaceable> | FORMAT { TEXT | XML | JSON | YAML } } [, ...] ) ] <replaceable class="parameter">statement</replaceable> EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="parameter">statement</replaceable> </synopsis> </refsynopsisdiv> @@ -143,8 +143,8 @@ ROLLBACK; <term><literal>FORMAT</literal></term> <listitem> <para> - Specify the output format, which can be TEXT, XML, or JSON. - XML or JSON output contains the same information as the text output + Specify the output format, which can be TEXT, XML, JSON, or YAML. + Non-text output contains the same information as the text output format, but is easier for programs to parse. This parameter defaults to <literal>TEXT</literal>. </para> diff --git a/doc/src/sgml/release-8.5.sgml b/doc/src/sgml/release-8.5.sgml index caca7508250..f95b35505c3 100644 --- a/doc/src/sgml/release-8.5.sgml +++ b/doc/src/sgml/release-8.5.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/release-8.5.sgml,v 1.8 2009/11/26 21:20:12 tgl Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/release-8.5.sgml,v 1.9 2009/12/11 01:33:35 adunstan Exp $ --> <sect1 id="release-8-5"> <title>Release 8.5alpha2</title> @@ -176,7 +176,7 @@ </listitem> <listitem> <para> - EXPLAIN allows output of plans in XML or JSON format for automated + EXPLAIN allows output of plans in XML, JSON, or YAML format for automated processing of explain plans by analysis or visualization tools. </para> </listitem> |