1999-07-22 17:09:15 +02:00
|
|
|
<!--
|
2003-03-18 23:19:47 +01:00
|
|
|
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.31 2003/03/18 22:19:46 petere Exp $
|
2001-12-08 04:24:40 +01:00
|
|
|
PostgreSQL documentation
|
1999-07-22 17:09:15 +02:00
|
|
|
-->
|
|
|
|
|
2001-08-29 21:11:00 +02:00
|
|
|
<refentry id="APP-CREATEDB">
|
1999-07-06 19:16:42 +02:00
|
|
|
<refmeta>
|
2000-11-12 00:01:45 +01:00
|
|
|
<refentrytitle id="APP-CREATEDB-TITLE"><application>createdb</application></refentrytitle>
|
|
|
|
<manvolnum>1</manvolnum>
|
1999-07-06 19:16:42 +02:00
|
|
|
<refmiscinfo>Application</refmiscinfo>
|
|
|
|
</refmeta>
|
2000-11-12 00:01:45 +01:00
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<refnamediv>
|
2000-11-12 00:01:45 +01:00
|
|
|
<refname>createdb</refname>
|
2001-09-03 14:57:50 +02:00
|
|
|
<refpurpose>create a new <productname>PostgreSQL</productname> database</refpurpose>
|
1999-07-06 19:16:42 +02:00
|
|
|
</refnamediv>
|
2000-11-12 00:01:45 +01:00
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<refsynopsisdiv>
|
2000-11-12 00:01:45 +01:00
|
|
|
<cmdsynopsis>
|
|
|
|
<command>createdb</command>
|
|
|
|
<arg rep="repeat"><replaceable>options</replaceable></arg>
|
2001-03-17 17:27:31 +01:00
|
|
|
<arg><replaceable>dbname</replaceable></arg>
|
2000-11-12 00:01:45 +01:00
|
|
|
<arg><replaceable>description</replaceable></arg>
|
|
|
|
</cmdsynopsis>
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsynopsisdiv>
|
1998-10-05 04:54:45 +02:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
|
|
|
|
<refsect1 id="R1-APP-CREATEDB-1">
|
|
|
|
<title>
|
|
|
|
Description
|
|
|
|
</title>
|
|
|
|
<para>
|
|
|
|
<application>createdb</application> creates a new <productname>PostgreSQL</productname>
|
|
|
|
database.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Normally, the database user who executes this command becomes the owner of
|
|
|
|
the new database.
|
|
|
|
However a different owner can be specified via the <option>-O</option>
|
|
|
|
option, if the executing user has appropriate privileges.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-18 23:19:47 +01:00
|
|
|
<application>createdb</application> is a wrapper around the
|
|
|
|
<acronym>SQL</acronym> command <xref linkend="SQL-CREATEDATABASE"
|
|
|
|
endterm="SQL-CREATEDATABASE-title">. Thus, there is nothing
|
|
|
|
special about creating databases via this or other methods. This
|
|
|
|
means that a database server must be running at the targeted
|
|
|
|
port. Also, any default settings and environment variables used by
|
|
|
|
the <application>libpq</application> front-end library will apply.
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Options</title>
|
1999-07-06 19:16:42 +02:00
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
<para>
|
|
|
|
<application>createdb</application> accepts the following command-line arguments:
|
1999-12-04 05:53:22 +01:00
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
<variablelist>
|
1999-07-06 19:16:42 +02:00
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><replaceable class="parameter">dbname</replaceable></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Specifies the name of the database to be created. The name must be
|
|
|
|
unique among all <productname>PostgreSQL</productname> databases in this installation.
|
|
|
|
The default is to create a database with the same name as the
|
|
|
|
current system user.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><replaceable class="parameter">description</replaceable></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
This optionally specifies a comment to be associated with the newly created
|
|
|
|
database.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><option>-D <replaceable class="parameter">location</replaceable></></term>
|
|
|
|
<term><option>--location <replaceable class="parameter">location</replaceable></></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Specifies the alternative location for the database. See also <xref
|
|
|
|
linkend="app-initlocation">.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-e</></term>
|
|
|
|
<term><option>--echo</></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
1999-12-04 05:53:22 +01:00
|
|
|
Echo the queries that <application>createdb</application> generates
|
2001-11-28 21:49:10 +01:00
|
|
|
and sends to the server.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><option>-E <replaceable class="parameter">encoding</replaceable></></term>
|
|
|
|
<term><option>--encoding <replaceable class="parameter">encoding</replaceable></></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Specifies the character encoding scheme to be used in this database.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-02-25 00:27:58 +01:00
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-O <replaceable class="parameter">owner</replaceable></></term>
|
|
|
|
<term><option>--owner <replaceable class="parameter">owner</replaceable></></term>
|
2002-02-25 00:27:58 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the database user who will own the new database.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><option>-q</></term>
|
|
|
|
<term><option>--quiet</></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Do not display a response.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-02-18 18:53:55 +01:00
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-T <replaceable class="parameter">template</replaceable></></term>
|
|
|
|
<term><option>--template <replaceable class="parameter">template</replaceable></></term>
|
2001-02-18 18:53:55 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the template database from which to build this database.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
</variablelist>
|
|
|
|
</para>
|
2001-02-18 18:53:55 +01:00
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
<para>
|
|
|
|
The options <option>-D</option>, <option>-E</option>,
|
|
|
|
<option>-O</option>, and
|
|
|
|
<option>-T</option> correspond to options of the underlying
|
|
|
|
SQL command <xref linkend="SQL-CREATEDATABASE"
|
|
|
|
endterm="SQL-CREATEDATABASE-title">; see there for more information
|
|
|
|
about them.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<application>createdb</application> also accepts the following
|
|
|
|
command-line arguments for connection parameters:
|
|
|
|
|
|
|
|
<variablelist>
|
1999-07-06 19:16:42 +02:00
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
|
|
|
|
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Specifies the host name of the machine on which the
|
|
|
|
server is running. If host begins with a slash, it is used
|
|
|
|
as the directory for the Unix domain socket.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
|
|
|
|
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Specifies the Internet TCP/IP port or the local Unix domain socket file
|
|
|
|
extension on which the server is listening for connections.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
|
|
|
|
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
User name to connect as
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-W</></term>
|
|
|
|
<term><option>--password</></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Force password prompt.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
1999-07-06 19:16:42 +02:00
|
|
|
</variablelist>
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
2002-10-12 01:03:48 +02:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Diagnostics</title>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><computeroutput>CREATE DATABASE</computeroutput></term>
|
|
|
|
<listitem>
|
|
|
|
<para>The database was successfully created.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><computeroutput>createdb: Database creation failed.</computeroutput></term>
|
|
|
|
<listitem>
|
|
|
|
<para>(Says it all.)</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
1999-12-07 23:41:44 +01:00
|
|
|
<term><computeroutput>createdb: Comment creation failed. (Database was created.)</computeroutput></term>
|
1999-12-04 05:53:22 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The comment/description for the database could not be created.
|
2001-02-18 18:53:55 +01:00
|
|
|
The database itself will have been created already. You can use the
|
1999-12-04 05:53:22 +01:00
|
|
|
<acronym>SQL</acronym> command <command>COMMENT ON DATABASE</command> to
|
|
|
|
create the comment later on.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<para>
|
1999-12-04 05:53:22 +01:00
|
|
|
If there is an error condition, the backend error message will be displayed.
|
2001-11-18 21:35:02 +01:00
|
|
|
See <xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-TITLE">
|
2003-03-18 23:19:47 +01:00
|
|
|
for possibilities.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsect1>
|
1999-07-06 19:16:42 +02:00
|
|
|
|
2002-02-25 00:27:58 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Environment</title>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<variablelist>
|
2002-08-10 18:57:32 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><envar>PGDATABASE</envar></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
If set, the name of the database to create, unless overridden on
|
|
|
|
the command line.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><envar>PGHOST</envar></term>
|
|
|
|
<term><envar>PGPORT</envar></term>
|
|
|
|
<term><envar>PGUSER</envar></term>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Default connection parameters. <envar>PGUSER</envar> also
|
|
|
|
determines the name of the database to create, if it is not
|
2002-08-10 18:57:32 +02:00
|
|
|
specified on the command line or by <envar>PGDATABASE</envar>.
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
1999-07-06 19:16:42 +02:00
|
|
|
</refsect1>
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<refsect1 id="R1-APP-CREATEDB-2">
|
2002-07-28 17:22:21 +02:00
|
|
|
<title>Examples</title>
|
1999-07-06 19:16:42 +02:00
|
|
|
|
2000-11-12 00:01:45 +01:00
|
|
|
<para>
|
|
|
|
To create the database <literal>demo</literal> using the default
|
|
|
|
database server:
|
|
|
|
<screen>
|
|
|
|
<prompt>$ </prompt><userinput>createdb demo</userinput>
|
|
|
|
<computeroutput>CREATE DATABASE</computeroutput>
|
|
|
|
</screen>
|
|
|
|
The response is the same as you would have gotten from running the
|
|
|
|
<command>CREATE DATABASE</command> <acronym>SQL</acronym> command.
|
|
|
|
</para>
|
1999-07-06 19:16:42 +02:00
|
|
|
|
2000-11-12 00:01:45 +01:00
|
|
|
<para>
|
|
|
|
To create the database <literal>demo</literal> using the
|
2002-01-20 23:19:57 +01:00
|
|
|
server on host <literal>eden</>, port 5000, using the
|
2000-11-12 00:01:45 +01:00
|
|
|
<literal>LATIN1</literal> encoding scheme with a look at the
|
|
|
|
underlying query:
|
|
|
|
<screen>
|
|
|
|
<prompt>$ </prompt><userinput>createdb -p 5000 -h eden -E LATIN1 -e demo</userinput>
|
|
|
|
<computeroutput>CREATE DATABASE "demo" WITH ENCODING = 'LATIN1'</computeroutput>
|
|
|
|
<computeroutput>CREATE DATABASE</computeroutput>
|
|
|
|
</screen>
|
|
|
|
</para>
|
1999-07-06 19:16:42 +02:00
|
|
|
</refsect1>
|
2002-07-28 17:22:21 +02:00
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
<simplelist type="inline">
|
|
|
|
<member><xref linkend="app-dropdb"></member>
|
|
|
|
<member><xref linkend="sql-createdatabase" endterm="sql-createdatabase-title"></member>
|
|
|
|
</simplelist>
|
|
|
|
</refsect1>
|
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
</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:
|
|
|
|
-->
|