begriffs open source - ai-pg/blob - full-docs/src/sgml/html/sql-alteraggregate.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ALTER AGGREGATE</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="sql-abort.html" title="ABORT" /><link rel="next" href="sql-altercollation.html" title="ALTER COLLATION" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">ALTER AGGREGATE</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="sql-abort.html" title="ABORT">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="sql-commands.html" title="SQL Commands">Up</a></td><th width="60%" align="center">SQL Commands</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="sql-altercollation.html" title="ALTER COLLATION">Next</a></td></tr></table><hr /></div><div class="refentry" id="SQL-ALTERAGGREGATE"><div class="titlepage"></div><a id="id-1.9.3.4.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">ALTER AGGREGATE</span></h2><p>ALTER AGGREGATE — change the definition of an aggregate function</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
   3 ALTER AGGREGATE <em class="replaceable"><code>name</code></em> ( <em class="replaceable"><code>aggregate_signature</code></em> ) RENAME TO <em class="replaceable"><code>new_name</code></em>
   4 ALTER AGGREGATE <em class="replaceable"><code>name</code></em> ( <em class="replaceable"><code>aggregate_signature</code></em> )
   5                 OWNER TO { <em class="replaceable"><code>new_owner</code></em> | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
   6 ALTER AGGREGATE <em class="replaceable"><code>name</code></em> ( <em class="replaceable"><code>aggregate_signature</code></em> ) SET SCHEMA <em class="replaceable"><code>new_schema</code></em>
   7
   8 <span class="phrase">where <em class="replaceable"><code>aggregate_signature</code></em> is:</span>
   9
  10 * |
  11 [ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [ , ... ] |
  12 [ [ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [ , ... ] ] ORDER BY [ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [ , ... ]
  13 </pre></div><div class="refsect1" id="id-1.9.3.4.5"><h2>Description</h2><p>
  14    <code class="command">ALTER AGGREGATE</code> changes the definition of an
  15    aggregate function.
  16   </p><p>
  17    You must own the aggregate function to use <code class="command">ALTER AGGREGATE</code>.
  18    To change the schema of an aggregate function, you must also have
  19    <code class="literal">CREATE</code> privilege on the new schema.
  20    To alter the owner, you must be able to <code class="literal">SET ROLE</code> to the
  21    new owning role, and that role must have <code class="literal">CREATE</code>
  22    privilege on the aggregate function's schema.
  23    (These restrictions enforce that altering
  24    the owner doesn't do anything you couldn't do by dropping and recreating
  25    the aggregate function.  However, a superuser can alter ownership of any
  26    aggregate function anyway.)
  27   </p></div><div class="refsect1" id="id-1.9.3.4.6"><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>name</code></em></span></dt><dd><p>
  28       The name (optionally schema-qualified) of an existing aggregate function.
  29      </p></dd><dt><span class="term"><em class="replaceable"><code>argmode</code></em></span></dt><dd><p>
  30       The mode of an argument: <code class="literal">IN</code> or <code class="literal">VARIADIC</code>.
  31       If omitted, the default is <code class="literal">IN</code>.
  32      </p></dd><dt><span class="term"><em class="replaceable"><code>argname</code></em></span></dt><dd><p>
  33       The name of an argument.
  34       Note that <code class="command">ALTER AGGREGATE</code> does not actually pay
  35       any attention to argument names, since only the argument data
  36       types are needed to determine the aggregate function's identity.
  37      </p></dd><dt><span class="term"><em class="replaceable"><code>argtype</code></em></span></dt><dd><p>
  38       An input data type on which the aggregate function operates.
  39       To reference a zero-argument aggregate function, write <code class="literal">*</code>
  40       in place of the list of argument specifications.
  41       To reference an ordered-set aggregate function, write
  42       <code class="literal">ORDER BY</code> between the direct and aggregated argument
  43       specifications.
  44      </p></dd><dt><span class="term"><em class="replaceable"><code>new_name</code></em></span></dt><dd><p>
  45       The new name of the aggregate function.
  46      </p></dd><dt><span class="term"><em class="replaceable"><code>new_owner</code></em></span></dt><dd><p>
  47       The new owner of the aggregate function.
  48      </p></dd><dt><span class="term"><em class="replaceable"><code>new_schema</code></em></span></dt><dd><p>
  49       The new schema for the aggregate function.
  50      </p></dd></dl></div></div><div class="refsect1" id="id-1.9.3.4.7"><h2>Notes</h2><p>
  51     The recommended syntax for referencing an ordered-set aggregate
  52     is to write <code class="literal">ORDER BY</code> between the direct and aggregated
  53     argument specifications, in the same style as in
  54     <a class="link" href="sql-createaggregate.html" title="CREATE AGGREGATE"><code class="command">CREATE AGGREGATE</code></a>.  However, it will also work to
  55     omit <code class="literal">ORDER BY</code> and just run the direct and aggregated
  56     argument specifications into a single list.  In this abbreviated form,
  57     if <code class="literal">VARIADIC "any"</code> was used in both the direct and
  58     aggregated argument lists, write <code class="literal">VARIADIC "any"</code> only once.
  59    </p></div><div class="refsect1" id="id-1.9.3.4.8"><h2>Examples</h2><p>
  60    To rename the aggregate function <code class="literal">myavg</code> for type
  61    <code class="type">integer</code> to <code class="literal">my_average</code>:
  62 </p><pre class="programlisting">
  63 ALTER AGGREGATE myavg(integer) RENAME TO my_average;
  64 </pre><p>
  65   </p><p>
  66    To change the owner of the aggregate function <code class="literal">myavg</code> for type
  67    <code class="type">integer</code> to <code class="literal">joe</code>:
  68 </p><pre class="programlisting">
  69 ALTER AGGREGATE myavg(integer) OWNER TO joe;
  70 </pre><p>
  71   </p><p>
  72    To move the ordered-set aggregate <code class="literal">mypercentile</code> with
  73    direct argument of type <code class="type">float8</code> and aggregated argument
  74    of type <code class="type">integer</code> into schema <code class="literal">myschema</code>:
  75 </p><pre class="programlisting">
  76 ALTER AGGREGATE mypercentile(float8 ORDER BY integer) SET SCHEMA myschema;
  77 </pre><p>
  78    This will work too:
  79 </p><pre class="programlisting">
  80 ALTER AGGREGATE mypercentile(float8, integer) SET SCHEMA myschema;
  81 </pre></div><div class="refsect1" id="id-1.9.3.4.9"><h2>Compatibility</h2><p>
  82    There is no <code class="command">ALTER AGGREGATE</code> statement in the SQL
  83    standard.
  84   </p></div><div class="refsect1" id="id-1.9.3.4.10"><h2>See Also</h2><span class="simplelist"><a class="xref" href="sql-createaggregate.html" title="CREATE AGGREGATE"><span class="refentrytitle">CREATE AGGREGATE</span></a>, <a class="xref" href="sql-dropaggregate.html" title="DROP AGGREGATE"><span class="refentrytitle">DROP AGGREGATE</span></a></span></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sql-abort.html" title="ABORT">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="sql-commands.html" title="SQL Commands">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="sql-altercollation.html" title="ALTER COLLATION">Next</a></td></tr><tr><td width="40%" align="left" valign="top">ABORT </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> ALTER COLLATION</td></tr></table></div></body></html>