granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/alter_user.sgml

   1 <!--
   2 doc/src/sgml/ref/alter_user.sgml
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-ALTERUSER">
   7  <refmeta>
   8   <refentrytitle>ALTER USER</refentrytitle>
   9   <manvolnum>7</manvolnum>
  10   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>ALTER USER</refname>
  15   <refpurpose>change a database role</refpurpose>
  16  </refnamediv>
  17
  18  <indexterm zone="sql-alteruser">
  19   <primary>ALTER USER</primary>
  20  </indexterm>
  21
  22  <refsynopsisdiv>
  23 <synopsis>
  24 ALTER USER <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ]
  25
  26 <phrase>where <replaceable class="PARAMETER">option</replaceable> can be:</phrase>
  27
  28       SUPERUSER | NOSUPERUSER
  29     | CREATEDB | NOCREATEDB
  30     | CREATEROLE | NOCREATEROLE
  31     | CREATEUSER | NOCREATEUSER
  32     | INHERIT | NOINHERIT
  33     | LOGIN | NOLOGIN
  34     | REPLICATION | NOREPLICATION
  35     | CONNECTION LIMIT <replaceable class="PARAMETER">connlimit</replaceable>
  36     | [ ENCRYPTED | UNENCRYPTED ] PASSWORD '<replaceable class="PARAMETER">password</replaceable>'
  37     | VALID UNTIL '<replaceable class="PARAMETER">timestamp</replaceable>'
  38
  39 ALTER USER <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>new_name</replaceable>
  40
  41 ALTER USER <replaceable class="PARAMETER">name</replaceable> SET <replaceable>configuration_parameter</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
  42 ALTER USER <replaceable class="PARAMETER">name</replaceable> SET <replaceable>configuration_parameter</replaceable> FROM CURRENT
  43 ALTER USER <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>configuration_parameter</replaceable>
  44 ALTER USER <replaceable class="PARAMETER">name</replaceable> RESET ALL
  45 </synopsis>
  46  </refsynopsisdiv>
  47
  48  <refsect1>
  49   <title>Description</title>
  50
  51   <para>
  52    <command>ALTER USER</command> is now an alias for
  53    <xref linkend="sql-alterrole">.
  54   </para>
  55  </refsect1>
  56
  57  <refsect1>
  58   <title>Compatibility</title>
  59
  60   <para>
  61    The <command>ALTER USER</command> statement is a
  62    <productname>PostgreSQL</productname> extension.  The SQL standard
  63    leaves the definition of users to the implementation.
  64   </para>
  65  </refsect1>
  66
  67  <refsect1>
  68   <title>See Also</title>
  69
  70   <simplelist type="inline">
  71    <member><xref linkend="sql-alterrole"></member>
  72   </simplelist>
  73  </refsect1>
  74 </refentry>