postgresql/doc/src/sgml/ref/alter_user.sgml

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.19 2002/02/27 21:14:53 petere Exp $
PostgreSQL documentation
-->

<refentry id="SQL-ALTERUSER">
 <refmeta>
  <refentrytitle id="sql-alteruser-title">ALTER USER</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>ALTER USER</refname>
  <refpurpose>change a database user account</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
<synopsis>
ALTER USER <replaceable class="PARAMETER">username</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ]

where <replaceable class="PARAMETER">option</replaceable> can be:

      [ ENCRYPTED | UNENCRYPTED ] PASSWORD '<replaceable class="PARAMETER">password</replaceable>' 
    | CREATEDB | NOCREATEDB
    | CREATEUSER | NOCREATEUSER 
    | VALID UNTIL '<replaceable class="PARAMETER">abstime</replaceable>'
</synopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <para>
   <command>ALTER USER</command> is used to change the attributes of a
   <productname>PostgreSQL</productname> user account.  Attributes not
   mentioned in the command retain their previous settings.
  </para>

  <para>
   Only a database superuser can change privileges and password
   expiration with this command. Ordinary users can only change their
   own password.
  </para>

  <refsect2>
   <title>Parameters</title>

   <para>
    <variablelist>
     <varlistentry>
      <term><replaceable class="PARAMETER">username</replaceable></term>
      <listitem>
       <para>
	The name of the user whose attributes are to be altered.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><replaceable class="PARAMETER">password</replaceable></term>
      <listitem>
       <para>
	The new password to be used for this account.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>ENCRYPTED</literal></term>
      <term><literal>UNENCRYPTED</literal></term>
      <listitem>
       <para>
	These key words control whether the password is stored
	encrypted in <literal>pg_shadow</>.  (See
	<xref linkend="SQL-CREATEUSER" endterm="SQL-CREATEUSER-title">
	for more information about this choice.)
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>CREATEDB</literal></term>
      <term><literal>NOCREATEDB</literal></term>
      <listitem>
       <para>
	These clauses define a user's ability to create databases.  If
	<literal>CREATEDB</literal> is specified, the user being
	defined will be allowed to create his own databases. Using
	<literal>NOCREATEDB</literal> will deny a user the ability to
	create databases.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>CREATEUSER</literal></term>
      <term><literal>NOCREATEUSER</literal></term>
      <listitem>
       <para>
	These clauses determine whether a user will be permitted to
	create new users himself. This option will also make the user
	a superuser who can override all access restrictions.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><replaceable class="PARAMETER">abstime</replaceable></term>
      <listitem>
       <para>
	The date (and, optionally, the time)
	at which this user's password is to expire.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>
 </refsect1>

 <refsect1>
  <title>Diagnostics</title>

  <para>
   <variablelist>
    <varlistentry>
     <term><computeroutput>ALTER USER</computeroutput></term>
     <listitem>
      <para>
       Message returned if the alteration was successful.
      </para>
     </listitem>
    </varlistentry>
     
    <varlistentry>
     <term><computeroutput>ERROR:  ALTER USER: user "username" does not exist</computeroutput></term>
     <listitem>
      <para>
       Error message returned if the specified user is not known to
       the database.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1>
  <title>Notes</title>

  <para>
   Use <xref linkend="SQL-CREATEUSER" endterm="SQL-CREATEUSER-title">
   to add new users, and <xref linkend="SQL-DROPUSER"
   endterm="SQL-DROPUSER-title"> to remoe a user.
  </para>

  <para>
   <command>ALTER USER</command> cannot change a user's group memberships.
   Use <xref linkend="SQL-ALTERGROUP" endterm="SQL-ALTERGROUP-title">
   to do that.
  </para>
 </refsect1>

 <refsect1>
  <title>Examples</title>

  <para>
   Change a user password:

<programlisting>
ALTER USER davide WITH PASSWORD 'hu8jmn3';
</programlisting>
  </para>

  <para>
   Change a user's valid until date:

<programlisting>
ALTER USER manuel VALID UNTIL 'Jan 31 2030';
</programlisting>
  </para>

  <para>
   Change a user's valid until date, specifying that his
   authorization should expire at midday on 4th May 1998 using
   the time zone which is one hour ahead of UTC:
<programlisting>
ALTER USER chris VALID UNTIL 'May 4 12:00:00 1998 +1';
</programlisting>
  </para>

  <para>
   Give a user the ability to create other users and new databases:

<programlisting>
ALTER USER miriam CREATEUSER CREATEDB;
</programlisting>
  </para>
 </refsect1>

 <refsect1>
  <title>Compatibility</title>
    
  <para>
   The <command>ALTER USER</command> statement is a
   <productname>PostgreSQL</productname> extension.  The SQL standard
   leaves the definition of users to the implementation.
  </para>
 </refsect1>

 <refsect1>
  <title>See Also</title>

  <simplelist type="inline">
   <member><xref linkend="sql-createuser" endterm="sql-createuser-title"></member>
   <member><xref linkend="sql-dropuser" endterm="sql-dropuser-title"></member>
  </simplelist>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->