aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/createdb.sgml
blob: f9c8e21101cc02dcd580a66d2345f5c0ea091fd3 (plain)
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<refentry id="APP-CREATEDB">
 <refmeta>
  <refentrytitle>
   <application>createdb</application>
  </refentrytitle>
  <refmiscinfo>Application</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>
   <application>createdb</application>
  </refname>
  <refpurpose>
   Create a new <productname>Postgres</productname> database
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1998-10-02</date>
  </refsynopsisdivinfo>
  <synopsis>
createdb [ <replaceable class="parameter">dbname</replaceable> ]
createdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ]
      [ -D <replaceable class="parameter">datadir</replaceable> ] [ -u ] [ <replaceable class="parameter">dbname</replaceable> ]
  </synopsis>

  <refsect2 id="R2-APP-CREATEDB-1">
   <refsect2info>
    <date>1998-10-02</date>
   </refsect2info>
   <title>
    Inputs
   </title>
   <para>

    <variablelist>
     <varlistentry>
      <term>-h <replaceable class="parameter">host</replaceable></term>
      <listitem>
       <para>
	Specifies the hostname of the machine on which the 
	<application>postmaster</application>
	is running.  Defaults to using a local Unix domain socket
	rather than an IP connection.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>-p <replaceable class="parameter">port</replaceable></term>
      <listitem>
       <para>
	Specifies the Internet TCP/IP port or local Unix domain socket file 
	extension on which the <application>postmaster</application>
	is listening for connections.  The port number defaults to 5432,
	or the value of the <envar>PGPORT</envar>
	environment variable (if set).
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-u</term>
      <listitem>
       <para>
	Use password authentication. 
	Prompts for
	<replaceable class="parameter">username</replaceable>
	and <replaceable class="parameter">password</replaceable>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-D <replaceable class="parameter">datadir</replaceable></term>
      <listitem>
       <para>
	Specifies the alternate database location for this database installation.
	This is the location of the installation system tables, not the location
	of this specific database, which may be different.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><replaceable class="parameter">dbname</replaceable></term>
      <listitem>
       <para>
	Specifies the name of the database to be created.  The name must be
	unique among all <productname>Postgres</productname> databases in this installation.
	<replaceable class="parameter">dbname</replaceable>
	defaults to the value of the
	<envar>USER</envar>
	environment variable.
       </para>
      </listitem>
     </varlistentry>

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

  <refsect2 id="R2-APP-CREATEDB-2">
   <refsect2info>
    <date>1998-10-02</date>
   </refsect2info>
   <title>
    Outputs
   </title>
   <para>
    <application>createdb</application> will create files in the
    <filename><envar>PGDATA</envar>/<replaceable class="parameter">dbname</replaceable>/</filename>
    data area for the new database.

    <variablelist>
     <varlistentry>
      <term><computeroutput>
Connection to database 'template1' failed.
connectDB() failed: Is the postmaster running and accepting connections at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
       </computeroutput></term>
      <listitem>
       <para>
	<application>createdb</application> could not attach to the 
	<application>postmaster</application> 
	process on the specified host and port.  If you see this message,
	ensure that the <application>postmaster</application> 
	is running on the proper host and that you have specified the proper
	port.  If your site uses an authentication system, ensure that you
	have obtained the required authentication credentials.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>
Connection to database 'template1' failed.
FATAL 1:  SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
      </computeroutput></term>
      <listitem>
       <para>
	You do not have a valid entry in the relation <literal>pg_shadow</literal>
	and and will not be allowed to access <productname>Postgres</productname>. 
	Contact your <productname>Postgres</productname> administrator.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>
ERROR:  user '<replaceable class="parameter">username</replaceable>' is not allowed to create/destroy databases
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
       </computeroutput></term>
      <listitem>
       <para>
	You do not have permission to create new databases.
	Contact your <productname>Postgres</productname> site administrator.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>
ERROR:  createdb: database '<replaceable class="parameter">dbname</replaceable>' already exists.
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
       </computeroutput></term>
      <listitem>
       <para>
	The database already exists.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>
createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
       </computeroutput></term>
      <listitem>
       <para>
	An internal error occurred in <application>psql</application>
	or in the backend server.  Ensure that your site administrator has
	properly installed <productname>Postgres</productname>and initialized the site with 
	<application>initdb</application>.
       </para>
      </listitem>
     </varlistentry>

    </variablelist>
   </para>
   <note>
    <para>
     <application>createdb</application> internally runs
     <command>CREATE DATABASE</command> from <application>psql</application>
     while connected to the <literal>template1</literal> database.
    </para>
   </note>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-APP-CREATEDB-1">
  <refsect1info>
   <date>1998-10-02</date>
  </refsect1info>
  <title>
   Description
  </title>
  <para>
   <application>createdb</application> creates a new 
   <productname>Postgres</productname> database.
   The person who executes this command becomes
   the database administrator, or <acronym>DBA</acronym>,
   for this database and is the only
   person, other than the <productname>Postgres</productname> super-user,
   who can destroy it.
  </para>
  <para>
   <application>createdb</application> is a shell script that invokes
   <application>psql</application>.
   Hence, a <application>postmaster</application>
   process must be running on the database server host before
   <application>createdb</application>
   is executed. The 
   <envar>PGOPTION</envar>
   and
   <envar>PGREALM</envar>
   environment variables will be passed on to
   <application>psql</application>
   and processed as described in <xref endterm="psql-ref"
    linkend="app-psql">.
  </para>
 </refsect1>

 <refsect1 id="R1-APP-CREATEDB-2">
  <refsect1info>
   <date>1998-10-02</date>
  </refsect1info>
  <title>
   Usage
  </title>
  <para>
   To create the database <literal>demo</literal>
   using the postmaster on the local host, port 5432:

   <programlisting>
$ createdb demo
   </programlisting>
  </para>

  <para>
   To create the database <literal>demo</literal>
   using the postmaster on host eden, port 5000:

   <programlisting>
$ createdb -p 5000 -h eden demo
   </programlisting>
  </para>
 </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:
-->