ecpg.sgml 29.7 KB
Newer Older
1
<!--
2
$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.23 2001/09/13 15:55:22 petere Exp $
3 4
-->

5
 <chapter id="ecpg">
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
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
  <docinfo>
   <authorgroup>
    <author>
     <firstname>Linus</firstname>
     <surname>Tolke</surname>
    </author>
    <author>
     <firstname>Michael</firstname>
     <surname>Meskes</surname>
    </author>
   </authorgroup>
   <copyright>
    <year>1996-1997</year>
    <holder>Linus Tolke</holder>
   </copyright>
   <copyright>
    <year>1998</year>
    <holder>Michael Meskes</holder>
   </copyright>
   <date>Transcribed 1998-02-12</date>
  </docinfo>

  <title><application>ecpg</application> - Embedded <acronym>SQL</acronym> 
   in <acronym>C</acronym></title>

  <para>
Bruce Momjian's avatar
Bruce Momjian committed
32 33 34 35 36 37
   This describes the embedded <acronym>SQL</acronym> package for
   <productname>Postgres</productname>. It works with
   <acronym>C</acronym> and <acronym>C++</acronym>. It was written by
   Linus Tolke (<email>linus@epact.se</email>) and Michael Meskes
   (<email>meskes@debian.org</email>). The package is installed with the
   <productname>Postgres</> distribution, and carries a similar license.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
38
  </para>
39

40
  <sect1 id="ecpg-why">
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
41 42 43
   <title>Why Embedded <acronym>SQL</acronym>?</title>

   <para>
Bruce Momjian's avatar
Bruce Momjian committed
44 45 46 47 48
    Embedded <acronym>SQL</acronym> has advantages over other methods
    for handling <acronym>SQL</acronym> queries. It takes care of
    the tedious passing of information to and from variables in your
    <acronym>C</acronym> or <acronym>C++</acronym> program. Many
    <acronym>RDBMS</acronym> packages support this embedded language.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
49 50
   </para>

Bruce Momjian's avatar
Bruce Momjian committed
51 52 53 54 55 56
   <para> 
    There is an ANSI standard describing how the embedded language
    should work. <application>ecpg</application> was designed to match
    this standard as much as possible. It is possible to port embedded
    <acronym>SQL</acronym> programs written for other
    <acronym>RDBMS</acronym> to <productname>Postgres</productname>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
57 58 59
   </para>
  </sect1>

60
  <sect1 id="ecpg-concept">
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
61 62 63
   <title>The Concept</title>

   <para>
Bruce Momjian's avatar
Bruce Momjian committed
64 65 66 67 68
    You write your program in <acronym>C/C++</acronym> with special
    <acronym>SQL</acronym> constructs. When declaring variables to be
    used in <acronym>SQL</acronym> statements, you need to put them in a
    special <command>declare</> section. You use a special syntax for the
    <acronym>SQL</acronym> queries.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
69 70 71
   </para>

   <para>
Bruce Momjian's avatar
Bruce Momjian committed
72 73 74 75 76
    Before compiling you run the file through the embedded
    <acronym>SQL</acronym> <acronym>C</acronym> preprocessor and it
    converts the <acronym>SQL</acronym> statements you used to function
    calls with the variables used as arguments. Both query input and
    result output variables are passed.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
77 78 79
   </para>

   <para>
Bruce Momjian's avatar
Bruce Momjian committed
80 81 82 83 84
    After compiling, you must link with a special library that contains
    needed functions. These functions fetch information from the
    arguments, perform the <acronym>SQL</acronym> query using the
    <filename>libpq</filename> interface, and put the result in the
    arguments specified for output.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
85 86 87
   </para>
  </sect1>

88
  <sect1 id="ecpg-use">
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
89 90 91
   <title>How To Use <application>ecpg</application></title>

   <para>
Bruce Momjian's avatar
Bruce Momjian committed
92
    This section describes how to use <application>ecpg</application>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
93 94 95 96 97 98
   </para>

   <sect2>
    <title>Preprocessor</title>

    <para>
Bruce Momjian's avatar
Bruce Momjian committed
99 100 101
     The preprocessor is called <application>ecpg</application>. After
     installation it resides in the <productname>Postgres</productname>
     <filename>bin/</filename> directory.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
