database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-06-11 20:28:21 +03:00
Code Activity

Include all information from the old man pages.

Browse Source
This commit is contained in:
Thomas G. Lockhart
2000-03-31 06:17:52 +00:00
parent fb43d74762
commit f43974f6f1
1 changed files with 315 additions and 235 deletions
Download Patch File Download Diff File Expand all files Collapse all files

494
doc/src/sgml/ref/ecpg-ref.sgml
View File

@ -1,5 +1,5 @@
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.1 1999/07/22 15:09:11 thomas Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.2 2000/03/31 06:17:52 thomas Exp $
Postgres documentation Postgres documentation
--> -->
@ -38,10 +38,60 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ] file1 [ file2 ] [ ... ]
line arguments: line arguments:
<variablelist> <variablelist>
<varlistentry>
<term>-v</term>
<listitem>
<para>
Print version information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-t</term>
<listitem>
<para>
Turn off auto-transactin mode.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-I <replaceable class="parameter">path</replaceable></term>
<listitem>
<para>
Specify an additional include path.
Defaults are <filename>.</filename>,
<filename>/usr/local/include</filename>, the
<productname>Postgres</productname> include path which is
defined at compile time (default:
<filename>/usr/local/pgsql/lib</filename>), and
<filename>/usr/include</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-o</term>
<listitem>
<para>
Specifies that ecpg should write all its output to outfile.
If no such option is given the output is written to
<filename><replaceable>name</replaceable>.c</filename>,
assuming the input file was
named <filename><replaceable>name</replaceable>.pgc</filename>.
If the input file does have the expected
<literal>.pgc</literal> suffix, then the output file will have
<literal>.pgc</literal> appended to the input file name.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><replaceable class="parameter">file</replaceable></term> <term><replaceable class="parameter">file</replaceable></term>
<listitem> <listitem>
<para> <para>
The files to be processed.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -62,10 +112,11 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ] file1 [ file2 ] [ ... ]
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><computeroutput> <term><replaceable>return value</replaceable></term>
</computeroutput></term>
<listitem> <listitem>
<para> <para>
ecpg returns 0 to the shell on successful completion, -1
for errors.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -74,239 +125,282 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ] file1 [ file2 ] [ ... ]
</refsect2> </refsect2>
</refsynopsisdiv> </refsynopsisdiv>
<refsect1 id="R1-APP-ECPG-1"> <refsect1 id="R1-APP-ECPG-description">
<refsect1info> <title>Description</title>
<date>1998-11-05</date>
</refsect1info>
<title>
Description
</title>
<para> <para>
<!-- <application>ecpg</application>
.TH ECPG UNIX 11/28/98 PostgreSQL \fIPostgreSQL\fP is an embedded SQL preprocessor for the C language and the
.SH NAME <productname>Postgres</productname>. It
ecpg - embedded SQL preprocessor for C / PostgreSQL
.SH SYNOPSIS
.\" \fBecpg\fR [-v ] [-t] [-I include-path ] [-o outfile ] file1 [ file2 ] [ ... ]
\fBecpg\fR [-v ] [-t] [-I include-path ] [-o outfile ] file1 [ file2 ] [ ... ]
.SH DESCRIPTION
.B \fIecpg\fP
is an embedded SQL preprocessor for C / PostgreSQL. It
enables development of C programs with embedded SQL code. enables development of C programs with embedded SQL code.
.PP </para>
.B \fIecpg\fP
is ultimately intended to be as compliant as possible with the <para>
ANSI SQL-2 standard and existing commercial ESQL/C packages. <ulink url="linus@epact.se">Linus Tolke</ulink> was the
.SH OPTIONS original author of <application>ecpg</application> (up to version 0.2).
.B \fIecpg\fP <ulink url="meskes@debian.org">Michael Meskes</ulink>
interprets the following flags when it is invoked is the current author and maintainer of <application>ecpg</application>.
on the command line: <ulink url="tomg@q8.nrnet.org">Thomas Good</ulink>
.PP is the author of the last revision of the ecpg man page, on which
.PD 0 this document is based.
.TP 10 </para>
.BI \-v </refsect1>
Print version information.
.PD <refsect1 id="R1-APP-ECPG-2">
.TP <title>Usage</title>
.B \-t
Turn off auto-transactin mode. <refsect2 id="R2-APP-ECPG-preprocessing">
.PD <title>Preprocessing for Compilation</title>
.TP
.PD <para>
.TP An embedded SQL source file must be preprocessed before
.B \-I include-path compilation:
Specify additional include path. Defaults are \., <programlisting>
/usr/local/include, the PostgreSQL include path which is defined at compile ecpg [ -d ] [ -o <replaceable>file</replaceable> ] <replaceable>file</replaceable>.pgc
time (default: /usr/local/pgsql/lib), /usr/include </programlisting>
.PD
.TP where the optional <option>-d</option> flag turns on debugging.
.B \-o The <literal>.pgc</literal> extension is an
Specifies that ecpg should write all its output to outfile. arbitrary means of denoting <application>ecpg</application> source.
If no such option is given the output is written to foo.c </para>
(if the input file was named foo.pgc.)
If the input file was named foo.bar the output file will be <para>
named foo.bar.c. You may want to redirect the preprocessor output to a log file.
.PD </para>
.TP </refsect2>
.B file1, file2...
The files to be processed. <refsect2 id="R2-APP-ECPG-compiling">
.\" <title>Compiling and Linking</title>
.SH INSTALLATION
The <para>
.B \fIecpg\fP Assuming the <productname>Postgres</productname> binaries are in
preprocessor is built during the PostgreSQL installation. Binaries and <filename>/usr/local/pgsql</filename>, you will need to compile
libraries are installed into the PGBASE (i.e., /usr/local/pgsql/... ) and link your preprocessed source file:
subdirectories.
.SH PREPROCESSING FOR COMPILATION <programlisting>
.B \fIecpg\fP gcc -g -I /usr/local/pgsql/include [ -o <replaceable>file</replaceable> ] <replaceable>file</replaceable>.c -L /usr/local/pgsql/lib -lecpg -lpq
.\" (-d ) (-o file) file.pgc ( 2> ecpf.log) </programlisting>
(-o file) file.pgc </para>
.LP </refsect2>
.\" The optional \-d flag turns on debugging and 2> ecpg.log </refsect1>
.\" redirects the debug output. The .pgc extension is an
.\" arbitrary means of denoting ecpg source. <refsect1 id="R1-APP-ECPG-grammar">
The .pgc extension is an arbitrary means of denoting ecpg source. <title>Grammar</title>
.SH COMPILING AND LINKING
Assuming the \fIPostgreSQL\fP binaries are in /usr/local/pgsql: <refsect2 id="R2-APP-ECPG-library">
.LP <title>Libraries</title>
gcc -g -i /usr/local/pgsql/include (-o file) file.c
-L /usr/local/pgsql/lib -lecpg -lpq <para>
.SH ECPG GRAMMAR
.LP
.SH LIBRARIES
.LP
The preprocessor will prepend two directives to the source: The preprocessor will prepend two directives to the source:
.LP
\fI#include <ecpgtype.h>\fP and \fI#include <ecpglib.h>\fP <programlisting>
.SH VARIABLE DECLARATION #include &lt;ecpgtype.h&gt;
#include &lt;ecpglib.h&gt;
</programlisting>
</para>
</refsect2>
<refsect2 id="R2-APP-declaration">
<title>Variable Declaration</title>
<para>
Variables declared within ecpg source code must be prepended with: Variables declared within ecpg source code must be prepended with:
.LP
<programlisting>
EXEC SQL BEGIN DECLARE SECTION; EXEC SQL BEGIN DECLARE SECTION;
.LP </programlisting>
</para>
<para>
Similarly, variable declaration sections must terminate with: Similarly, variable declaration sections must terminate with:
.LP
<programlisting>
EXEC SQL END DECLARE SECTION; EXEC SQL END DECLARE SECTION;
.LP </programlisting>
NOTE: prior to version 2.1.0, each variable had to be declared
<note>
<para>
Prior to version 2.1.0, each variable had to be declared
on a separate line. As of version 2.1.0 multiple variables may on a separate line. As of version 2.1.0 multiple variables may
be declared on a single line: be declared on a single line:
.LP <programlisting>
char foo(16), bar(16); char foo(16), bar(16);
.LP </programlisting>
.SH ERROR HANDLING </para>
</note>
</para>
</refsect2>
<refsect2 id="R2-APP-ECPG-errors">
<title>Error Handling</title>
<para>
The SQL communication area is defined with: The SQL communication area is defined with:
.LP
<programlisting>
EXEC SQL INCLUDE sqlca; EXEC SQL INCLUDE sqlca;
.LP </programlisting>
NOTE: the lowercase `sqlca'. While SQL convention may be
<note>
<para>
The <literal>sqlca</literal> is in lowercase.
While SQL convention may be
followed, i.e., using uppercase to separate embedded SQL followed, i.e., using uppercase to separate embedded SQL
from C statements, sqlca (which includes the sqlca.h from C statements, sqlca (which includes the sqlca.h
header file) MUST be lowercase. This is because the EXEC SQL header file) MUST be lowercase. This is because the EXEC SQL
prefix indicates that this INCLUDE will be parsed by ecpg. prefix indicates that this INCLUDE will be parsed by ecpg.
ecpg observes case sensitivity (SQLCA.h will not be found.) ecpg observes case sensitivity (SQLCA.h will not be found.)
EXEC SQL INCLUDE can be used to include other header files <command>EXEC SQL INCLUDE</command>
can be used to include other header files
as long as case sensitivity is observed. as long as case sensitivity is observed.
.LP </para>
</note>
</para>
<para>
The sqlprint command is used with the EXEC SQL WHENEVER The sqlprint command is used with the EXEC SQL WHENEVER
statement to turn on error handling throughout the statement to turn on error handling throughout the
program: program:
.LP
<programlisting>
EXEC SQL WHENEVER sqlerror sqlprint; EXEC SQL WHENEVER sqlerror sqlprint;
.LP </programlisting>
and
<programlisting>
EXEC SQL WHENEVER not found sqlprint; EXEC SQL WHENEVER not found sqlprint;
.LP </programlisting>
PLEASE NOTE: this is *not* an exhaustive example of usage for
the EXEC SQL WHENEVER statement. Further examples of usage may <note>
<para>
This is <emphasis>not</emphasis> an exhaustive example of usage for
the <command>EXEC SQL WHENEVER</command> statement.
Further examples of usage may
be found in SQL manuals (e.g., `The LAN TIMES Guide to SQL' by be found in SQL manuals (e.g., `The LAN TIMES Guide to SQL' by
Groff and Weinberg.) Groff and Weinberg).
.LP </para>
.SH CONNECTING TO THE DATABASE SERVER </note>
Prior to version 2.1.0 the database name was single quoted: </para>
.RS </refsect2>
EXEC SQL CONNECT 'test1';
.RE <refsect2 id="R2-APP-ECPG-connecting">
.LP <title>Connecting to the Database Server</title>
As of version 2.1.0, the syntax has been simplified:
.LP <para>
.RS One connects to a database using the following:
EXEC SQL CONNECT test1;
.RE <programlisting>
(The database name is no longer quoted.) EXEC SQL CONNECT <replaceable>dbname</replaceable>;
.LP </programlisting>
Specifying a server and port name in the connect statement is also possible
as of version 6.4. of PostgreSQL. The syntax is: where the database name is not quoted. Prior to version 2.1.0, the
.LP database name was required to be inside single quotes.
.RS </para>
dbname[@server][:port]
.RE <para>
.LP Specifying a server and port name in the connect statement is also
possible. The syntax is:
<programlisting>
<replaceable>dbname</replaceable>[@<replaceable>server</replaceable>][:<replaceable>port</replaceable>]
</programlisting>
or or
.LP
.RS <programlisting>
<tcp|unix>:postgresql://server[:port][/dbname][?options] &lt;tcp|unix&gt;:postgresql://<replaceable>server</replaceable>[:<replaceable>port</replaceable>][/<replaceable>dbname</replaceable>][?<replaceable>options</replaceable>]
.RE </programlisting>
.SH QUERIES </para>
.LP </refsect2>
.SS Create Table:
.LP <refsect2 id="R2-APP-ECPG-queries">
<title>Queries</title>
<para>
In general, SQL queries acceptable to other applications such as
<application>psql</application> can be embedded into your C
code. Here are some examples of how to do that.
</para>
<para>
Create Table:
<programlisting>
EXEC SQL CREATE TABLE foo (number int4, ascii char(16)); EXEC SQL CREATE TABLE foo (number int4, ascii char(16));
.RS
EXEC SQL CREATE UNIQUE index num1 on foo(number); EXEC SQL CREATE UNIQUE index num1 on foo(number);
.RE
EXEC SQL COMMIT; EXEC SQL COMMIT;
.LP </programlisting>
.SS Insert: </para>
.LP
EXEC SQL INSERT INTO foo (number, ascii) <para>
.RS Insert:
VALUES (9999, 'doodad');
.RE <programlisting>
EXEC SQL INSERT INTO foo (number, ascii) VALUES (9999, 'doodad');
EXEC SQL COMMIT; EXEC SQL COMMIT;
.LP </programlisting>
.SS Delete: </para>
.LP
EXEC SQL DELETE FROM foo <para>
.RS Delete:
WHERE number = 9999;
.RE <programlisting>
EXEC SQL DELETE FROM foo WHERE number = 9999;
EXEC SQL COMMIT; EXEC SQL COMMIT;
.LP </programlisting>
.SS Singleton Select: </para>
.LP
EXEC SQL SELECT foo INTO :FooBar FROM table1 <para>
.RS Singleton Select:
WHERE ascii = 'doodad';
.RE <programlisting>
.LP EXEC SQL SELECT foo INTO :FooBar FROM table1 WHERE ascii = 'doodad';
.SS Select using Cursors: </programlisting>
.LP </para>
<para>
Select using Cursors:
<programlisting>
EXEC SQL DECLARE foo_bar CURSOR FOR EXEC SQL DECLARE foo_bar CURSOR FOR
.RS
SELECT number, ascii FROM foo SELECT number, ascii FROM foo
.RS
ORDER BY ascii; ORDER BY ascii;
.RE
.RE
EXEC SQL FETCH foo_bar INTO :FooBar, DooDad; EXEC SQL FETCH foo_bar INTO :FooBar, DooDad;
.LP
... ...
EXEC SQL CLOSE foo_bar; EXEC SQL CLOSE foo_bar;
.RS
EXEC SQL COMMIT; EXEC SQL COMMIT;
.RE </programlisting>
.LP </para>
.SS Updates
.LP <para>
Updates:
<programlisting>
EXEC SQL UPDATE foo EXEC SQL UPDATE foo
.RS
SET ascii = 'foobar' SET ascii = 'foobar'
.RE
.RS
WHERE number = 9999; WHERE number = 9999;
.RE
EXEC SQL COMMIT; EXEC SQL COMMIT;
.LP </programlisting>
.SH BUGS </para>
.LP </refsect2>
The is no EXEC SQL PREPARE statement. </refsect1>
.LP
<refsect1 id="R1-APP-ECPG-notes">
<title>Notes</title>
<para>
There is no <command>EXEC SQL PREPARE</command> statement.
</para>
<para>
The complete structure definition MUST be listed The complete structure definition MUST be listed
inside the declare section. inside the declare section.
.LP </para>
See the TODO file in the source for some more missing features.
.LP <para>
.SH "RETURN VALUE" See the <filename>TODO</filename> file in the source for some more
.LP missing features.
ecpg returns 0 to the shell on successful completion, -1 </para>
for errors.
.LP <!--
.SH "SEE ALSO"
.PD 0
.TP
\fIcc\fP(1), \fIpgintro\fP(l), \fIcommit\fP(l), \fIdelete\fP(l)
.TP
\fIfetch\fP(l), \fIselect\fP(l), \fIsql\fP(l) , \fIupdate\fP(l)
.PD
.SH FILES .SH FILES
.PD 0 .PD 0
.TP .TP
@ -330,22 +424,8 @@ and \fIsqlca.h\fP.
.B /usr/local/pgsql/lib .B /usr/local/pgsql/lib
\fIPostgreSQL\fP libraries including \fIlibecpg.a\fP and \fIPostgreSQL\fP libraries including \fIlibecpg.a\fP and
\fIlibecpg.so\fP. \fIlibecpg.so\fP.
.SH AUTHORS
Linus Tolke \fI<linus@epact.se>\fP
- original author of ECPG (up to version 0.2).
.br
.PP
Michael Meskes \fI<meskes@debian.org>\fP
- actual author and maintainer of ECPG.
.br
.PP
Thomas Good \fI<tomg@q8.nrnet.org>\fP
- author of this revision of the ecpg man page.
.br
.zZ
--> -->
</para>
</refsect1> </refsect1>
</refentry> </refentry>