summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man7/DISCARD.7
blob: 0b7bbbc88401c0b3b5b94413727839f22db79567 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
'\" t
.\"     Title: DISCARD
.\"    Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2022
.\"    Manual: PostgreSQL 14.5 Documentation
.\"    Source: PostgreSQL 14.5
.\"  Language: English
.\"
.TH "DISCARD" "7" "2022" "PostgreSQL 14.5" "PostgreSQL 14.5 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
DISCARD \- discard session state
.SH "SYNOPSIS"
.sp
.nf
DISCARD { ALL | PLANS | SEQUENCES | TEMPORARY | TEMP }
.fi
.SH "DESCRIPTION"
.PP
\fBDISCARD\fR
releases internal resources associated with a database session\&. This command is useful for partially or fully resetting the session\*(Aqs state\&. There are several subcommands to release different types of resources; the
\fBDISCARD ALL\fR
variant subsumes all the others, and also resets additional state\&.
.SH "PARAMETERS"
.PP
PLANS
.RS 4
Releases all cached query plans, forcing re\-planning to occur the next time the associated prepared statement is used\&.
.RE
.PP
SEQUENCES
.RS 4
Discards all cached sequence\-related state, including
\fBcurrval()\fR/\fBlastval()\fR
information and any preallocated sequence values that have not yet been returned by
\fBnextval()\fR\&. (See
CREATE SEQUENCE (\fBCREATE_SEQUENCE\fR(7))
for a description of preallocated sequence values\&.)
.RE
.PP
TEMPORARY or TEMP
.RS 4
Drops all temporary tables created in the current session\&.
.RE
.PP
ALL
.RS 4
Releases all temporary resources associated with the current session and resets the session to its initial state\&. Currently, this has the same effect as executing the following sequence of statements:
.sp
.if n \{\
.RS 4
.\}
.nf
CLOSE ALL;
SET SESSION AUTHORIZATION DEFAULT;
RESET ALL;
DEALLOCATE ALL;
UNLISTEN *;
SELECT pg_advisory_unlock_all();
DISCARD PLANS;
DISCARD TEMP;
DISCARD SEQUENCES;
.fi
.if n \{\
.RE
.\}
.RE
.SH "NOTES"
.PP
\fBDISCARD ALL\fR
cannot be executed inside a transaction block\&.
.SH "COMPATIBILITY"
.PP
\fBDISCARD\fR
is a
PostgreSQL
extension\&.