102 103 104 105 106 107
    </para>
   </sect2>
   <sect2>
    <title>Library</title>

    <para>
Bruce Momjian's avatar
Bruce Momjian committed
108 109 110 111 112 113
     The <application>ecpg</application> library is called
     <filename>libecpg.a</filename> or <filename>libecpg.so</filename>.
     Additionally, the library uses the <filename>libpq</filename>
     library for communication to the
     <productname>Postgres</productname> server. You will have to link
     your program using <parameter>-lecpg -lpq</parameter>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
114 115 116
    </para>

    <para>
117
     The library has some methods that are <quote>hidden</quote> but may prove
Bruce Momjian's avatar
Bruce Momjian committed
118
     useful.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
119 120 121 122 123

     <itemizedlist>
      <listitem>
       <para>
	<function>ECPGdebug(int <replaceable>on</replaceable>, FILE
Bruce Momjian's avatar
Bruce Momjian committed
124 125 126 127
	*<replaceable>stream</replaceable>)</function> turns on debug
	logging if called with the first argument non-zero. Debug
	logging is done on <replaceable>stream</replaceable>. Most
	<acronym>SQL</acronym> statement log their arguments and results.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
128 129 130
       </para>

       <para>
Bruce Momjian's avatar
Bruce Momjian committed
131 132 133 134 135 136
	The most important function , <function>ECPGdo</function>, logs
	all <acronym>SQL</acronym> statements with both the expanded
	string, i.e. the string with all the input variables inserted,
	and the result from the <productname>Postgres</productname>
	server. This can be very useful when searching for errors in
	your <acronym>SQL</acronym> statements.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
       </para>
      </listitem>

      <listitem>
       <para>
	<function>ECPGstatus()</function>
	This method returns TRUE if we are connected to a database and FALSE if not.
       </para>
      </listitem>
     </itemizedlist>
    </para>
   </sect2>

   <sect2>
    <title>Error handling</title>

    <para>
Bruce Momjian's avatar
Bruce Momjian committed
154 155
     To detect errors from the <productname>Postgres</productname>
     server, include a line like: 
156
<programlisting>
Bruce Momjian's avatar
Bruce Momjian committed
157
exec sql include sqlca; 
158
</programlisting>
Bruce Momjian's avatar
Bruce Momjian committed
159 160
     in the include section of your file. This will define a struct and
     a variable with the name <parameter>sqlca</parameter> as follows:
161
<programlisting>
Michael Meskes's avatar
Michael Meskes committed
162 163 164 165 166 167 168 169 170 171 172 173 174
struct sqlca
{
 char sqlcaid[8];
 long sqlabc;
 long sqlcode;
 struct
 {
  int sqlerrml;
  char sqlerrmc[70];
 } sqlerrm;
 char sqlerrp[8];
 long sqlerrd[6];
 /* 0: empty                                         */
Michael Meskes's avatar
Michael Meskes committed
175
 /* 1: OID of processed tuple if applicable          */
Michael Meskes's avatar
Michael Meskes committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
 /* 2: number of rows processed in an INSERT, UPDATE */
 /*    or DELETE statement                           */
 /* 3: empty                                         */
 /* 4: empty                                         */
 /* 5: empty                                         */
 char sqlwarn[8];
 /* 0: set to 'W' if at least one other is 'W'       */
 /* 1: if 'W' at least one character string	     */
 /*    value was truncated when it was               */
 /*    stored into a host variable.                  */
 /* 2: empty                                         */
 /* 3: empty                                         */
 /* 4: empty                                         */
 /* 5: empty                                         */
 /* 6: empty                                         */
 /* 7: empty                                         */
 char sqlext[8];
193
} sqlca;
194
</programlisting>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
195 196 197
    </para>

    <para>
198
     If an error occurred in the last <acronym>SQL</acronym> statement.
Bruce Momjian's avatar
Bruce Momjian committed
199 200 201 202 203
     <parameter>sqlca.sqlcode</parameter> will be non-zero. If
     <parameter>sqlca.sqlcode</parameter> is less that 0, this is a
     serious error, like the database definition does not match the
     query. If it is greater than 0, it is a normal error like the
     table did not contain the requested row.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
