aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/initlocation.sgml
blob: b89acd883890cb5b62a27af5104ec9ee268cc1e9 (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
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.17 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->

<refentry id="APP-INITLOCATION">
 <refmeta>
  <refentrytitle id="APP-INITLOCATION-TITLE"><application>initlocation</application></refentrytitle>
  <manvolnum>1</manvolnum>
  <refmiscinfo>Application</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>initlocation</refname>
  <refpurpose>create a secondary <productname>PostgreSQL</productname> database storage area</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <cmdsynopsis>
   <command>initlocation</command>
   <arg choice="plain"><replaceable>directory</replaceable></arg>
  </cmdsynopsis>
 </refsynopsisdiv>

 <refsect1 id="R1-APP-INITLOCATION-1">
  <title>Description</title>
  <para>
   <application>initlocation</application> 
   creates a new <productname>PostgreSQL</productname> secondary database storage area.
   See the discussion under <xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-title">
   about how to manage and use secondary storage areas. If the argument does not contain
   a slash and is not valid as a path, it is assumed to be an environment variable,
   which is referenced. See the examples at the end.
  </para>
  <para>
   In order to use this command you must be logged in (using <command>su</command>, for example)
   as the database superuser.
  </para>
 </refsect1>

 <refsect1 id="R1-APP-INITLOCATION-2">
  <title>Examples</title>

   <para>
    To create a database in an alternate location, using an
    environment variable:
<screen>
<prompt>$ </prompt><userinput>export PGDATA2=/opt/postgres/data</userinput>
</screen>
    Stop and start postmaster so it sees the <envar>PGDATA2</envar>
    environment variable.  The system must be configured so the
    postmaster sees <envar>PGDATA2</envar> every time it starts.  Finally:
<screen>
<prompt>$</prompt> <userinput>initlocation PGDATA2</userinput>
<prompt>$</prompt> <userinput>createdb -D PGDATA2 testdb</userinput>
</screen>
   </para>

   <para>
    Alternatively, if you allow absolute paths you could write:
<screen>
<prompt>$</prompt> <userinput>initlocation /opt/postgres/data</userinput>
<prompt>$</prompt> <userinput>createdb -D /opt/postgres/data/testdb testdb</userinput>
</screen>
   </para>
 </refsect1>

 <refsect1>
  <title>See Also</title>

  <simplelist type="inline">
   <member><citetitle>PostgreSQL Administrator's Guide</citetitle></member>
  </simplelist>
 </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:
-->