aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/delete.sgml
blob: 341c97370fb93ff114eab45b8bf4a652d1af935e (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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
<REFENTRY ID="SQL-DELETE">
 <REFMETA>
  <REFENTRYTITLE>
   DELETE
  </REFENTRYTITLE>
  <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
 </REFMETA>
 <REFNAMEDIV>
  <REFNAME>
   DELETE
  </REFNAME>
  <REFPURPOSE>
   Deletes rows from a table
  </REFPURPOSE>
  
 </refnamediv>
 <REFSYNOPSISDIV>
  <REFSYNOPSISDIVINFO>
   <DATE>1998-04-15</DATE>
  </REFSYNOPSISDIVINFO>
  <SYNOPSIS>
   DELETE FROM <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> [ WHERE <REPLACEABLE CLASS="PARAMETER">condition</REPLACEABLE> ]
  </SYNOPSIS>
  
  <REFSECT2 ID="R2-SQL-DELETE-1">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Inputs
   </TITLE>
   <PARA>
   </PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <replaceable class="parameter">table</replaceable>
	 </TERM>
	 <LISTITEM>
	  <PARA>
          The name of an existing table.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <replaceable class="parameter">condition</replaceable>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   This is an SQL selection query which returns the rows which
	   are to be deleted.
	  </PARA>
	  <PARA>
          Refer to the SELECT statement for further description
          of the WHERE clause.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </variablelist>
  </REFSECT2>
  
  <REFSECT2 ID="R2-SQL-DELETE-2">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Outputs
   </TITLE>
   <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue> DELETE <replaceable class="parameter">count</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   Message returned if items are successfully deleted. The
	   <replaceable class="parameter">count</replaceable> is the number
	   of rows deleted.
	  </PARA>
	  <PARA>
	   If <replaceable class="parameter">count</replaceable> is 0,
	   no rows were deleted.
       </para>
      </listitem>
     </varlistentry>
    </VARIABLELIST>
   </para>
  </REFSECT2>
 </REFSYNOPSISDIV>
 
 <REFSECT1 ID="R1-SQL-DELETE-1">
  <REFSECT1INFO>
   <DATE>1998-04-15</DATE>
  </REFSECT1INFO>
  <TITLE>
   Description
  </TITLE>
  <PARA>
   DELETE removes rows which satisfy the WHERE <replaceable class="parameter">condition</replaceable>,
   from the specified table.
  </PARA>
  <PARA>
   If the <replaceable class="parameter">condition</replaceable> is absent,
   the effect is to delete all rows in the table.
   The result is a valid, but empty table.
  </PARA>
  <PARA>
   You must have write access to the table in order to modify
   it, as well as read access to any table whose values are
   read in the <replaceable class="parameter">condition</replaceable>.
  </PARA>
 </REFSECT1>
  
 <REFSECT1 ID="R1-SQL-DELETE-2">
  <TITLE>
   Usage
  </TITLE>
  <PARA>
   Remove all films but musicals:
  </PARA>
  <ProgramListing>
DETETE FROM films WHERE kind &lt;&gt; 'Musical';

SELECT * FROM films;

code |title                    |did| date_prod|kind      |len
-----+-------------------------+---+----------+----------+------
UA501|West Side Story          |105|1961-01-03|Musical   | 02:32
TC901|The King and I           |109|1956-08-11|Musical   | 02:13
WD101|Bed Knobs and Broomsticks|111|          |Musical   | 01:57
(3 rows)
  </ProgramListing>
  <para>
   Clear the table <literal>films</literal>:
  </para>
  <programlisting>
DELETE FROM films;
   
SELECT * FROM films;
code|title|did|date_prod|kind|len
----+-----+---+---------+----+---
(0 rows)
  </programlisting>      
 </REFSECT1>
 
 <REFSECT1 ID="R1-SQL-DELETE-3">
  <TITLE>
   Compatibility
  </TITLE>
  <PARA>
  </PARA>
  
  <REFSECT2 ID="R2-SQL-DELETE-4">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    SQL92
   </TITLE>
   <PARA>
   <acronym>SQL92</acronym> allows a positioned DELETE statement:
   </PARA>
   
   <synopsis>
DELETE FROM <replaceable class="parameter">table</replaceable> WHERE CURRENT OF <replaceable class="parameter">cursor</replaceable>
   </synopsis>
   <para>
   where <replaceable class="parameter">cursor</replaceable> identifies an open cursor. Interactive cursors in <productname>Postgres</productname> are read-only.
   </para>
  </refsect2>
 </refsect1>
</REFENTRY>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->