<!--
$Header: /home/projects/pgsql/cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.10 2000/03/27 17:14:42 thomas Exp $
Postgres documentation
-->

<refentry id="APP-CREATEDB" xreflabel="createdb">
 <refmeta>
  <refentrytitle id="APP-CREATEDB-TITLE">
   <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>1999-11-07</date>
  </refsynopsisdivinfo>
  <synopsis>
createdb [ <replaceable class="parameter">options</replaceable> ] <replaceable class="parameter">dbname</replaceable> [ <replaceable class="parameter">description</replaceable> ]
  </synopsis>

  <refsect2 id="R2-APP-CREATEDB-1">
   <refsect2info>
    <date>1999-11-07</date>
   </refsect2info>
   <title>
    Inputs
   </title>
   <para>

    <variablelist>
     <varlistentry>
      <term>-h, --host <replaceable class="parameter">host</replaceable></term>
      <listitem>
       <para>
	Specifies the hostname of the machine on which the 
	<application>postmaster</application>
	is running.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-p, --port <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.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-U, --username <replaceable class="parameter">username</replaceable></term>
      <listitem>
       <para>
        Username to connect as.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-W, --password</term>
      <listitem>
       <para>
        Force password prompt.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-e, --echo</term>
      <listitem>
       <para>
        Echo the queries that <application>createdb</application> generates
	and sends to the backend.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-q, --quiet</term>
      <listitem>
       <para>
        Do not display a response.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-D, --location <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>-E, --encoding <replaceable class="parameter">encoding</replaceable></term>
      <listitem>
       <para>
        Specifies the character encoding scheme to be used with this database.
       </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.
        The default is to create a database with the same name as the
        current system user.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><replaceable class="parameter">description</replaceable></term>
      <listitem>
       <para>
        This optionally specifies a comment to be associated with the newly created
	database.
       </para>
      </listitem>
     </varlistentry>

    </variablelist>

    The options <literal>-h</literal>, <literal>-p</literal>, <literal>-U</literal>,
    <literal>-W</literal>, and <literal>-e</literal> are passed on literally to
    <xref linkend="APP-PSQL" endterm="APP-PSQL-title">.
   </para>
  </refsect2>

  <refsect2 id="R2-APP-CREATEDB-2">
   <refsect2info>
    <date>1999-11-07</date>
   </refsect2info>
   <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>
      <term><computeroutput>createdb: Comment creation failed. (Database was created.)</computeroutput></term>
      <listitem>
       <para>
       The comment/description for the database could not be created.
       the database itself will have been created already. You can use the
       <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.
    See <xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-title">
    and <xref linkend="APP-PSQL" endterm="APP-PSQL-title"> for possibilities.
   </para>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-APP-CREATEDB-1">
  <refsect1info>
   <date>1999-11-07</date>
  </refsect1info>
  <title>
   Description
  </title>
  <para>
   <application>createdb</application> creates a new <productname>Postgres</productname>
   database. The user who executes this command becomes the database owner.
  </para>

  <para>
   <application>createdb</application> is a shell script wrapper around the
   <acronym>SQL</acronym> command
   <xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-title"> via
   the <productname>Postgres</productname> interactive terminal
   <xref linkend="APP-PSQL" endterm="APP-PSQL-title">. Thus, there is nothing
   special about creating databases via this or other methods. This means
   that the <application>psql</application> must be found by the script and that
   a database server is running at the targeted host. Also, any default
   settings and environment variables available to <application>psql</application>
   and the <application>libpq</application> front-end library do apply.
  </para>
 </refsect1>

 <refsect1 id="R1-APP-CREATEDB-2">
  <refsect1info>
   <date>1999-11-07</date>
  </refsect1info>
  <title>
   Usage
  </title>
  <para>
   To create the database <literal>demo</literal>
   using the default database server:

   <programlisting>
$ <userinput>createdb demo</userinput>
CREATE DATABASE
   </programlisting>

   The response is the same as you would have gotten from running the
   <command>CREATE DATABASE</command> <acronym>SQL</acronym> command.
  </para>

  <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:

   <programlisting>
$ <userinput>createdb -p 5000 -h eden -E LATIN1 -e demo</userinput>
CREATE DATABASE "demo" WITH ENCODING = 'LATIN1'
CREATE DATABASE
   </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:
-->