204 205 206
    </para>

    <para>
Bruce Momjian's avatar
Bruce Momjian committed
207 208 209
     <parameter>sqlca.sqlerrm.sqlerrmc</parameter> will contain a string
     that describes the error. The string ends with the line number in
     the source file.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
210 211 212 213 214 215 216
    </para>

    <para>
     List of errors that can occur:

     <variablelist>
      <varlistentry>
217
       <term><computeroutput>-12, Out of memory in line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
218 219
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
220
	 Should not normally occur. This indicates your virtual memory is
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
221 222 223 224 225 226
	 exhausted.
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
227
       <term><computeroutput>-200, Unsupported type %s on line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
228 229
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
230 231 232 233
	 Should not normally occur. This indicates the preprocessor has
	 generated something that the library does not know about.
	 Perhaps you are running incompatible versions of the
	 preprocessor and the library.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
234 235 236 237 238
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
239
       <term><computeroutput>-201, Too many arguments line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
240 241
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
242 243 244 245
	 This means that <productname>Postgres</productname> has
	 returned more arguments than we have matching variables.
	 Perhaps you have forgotten a couple of the host variables in
	 the <command>INTO :var1,:var2</command>-list.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
246 247 248 249 250
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
251
       <term><computeroutput>-202, Too few arguments line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
252 253
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
254 255 256 257
	 This means that <productname>Postgres</productname> has
	 returned fewer arguments than we have host variables. Perhaps
	 you have too many host variables in the <command>INTO
	 :var1,:var2</command>-list.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
258 259 260 261 262
	</para> 
       </listitem>
      </varlistentry>

      <varlistentry>
263
       <term><computeroutput>-203, Too many matches line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
264 265
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
266 267 268
	 This means the query has returned several rows but the
	 variables specified are not arrays. The
	 <command>SELECT</command> command was not unique.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
269 270 271 272 273
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
274
       <term><computeroutput>-204, Not correctly formatted int type: %s line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
275 276
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
277 278 279 280 281
	 This means the host variable is of type <type>int</type> and
	 the field in the <productname>Postgres</productname> database
	 is of another type and contains a value that cannot be
	 interpreted as an <type>int</type>. The library uses
	 <function>strtol()</function> for this conversion.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
282 283 284 285 286
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
287
       <term><computeroutput>-205, Not correctly formatted unsigned type: %s line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
288 289
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
290 291 292 293 294 295
	 This means the host variable is of type <type>unsigned
	 int</type> and the field in the
	 <productname>Postgres</productname> database is of another type
	 and contains a value that cannot be interpreted as an
	 <type>unsigned int</type>. The library uses
	 <function>strtoul()</function> for this conversion.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
296 297 298 299 300
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
301
       <term><computeroutput>-206, Not correctly formatted floating point type: %s line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
302 303
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
304 305 306 307 308
	 This means the host variable is of type <type>float</type> and
	 the field in the <productname>Postgres</productname> database
	 is of another type and contains a value that cannot be
	 interpreted as a <type>float</type>. The library uses
	 <function>strtod()</function> for this conversion.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
309 310 311 312 313
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
314
       <term><computeroutput>-207, Unable to convert %s to bool on line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
315 316
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
317 318
	 This means the host variable is of type <type>bool</type> and
	 the field in the <productname>Postgres</productname> database
319
	 is neither <literal>'t'</> nor <literal>'f'</>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
320 321 322 323 324
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
325
       <term><computeroutput>-208, Empty query line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
326 327
       <listitem>
	<para>
328
	 <productname>Postgres</productname> returned <symbol>PGRES_EMPTY_QUERY</symbol>, probably
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
329 330 331 332 333 334
	 because the query indeed was empty.
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
335
       <term><computeroutput>-220, No such connection %s in line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
336 337
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
338
	 The program tried to access a connection that does not exist.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
339 340 341 342 343
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
344
       <term><computeroutput>-221, Not connected in line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
345 346
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
347 348
	 The program tried to access a connection that does exist but is
	 not open.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
349 350 351 352 353
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
354
       <term><computeroutput>-230, Invalid statement name %s in line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
355 356 357 358 359 360 361 362
       <listitem>
	<para>
	 The statement you are trying to use has not been prepared.
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
363
       <term><computeroutput>-400, Postgres error: %s line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
