]> granicus.if.org Git - postgresql/blobdiff - doc/src/sgml/ref/alter_database.sgml
Allow CREATE/ALTER DATABASE to manipulate datistemplate and datallowconn.
[postgresql] / doc / src / sgml / ref / alter_database.sgml
index d16cc2fdad1a0b889d34d94b00f0d85469284d68..3724c05e2c0cfd6c1128094d9545747f8a75970c 100644 (file)
@@ -1,11 +1,16 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.20 2007/09/03 18:46:29 tgl Exp $
+doc/src/sgml/ref/alter_database.sgml
 PostgreSQL documentation
 -->
 
 <refentry id="SQL-ALTERDATABASE">
+ <indexterm zone="sql-alterdatabase">
+  <primary>ALTER DATABASE</primary>
+ </indexterm>
+
  <refmeta>
-  <refentrytitle id="sql-alterdatabase-title">ALTER DATABASE</refentrytitle>
+  <refentrytitle>ALTER DATABASE</refentrytitle>
+  <manvolnum>7</manvolnum>
   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  </refmeta>
 
@@ -14,22 +19,22 @@ PostgreSQL documentation
   <refpurpose>change a database</refpurpose>
  </refnamediv>
 
- <indexterm zone="sql-alterdatabase">
-  <primary>ALTER DATABASE</primary>
- </indexterm>
-
  <refsynopsisdiv>
 <synopsis>
 ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ]
 
-where <replaceable class="PARAMETER">option</replaceable> can be:
+<phrase>where <replaceable class="PARAMETER">option</replaceable> can be:</phrase>
 
+    IS_TEMPLATE <replaceable class="PARAMETER">istemplate</replaceable>
+    ALLOW_CONNECTIONS <replaceable class="PARAMETER">allowconn</replaceable>
     CONNECTION LIMIT <replaceable class="PARAMETER">connlimit</replaceable>
 
-ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>
+ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>new_name</replaceable>
 
 ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> OWNER TO <replaceable>new_owner</replaceable>
 
+ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> SET TABLESPACE <replaceable class="PARAMETER">new_tablespace</replaceable>
+
 ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> SET <replaceable>configuration_parameter</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
 ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> SET <replaceable>configuration_parameter</replaceable> FROM CURRENT
 ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>configuration_parameter</replaceable>
@@ -48,7 +53,7 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
   <para>
    The first form changes certain per-database settings.  (See below for
    details.)  Only the database owner or a superuser can change these settings.
-  </para> 
+  </para>
 
   <para>
    The second form changes the name of the database.  Only the database
@@ -67,6 +72,15 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
    (Note that superusers have all these privileges automatically.)
   </para>
 
+  <para>
+   The fourth form changes the default tablespace of the database.
+   Only the database owner or a superuser can do this; you must also have
+   create privilege for the new tablespace.
+   This command physically moves any tables or indexes in the database's old
+   default tablespace to the new tablespace.  Note that tables and indexes
+   in non-default tablespaces are not affected.
+  </para>
+
   <para>
    The remaining forms change the session default for a run-time
    configuration variable for a <productname>PostgreSQL</productname>
@@ -95,6 +109,26 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
      </varlistentry>
 
      <varlistentry>
+       <term><replaceable class="parameter">istemplate</replaceable></term>
+       <listitem>
+        <para>
+         If true, then this database can be cloned by any user with CREATEDB
+         privileges; if false, then only superusers or the owner of the
+         database can clone it.
+        </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term><replaceable class="parameter">allowconn</replaceable></term>
+       <listitem>
+        <para>
+         If false then no one can connect to this database.
+        </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
       <term><replaceable class="parameter">connlimit</replaceable></term>
       <listitem>
        <para>
@@ -102,10 +136,10 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
         to this database.  -1 means no limit.
        </para>
       </listitem>
-     </varlistentry> 
+     </varlistentry>
 
    <varlistentry>
-    <term><replaceable>newname</replaceable></term>
+    <term><replaceable>new_name</replaceable></term>
     <listitem>
      <para>
       The new name of the database.
@@ -122,6 +156,15 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
     </listitem>
    </varlistentry>
 
+   <varlistentry>
+    <term><replaceable class="parameter">new_tablespace</replaceable></term>
+    <listitem>
+     <para>
+      The new default tablespace of the database.
+     </para>
+    </listitem>
+   </varlistentry>
+
      <varlistentry>
       <term><replaceable>configuration_parameter</replaceable></term>
       <term><replaceable>value</replaceable></term>
@@ -139,7 +182,7 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
        </para>
 
        <para>
-        See <xref linkend="sql-set" endterm="sql-set-title"> and <xref linkend="runtime-config">
+        See <xref linkend="sql-set"> and <xref linkend="runtime-config">
         for more information about allowed parameter names
         and values.
        </para>
@@ -154,7 +197,7 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
   <para>
    It is also possible to tie a session default to a specific role
    rather than to a database; see
-   <xref linkend="sql-alterrole" endterm="sql-alterrole-title">.
+   <xref linkend="sql-alterrole">.
    Role-specific settings override database-specific
    ones if there is a conflict.
   </para>
@@ -169,13 +212,12 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
 
 <programlisting>
 ALTER DATABASE test SET enable_indexscan TO off;
-</programlisting>
-  </para>
+</programlisting></para>
  </refsect1>
 
  <refsect1>
   <title>Compatibility</title>
-    
+
   <para>
    The <command>ALTER DATABASE</command> statement is a
    <productname>PostgreSQL</productname> extension.
@@ -186,9 +228,10 @@ ALTER DATABASE test SET enable_indexscan TO off;
   <title>See Also</title>
 
   <simplelist type="inline">
-   <member><xref linkend="sql-createdatabase" endterm="sql-createdatabase-title"></member>
-   <member><xref linkend="sql-dropdatabase" endterm="sql-dropdatabase-title"></member>
-   <member><xref linkend="sql-set" endterm="sql-set-title"></member>
+   <member><xref linkend="sql-createdatabase"></member>
+   <member><xref linkend="sql-dropdatabase"></member>
+   <member><xref linkend="sql-set"></member>
+   <member><xref linkend="sql-createtablespace"></member>
   </simplelist>
  </refsect1>
 </refentry>