doc/src/sgml/ref/alter_user.sgml

   1 <!--
   2 $PostgreSQL$
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-ALTERUSER">
   7  <refmeta>
   8   <refentrytitle id="sql-alteruser-title">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 where <replaceable class="PARAMETER">option</replaceable> can be:
  27
  28       SUPERUSER | NOSUPERUSER
  29     | CREATEDB | NOCREATEDB
  30     | CREATEROLE | NOCREATEROLE
  31     | CREATEUSER | NOCREATEUSER
  32     | INHERIT | NOINHERIT
  33     | LOGIN | NOLOGIN
  34     | CONNECTION LIMIT <replaceable class="PARAMETER">connlimit</replaceable>
  35     | [ ENCRYPTED | UNENCRYPTED ] PASSWORD '<replaceable class="PARAMETER">password</replaceable>'
  36     | VALID UNTIL '<replaceable class="PARAMETER">timestamp</replaceable>'
  37
  38 ALTER USER <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>
  39
  40 ALTER USER <replaceable class="PARAMETER">name</replaceable> SET <replaceable>configuration_parameter</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
  41 ALTER USER <replaceable class="PARAMETER">name</replaceable> SET <replaceable>configuration_parameter</replaceable> FROM CURRENT
  42 ALTER USER <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>configuration_parameter</replaceable>
  43 ALTER USER <replaceable class="PARAMETER">name</replaceable> RESET ALL
  44 </synopsis>
  45  </refsynopsisdiv>
  46
  47  <refsect1>
  48   <title>Description</title>
  49
  50   <para>
  51    <command>ALTER USER</command> is now an alias for
  52    <xref linkend="sql-alterrole" endterm="sql-alterrole-title">.
  53   </para>
  54  </refsect1>
  55
  56  <refsect1>
  57   <title>Compatibility</title>
  58
  59   <para>
  60    The <command>ALTER USER</command> statement is a
  61    <productname>PostgreSQL</productname> extension.  The SQL standard
  62    leaves the definition of users to the implementation.
  63   </para>
  64  </refsect1>
  65
  66  <refsect1>
  67   <title>See Also</title>
  68
  69   <simplelist type="inline">
  70    <member><xref linkend="sql-alterrole" endterm="sql-alterrole-title"></member>
  71   </simplelist>
  72  </refsect1>
  73 </refentry>