364 365 366 367 368 369 370 371 372 373
       <listitem>
	<para>
	 Some <productname>Postgres</productname> error. 
	 The message contains the error message from the
	 <productname>Postgres</productname> backend.
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
374
       <term><computeroutput>-401, Error in transaction processing line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
375 376
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
377
	 <productname>Postgres</productname> signaled that we cannot start,
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
378 379 380 381 382 383
	 commit or rollback the transaction.
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
384
       <term><computeroutput>-402, connect: could not open database %s.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
385 386 387 388 389 390 391 392
       <listitem>
	<para>
	 The connect to the database did not work.
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
393
       <term><computeroutput>100, Data not found line %d.</computeroutput></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
394 395
       <listitem>
	<para>
396
	 This is a <quote>normal</quote> error that tells you that what you are querying cannot
Bruce Momjian's avatar
Bruce Momjian committed
397
	 be found or you are at the end of the cursor.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
398 399 400 401 402 403 404 405 406
	</para>
       </listitem>
      </varlistentry>

     </variablelist>
    </para>
   </sect2>
  </sect1>

407
  <sect1 id="ecpg-limitations">
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
408 409 410 411
   <title>Limitations</title>

   <abstract>
    <para>
Bruce Momjian's avatar
Bruce Momjian committed
412
     What will never be included and why it cannot be done.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
413 414 415 416 417 418
    </para>
   </abstract>

   <para>
    <variablelist>
     <varlistentry>
Bruce Momjian's avatar
Bruce Momjian committed
419
      <term>Oracle's single tasking</term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
420 421
      <listitem>
       <para>
422
	Oracle version 7.0 on <systemitem class="osname">AIX</> 3 uses OS-supported locks in shared
Bruce Momjian's avatar
Bruce Momjian committed
423
	memory that allow an application designer to link an application
424
	in a <quote>single tasking</quote> way. Instead of starting one client
Bruce Momjian's avatar
Bruce Momjian committed
425 426 427
	process per application process, both the database part and the
	application part run in the same process. In later versions of
	Oracle this is no longer supported.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
428 429 430 431
       </para>

       <para>
	This would require a total redesign of the
Bruce Momjian's avatar
Bruce Momjian committed
432 433
	<productname>Postgres</productname> access model and the
	performance gain does not justify the effort.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
434 435 436 437 438 439 440
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect1>

441
  <sect1 id="ecpg-porting">
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
442 443 444
   <title>Porting From Other <acronym>RDBMS</acronym> Packages</title>

   <para>
Bruce Momjian's avatar
Bruce Momjian committed
445 446 447 448 449 450
    The design of <application>ecpg</application> follows the SQL
    standard. Porting from a standard RDBMS should not be a problem.
    Unfortunately there is no such thing as a standard RDBMS. Therefore
    <application>ecpg</application> tries to understand syntax
    extensions as long as they do not create conflicts with the
    standard.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
451 452 453
   </para>

   <para>
Bruce Momjian's avatar
Bruce Momjian committed
454 455 456 457 458 459 460
    The following list shows all the known incompatibilities. If you
    find one not listed please notify <ulink
    url="meskes@debian.org">Michael Meskes</ulink>. Note, however, that
    we list only incompatibilities from a precompiler of another RDBMS
    to <application>ecpg</application> and not
    <application>ecpg</application> features that these RDBMS do not
    support.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
461 462 463 464 465
   </para>

   <para>
    <variablelist>
     <varlistentry>
Bruce Momjian's avatar
Bruce Momjian committed
466
      <term>Syntax of FETCH</term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
467 468
      <listitem>
       <para>
Bruce Momjian's avatar
Bruce Momjian committed
469
	The standard syntax for FETCH is:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
470 471
       </para>
       <para>
Bruce Momjian's avatar
Bruce Momjian committed
472
	FETCH [direction] [amount] IN|FROM <replaceable>cursor</replaceable>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
473 474 475
       </para>
       <para>
	<application>ORACLE</application>, however, does not use the keywords IN
Bruce Momjian's avatar
Bruce Momjian committed
476
	or FROM. This feature cannot be added since it would create parsing
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
477 478 479 480 481 482 483 484
	conflicts.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect1>

