Seth Woolley's Man Viewer

initdb(1) - initdb - create a new PostgreSQL database cluster - man 1 initdb

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

INITDB(1)               PostgreSQL Server Applications               INITDB(1)



NAME
       initdb - create a new PostgreSQL database cluster


SYNOPSIS
       initdb [ option... ]  --pgdata  | -D directory

DESCRIPTION
       initdb creates a new PostgreSQL database cluster. A database cluster is
       a collection of databases that are managed by a single server instance.

       Creating  a  database  cluster  consists of creating the directories in(1,8)
       which the database data will live, generating the shared catalog tables
       (tables  that belong to the whole cluster rather than to any particular
       database), and creating the template1 database. When you later create a
       new  database, everything in(1,8) the template1 database is copied.  It con-
       tains catalog tables filled in(1,8) for things like the built-in types.

       initdb initializes the database cluster's default locale(3,5,7) and  character
       set(7,n,1 builtins)  encoding. Some locale(3,5,7) categories are fixed for the lifetime of the
       cluster, so it is important to  make  the  right  choice  when  running
       initdb.   Other  locale(3,5,7) categories can be changed later when the server
       is started. initdb will write(1,2) those  locale(3,5,7)  settings  into  the  post-
       gresql.conf configuration file(1,n) so they are the default, but they can be
       changed by editing that file. To set(7,n,1 builtins) the locale(3,5,7) that initdb  uses,  see
       the  description of the --locale option. The character set(7,n,1 builtins) encoding(3,n) can
       be set(7,n,1 builtins) separately for each database as it is  created.   initdb  deter-
       mines  the encoding(3,n) for the template1 database, which will serve as the
       default for all other databases. To alter the default encoding(3,n) use  the
       --encoding option.

       initdb  must  be  run  as  the  user  that will own the server process,
       because the server needs to have access(2,5) to the  files  and  directories
       that initdb creates.  Since the server may not be run as root, you must
       not run initdb as root either. (It will in(1,8) fact refuse to do so.)

       Although initdb will attempt to create the  specified  data  directory,
       often  it  won't  have  permission  to  do  so, since the parent of the
       desired data directory is often a root-owned directory. To  set(7,n,1 builtins)  up  an
       arrangement like this, create an empty data directory as root, then use
       chown(1,2) to hand over ownership of that directory  to  the  database  user
       account, then su to become the database user, and finally run initdb as
       the database user.

OPTIONS
       -D directory

       --pgdata=directory
              This option specifies the directory where the  database  cluster
              should  be  stored.  This  is  the  only information required by
              initdb, but you can avoid writing it by setting the PGDATA envi-
              ronment  variable,  which  can  be convenient since the database
              server (postmaster) can find the database directory later by the
              same variable.

       -E encoding(3,n)

       --encoding=encoding(3,n)
              Selects the encoding(3,n) of the template database. This will also be
              the default encoding(3,n) of any database you  create  later,  unless
              you override it there. The default is SQL_ASCII.

       --locale=locale(3,5,7)
              Sets the default locale(3,5,7) for the database cluster. If this option
              is not specified, the locale(3,5,7) is inherited from  the  environment
              that initdb runs in.

       --lc-collate=locale(3,5,7)

       --lc-ctype=locale(3,5,7)

       --lc-messages=locale(3,5,7)

       --lc-monetary=locale(3,5,7)

       --lc-numeric=locale(3,5,7)

       --lc-time=locale(3,5,7)
              Like  --locale,  but only sets the locale(3,5,7) in(1,8) the specified cate-
              gory.

       -U username

       --username=username
              Selects the user name of the database superuser.  This  defaults
              to  the  name of the effective user running initdb. It is really
              not important what the superuser's name is, but one might choose
              to  keep the customary name postgres, even if(3,n) the operating sys-
              tem user's name is different.

       -W

       --pwprompt
              Makes initdb prompt for a password to give  the  database  supe-
              ruser.  If you don't plan on using password authentication, this
              is not important. Otherwise you won't be able  to  use  password
              authentication until you have a password set(7,n,1 builtins) up.


       Other, less(1,3) commonly used, parameters are also available:

       -d

       --debug
              Print  debugging  output  from  the  bootstrap backend and a few
              other messages of lesser interest for the general  public.   The
              bootstrap backend is the program initdb uses to create the cata-
              log  tables.  This  option  generates  a  tremendous  amount  of
              extremely boring output.

       -L directory
              Specifies where initdb should find its input files to initialize
              the database cluster. This is normally not necessary.  You  will
              be told if(3,n) you need to specify their location explicitly.

       -n

       --noclean
              By  default,  when  initdb determines that an error(8,n) prevented it
              from completely creating the database cluster,  it  removes  any
              files  it may have created before discovering that it can't fin-
              ish the job. This option inhibits tidying-up and is thus  useful
              for debugging.


ENVIRONMENT
       PGDATA Specifies  the  directory  where  the  database cluster is to be
              stored; may be overridden using the -D option.

SEE ALSO
       postgres(1), postmaster(1)




Application                       2003-11-02                         INITDB(1)

References for this manual (incoming links)