]> begriffs open source - ai-pg/blob - full-docs/html/sql-alterserver.html
Include latest toc output
[ai-pg] / full-docs / html / sql-alterserver.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 SERVER</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-altersequence.html" title="ALTER SEQUENCE" /><link rel="next" href="sql-alterstatistics.html" title="ALTER STATISTICS" /></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 SERVER</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="sql-altersequence.html" title="ALTER SEQUENCE">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-alterstatistics.html" title="ALTER STATISTICS">Next</a></td></tr></table><hr /></div><div class="refentry" id="SQL-ALTERSERVER"><div class="titlepage"></div><a id="id-1.9.3.31.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">ALTER SERVER</span></h2><p>ALTER SERVER — change the definition of a foreign server</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
3 ALTER SERVER <em class="replaceable"><code>name</code></em> [ VERSION '<em class="replaceable"><code>new_version</code></em>' ]
4     [ OPTIONS ( [ ADD | SET | DROP ] <em class="replaceable"><code>option</code></em> ['<em class="replaceable"><code>value</code></em>'] [, ... ] ) ]
5 ALTER SERVER <em class="replaceable"><code>name</code></em> OWNER TO { <em class="replaceable"><code>new_owner</code></em> | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
6 ALTER SERVER <em class="replaceable"><code>name</code></em> RENAME TO <em class="replaceable"><code>new_name</code></em>
7 </pre></div><div class="refsect1" id="id-1.9.3.31.5"><h2>Description</h2><p>
8    <code class="command">ALTER SERVER</code> changes the definition of a foreign
9    server.  The first form changes the server version string or the
10    generic options of the server (at least one clause is required).
11    The second form changes the owner of the server.
12   </p><p>
13    To alter the server you must be the owner of the server.
14    Additionally to alter the owner, you must be able to
15    <code class="literal">SET ROLE</code> to the new owning role, and you must
16    have <code class="literal">USAGE</code> privilege on the server's foreign-data
17    wrapper.  (Note that superusers satisfy all these criteria
18    automatically.)
19   </p></div><div class="refsect1" id="id-1.9.3.31.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>
20       The name of an existing server.
21      </p></dd><dt><span class="term"><em class="replaceable"><code>new_version</code></em></span></dt><dd><p>
22       New server version.
23      </p></dd><dt><span class="term"><code class="literal">OPTIONS ( [ ADD | SET | DROP ] <em class="replaceable"><code>option</code></em> ['<em class="replaceable"><code>value</code></em>'] [, ... ] )</code></span></dt><dd><p>
24       Change options for the
25       server.  <code class="literal">ADD</code>, <code class="literal">SET</code>, and <code class="literal">DROP</code>
26       specify the action to be performed.  <code class="literal">ADD</code> is assumed
27       if no operation is explicitly specified.  Option names must be
28       unique; names and values are also validated using the server's
29       foreign-data wrapper library.
30      </p></dd><dt><span class="term"><em class="replaceable"><code>new_owner</code></em></span></dt><dd><p>
31       The user name of the new owner of the foreign server.
32      </p></dd><dt><span class="term"><em class="replaceable"><code>new_name</code></em></span></dt><dd><p>
33       The new name for the foreign server.
34      </p></dd></dl></div></div><div class="refsect1" id="id-1.9.3.31.7"><h2>Examples</h2><p>
35    Alter server <code class="literal">foo</code>, add connection options:
36 </p><pre class="programlisting">
37 ALTER SERVER foo OPTIONS (host 'foo', dbname 'foodb');
38 </pre><p>
39   </p><p>
40    Alter server <code class="literal">foo</code>, change version,
41    change <code class="literal">host</code> option:
42 </p><pre class="programlisting">
43 ALTER SERVER foo VERSION '8.4' OPTIONS (SET host 'baz');
44 </pre></div><div class="refsect1" id="id-1.9.3.31.8"><h2>Compatibility</h2><p>
45    <code class="command">ALTER SERVER</code> conforms to ISO/IEC 9075-9 (SQL/MED).
46    The <code class="literal">OWNER TO</code> and <code class="literal">RENAME</code> forms are
47    PostgreSQL extensions.
48   </p></div><div class="refsect1" id="id-1.9.3.31.9"><h2>See Also</h2><span class="simplelist"><a class="xref" href="sql-createserver.html" title="CREATE SERVER"><span class="refentrytitle">CREATE SERVER</span></a>, <a class="xref" href="sql-dropserver.html" title="DROP SERVER"><span class="refentrytitle">DROP SERVER</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-altersequence.html" title="ALTER SEQUENCE">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-alterstatistics.html" title="ALTER STATISTICS">Next</a></td></tr><tr><td width="40%" align="left" valign="top">ALTER SEQUENCE </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 STATISTICS</td></tr></table></div></body></html>