rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve DISCARD documentation. 

The new DISCARD SEQUENCES option was inadequately described, and hadn't
been mentioned at all in the initial Description paragraph.  Rather than
rectifying the latter the hard way, it seemed better to rewrite the
description as a summary, instead of having it basically duplicate
statements made under Parameters.  Be more consistent about the ordering
of the options, too.
This commit is contained in:
Tom Lane 2014-08-17 15:59:03 -04:00
parent 1330e2922c
commit 259904ecd4
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
doc/src/sgml/ref/discard.sgml
View File

@ -30,16 +30,10 @@ DISCARD { ALL | PLANS | SEQUENCES | TEMPORARY | TEMP }
<para>
<command>DISCARD</> releases internal resources associated with a
database session. These resources are normally released at the end
of the session.
</para>
<para>
<command>DISCARD TEMP</> drops all temporary tables created in the
current session. <command>DISCARD PLANS</> releases all internally
cached query plans. <command>DISCARD ALL</> resets a session to
its original state, discarding temporary resources and resetting
session-local configuration changes.
database session. This command is useful for partially or fully
resetting the session's state. There are several subcommands to
release different types of resources; the <command>DISCARD ALL</>
variant subsumes all the others, and also resets additional state.
</para>
</refsect1>
@ -48,20 +42,12 @@ DISCARD { ALL | PLANS | SEQUENCES | TEMPORARY | TEMP }
<variablelist>
<varlistentry>
<term><literal>TEMPORARY</literal> or <literal>TEMP</literal></term>
<listitem>
<para>
Drops all temporary tables created in the current session.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>PLANS</literal></term>
<listitem>
<para>
Releases all cached query plans.
Releases all cached query plans, forcing re-planning to occur
the next time the associated prepared statement is used.
</para>
</listitem>
</varlistentry>
@ -70,7 +56,21 @@ DISCARD { ALL | PLANS | SEQUENCES | TEMPORARY | TEMP }
<term><literal>SEQUENCES</literal></term>
<listitem>
<para>
Discards all cached sequence values.
Discards all cached sequence-related state,
including <function>currval()</>/<function>lastval()</>
information and any preallocated sequence values that have not
yet been returned by <function>nextval()</>.
(See <xref linkend="sql-createsequence"> for a description of
preallocated sequence values.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>TEMPORARY</literal> or <literal>TEMP</literal></term>
<listitem>
<para>
Drops all temporary tables created in the current session.
</para>
</listitem>
</varlistentry>
@ -91,8 +91,8 @@ CLOSE ALL;
UNLISTEN *;
SELECT pg_advisory_unlock_all();
DISCARD PLANS;
DISCARD TEMP;
DISCARD SEQUENCES;
DISCARD TEMP;
</programlisting></para>
</listitem>
</varlistentry>