281 lines
8.2 KiB
Plaintext
281 lines
8.2 KiB
Plaintext
<!--
|
|
$PostgreSQL: pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.32 2003/11/29 19:51:38 pgsql 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>
|
|
|
|
<indexterm zone="sql-alteruser">
|
|
<primary>ALTER USER</primary>
|
|
</indexterm>
|
|
|
|
<refsynopsisdiv>
|
|
<synopsis>
|
|
ALTER USER <replaceable class="PARAMETER">name</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>'
|
|
|
|
ALTER USER <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>
|
|
|
|
ALTER USER <replaceable class="PARAMETER">name</replaceable> SET <replaceable>parameter</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
|
|
ALTER USER <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>parameter</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>
|
|
The first variant of this command in the synopsis changes certain
|
|
global user privileges and authentication settings. (See below for
|
|
details.) Only a database superuser can change these privileges and
|
|
the password expiration with this command. Ordinary users can only
|
|
change their own password.
|
|
</para>
|
|
|
|
<para>
|
|
The second variant changes the name of the user. Only a database
|
|
superuser can rename user accounts. The session user cannot be
|
|
renamed. (Connect as a different user if you need to do that.)
|
|
</para>
|
|
|
|
<para>
|
|
The third and the fourth variant change a user's session default for
|
|
a specified configuration variable. Whenever the user subsequently
|
|
starts a new session, the specified value becomes the session default,
|
|
overriding whatever setting is present in <filename>postgresql.conf</>
|
|
or has been received from the <command>postmaster</command> command line.
|
|
Ordinary users can change their own session defaults.
|
|
Superusers can change anyone's session defaults.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Parameters</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><replaceable class="PARAMETER">name</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
|
|
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. To set the password
|
|
never to expire, use <literal>'infinity'</>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><replaceable>newname</replaceable></term>
|
|
<listitem>
|
|
<para>
|
|
The new name of the user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><replaceable>parameter</replaceable></term>
|
|
<term><replaceable>value</replaceable></term>
|
|
<listitem>
|
|
<para>
|
|
Set this user's session default for the specified configuration
|
|
parameter to the given value. If
|
|
<replaceable>value</replaceable> is <literal>DEFAULT</literal>
|
|
or, equivalently, <literal>RESET</literal> is used, the
|
|
user-specific variable setting is removed and the user will
|
|
inherit the system-wide default setting in new sessions. Use
|
|
<literal>RESET ALL</literal> to clear all settings.
|
|
</para>
|
|
|
|
<para>
|
|
See <xref linkend="sql-set" endterm="sql-set-title"> and <xref
|
|
linkend="runtime-config"> for more information about allowed
|
|
parameter names and values.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</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 remove 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>
|
|
|
|
<para>
|
|
Using <xref linkend="sql-alterdatabase"
|
|
endterm="sql-alterdatabase-title">, it is also possible to tie a
|
|
session default to a specific database rather than a user.
|
|
</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 2005 using
|
|
the time zone which is one hour ahead of <acronym>UTC</>:
|
|
<programlisting>
|
|
ALTER USER chris VALID UNTIL 'May 4 12:00:00 2005 +1';
|
|
</programlisting>
|
|
</para>
|
|
|
|
<para>
|
|
Make a user valid forever:
|
|
<programlisting>
|
|
ALTER USER fred VALID UNTIL 'infinity';
|
|
</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>
|
|
<member><xref linkend="sql-set" endterm="sql-set-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:
|
|
-->
|