1999-12-05 21:02:49 +01:00
|
|
|
<!--
|
2003-03-24 15:32:51 +01:00
|
|
|
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.31 2003/03/24 14:32:51 petere Exp $
|
2001-12-08 04:24:40 +01:00
|
|
|
PostgreSQL documentation
|
1999-12-05 21:02:49 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
<refentry id="APP-CREATELANG">
|
|
|
|
<refmeta>
|
2000-11-12 00:01:45 +01:00
|
|
|
<refentrytitle id="APP-CREATELANG-TITLE"><application>createlang</application></refentrytitle>
|
|
|
|
<manvolnum>1</manvolnum>
|
1999-12-05 21:02:49 +01:00
|
|
|
<refmiscinfo>Application</refmiscinfo>
|
|
|
|
</refmeta>
|
2000-11-12 00:01:45 +01:00
|
|
|
|
1999-12-05 21:02:49 +01:00
|
|
|
<refnamediv>
|
2002-07-28 17:22:21 +02:00
|
|
|
<refname>createlang</refname>
|
2001-09-03 14:57:50 +02:00
|
|
|
<refpurpose>define a new <productname>PostgreSQL</productname> procedural language</refpurpose>
|
1999-12-05 21:02:49 +01:00
|
|
|
</refnamediv>
|
2000-11-12 00:01:45 +01:00
|
|
|
|
1999-12-05 21:02:49 +01:00
|
|
|
<refsynopsisdiv>
|
2000-11-12 00:01:45 +01:00
|
|
|
<cmdsynopsis>
|
|
|
|
<command>createlang</command>
|
2003-03-24 15:32:51 +01:00
|
|
|
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
|
2002-01-03 06:30:04 +01:00
|
|
|
<arg choice="plain"><replaceable>langname</replaceable></arg>
|
|
|
|
<arg><replaceable>dbname</replaceable></arg>
|
2000-11-12 00:01:45 +01:00
|
|
|
<sbr>
|
|
|
|
<command>createlang</command>
|
2003-03-24 15:32:51 +01:00
|
|
|
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
|
2000-11-12 00:01:45 +01:00
|
|
|
<group choice="plain"><arg>--list</arg><arg>-l</arg></group>
|
|
|
|
<arg choice="plain"><replaceable>dbname</replaceable></arg>
|
|
|
|
</cmdsynopsis>
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<application>createlang</application> is a utility for adding a new
|
|
|
|
programming language to a <productname>PostgreSQL</productname> database.
|
|
|
|
<application>createlang</application> can handle all the languages
|
|
|
|
supplied in the default <productname>PostgreSQL</> distribution, but
|
|
|
|
not languages provided by other parties.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
Although backend programming languages can be added directly using
|
|
|
|
several <acronym>SQL</acronym> commands, it is recommended to use
|
|
|
|
<application>createlang</application> because it performs a number
|
|
|
|
of checks and is much easier to use. See
|
|
|
|
<xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
|
2002-10-12 01:03:48 +02:00
|
|
|
for additional information.
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Options</title>
|
1999-12-05 21:02:49 +01:00
|
|
|
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
<application>createlang</application> accepts the following command-line arguments:
|
1999-12-05 21:02:49 +01:00
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><replaceable class="parameter">langname</replaceable></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-10-26 23:17:03 +02:00
|
|
|
Specifies the name of the procedural programming language to be
|
|
|
|
defined.
|
1999-12-05 21:02:49 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></></term>
|
|
|
|
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
|
1999-12-05 21:02:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-10-26 23:17:03 +02:00
|
|
|
Specifies to which database the language should be added.
|
2002-01-06 04:33:26 +01:00
|
|
|
The default is to use the database with the same name as the
|
2002-01-03 06:30:04 +01:00
|
|
|
current system user.
|
1999-12-05 21:02:49 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-05-10 00:08:19 +02:00
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-e</></term>
|
|
|
|
<term><option>--echo</></term>
|
2001-05-10 00:08:19 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Display SQL commands as they are executed.
|
2001-05-10 00:08:19 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-12-05 21:02:49 +01:00
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-l</></term>
|
|
|
|
<term><option>--list</></term>
|
1999-12-05 21:02:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Show a list of already installed languages in the target database.
|
1999-12-05 21:02:49 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-05-10 00:08:19 +02:00
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-L <replaceable class="parameter">directory</replaceable></></term>
|
2001-05-10 00:08:19 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the directory in which the language interpreter is
|
2001-11-28 21:49:10 +01:00
|
|
|
to be found. The directory is normally found automatically; this
|
|
|
|
option is primarily for debugging purposes.
|
2001-05-10 00:08:19 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-12-05 21:02:49 +01:00
|
|
|
</variablelist>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<application>createlang</application> also accepts
|
2002-10-12 01:03:48 +02:00
|
|
|
the following command-line arguments for connection parameters:
|
1999-12-05 21:02:49 +01:00
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
|
|
|
|
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
|
1999-12-05 21:02:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-11-28 21:49:10 +01:00
|
|
|
Specifies the host name of the machine on which the
|
|
|
|
server
|
2003-03-24 15:32:51 +01:00
|
|
|
is running. If the value begins with a slash, it is used
|
2001-11-28 21:49:10 +01:00
|
|
|
as the directory for the Unix domain socket.
|
1999-12-05 21:02:49 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
|
|
|
|
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
|
1999-12-05 21:02:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Specifies the TCP port or local Unix domain socket file
|
2001-11-28 21:49:10 +01:00
|
|
|
extension on which the server
|
1999-12-05 21:02:49 +01:00
|
|
|
is listening for connections.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
|
|
|
|
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
|
1999-12-05 21:02:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-02-13 06:37:44 +01:00
|
|
|
User name to connect as.
|
1999-12-05 21:02:49 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-09-21 20:32:54 +02:00
|
|
|
<term><option>-W</></term>
|
|
|
|
<term><option>--password</></term>
|
1999-12-05 21:02:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Force password prompt.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
</variablelist>
|
|
|
|
</para>
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Environment</title>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2002-08-10 18:57:32 +02:00
|
|
|
<term><envar>PGDATABASE</envar></term>
|
2002-07-28 17:22:21 +02:00
|
|
|
<term><envar>PGHOST</envar></term>
|
|
|
|
<term><envar>PGPORT</envar></term>
|
|
|
|
<term><envar>PGUSER</envar></term>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Default connection parameters
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Diagnostics</title>
|
1999-12-05 21:02:49 +01:00
|
|
|
|
|
|
|
<para>
|
|
|
|
Most error messages are self-explanatory. If not, run
|
|
|
|
<application>createlang</application> with the <option>--echo</option>
|
|
|
|
option and see under the respective <acronym>SQL</acronym> command
|
2003-03-18 23:19:47 +01:00
|
|
|
for details.
|
1999-12-05 21:02:49 +01:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Notes</title>
|
|
|
|
|
1999-12-05 21:02:49 +01:00
|
|
|
<para>
|
2000-12-26 00:15:27 +01:00
|
|
|
Use <xref linkend="app-droplang"> to remove a language.
|
1999-12-05 21:02:49 +01:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Examples</title>
|
2000-11-12 00:01:45 +01:00
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
To install the language <literal>pltcl</literal> into the database
|
2000-11-12 00:01:45 +01:00
|
|
|
<literal>template1</literal>:
|
|
|
|
<screen>
|
|
|
|
<prompt>$ </prompt><userinput>createlang pltcl template1</userinput>
|
|
|
|
</screen>
|
|
|
|
</para>
|
1999-12-05 21:02:49 +01:00
|
|
|
</refsect1>
|
2002-07-28 17:22:21 +02:00
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
<simplelist type="inline">
|
|
|
|
<member><xref linkend="app-droplang"></member>
|
|
|
|
<member><xref linkend="sql-createlanguage" endterm="sql-createlanguage-title"></member>
|
|
|
|
</simplelist>
|
|
|
|
</refsect1>
|
|
|
|
|
1999-12-05 21:02:49 +01:00
|
|
|
</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:
|
|
|
|
-->
|