485
  <sect1 id="ecpg-develop">
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
486 487 488
   <title>For the Developer</title>

   <para>
Bruce Momjian's avatar
Bruce Momjian committed
489 490 491
    This section explain how <application>ecpg</application>
    works internally. It contains valuable information to help users
    understand how to use <application>ecpg</application>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
492 493 494 495 496 497
   </para>

   <sect2>
    <title>ToDo List</title>

    <para>
Bruce Momjian's avatar
Bruce Momjian committed
498
     This version of the preprocessor has some flaws:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
499 500 501 502 503 504

     <variablelist>
      <varlistentry>
       <term>Library functions</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
505 506 507
	 to_date et al. does not exist. However,
	 <productname>Postgres</productname> has some good conversion
	 routines so you probably won't miss them.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
508 509 510 511 512
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
Bruce Momjian's avatar
Bruce Momjian committed
513
       <term>Structures and unions</term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
514 515
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
516 517
	 Structures and unions have to be defined in the
	 <command>declare</> section.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
518 519 520 521 522 523 524 525 526 527 528
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Missing statements</term>
       <listitem>
	<para>
	 The following statements are not implemented thus far:
	 <variablelist>
	  <varlistentry>
529
	   <term><literal>exec sql allocate</></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
530 531 532 533 534 535
	   <listitem>
	    <para>
	    </para>
	   </listitem>
	  </varlistentry>
	  <varlistentry>
536
	   <term><literal>exec sql deallocate</></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
537 538 539 540 541 542
	   <listitem>
	    <para>
	    </para>
	   </listitem>
	  </varlistentry>
	  <varlistentry>
543
	   <term><literal>SQLSTATE</></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
544 545 546 547 548 549 550 551 552 553 554 555 556 557
	   <listitem>
	    <para>
	    </para>
	   </listitem>
	  </varlistentry>
	 </variablelist>
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>message 'no data found'</term>
       <listitem>
	<para>
558
	 The error message for <quote>no data</quote> in:
Bruce Momjian's avatar
Bruce Momjian committed
559 560 561 562
	 <programlisting>
exec sql insert select from statement
	</programlisting>
	 has to be <literal>100</>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
563 564 565 566 567
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
568
       <term><literal>sqlwarn[6]</literal></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
569 570
       <listitem>
	<para>
571
	 <literal>sqlwarn[6]</literal> should be <literal>W</> if the <command>PRECISION</>
Bruce Momjian's avatar
Bruce Momjian committed
572 573
	 or <command>SCALE</> value specified in a <command>SET
	 DESCRIPTOR</> statement was ignored.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
574 575 576 577 578 579 580 581 582 583 584
	</para>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
   </sect2>

   <sect2>
    <title>The Preprocessor</title>

    <para>
585
     The first four lines written by <command>ecpg</command> to the output are fixed lines.
Bruce Momjian's avatar
Bruce Momjian committed
586 587
     Two are comments and two are include lines necessary to interface
     to the library.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
588 589 590
    </para>

    <para>
Bruce Momjian's avatar
Bruce Momjian committed
591 592
     Then the preprocessor reads through the file and writes output.
     Normally it just echoes everything to the output.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
593 594 595
    </para>

    <para>
Bruce Momjian's avatar
Bruce Momjian committed
596 597 598
     When it sees an <command>EXEC SQL</command> statement, it
     intervenes and changes it. The <command>EXEC SQL</command>
     statement can be one of these:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
599 600 601 602 603 604

     <variablelist>
      <varlistentry>
       <term>Declare sections</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
605
	 <command>Declare</> sections begin with:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
606
	 <programlisting>
607
exec sql begin declare section;
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
608
	 </programlisting>
Bruce Momjian's avatar
Bruce Momjian committed
609
	 and end with:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
610
	 <programlisting>
611
exec sql end declare section;
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
612
	 </programlisting>
Bruce Momjian's avatar
Bruce Momjian committed
613 614 615 616
	 In this section only variable declarations are allowed. Every
	 variable declared within this section is stored in a list
	 of variables indexed by name together with its corresponding
	 type.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
617 618 619
	</para>

	<para>
