<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_group.sgml,v 1.4 2001/08/13 15:24:46 momjian Exp $
Postgres documentation
-->

<refentry id="SQL-ALTERGROUP">
 <refmeta>
  <refentrytitle id="SQL-ALTERGROUP-title">
   ALTER GROUP
  </refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>
   ALTER GROUP
  </refname>
  <refpurpose>
   Add users to a group;  remove users from a group
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>2000-01-14</date>
  </refsynopsisdivinfo>
  <synopsis>
ALTER GROUP <replaceable class="PARAMETER">name</replaceable> ADD USER <replaceable class="PARAMETER">username</replaceable> [, ... ]
ALTER GROUP <replaceable class="PARAMETER">name</replaceable> DROP USER <replaceable class="PARAMETER">username</replaceable> [, ... ]
  </synopsis>

  <refsect2 id="R2-SQL-ALTERGROUP-1">
   <refsect2info>
    <date>2000-01-14</date>
   </refsect2info>
   <title>
    Inputs
   </title>

   <para>
    <variablelist>
     <varlistentry>
      <term><replaceable class="PARAMETER">name</replaceable></term>
      <listitem>
       <para>
	The name of the group to modify.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><replaceable class="PARAMETER">username</replaceable></term>
      <listitem>
       <para>
        Users which are to be added or removed from the group. The user
        names must exist.
       </para>
      </listitem>
     </varlistentry>

    </variablelist>
   </para>
  </refsect2>
    
  <refsect2 id="R2-SQL-ALTERGROUP-2">
   <refsect2info>
    <date>2000-01-14</date>
   </refsect2info>
   <title>
    Outputs
   </title>
   <para>
    <variablelist>
     <varlistentry>
      <term><computeroutput>ALTER GROUP</computeroutput></term>
      <listitem>
       <para>
	Message returned if the alteration was successful.
       </para>
      </listitem>
     </varlistentry>
     
    </variablelist>
   </para>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-SQL-ALTERGROUP-1">
  <refsect1info>
   <date>2000-01-14</date>
  </refsect1info>
  <title>
   Description
  </title>
  <para>
   <command>ALTER GROUP</command> is used to add or remove users from a
   group. Only database superusers can use this command.
   Adding a user to a group does not create the user. Similarly, removing
   a user from a group does not drop the user itself.
  </para>
  <para>
   Use <xref linkend="SQL-CREATEGROUP" endterm="SQL-CREATEGROUP-title">
   to create a new group and <xref linkend="SQL-DROPGROUP"
   endterm="SQL-DROPGROUP-title"> to remove a group.
  </para>
 </refsect1>

 <refsect1 id="R1-SQL-ALTERGROUP-2">
  <title>
   Usage
  </title>
  <para>
   Add users to a group:

<programlisting>
ALTER GROUP staff ADD USER karl, john
</programlisting>

   Remove a user from a group:

<programlisting>
ALTER GROUP workers DROP USER beth
</programlisting>

  </para>
 </refsect1>

 <refsect1 id="R1-SQL-ALTERGROUP-3">
  <title>
   Compatibility
  </title>
    
  <refsect2 id="R2-SQL-ALTERGROUP-4">
   <refsect2info>
    <date>2000-01-14</date>
   </refsect2info>
   <title>
    SQL92
   </title>
   <para>
    There is no <command>ALTER GROUP</command> statement in
    <acronym>SQL92</acronym>. The concept of roles is
    similar.
   </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:
-->
