blob: 227aa454971bebaeb345a894abaee7b4629781bc (
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
97
98
99
100
101
102
103
104
105
106
|
'\" t
.\" Title: DO
.\" Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024
.\" Manual: PostgreSQL 16.2 Documentation
.\" Source: PostgreSQL 16.2
.\" Language: English
.\"
.TH "DO" "7" "2024" "PostgreSQL 16.2" "PostgreSQL 16.2 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"
DO \- execute an anonymous code block
.SH "SYNOPSIS"
.sp
.nf
DO [ LANGUAGE \fIlang_name\fR ] \fIcode\fR
.fi
.SH "DESCRIPTION"
.PP
\fBDO\fR
executes an anonymous code block, or in other words a transient anonymous function in a procedural language\&.
.PP
The code block is treated as though it were the body of a function with no parameters, returning
void\&. It is parsed and executed a single time\&.
.PP
The optional
LANGUAGE
clause can be written either before or after the code block\&.
.SH "PARAMETERS"
.PP
\fIcode\fR
.RS 4
The procedural language code to be executed\&. This must be specified as a string literal, just as in
\fBCREATE FUNCTION\fR\&. Use of a dollar\-quoted literal is recommended\&.
.RE
.PP
\fIlang_name\fR
.RS 4
The name of the procedural language the code is written in\&. If omitted, the default is
plpgsql\&.
.RE
.SH "NOTES"
.PP
The procedural language to be used must already have been installed into the current database by means of
\fBCREATE EXTENSION\fR\&.
plpgsql
is installed by default, but other languages are not\&.
.PP
The user must have
USAGE
privilege for the procedural language, or must be a superuser if the language is untrusted\&. This is the same privilege requirement as for creating a function in the language\&.
.PP
If
\fBDO\fR
is executed in a transaction block, then the procedure code cannot execute transaction control statements\&. Transaction control statements are only allowed if
\fBDO\fR
is executed in its own transaction\&.
.SH "EXAMPLES"
.PP
Grant all privileges on all views in schema
public
to role
webuser:
.sp
.if n \{\
.RS 4
.\}
.nf
DO $$DECLARE r record;
BEGIN
FOR r IN SELECT table_schema, table_name FROM information_schema\&.tables
WHERE table_type = \*(AqVIEW\*(Aq AND table_schema = \*(Aqpublic\*(Aq
LOOP
EXECUTE \*(AqGRANT ALL ON \*(Aq || quote_ident(r\&.table_schema) || \*(Aq\&.\*(Aq || quote_ident(r\&.table_name) || \*(Aq TO webuser\*(Aq;
END LOOP;
END$$;
.fi
.if n \{\
.RE
.\}
.SH "COMPATIBILITY"
.PP
There is no
\fBDO\fR
statement in the SQL standard\&.
.SH "SEE ALSO"
CREATE LANGUAGE (\fBCREATE_LANGUAGE\fR(7))
|