Bruce Momjian's avatar
Bruce Momjian committed
620 621 622 623
	 In particular the definition of a structure or union also must
	 be listed inside a <command>declare</> section. Otherwise
	 <application>ecpg</application> cannot handle these types since
	 it does not know the definition.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
624 625 626
	</para>

	<para>
Bruce Momjian's avatar
Bruce Momjian committed
627 628
	 The declaration is also echoed to the file to make it a normal
	 C variable.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
629 630 631
	</para>

	<para>
632
	 The special types <type>VARCHAR</type> and <type>VARCHAR2</type> are converted into a named struct
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
633 634
	 for every variable. A declaration like:
	 <programlisting>
635
VARCHAR var[180];
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
636
	 </programlisting>
Bruce Momjian's avatar
Bruce Momjian committed
637
	 is converted into:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
638
	 <programlisting>
639
struct varchar_var { int len; char arr[180]; } var;
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
640 641 642 643 644 645 646 647 648 649 650
	 </programlisting>
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Include statements</term>
       <listitem>
	<para>
	 An include statement looks like:
	 <programlisting>
651
exec sql include filename;
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
652
	 </programlisting>
Bruce Momjian's avatar
Bruce Momjian committed
653
	 Note that this is NOT the same as:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
654
	 <programlisting>
655
#include &lt;filename.h&gt;
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
656 657 658 659
	 </programlisting>
	</para>

	<para>
Bruce Momjian's avatar
Bruce Momjian committed
660 661 662 663
	 Instead the file specified is parsed by
	 <application>ecpg</application> so the contents of the file are
	 included in the resulting C code. This way you are able to
	 specify EXEC SQL commands in an include file.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Connect statement</term>
       <listitem>
	<para>
	 A connect statement looks like:
	 <programlisting>
exec sql connect to <replaceable>connection target</replaceable>;
	 </programlisting>
	 It creates a connection to the specified database.
	</para>

	<para>
	 The <replaceable>connection target</replaceable> can be specified in the
	 following ways:
	 <variablelist>
	  <varlistentry>
	   <term>dbname[@server][:port][as <replaceable>connection
	     name</replaceable>][user <replaceable>user name</replaceable>]</term>
	   <listitem><para></para></listitem>
	  </varlistentry>

	  <varlistentry>
	   <term>tcp:postgresql://server[:port][/dbname][as
	    <replaceable>connection name</replaceable>][user <replaceable>user name</replaceable>]</term>
	   <listitem><para></para></listitem>
	  </varlistentry>

	  <varlistentry>
	   <term>unix:postgresql://server[:port][/dbname][as
	    <replaceable>connection name</replaceable>][user <replaceable>user name</replaceable>]</term>
	   <listitem><para></para></listitem>
	  </varlistentry>

	  <varlistentry>
	   <term><replaceable>character variable</replaceable>[as
	    <replaceable>connection name</replaceable>][user <replaceable>user name</replaceable>]</term>
	   <listitem><para></para></listitem>
	  </varlistentry>

	  <varlistentry>
	   <term><replaceable>character string</replaceable>[as
	    <replaceable>connection name</replaceable>][<replaceable>user</replaceable>]</term>
	   <listitem><para></para></listitem>
	  </varlistentry>

	  <varlistentry>
	   <term>default</term>
	   <listitem><para></para></listitem>
	  </varlistentry>

	  <varlistentry>
	   <term>user</term>
	   <listitem><para></para></listitem>
	  </varlistentry>
	 </variablelist>
	</para>

	<para>
	 There are also different ways to specify the user name:
	 <variablelist>
	  <varlistentry>
	   <term><replaceable>userid</replaceable></term>
	   <listitem><para></para></listitem>
	  </varlistentry>
	  <varlistentry>
	   <term><replaceable>userid</replaceable>/<replaceable>password</replaceable></term>
	   <listitem><para></para></listitem>
	  </varlistentry>
	  <varlistentry>
	   <term><replaceable>userid</replaceable> identified by <replaceable>password</replaceable></term>
	   <listitem><para></para></listitem>
	  </varlistentry>
	  <varlistentry>
	   <term><replaceable>userid</replaceable> using <replaceable>password</replaceable></term>
	   <listitem><para></para></listitem>
	  </varlistentry>
	 </variablelist>
	</para>

