diff options
Diffstat (limited to 'doc/src/sgml/ref/drop_aggregate.sgml')
| -rw-r--r-- | doc/src/sgml/ref/drop_aggregate.sgml | 249 |
1 files changed, 104 insertions, 145 deletions
diff --git a/doc/src/sgml/ref/drop_aggregate.sgml b/doc/src/sgml/ref/drop_aggregate.sgml index b671fa5c145..539d578653a 100644 --- a/doc/src/sgml/ref/drop_aggregate.sgml +++ b/doc/src/sgml/ref/drop_aggregate.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.21 2003/03/25 16:15:39 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.22 2003/05/04 02:23:16 petere Exp $ PostgreSQL documentation --> @@ -8,167 +8,126 @@ PostgreSQL documentation <refentrytitle id="SQL-DROPAGGREGATE-TITLE">DROP AGGREGATE</refentrytitle> <refmiscinfo>SQL - Language Statements</refmiscinfo> </refmeta> + <refnamediv> - <refname> - DROP AGGREGATE - </refname> - <refpurpose> - remove a user-defined aggregate function - </refpurpose> + <refname>DROP AGGREGATE</refname> + <refpurpose>remove a user-defined aggregate function</refpurpose> </refnamediv> + <refsynopsisdiv> - <refsynopsisdivinfo> - <date>1999-07-20</date> - </refsynopsisdivinfo> - <synopsis> +<synopsis> DROP AGGREGATE <replaceable class="PARAMETER">name</replaceable> ( <replaceable class="PARAMETER">type</replaceable> ) [ CASCADE | RESTRICT ] - </synopsis> - - <refsect2 id="R2-SQL-DROPAGGREGATE-1"> - <refsect2info> - <date>1998-04-15</date> - </refsect2info> - <title> - Inputs - </title> - <para> - <variablelist> - <varlistentry> - <term><replaceable class="parameter">name</replaceable></term> - <listitem> - <para> - The name (optionally schema-qualified) of an existing aggregate function. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><replaceable class="parameter">type</replaceable></term> - <listitem> - <para> - The input data type of the aggregate function, - or <literal>*</literal> if the function accepts any input type. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>CASCADE</term> - <listitem> - <para> - Automatically drop objects that depend on the aggregate. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>RESTRICT</term> - <listitem> - <para> - Refuse to drop the aggregate if there are any dependent objects. - This is the default. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect2> - - <refsect2 id="R2-SQL-DROPAGGREGATE-2"> - <refsect2info> - <date>1998-04-15</date> - </refsect2info> - <title> - Outputs - </title> - <para> - <variablelist> - <varlistentry> - <term><computeroutput> -DROP AGGREGATE - </computeroutput></term> - <listitem> - <para> - Message returned if the command is successful. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><computeroutput> -ERROR: RemoveAggregate: aggregate '<replaceable class="parameter">name</replaceable>' for type <replaceable class="parameter">type</replaceable> does not exist - </computeroutput></term> - <listitem> - <para> - This message occurs if the aggregate function specified does not - exist in the database. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect2> +</synopsis> </refsynopsisdiv> - <refsect1 id="R1-SQL-DROPAGGREGATE-1"> - <refsect1info> - <date>1998-04-15</date> - </refsect1info> - <title> - Description - </title> + <refsect1> + <title>Description</title> + <para> <command>DROP AGGREGATE</command> will delete an existing - aggregate definition. To execute this command the current - user must be the owner of the aggregate. + aggregate function. To execute this command the current + user must be the owner of the aggregate function. </para> + </refsect1> + + <refsect1> + <title>Parameters</title> + + <variablelist> + <varlistentry> + <term><replaceable class="parameter">name</replaceable></term> + <listitem> + <para> + The name (optionally schema-qualified) of an existing aggregate function. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">type</replaceable></term> + <listitem> + <para> + The argument data type of the aggregate function, or + <literal>*</literal> if the function accepts any data type. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>CASCADE</literal></term> + <listitem> + <para> + Automatically drop objects that depend on the aggregate function. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>RESTRICT</literal></term> + <listitem> + <para> + Refuse to drop the aggregate function if any objects depend on + it. This is the default. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> - <refsect2 id="R2-SQL-DROPAGGREGATE-3"> - <refsect2info> - <date>1998-04-15</date> - </refsect2info> - <title> - Notes - </title> - - <para> - Use - <xref linkend="sql-createaggregate" endterm="sql-createaggregate-title"> - to create aggregate functions. - </para> - </refsect2> + <refsect1> + <title>Diagnostics</title> + + <variablelist> + <varlistentry> + <term><computeroutput>DROP AGGREGATE</computeroutput></term> + <listitem> + <para> + Message returned if the command was successful. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><computeroutput>ERROR: RemoveAggregate: aggregate '<replaceable class="parameter">name</replaceable>' for type <replaceable class="parameter">type</replaceable> does not exist</computeroutput></term> + <listitem> + <para> + This message is returned if the specified aggregate function + does not exist. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Examples</title> + + <para> + To remove the aggregate function <literal>myavg</literal> for type + <type>integer</type>: +<programlisting> +DROP AGGREGATE myavg(integer); +</programlisting> + </para> </refsect1> - <refsect1 id="R1-SQL-DROPAGGREGATE-2"> - <title> - Usage - </title> + <refsect1> + <title>Compatibility</title> + <para> - To remove the <literal>myavg</literal> aggregate for type - <literal>int4</literal>: + There is no <command>DROP AGGREGATE</command> statement in the SQL + standard. </para> - <programlisting> -DROP AGGREGATE myavg(int4); - </programlisting> </refsect1> - <refsect1 id="R1-SQL-DROPAGGREGATE-3"> - <title> - Compatibility - </title> - - <refsect2 id="R2-SQL-DROPAGGREGATE-4"> - <refsect2info> - <date>1998-04-15</date> - </refsect2info> - <title> - SQL92 - </title> - - <para> - There is no <command>DROP AGGREGATE</command> statement - in <acronym>SQL92</acronym>; the statement is a - <productname>PostgreSQL</productname> - language extension. - </para> - </refsect2> + <refsect1> + <title>See Also</title> + + <simplelist type="inline"> + <member><xref linkend="sql-createaggregate" endterm="sql-createaggregate-title"></member> + </simplelist> </refsect1> + </refentry> <!-- Keep this comment at the end of the file |