aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/drop_aggregate.sgml
blob: 2cd03ae2ff299fb8711a0f4140dcd637a204da22 (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
<REFENTRY ID="SQL-DROPAGGREGATE">
 <REFMETA>
  <REFENTRYTITLE>
   DROP AGGREGATE
  </REFENTRYTITLE>
  <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
 </REFMETA>
 <REFNAMEDIV>
  <REFNAME>
   DROP AGGREGATE
  </REFNAME>
  <REFPURPOSE>
   Removes the definition of an aggregate function
  </REFPURPOSE>
 </refnamediv>
 <REFSYNOPSISDIV>
  <REFSYNOPSISDIVINFO>
   <DATE>1998-04-15</DATE>
  </REFSYNOPSISDIVINFO>
  <SYNOPSIS>
DROP AGGREGATE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> <REPLACEABLE CLASS="PARAMETER">type</REPLACEABLE>
  </SYNOPSIS>
  
  <REFSECT2 ID="R2-SQL-DROPAGGREGATE-1">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Inputs
   </TITLE>
   <PARA>
   </PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <replaceable class="parameter">name</replaceable>
	 </TERM>
	 <LISTITEM>
	  <PARA>
          The name of an existing aggregate function.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <replaceable class="parameter">type</replaceable>
	 </TERM>
	 <LISTITEM>
	  <PARA>
          The type of an existing aggregate function.
          (Refer to the <citetitle>PostgreSQL User's Guide</citetitle> for
	   further information about data types).
	   <comment>This should become a cross-reference rather than a
	    hard-coded chapter number</comment>
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </variablelist>
  </REFSECT2>
  
  <REFSECT2 ID="R2-SQL-DROPAGGREGATE-2">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Outputs
   </TITLE>
   <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>DROP</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
          Message returned if the command is successful.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>WARN RemoveAggregate: aggregate '<replaceable class="parameter">name</replaceable>' for '<replaceable class="parameter">type</replaceable>' does not exist</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
          This message occurs if the aggregate function specified does not
	   exist in the database.
       </para>
      </listitem>
     </varlistentry>
    </VARIABLELIST>
   </para>
  </REFSECT2>
 </REFSYNOPSISDIV>
 
 <REFSECT1 ID="R1-SQL-DROPAGGREGATE-1">
  <REFSECT1INFO>
   <DATE>1998-04-15</DATE>
  </REFSECT1INFO>
  <TITLE>
   Description
  </TITLE>
  <PARA>
   <command>DROP AGGREGATE</command> will remove all references to an existing
   aggregate definition. To execute this command the current
   user must be the owner of the aggregate.
  </PARA>
  
  <REFSECT2 ID="R2-SQL-DROPAGGREGATE-3">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Notes
   </TITLE>
   <PARA>
    The <command>DROP AGGREGATE</command> statement is a
<productname>Postgres</productname>
    language extension.
   </PARA>
   <PARA>
    Refer to the <command>CREATE AGGREGATE</command> statement to
    create aggregate functions.
   </PARA>
  </REFSECT2>
 </REFSECT1>
  
 <REFSECT1 ID="R1-SQL-DROPAGGREGATE-2">
  <TITLE>
   Usage
  </TITLE>
  <PARA>
   To remove the <literal>myavg</literal> aggregate for type
   <literal>int4</literal>:
  </PARA>
  <ProgramListing>
DROP AGGREGATE myavg int4;
  </ProgramListing>
 </REFSECT1>
 
 <REFSECT1 ID="R1-SQL-DROPAGGREGATE-3">
  <TITLE>
   Compatibility
  </TITLE>
  <PARA>
  </PARA>
  
  <REFSECT2 ID="R2-SQL-DROPAGGREGATE-4">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    SQL92
   </TITLE>
   <PARA>
   There is no DROP AGGREGATE statement in <acronym>SQL92</acronym>.
   </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:
-->