diff options
Diffstat (limited to 'doc/src/sgml/ref/drop_aggregate.sgml')
| -rw-r--r-- | doc/src/sgml/ref/drop_aggregate.sgml | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/drop_aggregate.sgml b/doc/src/sgml/ref/drop_aggregate.sgml new file mode 100644 index 0000000000..6bf9fe2c9d --- /dev/null +++ b/doc/src/sgml/ref/drop_aggregate.sgml @@ -0,0 +1,193 @@ +<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> + <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> + </TERM> + <LISTITEM> + <PARA> + <VARIABLELIST> + <VARLISTENTRY> + <TERM> + <ReturnValue><replaceable class="parameter">name</replaceable></ReturnValue> + </TERM> + <LISTITEM> + <PARA> + The name of an existing aggregate function. + </PARA> + </LISTITEM> + </VARLISTENTRY> + <VARLISTENTRY> + <TERM> + <ReturnValue><replaceable class="parameter">type</replaceable></ReturnValue> + </TERM> + <LISTITEM> + <PARA> + The type of an existing aggregate function. + (Refer to PostgreSQL User's Guide chapter 4 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> + </LISTITEM> + </VARLISTENTRY> + </VARIABLELIST> + </REFSECT2> + + <REFSECT2 ID="R2-SQL-DROPAGGREGATE-2"> + <REFSECT2INFO> + <DATE>1998-04-15</DATE> + </REFSECT2INFO> + <TITLE> + Outputs + </TITLE> + <PARA> + </PARA> + <VARIABLELIST> + <VARLISTENTRY> + <TERM> + </TERM> + <LISTITEM> + <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 'type' 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> + </LISTITEM> + </VARLISTENTRY> + </VARIABLELIST> + </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 PostgreSQL + 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 SQL92. + </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: +--> |