summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/html/sql-alteraggregate.html
blob: 291e12f4264e4bf74b6f1be3c44922a796d67138 (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
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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 16.2 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">
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>
ALTER AGGREGATE <em class="replaceable"><code>name</code></em> ( <em class="replaceable"><code>aggregate_signature</code></em> )
                OWNER TO { <em class="replaceable"><code>new_owner</code></em> | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
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>

<span class="phrase">where <em class="replaceable"><code>aggregate_signature</code></em> is:</span>

* |
[ <em class="replaceable"><code>argmode</code></em> ] [ <em class="replaceable"><code>argname</code></em> ] <em class="replaceable"><code>argtype</code></em> [ , ... ] |
[ [ <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> [ , ... ]
</pre></div><div class="refsect1" id="id-1.9.3.4.5"><h2>Description</h2><p>
   <code class="command">ALTER AGGREGATE</code> changes the definition of an
   aggregate function.
  </p><p>
   You must own the aggregate function to use <code class="command">ALTER AGGREGATE</code>.
   To change the schema of an aggregate function, you must also have
   <code class="literal">CREATE</code> privilege on the new schema.
   To alter the owner, you must be able to <code class="literal">SET ROLE</code> to the
   new owning role, and that role must have <code class="literal">CREATE</code>
   privilege on the aggregate function's schema.
   (These restrictions enforce that altering
   the owner doesn't do anything you couldn't do by dropping and recreating
   the aggregate function.  However, a superuser can alter ownership of any
   aggregate function anyway.)
  </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>
      The name (optionally schema-qualified) of an existing aggregate function.
     </p></dd><dt><span class="term"><em class="replaceable"><code>argmode</code></em></span></dt><dd><p>
      The mode of an argument: <code class="literal">IN</code> or <code class="literal">VARIADIC</code>.
      If omitted, the default is <code class="literal">IN</code>.
     </p></dd><dt><span class="term"><em class="replaceable"><code>argname</code></em></span></dt><dd><p>
      The name of an argument.
      Note that <code class="command">ALTER AGGREGATE</code> does not actually pay
      any attention to argument names, since only the argument data
      types are needed to determine the aggregate function's identity.
     </p></dd><dt><span class="term"><em class="replaceable"><code>argtype</code></em></span></dt><dd><p>
      An input data type on which the aggregate function operates.
      To reference a zero-argument aggregate function, write <code class="literal">*</code>
      in place of the list of argument specifications.
      To reference an ordered-set aggregate function, write
      <code class="literal">ORDER BY</code> between the direct and aggregated argument
      specifications.
     </p></dd><dt><span class="term"><em class="replaceable"><code>new_name</code></em></span></dt><dd><p>
      The new name of the aggregate function.
     </p></dd><dt><span class="term"><em class="replaceable"><code>new_owner</code></em></span></dt><dd><p>
      The new owner of the aggregate function.
     </p></dd><dt><span class="term"><em class="replaceable"><code>new_schema</code></em></span></dt><dd><p>
      The new schema for the aggregate function.
     </p></dd></dl></div></div><div class="refsect1" id="id-1.9.3.4.7"><h2>Notes</h2><p>
    The recommended syntax for referencing an ordered-set aggregate
    is to write <code class="literal">ORDER BY</code> between the direct and aggregated
    argument specifications, in the same style as in
    <a class="link" href="sql-createaggregate.html" title="CREATE AGGREGATE"><code class="command">CREATE AGGREGATE</code></a>.  However, it will also work to
    omit <code class="literal">ORDER BY</code> and just run the direct and aggregated
    argument specifications into a single list.  In this abbreviated form,
    if <code class="literal">VARIADIC "any"</code> was used in both the direct and
    aggregated argument lists, write <code class="literal">VARIADIC "any"</code> only once.
   </p></div><div class="refsect1" id="id-1.9.3.4.8"><h2>Examples</h2><p>
   To rename the aggregate function <code class="literal">myavg</code> for type
   <code class="type">integer</code> to <code class="literal">my_average</code>:
</p><pre class="programlisting">
ALTER AGGREGATE myavg(integer) RENAME TO my_average;
</pre><p>
  </p><p>
   To change the owner of the aggregate function <code class="literal">myavg</code> for type
   <code class="type">integer</code> to <code class="literal">joe</code>:
</p><pre class="programlisting">
ALTER AGGREGATE myavg(integer) OWNER TO joe;
</pre><p>
  </p><p>
   To move the ordered-set aggregate <code class="literal">mypercentile</code> with
   direct argument of type <code class="type">float8</code> and aggregated argument
   of type <code class="type">integer</code> into schema <code class="literal">myschema</code>:
</p><pre class="programlisting">
ALTER AGGREGATE mypercentile(float8 ORDER BY integer) SET SCHEMA myschema;
</pre><p>
   This will work too:
</p><pre class="programlisting">
ALTER AGGREGATE mypercentile(float8, integer) SET SCHEMA myschema;
</pre></div><div class="refsect1" id="id-1.9.3.4.9"><h2>Compatibility</h2><p>
   There is no <code class="command">ALTER AGGREGATE</code> statement in the SQL
   standard.
  </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 16.2 Documentation">Home</a></td><td width="40%" align="right" valign="top"> ALTER COLLATION</td></tr></table></div></body></html>