1999-07-22 17:09:15 +02:00
|
|
|
<!--
|
2003-08-31 19:32:24 +02:00
|
|
|
$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.27 2003/08/31 17:32:23 petere Exp $
|
2001-12-08 04:24:40 +01:00
|
|
|
PostgreSQL documentation
|
1999-07-22 17:09:15 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
<refentry id="APP-ECPG">
|
|
|
|
<refmeta>
|
2002-10-21 20:04:05 +02:00
|
|
|
<refentrytitle><application>ecpg</application></refentrytitle>
|
2000-12-26 00:15:27 +01:00
|
|
|
<manvolnum>1</manvolnum>
|
1999-07-22 17:09:15 +02:00
|
|
|
<refmiscinfo>Application</refmiscinfo>
|
|
|
|
</refmeta>
|
2002-07-28 17:22:21 +02:00
|
|
|
|
1999-07-22 17:09:15 +02:00
|
|
|
<refnamediv>
|
2002-10-21 20:04:05 +02:00
|
|
|
<refname><application>ecpg</application></refname>
|
|
|
|
<refpurpose>embedded SQL C preprocessor</refpurpose>
|
1999-07-22 17:09:15 +02:00
|
|
|
</refnamediv>
|
2002-07-28 17:22:21 +02:00
|
|
|
|
2003-08-31 19:32:24 +02:00
|
|
|
<indexterm zone="app-ecpg">
|
|
|
|
<primary>ecpg</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
1999-07-22 17:09:15 +02:00
|
|
|
<refsynopsisdiv>
|
2001-11-18 21:35:02 +01:00
|
|
|
<cmdsynopsis>
|
|
|
|
<command>ecpg</command>
|
2002-10-21 20:04:05 +02:00
|
|
|
<arg choice="opt" rep="repeat"><replaceable>option</replaceable></arg>
|
2001-11-18 21:35:02 +01:00
|
|
|
<arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
|
|
|
|
</cmdsynopsis>
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsynopsisdiv>
|
|
|
|
|
2002-10-21 20:04:05 +02:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<refsect1 id="APP-ECPG-description">
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
|
|
<para>
|
2002-10-21 20:04:05 +02:00
|
|
|
<command>ecpg</command> is the embedded SQL preprocessor for C
|
|
|
|
programs. It converts C programs with embedded SQL statements to
|
|
|
|
normal C code by replacing the SQL invocations with special
|
|
|
|
function calls. The output files can then be processed with any C
|
|
|
|
compiler tool chain.
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-10-21 20:04:05 +02:00
|
|
|
<command>ecpg</command> will convert each input file given on the
|
|
|
|
command line to the corresponding C output file. Input files
|
|
|
|
preferrably have the extension <filename>.pgc</filename>, in which
|
|
|
|
case the extension will be replaced by <filename>.c</filename> to
|
|
|
|
determine the output file name. If the extension of the input file
|
|
|
|
is not <filename>.pgc</filename>, then the output file name is
|
|
|
|
computed by appending <literal>.c</literal> to the full file name.
|
|
|
|
The output file name can also be overridden using the
|
|
|
|
<option>-o</option> option.
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
1999-07-22 17:09:15 +02:00
|
|
|
|
2002-10-21 20:04:05 +02:00
|
|
|
<para>
|
|
|
|
This reference page does not describe the embedded SQL language.
|
2003-03-25 17:15:44 +01:00
|
|
|
See <xref linkend="ecpg"> for more information on that topic.
|
2002-10-21 20:04:05 +02:00
|
|
|
</para>
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsect1>
|
1999-07-22 17:09:15 +02:00
|
|
|
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<refsect1>
|
2002-10-21 20:04:05 +02:00
|
|
|
<title>Options</title>
|
2000-03-31 08:17:52 +02:00
|
|
|
|
|
|
|
<para>
|
2002-10-21 20:04:05 +02:00
|
|
|
<command>ecpg</command> accepts the following command-line
|
|
|
|
arguments:
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-c</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Automatically generate certain C code from SQL code. Currently, this
|
2002-10-21 20:04:05 +02:00
|
|
|
works for <literal>EXEC SQL TYPE</literal>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-D <replaceable>symbol</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Define a C preprocessor symbol.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-I <replaceable class="parameter">directory</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specify an additional include path, used to find files included
|
|
|
|
via <literal>EXEC SQL INCLUDE</literal>. Defaults are
|
|
|
|
<filename>.</filename> (current directory),
|
|
|
|
<filename>/usr/local/include</filename>, the
|
|
|
|
<productname>PostgreSQL</productname> include directory which
|
|
|
|
is defined at compile time (default:
|
|
|
|
<filename>/usr/local/pgsql/include</filename>), and
|
|
|
|
<filename>/usr/include</filename>, in that order.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-o <replaceable>filename</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Specifies that <command>ecpg</command> should write all
|
2002-10-21 20:04:05 +02:00
|
|
|
its output to the given <replaceable>filename</replaceable>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-t</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Turn on autocommit of transactions. In this mode, each SQL command is
|
2002-10-21 20:04:05 +02:00
|
|
|
automatically committed unless it is inside an explicit
|
2003-03-24 15:32:51 +01:00
|
|
|
transaction block. In the default mode, commands are committed
|
2002-10-21 20:04:05 +02:00
|
|
|
only when <command>EXEC SQL COMMIT</command> is issued.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-v</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Print additional information including the version and the
|
|
|
|
include path.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2003-03-24 15:32:51 +01:00
|
|
|
<term><option>--help</option></term>
|
2002-10-21 20:04:05 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Show a brief summary of the command usage, then exit.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--version</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Output version information, then exit.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
2000-03-31 08:17:52 +02:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
|
|
|
|
<refsect1>
|
2002-10-21 20:04:05 +02:00
|
|
|
<title>Notes</title>
|
2000-03-31 08:17:52 +02:00
|
|
|
|
2002-10-21 20:04:05 +02:00
|
|
|
<para>
|
|
|
|
When compiling the preprocessed C code files, the compiler needs to
|
|
|
|
be able to find the <application>ECPG</> header files in the
|
2002-11-15 04:11:18 +01:00
|
|
|
<productname>PostgreSQL</> include directory. Therefore, one might
|
|
|
|
have to use the <option>-I</> option when invoking the compiler
|
|
|
|
(e.g., <literal>-I/usr/local/pgsql/include</literal>).
|
2002-10-21 20:04:05 +02:00
|
|
|
</para>
|
2000-03-31 08:17:52 +02:00
|
|
|
|
2002-10-21 20:04:05 +02:00
|
|
|
<para>
|
|
|
|
Programs using C code with embedded SQL have to be linked against
|
|
|
|
the <filename>libecpg</filename> library, for example using the
|
2003-03-24 15:32:51 +01:00
|
|
|
linker options <literal>-L/usr/local/pgsql/lib -lecpg</literal>.
|
2002-10-21 20:04:05 +02:00
|
|
|
</para>
|
2000-03-31 08:17:52 +02:00
|
|
|
|
2002-10-21 20:04:05 +02:00
|
|
|
<para>
|
|
|
|
The value of either of these directories that is appropriate for
|
|
|
|
the installation can be found out using <xref
|
|
|
|
linkend="app-pgconfig">.
|
|
|
|
</para>
|
2000-03-31 08:17:52 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
2002-10-21 20:04:05 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Examples</title>
|
2000-03-31 08:17:52 +02:00
|
|
|
|
2002-10-21 20:04:05 +02:00
|
|
|
<para>
|
|
|
|
If you have an embedded SQL C source file named
|
|
|
|
<filename>prog1.pgc</filename>, you can create an executable
|
|
|
|
program using the following sequence of commands:
|
2001-11-28 21:49:10 +01:00
|
|
|
<programlisting>
|
2002-10-21 20:04:05 +02:00
|
|
|
ecpg prog1.pgc
|
|
|
|
cc -I/usr/local/pgsql/include -c prog1.c
|
|
|
|
cc -o prog1 prog1.o -L/usr/local/pgsql/lib -lecpg
|
2001-11-28 21:49:10 +01:00
|
|
|
</programlisting>
|
2000-03-31 08:17:52 +02:00
|
|
|
</para>
|
1999-07-22 17:09:15 +02:00
|
|
|
</refsect1>
|
2002-07-28 17:22:21 +02:00
|
|
|
|
1999-07-22 17:09:15 +02: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:
|
|
|
|
-->
|