1999-07-22 17:09:15 +02:00
|
|
|
<!--
|
2001-03-17 17:27:31 +01:00
|
|
|
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.18 2001/03/17 16:27:31 petere Exp $
|
1999-07-22 17:09:15 +02:00
|
|
|
Postgres documentation
|
|
|
|
-->
|
|
|
|
|
1999-08-06 15:50:31 +02:00
|
|
|
<refentry id="APP-CREATEDB" xreflabel="createdb">
|
2000-11-12 00:01:45 +01:00
|
|
|
<docinfo>
|
|
|
|
<date>2000-11-11</date>
|
|
|
|
</docinfo>
|
|
|
|
|
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>
|
|
|
|
<refpurpose>Create a new <productname>Postgres</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>
|
1998-10-05 04:54:45 +02:00
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<refsect2 id="R2-APP-CREATEDB-1">
|
|
|
|
<title>
|
|
|
|
Inputs
|
|
|
|
</title>
|
|
|
|
<para>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
1999-12-04 05:53:22 +01:00
|
|
|
<term>-h, --host <replaceable class="parameter">host</replaceable></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the hostname of the machine on which the
|
|
|
|
<application>postmaster</application>
|
2000-11-14 00:57:20 +01:00
|
|
|
is running. If host begins with a slash, it is used
|
2001-03-17 17:27:31 +01:00
|
|
|
as the directory for the Unix domain socket.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<varlistentry>
|
1999-12-04 05:53:22 +01:00
|
|
|
<term>-p, --port <replaceable class="parameter">port</replaceable></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-03-17 17:27:31 +01:00
|
|
|
Specifies the Internet TCP/IP port or the local Unix domain socket file
|
|
|
|
extension on which the <command>postmaster</command>
|
1999-12-04 05:53:22 +01:00
|
|
|
is listening for connections.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
1999-12-04 05:53:22 +01:00
|
|
|
<term>-U, --username <replaceable class="parameter">username</replaceable></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
1999-12-04 05:53:22 +01:00
|
|
|
Username to connect as.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
1999-12-04 05:53:22 +01:00
|
|
|
<term>-W, --password</term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
1999-12-04 05:53:22 +01:00
|
|
|
Force password prompt.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
1999-12-04 05:53:22 +01:00
|
|
|
<term>-e, --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
|
|
|
|
and sends to the backend.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
1999-12-04 05:53:22 +01:00
|
|
|
<term>-q, --quiet</term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
1999-12-04 05:53:22 +01:00
|
|
|
Do not display a response.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
1999-12-07 23:41:44 +01:00
|
|
|
<term>-D, --location <replaceable class="parameter">datadir</replaceable></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-02-18 18:53:55 +01:00
|
|
|
Specifies the alternative location for the database. See also <xref
|
2000-12-26 00:15:27 +01:00
|
|
|
linkend="app-initlocation">.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-02-18 18:53:55 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term>-T, --template <replaceable class="parameter">template</replaceable></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the template database from which to build this database.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<varlistentry>
|
1999-12-04 05:53:22 +01:00
|
|
|
<term>-E, --encoding <replaceable class="parameter">encoding</replaceable></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-02-18 18:53:55 +01:00
|
|
|
Specifies the character encoding scheme to be used in this database.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
1999-12-04 05:53:22 +01:00
|
|
|
<term><replaceable class="parameter">dbname</replaceable></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
1999-12-04 05:53:22 +01:00
|
|
|
Specifies the name of the database to be created. The name must be
|
2000-03-27 19:14:43 +02:00
|
|
|
unique among all <productname>Postgres</productname> databases in this installation.
|
2000-02-10 21:08:58 +01:00
|
|
|
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>
|
1999-12-04 05:53:22 +01:00
|
|
|
<term><replaceable class="parameter">description</replaceable></term>
|
1999-07-06 19:16:42 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
1999-12-04 05:53:22 +01: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>
|
|
|
|
|
|
|
|
</variablelist>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
|
|
|
The options <literal>-h</literal>, <literal>-p</literal>, <literal>-U</literal>,
|
|
|
|
<literal>-W</literal>, and <literal>-e</literal> are passed on literally to
|
2000-12-26 00:15:27 +01:00
|
|
|
<xref linkend="app-psql">.
|
2001-02-18 18:53:55 +01:00
|
|
|
|
|
|
|
The options <literal>-D</literal>, <literal>-T</literal>, and
|
|
|
|
<literal>-E</literal> are converted into options for the underlying
|
|
|
|
SQL command <xref linkend="SQL-CREATEDATABASE"
|
2001-03-17 17:27:31 +01:00
|
|
|
endterm="SQL-CREATEDATABASE-title">; see there for more information
|
2001-02-18 18:53:55 +01:00
|
|
|
about them.
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</refsect2>
|
|
|
|
|
|
|
|
<refsect2 id="R2-APP-CREATEDB-2">
|
|
|
|
<title>
|
|
|
|
Outputs
|
|
|
|
</title>
|
|
|
|
<para>
|
|
|
|
<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>
|
|
|
|
|
|
|
|
If there is an error condition, the backend error message will be displayed.
|
2000-12-26 00:15:27 +01:00
|
|
|
See <xref linkend="SQL-CREATEDATABASE">
|
|
|
|
and <xref linkend="APP-PSQL"> for possibilities.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</refsect2>
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
<refsect1 id="R1-APP-CREATEDB-1">
|
|
|
|
<title>
|
|
|
|
Description
|
|
|
|
</title>
|
|
|
|
<para>
|
2000-03-27 19:14:43 +02:00
|
|
|
<application>createdb</application> creates a new <productname>Postgres</productname>
|
1999-12-04 05:53:22 +01:00
|
|
|
database. The user who executes this command becomes the database owner.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<para>
|
1999-12-04 05:53:22 +01:00
|
|
|
<application>createdb</application> is a shell script wrapper around the
|
|
|
|
<acronym>SQL</acronym> command
|
|
|
|
<xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-title"> via
|
2000-03-27 19:14:43 +02:00
|
|
|
the <productname>Postgres</productname> interactive terminal
|
2000-12-26 00:15:27 +01:00
|
|
|
<xref linkend="APP-PSQL">. Thus, there is nothing
|
1999-12-04 05:53:22 +01:00
|
|
|
special about creating databases via this or other methods. This means
|
2001-02-18 18:53:55 +01:00
|
|
|
that the <application>psql</application> program must be found by the script and that
|
|
|
|
a database server must be running at the targeted port. Also, any default
|
1999-12-04 05:53:22 +01:00
|
|
|
settings and environment variables available to <application>psql</application>
|
2001-02-18 18:53:55 +01:00
|
|
|
and the <application>libpq</application> front-end library will apply.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 id="R1-APP-CREATEDB-2">
|
2000-11-12 00:01:45 +01:00
|
|
|
<title>Usage</title>
|
1999-07-06 19:16:42 +02:00
|
|
|
|
2000-11-12 00:01:45 +01:00
|
|
|
<informalexample>
|
|
|
|
<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>
|
|
|
|
</informalexample>
|
1999-07-06 19:16:42 +02:00
|
|
|
|
2000-11-12 00:01:45 +01:00
|
|
|
<informalexample>
|
|
|
|
<para>
|
|
|
|
To create the database <literal>demo</literal> using the
|
|
|
|
postmaster on host eden, port 5000, using the
|
|
|
|
<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>
|
|
|
|
</informalexample>
|
1999-07-06 19:16:42 +02:00
|
|
|
</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:
|
|
|
|
-->
|