postgresql/doc/src/sgml/ref/drop_user.sgml

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_user.sgml,v 1.12 2001/09/03 12:57:50 petere Exp $
Postgres documentation
-->

<refentry id="SQL-DROPUSER">
 <refmeta>
  <refentrytitle id="SQL-DROPUSER-TITLE">
   DROP USER
  </refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>
   DROP USER
  </refname>
  <refpurpose>
   remove a database user account
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1999-07-20</date>
  </refsynopsisdivinfo>
  <synopsis>
DROP USER <replaceable class="PARAMETER">name</replaceable>
  </synopsis>
  
  <refsect2 id="R2-SQL-DROPUSER-1">
   <refsect2info>
    <date>1998-09-22</date>
   </refsect2info>
   <title>
    Inputs
   </title>
   <para>

    <variablelist>
     <varlistentry>
      <term><replaceable class="PARAMETER">name</replaceable></term>
      <listitem>
       <para>
	The name of an existing user.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>
  
  <refsect2 id="R2-SQL-DROPUSER-2">
   <refsect2info>
    <date>1998-09-22</date>
   </refsect2info>
   <title>
    Outputs
   </title>
   <para>
    <variablelist>
     <varlistentry>
      <term><computeroutput>DROP USER</computeroutput></term>
      <listitem>
       <para>
	The message returned if the user is successfully deleted.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>
ERROR:  DROP USER: user "<replaceable class="parameter">name</replaceable>" does not exist
       </computeroutput></term>
      <listitem>
       <para>
	This message occurs if the username is not found.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>
DROP USER: user "<replaceable class="parameter">name</replaceable>" owns database "<replaceable class="parameter">name</replaceable>", cannot be removed
       </computeroutput></term>
      <listitem>
       <para>
        You must drop the database first or change its ownership.
       </para>
      </listitem>
     </varlistentry>

    </variablelist>
   </para>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-SQL-DROPUSER-1">
  <refsect1info>
   <date>1998-09-22</date>
  </refsect1info>
  <title>
   Description
  </title>
  <para>
   <command>DROP USER</command> removes the specified user from the database.
   It does not remove tables, views, or other objects owned by the user. If the
   user owns any database you get an error.
  </para>
  <para>
   Use <xref linkend="SQL-CREATEUSER" endterm="SQL-CREATEUSER-title">
   to add new users, and <xref linkend="SQL-ALTERUSER"
   endterm="SQL-ALTERUSER-title"> to change a user's properties.
   <productname>Postgres</productname>
   comes with a script <xref linkend="APP-DROPUSER"
   endterm="APP-DROPUSER-title">
   which has the same functionality as this command (in fact, it calls this command)
   but can be run from the command shell.
  </para>  
 </refsect1>

 <refsect1 id="R1-SQL-DROPUSER-2">
  <title>
   Usage
  </title>
  <para>
   To drop a user account:
<programlisting>
DROP USER jonathan;
</programlisting>
  </para>
 </refsect1>
 
 <refsect1 id="R1-SQL-DROPUSER-3">
  <title>
   Compatibility
  </title>
  
  <refsect2 id="R2-SQL-DROPUSER-4">
   <refsect2info>
    <date>1998-09-22</date>
   </refsect2info>
   <title>
    SQL92
   </title>
   <para>
    There is no <command>DROP USER</command> in <acronym>SQL92</acronym>.
   </para>
  </refsect2>
 </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:
-->