Bruce Momjian's avatar
Bruce Momjian committed
747
	<para> 
748
	 Finally, the <replaceable>userid</replaceable> and <replaceable>password</replaceable> may be a constant text, a
Bruce Momjian's avatar
Bruce Momjian committed
749
	 character variable, or a character string.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
750 751 752 753 754 755 756 757
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Disconnect statements</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
758
	 A disconnect statement looks like:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
	 <programlisting>
exec sql disconnect [<replaceable>connection target</replaceable>];
	 </programlisting>
	 It closes the connection to the specified database.
	</para>

	<para>
	 The <replaceable>connection target</replaceable> can be specified in the
	 following ways:
	 <variablelist>
	  <varlistentry>
	   <term><replaceable>connection name</replaceable></term>
	   <listitem><para></para></listitem>
	  </varlistentry>
	  <varlistentry>
	   <term>default</term>
	   <listitem><para></para></listitem>
	  </varlistentry>
	  <varlistentry>
	   <term>current</term>
	   <listitem><para></para></listitem>
	  </varlistentry>
	  <varlistentry>
	   <term>all</term>
	   <listitem><para></para></listitem>
	  </varlistentry>
	 </variablelist>
	</para>
       </listitem>
      </varlistentry>

790 791 792 793 794 795 796 797
      <varlistentry>
       <term>Open cursor statement</term>
       <listitem>
	<para>
	 An open cursor statement looks like:
	 <programlisting>
exec sql open <replaceable>cursor</replaceable>;
	 </programlisting>
Bruce Momjian's avatar
Bruce Momjian committed
798 799 800
	 and is not copied to the output. Instead, the cursor's
	 <command>DECLARE</> command is used because it opens the cursor
	 as well.
801 802 803 804 805 806 807 808
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Commit statement</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
809
	 A commit statement looks like:
810 811 812 813 814 815 816 817 818 819 820
	 <programlisting>
exec sql commit;
	 </programlisting>
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Rollback statement</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
821
	 A rollback statement looks like:
822 823 824 825 826 827 828
	 <programlisting>
exec sql rollback;
	 </programlisting>
	</para>
       </listitem>
      </varlistentry>

Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
829 830 831 832
      <varlistentry>
       <term>Other statements</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
833 834 835 836 837
	 Other <acronym>SQL</acronym> statements are used by
	 starting with <command>exec sql</command> and ending with
	 <command>;</command>. Everything in between is treated as an
	 <acronym>SQL</acronym> statement and parsed for variable
	 substitution.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
838 839 840
	</para>

	<para>
Bruce Momjian's avatar
Bruce Momjian committed
841 842 843 844 845 846
	 Variable substitution occurs when a symbol starts with a colon
	 (<command>:</command>). The variable with that name is looked
	 up among the variables that were previously declared within a
	 <command>declare</> section. Depending on whether the variable is
	 being use for input or output, a pointer to the variable is
	 output to allow access by the function.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
847 848 849
	</para>

	<para>
Bruce Momjian's avatar
Bruce Momjian committed
850 851
	 For every variable that is part of the <acronym>SQL</acronym>
	 query, the function gets other arguments:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
852 853 854 855

	 <simplelist>
	  <member>The type as a special symbol.</member>
	  <member>A pointer to the value or a pointer to the pointer.</member>
856
	  <member>The size of the variable if it is a <type>char</type> or <type>varchar</type>.</member>
Bruce Momjian's avatar
Bruce Momjian committed
857 858
	  <member>The number of elements in the array (for array fetches).</member>
	  <member>The offset to the next element in the array (for array fetches).</member>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
859 860 861 862
	  <member>The type of the indicator variable as a special symbol.</member>
	  <member>A pointer to the value of the indicator variable or a pointer to the pointer of the indicator variable.</member>
	  <member>0.</member>
	  <member>Number of elements in the indicator array (for array fetches).</member>
Bruce Momjian's avatar
Bruce Momjian committed
863 864
	  <member>The offset to the next element in the indicator array
	  (for array fetches).</member>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
865 866 867 868 869 870 871 872 873 874 875 876 877 878
	 </simplelist>
	</para>

       </listitem>
      </varlistentry>
     </variablelist>
    </para>
   </sect2>

   <sect2>
    <title>A Complete Example</title>

    <para>
     Here is a complete example describing the output of the preprocessor of a
