create_database.sgml 6.19 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
<REFENTRY ID="SQL-CREATEDATABASE-1">
 <REFMETA>
  <REFENTRYTITLE>
   CREATE DATABASE
  </REFENTRYTITLE>
  <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
 </REFMETA>
 <REFNAMEDIV>
  <REFNAME>
   CREATE DATABASE
  </REFNAME>
  <REFPURPOSE>
   Creates a new database
  </REFPURPOSE>
 <REFSYNOPSISDIV>
  <REFSYNOPSISDIVINFO>
   <DATE>1998-04-15</DATE>
  </REFSYNOPSISDIVINFO>
  <SYNOPSIS>
   CREATE DATABASE <REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> [WITH LOCATION = '<replaceable class="parameter">dbpath</replaceable>']
  </SYNOPSIS>
  
  <REFSECT2 ID="R2-SQL-CREATEDATABASE-1">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Inputs
   </TITLE>
   <PARA>
   </PARA>
   <VARIABLELIST>
    <VARLISTENTRY>
     <TERM>
     </TERM>
     <LISTITEM>
      <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <replaceable class="parameter">name</replaceable>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   The name of a database to create.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <replaceable class="parameter">dbpath</replaceable>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   An alternate location can be specified as either an
	   environment variable known to the backend server
	   (e.g. '<envar>PGDATA2</envar>') or as an absolute path name
	   (e.g. '<filename>/usr/local/pgsql/data</filename>').
	   In either case, the location must be pre-configured
	   by <command>initlocation</command>.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </VARIABLELIST>
     </LISTITEM>
    </VARLISTENTRY>
   </VARIABLELIST>
  </REFSECT2>

  <REFSECT2 ID="R2-SQL-CREATEDATABASE-2">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Outputs
   </TITLE>
   <PARA>
   </PARA>
   <VARIABLELIST>
    <VARLISTENTRY>
     <TERM>
     </TERM>
     <LISTITEM>
      <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>CREATEDB</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
          Message returned if the command completes successfully.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>WARN:  createdb: database "<replaceable class="parameter">name</replaceable>" already exists.</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   This occurs if <replaceable class="parameter">database</replaceable> specified already exists.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>ERROR:  Unable to create database directory <replaceable class="parameter">directory</replaceable>
</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
There was a problem with creating the required directory; this operation will
	   need permissions for the <literal>postgres</literal> user on the specified location.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </variablelist>
     </LISTITEM>
    </VARLISTENTRY>
   </VARIABLELIST>
  </REFSECT2>
 </REFSYNOPSISDIV>
 
 <REFSECT1 ID="R1-SQL-CREATEDATABASE-1">
  <REFSECT1INFO>
   <DATE>1998-04-15</DATE>
  </REFSECT1INFO>
  <TITLE>
   Description
  </TITLE>
  <PARA>
133
   <command>CREATE DATABASE</command> creates a new Postgres database.
134 135 136 137 138 139 140 141 142 143 144
   The creator becomes the administrator of the new database.
  </PARA>
  
  <REFSECT2 ID="R2-SQL-CREATEDATABASE-3">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Notes
   </TITLE>
   <PARA>
145
    <command>CREATE DATABASE</command> statement is a Postgres language extension.
146 147
   </PARA>
   <para>
148
    Refer to <command>DROP DATABASE</command> statement to remove a database.
149 150 151 152 153 154 155 156 157 158 159
   </para>
  </REFSECT2>
  
 <REFSECT1 ID="R1-SQL-CREATEDATABASE-2">
  <TITLE>
   Usage
  </TITLE>
  <PARA>
   To create a new database:
  </PARA>
  <ProgramListing>
160
   <prompt>olly=></prompt> <userinput>create database lusiadas;</userinput>
161 162
  </ProgramListing>
  <PARA>
163
   To create a new database in an alternate area <filename>~/private_db</filename>:
164 165
  </PARA>
  <ProgramListing>
166 167
   <prompt>$</prompt> <userinput>mkdir private_db</userinput>
   <prompt>$</prompt> <userinput>initlocation ~/private_db</userinput>
168 169
   <computeroutput>Creating Postgres database system directory /home/olly/private_db/base</computeroutput>

170
   <prompt>$</prompt> <userinput>psql olly</userinput>
171 172 173 174 175 176 177 178
   <computeroutput>Welcome to the POSTGRESQL interactive sql monitor:
     Please read the file COPYRIGHT for copyright terms of POSTGRESQL

      type \? for help on slash commands
      type \q to quit
      type \g or terminate with semicolon to execute query
    You are currently connected to the database: template1

179
    <prompt>olly=></prompt></computeroutput> <userinput>create database elsewhere with location = '/home/olly/private_db';</userinput>
180 181 182 183 184 185 186 187 188
    <computeroutput>CREATEDB</computeroutput>
  </ProgramListing>
 </REFSECT1>
 
 <REFSECT1 ID="R1-SQL-CREATEDATABASE-3">
  <TITLE>
   Bugs
  </TITLE>
  <PARA>
189 190
   There are security and data integrity issues involved with using alternate database locations
   specified with absolute path names. See the Administrator's Guide for more information.
191
  </PARA>
192 193 194
 </refsect1>

<!--
195
comment from Olly; response from Thomas...
196 197
  <comment>
   initlocation does not create a PG_VERSION file in the specified location.
198
   How will Postgres handle the situation if it is upgraded to an 
199 200
   incompatible database version?
  </comment>
201 202
Hmm. This isn't an issue since the upgrade would do a dump/reload from the main database area also.
Not sure if the dump/reload would guarantee that the alternate data area gets refreshed though...
203
-->
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
 
 <REFSECT1 ID="R1-SQL-CREATEDATABASE-4">
  <TITLE>
   Compatibility
  </TITLE>
  <PARA>
  </PARA>
  
  <REFSECT2 ID="R2-SQL-CREATEDATABASE-4">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    SQL92
   </TITLE>
   <PARA>
    There is no <command>CREATE DATABASE</command> statement on SQL92.
   </PARA>
   <para>
    The equivalent command in standard SQL is <command>CREATE SCHEMA</command>.
   </para>
  </refsect2>
 </refsect1>
</REFENTRY>


<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
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:
-->