granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/createlang.sgml

   1 <!--
   2 $Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.10 2000/11/11 23:01:38 petere Exp $
   3 Postgres documentation
   4 -->
   5
   6 <refentry id="APP-CREATELANG">
   7  <docinfo>
   8   <date>2000-11-11</date>
   9  </docinfo>
  10
  11  <refmeta>
  12   <refentrytitle id="APP-CREATELANG-TITLE"><application>createlang</application></refentrytitle>
  13   <manvolnum>1</manvolnum>
  14   <refmiscinfo>Application</refmiscinfo>
  15  </refmeta>
  16
  17  <refnamediv>
  18   <refname id="createlang">createlang</refname>
  19   <refpurpose>Add a new programming language to a <productname>Postgres</productname> database</refpurpose>
  20  </refnamediv>
  21
  22  <refsynopsisdiv>
  23   <cmdsynopsis>
  24    <command>createlang</command>
  25    <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
  26    <arg><replaceable>langname</replaceable></arg>
  27    <arg choice="plain"><replaceable>dbname</replaceable></arg>
  28    <sbr>
  29    <command>createlang</command>
  30    <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
  31    <group choice="plain"><arg>--list</arg><arg>-l</arg></group>
  32    <arg choice="plain"><replaceable>dbname</replaceable></arg>
  33   </cmdsynopsis>
  34
  35   <refsect2 id="R2-APP-CREATELANG-1">
  36    <title>
  37     Inputs
  38    </title>
  39    <para>
  40     <application>createlang</application> accepts the following command line arguments:
  41
  42     <variablelist>
  43      <varlistentry>
  44       <term><replaceable class="parameter">langname</replaceable></term>
  45       <listitem>
  46        <para>
  47         Specifies the name of the backend programming language to be defined.
  48         <application>createlang</application> will prompt for
  49         <replaceable class="parameter">langname</replaceable>
  50         if it is not specified on the command line.
  51        </para>
  52       </listitem>
  53      </varlistentry>
  54
  55      <varlistentry>
  56       <term>-d, --dbname <replaceable class="parameter">dbname</replaceable></term>
  57       <listitem>
  58        <para>
  59         Specifies which database the language should be added.
  60        </para>
  61       </listitem>
  62      </varlistentry>
  63
  64      <varlistentry>
  65       <term>-l, --list</term>
  66       <listitem>
  67        <para>
  68         Shows a list of already installed languages in the target database
  69         (which must be specified).
  70        </para>
  71       </listitem>
  72      </varlistentry>
  73
  74     </variablelist>
  75    </para>
  76
  77    <para>
  78     <application>createlang</application> also accepts
  79     the following command line arguments for connection parameters:
  80
  81     <variablelist>
  82      <varlistentry>
  83       <term>-h, --host <replaceable class="parameter">host</replaceable></term>
  84       <listitem>
  85        <para>
  86         Specifies the hostname of the machine on which the
  87         <application>postmaster</application>
  88         is running.
  89        </para>
  90       </listitem>
  91      </varlistentry>
  92
  93      <varlistentry>
  94       <term>-p, --port <replaceable class="parameter">port</replaceable></term>
  95       <listitem>
  96        <para>
  97         Specifies the Internet TCP/IP port or local Unix domain socket file
  98         extension on which the <application>postmaster</application>
  99         is listening for connections.
 100        </para>
 101       </listitem>
 102      </varlistentry>
 103
 104      <varlistentry>
 105       <term>-U, --username <replaceable class="parameter">username</replaceable></term>
 106       <listitem>
 107        <para>
 108         Username to connect as.
 109        </para>
 110       </listitem>
 111      </varlistentry>
 112
 113      <varlistentry>
 114       <term>-W, --password</term>
 115       <listitem>
 116        <para>
 117         Force password prompt.
 118        </para>
 119       </listitem>
 120      </varlistentry>
 121
 122     </variablelist>
 123    </para>
 124   </refsect2>
 125
 126   <refsect2 id="R2-APP-CREATELANG-2">
 127    <title>
 128     Outputs
 129    </title>
 130    <para>
 131     Most error messages are self-explanatory. If not, run
 132     <application>createlang</application> with the <option>--echo</option>
 133     option and see under the respective <acronym>SQL</acronym> command
 134     for details. Check also under <xref linkend="APP-PSQL" endterm="APP-PSQL-title">
 135     for more possibilities.
 136    </para>
 137   </refsect2>
 138  </refsynopsisdiv>
 139
 140  <refsect1 id="R1-APP-CREATELANG-1">
 141   <title>
 142    Description
 143   </title>
 144
 145   <para>
 146    <application>createlang</application> is a utility for adding a new
 147    programming language to a <productname>Postgres</productname> database.
 148    <application>createlang</application> currently accepts several
 149    languages, <literal>plpgsql, pltcl, pltclu,</literal> and <literal>
 150    plperl</literal>.
 151   </para>
 152   <para>
 153    Although backend programming languages can be added directly using
 154    several <acronym>SQL</acronym> commands, it is recommended to use
 155    <application>createlang</application> because it performs a number
 156    of checks and is much easier to use. See
 157    <xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
 158    for more.
 159   </para>
 160  </refsect1>
 161
 162  <refsect1 id="R1-APP-CREATELANG-2">
 163   <title>
 164    Notes
 165   </title>
 166   <para>
 167    Use <xref linkend="app-droplang" endterm="app-droplang-title">
 168    to remove a language.
 169   </para>
 170  </refsect1>
 171
 172  <refsect1 id="R1-APP-CREATELANG-3">
 173   <title>Usage</title>
 174
 175   <informalexample>
 176    <para>
 177     To install <literal>pltcl</literal> into the database
 178     <literal>template1</literal>:
 179 <screen>
 180 <prompt>$ </prompt><userinput>createlang pltcl template1</userinput>
 181 </screen>
 182    </para>
 183   </informalexample>
 184  </refsect1>
 185 </refentry>
 186
 187 <!-- Keep this comment at the end of the file
 188 Local variables:
 189 mode: sgml
 190 sgml-omittag:nil
 191 sgml-shorttag:t
 192 sgml-minimize-attributes:nil
 193 sgml-always-quote-attributes:t
 194 sgml-indent-step:1
 195 sgml-indent-data:t
 196 sgml-parent-document:nil
 197 sgml-default-dtd-file:"../reference.ced"
 198 sgml-exposed-tags:nil
 199 sgml-local-catalogs:"/usr/lib/sgml/catalog"
 200 sgml-local-ecat-files:nil
 201 End:
 202 -->