879
     file <filename>foo.pgc</filename>:
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
880
     <programlisting>
881 882 883 884 885
exec sql begin declare section;
int index;
int result;
exec sql end declare section;
...
Michael Meskes's avatar
Michael Meskes committed
886
exec sql select res into :result from mytable where index = :index;
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
887 888 889
     </programlisting>
     is translated into:
     <programlisting>
Michael Meskes's avatar
Michael Meskes committed
890
/* Processed by ecpg (2.6.0) */
891
/* These two include files are added by the preprocessor */
Michael Meskes's avatar
Michael Meskes committed
892 893 894
#include &lt;ecpgtype.h&gt;;
#include &lt;ecpglib.h&gt;;

895 896
/* exec sql begin declare section */

Michael Meskes's avatar
Michael Meskes committed
897 898
#line 1 "foo.pgc"

899 900 901 902
 int index;
 int result;
/* exec sql end declare section */
...
Michael Meskes's avatar
Michael Meskes committed
903 904 905 906 907 908
ECPGdo(__LINE__, NULL, "select  res  from mytable where index = ?     ",
	ECPGt_int,&amp;(index),1L,1L,sizeof(int),
        ECPGt_NO_INDICATOR, NULL , 0L, 0L, 0L, ECPGt_EOIT,
        ECPGt_int,&amp;(result),1L,1L,sizeof(int),
        ECPGt_NO_INDICATOR, NULL , 0L, 0L, 0L, ECPGt_EORT);
#line 147 "foo.pgc"
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
909
     </programlisting>
Bruce Momjian's avatar
Bruce Momjian committed
910 911
     (The indentation in this manual is added for readability and not
     something the preprocessor does.)
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
912 913 914 915 916 917 918
    </para>
   </sect2>

   <sect2>
    <title>The Library</title>

    <para>
Bruce Momjian's avatar
Bruce Momjian committed
919 920 921
     The most important function in the library is
     <function>ECPGdo</function>. It takes a variable number of
     arguments. Hopefully there are no computers that limit the
922
     number of variables that can be accepted by a <function>varargs()</function> function. This
Bruce Momjian's avatar
Bruce Momjian committed
923
     can easily add up to 50 or so arguments.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
924 925 926 927 928 929 930 931 932 933
    </para>

    <para>
     The arguments are:

     <variablelist>
      <varlistentry>
       <term>A line number</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
934
	 This is a line number of the original line; used in error messages only.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
935 936 937 938 939 940 941 942
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>A string</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
943 944 945 946 947
	 This is the <acronym>SQL</acronym> query that is to be issued.
	 It is modified by the input variables, i.e. the variables that
	 where not known at compile time but are to be entered in the
	 query. Where the variables should go the string contains
	 <literal>?</literal>.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
948 949 950 951 952 953 954 955
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Input variables</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
956
	 As described in the section about the preprocessor, every input variable
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
957 958 959 960 961 962
	 gets ten arguments.
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
963
       <term><literal>ECPGt_EOIT</literal></term>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
964 965 966 967 968 969 970 971 972 973 974
       <listitem>
	<para>
	 An enum telling that there are no more input variables.
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Output variables</term>
       <listitem>
	<para>
Bruce Momjian's avatar
Bruce Momjian committed
975
	 As described in the section about the preprocessor, every input variable
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
	 gets ten arguments. These variables are filled by the function.
	</para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>ECPGt_EORT</term>
       <listitem>
	<para>
	 An enum telling that there are no more variables.
	</para>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>

    <para>
Bruce Momjian's avatar
Bruce Momjian committed
993 994 995 996 997 998
     All <acronym>SQL</acronym> statements are performed in one
     transaction unless you issue a commit transaction. To accomplish
     this auto-transaction behavior, the first statement and the first
     statement after a commit or rollback always begins a new transaction. To
     disable this feature, use the <option>-t</option> command-line
     option.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
    </para>

   </sect2>
  </sect1>
 </chapter>

<!-- 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
1017
sgml-local-catalogs:("/usr/lib/sgml/catalog")
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
1018 1019 1020
sgml-local-ecat-files:nil
End:
-->