postgresql/doc/src/sgml/ref/alter_group.sgml

136 lines
3.6 KiB
Plaintext
Raw Normal View History

<!--
2010-09-20 22:08:53 +02:00
doc/src/sgml/ref/alter_group.sgml
PostgreSQL documentation
-->
<refentry id="sql-altergroup">
<indexterm zone="sql-altergroup">
<primary>ALTER GROUP</primary>
</indexterm>
<refmeta>
<refentrytitle>ALTER GROUP</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ALTER GROUP</refname>
<refpurpose>change role name or membership</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
ALTER GROUP <replaceable class="parameter">role_specification</replaceable> ADD USER <replaceable class="parameter">user_name</replaceable> [, ... ]
ALTER GROUP <replaceable class="parameter">role_specification</replaceable> DROP USER <replaceable class="parameter">user_name</replaceable> [, ... ]
<phrase>where <replaceable class="parameter">role_specification</replaceable> can be:</phrase>
<replaceable class="parameter">role_name</replaceable>
| CURRENT_ROLE
| CURRENT_USER
| SESSION_USER
2003-06-27 16:45:32 +02:00
ALTER GROUP <replaceable class="parameter">group_name</replaceable> RENAME TO <replaceable>new_name</replaceable>
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
2005-01-04 01:39:53 +01:00
<command>ALTER GROUP</command> changes the attributes of a user group.
This is an obsolete command, though still accepted for backwards
compatibility, because groups (and users too) have been superseded by the
more general concept of roles.
2005-01-04 01:39:53 +01:00
</para>
<para>
The first two variants add users to a group or remove them from a group.
(Any role can play the part of either a <quote>user</quote> or a
<quote>group</quote> for this purpose.) These variants are effectively
equivalent to granting or revoking membership in the role named as the
<quote>group</quote>; so the preferred way to do this is to use
Improve <xref> vs. <command> formatting in the documentation SQL commands are generally marked up as <command>, except when a link to a reference page is used using <xref>. But the latter doesn't create monospace markup, so this looks strange especially when a paragraph contains a mix of links and non-links. We considered putting <command> in the <refentrytitle> on the target side, but that creates some formatting side effects elsewhere. Generally, it seems safer to solve this on the link source side. We can't put the <xref> inside the <command>; the DTD doesn't allow this. DocBook 5 would allow the <command> to have the linkend attribute itself, but we are not there yet. So to solve this for now, convert the <xref>s to <link> plus <command>. This gives the correct look and also gives some more flexibility what we can put into the link text (e.g., subcommands or other clauses). In the future, these could then be converted to DocBook 5 style. I haven't converted absolutely all xrefs to SQL command reference pages, only those where we care about the appearance of the link text or where it was otherwise appropriate to make the appearance match a bit better. Also in some cases, the links where repetitive, so in those cases the links where just removed and replaced by a plain <command>. In cases where we just want the link and don't specifically care about the generated link text (typically phrased "for further information see <xref ...>") the xref is kept. Reported-by: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org> Discussion: https://www.postgresql.org/message-id/flat/87o8pco34z.fsf@wibble.ilmari.org
2020-10-03 16:16:51 +02:00
<link linkend="sql-grant"><command>GRANT</command></link> or
<link linkend="sql-revoke"><command>REVOKE</command></link>.
</para>
<para>
The third variant changes the name of the group. This is exactly
equivalent to renaming the role with
Improve <xref> vs. <command> formatting in the documentation SQL commands are generally marked up as <command>, except when a link to a reference page is used using <xref>. But the latter doesn't create monospace markup, so this looks strange especially when a paragraph contains a mix of links and non-links. We considered putting <command> in the <refentrytitle> on the target side, but that creates some formatting side effects elsewhere. Generally, it seems safer to solve this on the link source side. We can't put the <xref> inside the <command>; the DTD doesn't allow this. DocBook 5 would allow the <command> to have the linkend attribute itself, but we are not there yet. So to solve this for now, convert the <xref>s to <link> plus <command>. This gives the correct look and also gives some more flexibility what we can put into the link text (e.g., subcommands or other clauses). In the future, these could then be converted to DocBook 5 style. I haven't converted absolutely all xrefs to SQL command reference pages, only those where we care about the appearance of the link text or where it was otherwise appropriate to make the appearance match a bit better. Also in some cases, the links where repetitive, so in those cases the links where just removed and replaced by a plain <command>. In cases where we just want the link and don't specifically care about the generated link text (typically phrased "for further information see <xref ...>") the xref is kept. Reported-by: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org> Discussion: https://www.postgresql.org/message-id/flat/87o8pco34z.fsf@wibble.ilmari.org
2020-10-03 16:16:51 +02:00
<link linkend="sql-alterrole"><command>ALTER ROLE</command></link>.
</para>
</refsect1>
<refsect1>
2003-09-12 02:12:47 +02:00
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><replaceable class="parameter">group_name</replaceable></term>
<listitem>
<para>
The name of the group (role) to modify.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">user_name</replaceable></term>
<listitem>
<para>
Users (roles) that are to be added to or removed from the group.
The users must already exist; <command>ALTER GROUP</command> does not
create or drop users.
</para>
</listitem>
</varlistentry>
2003-06-27 16:45:32 +02:00
<varlistentry>
<term><replaceable>new_name</replaceable></term>
2003-06-27 16:45:32 +02:00
<listitem>
<para>
The new name of the group.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
Add users to a group:
<programlisting>
2001-09-12 03:55:25 +02:00
ALTER GROUP staff ADD USER karl, john;
</programlisting>
2000-07-22 04:39:10 +02:00
Remove a user from a group:
<programlisting>
2001-09-12 03:55:25 +02:00
ALTER GROUP workers DROP USER beth;
</programlisting></para>
</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
There is no <command>ALTER GROUP</command> statement in the SQL
standard.
</para>
</refsect1>
2003-06-27 16:45:32 +02:00
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="sql-grant"/></member>
<member><xref linkend="sql-revoke"/></member>
<member><xref linkend="sql-alterrole"/></member>
2003-06-27 16:45:32 +02:00
</simplelist>
</refsect1>
</refentry>