ecpg.sgml 155 KB
Newer Older
1
<!-- $PostgreSQL: pgsql/doc/src/sgml/ecpg.sgml,v 1.79 2007/02/01 00:28:16 momjian Exp $ -->
2

3 4 5 6
<chapter id="ecpg">
 <title><application>ECPG</application> - Embedded <acronym>SQL</acronym> in C</title>

 <indexterm zone="ecpg"><primary>embedded SQL</primary><secondary>in C</secondary></indexterm>
Peter Eisentraut's avatar
Peter Eisentraut committed
7 8
 <indexterm zone="ecpg"><primary>C</primary></indexterm>
 <indexterm zone="ecpg"><primary>ECPG</primary></indexterm>
9 10 11

 <para>
  This chapter describes the embedded <acronym>SQL</acronym> package
12
  for <productname>PostgreSQL</productname>. It was written by
13
  Linus Tolke (<email>linus@epact.se</email>) and Michael Meskes
14 15 16
  (<email>meskes@postgresql.org</email>). Originally it was written to work with
  <acronym>C</acronym>. It also works with <acronym>C++</acronym>, but
  it does not recognize all <acronym>C++</acronym> constructs yet. 
17 18 19
 </para>

 <para>
20
  This documentation is quite incomplete.  But since this
21 22 23 24 25 26
  interface is standardized, additional information can be found in
  many resources about SQL.
 </para>

 <sect1 id="ecpg-concept">
  <title>The Concept</title>
27

Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
28
  <para>
29 30 31
   An embedded SQL program consists of code written in an ordinary
   programming language, in this case C, mixed with SQL commands in
   specially marked sections.  To build the program, the source code
32
   is first passed through the embedded SQL preprocessor, which converts it
33
   to an ordinary C program, and afterwards it can be processed by a C
34
   compiler.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
35
  </para>
36

37 38 39 40
  <para>
   Embedded <acronym>SQL</acronym> has advantages over other methods
   for handling <acronym>SQL</acronym> commands from C code. First, it
   takes care of the tedious passing of information to and from
41 42 43 44 45 46 47 48 49 50
   variables in your <acronym>C</acronym> program.  Second, the SQL
   code in the program is checked at build time for syntactical
   correctness.  Third, embedded <acronym>SQL</acronym> in C is
   specified in the <acronym>SQL</acronym> standard and supported by
   many other <acronym>SQL</acronym> database systems.  The
   <productname>PostgreSQL</> implementation is designed to match this
   standard as much as possible, and it is usually possible to port
   embedded <acronym>SQL</acronym> programs written for other SQL
   databases to <productname>PostgreSQL</productname> with relative
   ease.
51
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
52

53
  <para>
54
   As already stated, programs written for the embedded
Bruce Momjian's avatar
Bruce Momjian committed
55 56
   <acronym>SQL</acronym> interface are normal C programs with special
   code inserted to perform database-related actions.  This special
57
   code always has the form:
58 59 60 61
<programlisting>
EXEC SQL ...;
</programlisting>
   These statements syntactically take the place of a C statement.
62
   Depending on the particular statement, they can appear at the
63
   global level or within a function.  Embedded
Bruce Momjian's avatar
Bruce Momjian committed
64 65
   <acronym>SQL</acronym> statements follow the case-sensitivity rules
   of normal <acronym>SQL</acronym> code, and not those of C.
66
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
67

68 69 70 71
  <para>
   The following sections explain all the embedded SQL statements.
  </para>
 </sect1>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
72

73 74
 <sect1 id="ecpg-connect">
  <title>Connecting to the Database Server</title>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
75

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
  <para>
   One connects to a database using the following statement:
<programlisting>
EXEC SQL CONNECT TO <replaceable>target</replaceable> <optional>AS <replaceable>connection-name</replaceable></optional> <optional>USER <replaceable>user-name</replaceable></optional>;
</programlisting>
   The <replaceable>target</replaceable> can be specified in the
   following ways:

   <itemizedlist>
    <listitem>
     <simpara>
      <literal><replaceable>dbname</><optional>@<replaceable>hostname</></optional><optional>:<replaceable>port</></optional></literal>
     </simpara>
    </listitem>

    <listitem>
     <simpara>
      <literal>tcp:postgresql://<replaceable>hostname</><optional>:<replaceable>port</></optional><optional>/<replaceable>dbname</></optional><optional>?<replaceable>options</></optional></literal>
     </simpara>
    </listitem>

    <listitem>
     <simpara>
      <literal>unix:postgresql://<replaceable>hostname</><optional>:<replaceable>port</></optional><optional>/<replaceable>dbname</></optional><optional>?<replaceable>options</></optional></literal>
     </simpara>
    </listitem>
 
    <listitem>
     <simpara>
105
      an SQL string literal containing one of the above forms
106 107 108 109 110
     </simpara>
    </listitem>

    <listitem>
     <simpara>
111
      a reference to a character variable containing one of the above forms (see examples)
112 113 114 115 116 117 118 119 120
     </simpara>
    </listitem>
 
    <listitem>
     <simpara>
      <literal>DEFAULT</literal>
     </simpara>
    </listitem>
   </itemizedlist>
121 122 123 124 125 126 127 128 129

   If you specify the connection target literally (that is, not
   through a variable reference) and you don't quote the value, then
   the case-insensitivity rules of normal SQL are applied.  In that
   case you can also double-quote the individual parameters separately
   as needed.  In practice, it is probably less error-prone to use a
   (single-quoted) string literal or a variable reference.  The
   connection target <literal>DEFAULT</literal> initiates a connection
   to the default database under the default user name.  No separate
130
   user name or connection name can be specified in that case.
131
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
132

133 134 135 136 137 138
  <para>
   There are also different ways to specify the user name:

   <itemizedlist>
    <listitem>
     <simpara>
139
      <literal><replaceable>username</replaceable></literal>
140 141 142 143 144
     </simpara>
    </listitem>

    <listitem>
     <simpara>
145
      <literal><replaceable>username</replaceable>/<replaceable>password</replaceable></literal>
146 147 148 149 150
     </simpara>
    </listitem>

    <listitem>
     <simpara>
151
      <literal><replaceable>username</replaceable> IDENTIFIED BY <replaceable>password</replaceable></literal>
152 153 154 155 156
     </simpara>
    </listitem>

    <listitem>
     <simpara>
157
      <literal><replaceable>username</replaceable> USING <replaceable>password</replaceable></literal>
158 159 160
     </simpara>
    </listitem>
   </itemizedlist>
161 162

   As above, the parameters <replaceable>username</replaceable> and
163
   <replaceable>password</replaceable> can be an SQL identifier, an
164
   SQL string literal, or a reference to a character variable.
165
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
166

167 168 169
  <para>
   The <replaceable>connection-name</replaceable> is used to handle
   multiple connections in one program.  It can be omitted if a
170 171 172 173 174 175 176 177 178 179 180
   program uses only one connection.  The most recently opened
   connection becomes the current connection, which is used by default
   when an SQL statement is to be executed (see later in this
   chapter).
  </para>

  <para>
   Here are some examples of <command>CONNECT</command> statements:
<programlisting>
EXEC SQL CONNECT TO mydb@sql.mydomain.com;

181
EXEC SQL CONNECT TO unix:postgresql://sql.mydomain.com/mydb AS myconnection USER john;
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201

EXEC SQL BEGIN DECLARE SECTION;
const char *target = "mydb@sql.mydomain.com";
const char *user = "john";
EXEC SQL END DECLARE SECTION;
 ...
EXEC SQL CONNECT TO :target USER :user;
</programlisting>
   The last form makes use of the variant referred to above as
   character variable reference.  You will see in later sections how C
   variables can be used in SQL statements when you prefix them with a
   colon.
  </para>

  <para>
   Be advised that the format of the connection target is not
   specified in the SQL standard.  So if you want to develop portable
   applications, you might want to use something based on the last
   example above to encapsulate the connection target string
   somewhere.
202 203
  </para>
 </sect1>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
204

205 206
 <sect1 id="ecpg-disconnect">
  <title>Closing a Connection</title>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
207

208 209 210
  <para>
   To close a connection, use the following statement:
<programlisting>
211
EXEC SQL DISCONNECT <optional><replaceable>connection</replaceable></optional>;
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
</programlisting>
   The <replaceable>connection</replaceable> can be specified
   in the following ways:

   <itemizedlist>
    <listitem>
     <simpara>
      <literal><replaceable>connection-name</replaceable></literal>
     </simpara>
    </listitem>

    <listitem>
     <simpara>
      <literal>DEFAULT</literal>
     </simpara>
    </listitem>

    <listitem>
     <simpara>
      <literal>CURRENT</literal>
     </simpara>
    </listitem>

    <listitem>
     <simpara>
      <literal>ALL</literal>
     </simpara>
    </listitem>
   </itemizedlist>
241 242 243 244 245 246 247 248

   If no connection name is specified, the current connection is
   closed.
  </para>

  <para>
   It is good style that an application always explicitly disconnect
   from every connection it opened.
249 250
  </para>
 </sect1>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
251

252 253
 <sect1 id="ecpg-commands">
  <title>Running SQL Commands</title>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
254

255 256 257 258
  <para>
   Any SQL command can be run from within an embedded SQL application.
   Below are some examples of how to do that.
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
259

260 261 262 263 264 265 266 267
  <para>
   Creating a table:
<programlisting>
EXEC SQL CREATE TABLE foo (number integer, ascii char(16));
EXEC SQL CREATE UNIQUE INDEX num1 ON foo(number);
EXEC SQL COMMIT;
</programlisting>
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
268

269 270 271 272 273 274 275
  <para>
   Inserting rows:
<programlisting>
EXEC SQL INSERT INTO foo (number, ascii) VALUES (9999, 'doodad');
EXEC SQL COMMIT;
</programlisting>
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
276

277 278 279 280 281 282 283
  <para>
   Deleting rows:
<programlisting>
EXEC SQL DELETE FROM foo WHERE number = 9999;
EXEC SQL COMMIT;
</programlisting>
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
284

285
  <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
286
   Single-row select:
287 288 289 290
<programlisting>
EXEC SQL SELECT foo INTO :FooBar FROM table1 WHERE ascii = 'doodad';
</programlisting>
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
291

292
  <para>
293
   Select using cursors:
294 295 296 297
<programlisting>
EXEC SQL DECLARE foo_bar CURSOR FOR
    SELECT number, ascii FROM foo
    ORDER BY ascii;
298
EXEC SQL OPEN foo_bar;
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
EXEC SQL FETCH foo_bar INTO :FooBar, DooDad;
...
EXEC SQL CLOSE foo_bar;
EXEC SQL COMMIT;
</programlisting>
  </para>

  <para>
   Updates:
<programlisting>
EXEC SQL UPDATE foo
    SET ascii = 'foobar'
    WHERE number = 9999;
EXEC SQL COMMIT;
</programlisting>
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
315

316 317 318 319
  <para>
   The tokens of the form
   <literal>:<replaceable>something</replaceable></literal> are
   <firstterm>host variables</firstterm>, that is, they refer to
320 321
   variables in the C program.  They are explained in <xref
   linkend="ecpg-variables">.
322
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
323

324 325 326
  <para>
   In the default mode, statements are committed only when
   <command>EXEC SQL COMMIT</command> is issued. The embedded SQL
327 328 329
   interface also supports autocommit of transactions (similar to
   <application>libpq</> behavior) via the <option>-t</option> command-line
   option to <command>ecpg</command> (see below) or via the <literal>EXEC SQL
330
   SET AUTOCOMMIT TO ON</literal> statement. In autocommit mode, each
331
   command is automatically committed unless it is inside an explicit
332 333 334 335 336
   transaction block. This mode can be explicitly turned off using
   <literal>EXEC SQL SET AUTOCOMMIT TO OFF</literal>.
  </para>
 </sect1>

337 338
 <sect1 id="ecpg-set-connection">
  <title>Choosing a Connection</title>
339 340

  <para>
341 342 343 344
   The SQL statements shown in the previous section are executed on
   the current connection, that is, the most recently opened one.  If
   an application needs to manage multiple connections, then there are
   two ways to handle this.
345 346 347
  </para>

  <para>
348
   The first option is to explicitly choose a connection for each SQL
349
   statement, for example:
350 351 352 353 354
<programlisting>
EXEC SQL AT <replaceable>connection-name</replaceable> SELECT ...;
</programlisting>
   This option is particularly suitable if the application needs to
   use several connections in mixed order.
355 356 357 358 359 360 361
      </para>

      <para>
      If your application uses multiple threads of execution, they cannot share a
      connection concurrently. You must either explicitly control access to the connection
      (using mutexes) or use a connection for each thread. If each thread uses its own connection,
      you will need to use the AT clause to specify which connection the thread will use.
362 363 364 365 366 367
  </para>

  <para>
   The second option is to execute a statement to switch the current
   connection.  That statement is:
<programlisting>
Peter Eisentraut's avatar
Peter Eisentraut committed
368
EXEC SQL SET CONNECTION <replaceable>connection-name</replaceable>;
369 370
</programlisting>
   This option is particularly convenient if many statements are to be
371
   executed on the same connection.  It is not thread-aware.
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
  </para>
 </sect1>

 <sect1 id="ecpg-variables">
  <title>Using Host Variables</title>

  <para>
   In <xref linkend="ecpg-commands"> you saw how you can execute SQL
   statements from an embedded SQL program.  Some of those statements
   only used fixed values and did not provide a way to insert
   user-supplied values into statements or have the program process
   the values returned by the query.  Those kinds of statements are
   not really useful in real applications.  This section explains in
   detail how you can pass data between your C program and the
   embedded SQL statements using a simple mechanism called
387 388 389 390 391
   <firstterm>host variables</firstterm>. In an embedded SQL program  we
   consider the SQL statements to be <firstterm>guests</firstterm> in the C
   program code which is the <firstterm>host language</firstterm>. Therefore
   the variables of the C program are called <firstterm>host
   variables</firstterm>.
392 393 394 395 396 397 398 399 400 401 402 403 404
  </para>

  <sect2>
   <title>Overview</title>

   <para>
    Passing data between the C program and the SQL statements is
    particularly simple in embedded SQL.  Instead of having the
    program paste the data into the statement, which entails various
    complications, such as properly quoting the value, you can simply
    write the name of a C variable into the SQL statement, prefixed by
    a colon.  For example:
<programlisting>
Peter Eisentraut's avatar
Peter Eisentraut committed
405
EXEC SQL INSERT INTO sometable VALUES (:v1, 'foo', :v2);
406 407 408 409 410 411 412 413 414
</programlisting>
    This statements refers to two C variables named
    <varname>v1</varname> and <varname>v2</varname> and also uses a
    regular SQL string literal, to illustrate that you are not
    restricted to use one kind of data or the other.
   </para>

   <para>
    This style of inserting C variables in SQL statements works
415
    anywhere a value expression is expected in an SQL statement.
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
   </para>
  </sect2>

  <sect2>
   <title>Declare Sections</title>

   <para>
    To pass data from the program to the database, for example as
    parameters in a query, or to pass data from the database back to
    the program, the C variables that are intended to contain this
    data need to be declared in specially marked sections, so the
    embedded SQL preprocessor is made aware of them.
   </para>

   <para>
431
    This section starts with:
432
<programlisting>
433
EXEC SQL BEGIN DECLARE SECTION;
434
</programlisting>
435
    and ends with:
436
<programlisting>
437
EXEC SQL END DECLARE SECTION;
438
</programlisting>
439
    Between those lines, there must be normal C variable declarations,
440
    such as:
441
<programlisting>
442
int   x = 4;
443
char  foo[16], bar[16];
444 445 446 447 448 449 450 451
</programlisting>
    As you can see, you can optionally assign an initial value to the variable.
    The variable's scope is determined by the location of its declaring
    section within the program.
    You can also declare variables with the following syntax which implicitly
    creates a declare section:
<programlisting>
EXEC SQL int i = 4;
452
</programlisting>
453 454 455 456
    You can have as many declare sections in a program as you like.
   </para>

   <para>
457
    The declarations are also echoed to the output file as normal C
458
    variables, so there's no need to declare them again.  Variables
459
    that are not intended to be used in SQL commands can be declared
460 461 462 463 464 465 466 467
    normally outside these special sections.
   </para>

   <para>
    The definition of a structure or union also must be listed inside
    a <literal>DECLARE</> section. Otherwise the preprocessor cannot
    handle these types since it does not know the definition.
   </para>
468 469 470 471 472 473 474
  </sect2>

  <sect2>
   <title>Different types of host variables</title>
   <para>
    As a host variable you can also use arrays, typedefs, structs and
    pointers. Moreover there are special types of host variables that exist
Peter Eisentraut's avatar
Peter Eisentraut committed
475
    only in ECPG.
476
   </para>
477 478

   <para>
479 480 481 482 483 484 485
    A few examples on host variables:
    <variablelist>
     <varlistentry>
      <term>Arrays</term>
      <listitem>
      <para>
       One of the most common uses of an array declaration is probably the
486
       allocation of a char array as in:
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
    char str[50];
EXEC SQL END DECLARE SECTION;
</programlisting>
       Note that you have to take care of the length for yourself. If you use
       this host variable as the target variable of a query which returns a
       string with more than 49 characters, a buffer overflow occurs.
      </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>Typedefs</term>
      <listitem>
      <para>
      Use the <literal>typedef</literal> keyword to map new types to already
      existing types.
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
    typedef char mychartype[40];
    typedef long serial_t;
EXEC SQL END DECLARE SECTION;
</programlisting>
511
       Note that you could also use:
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
<programlisting>
EXEC SQL TYPE serial_t IS long;
</programlisting>
       This declaration does not need to be part of a declare section.
      </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>Pointers</term>
      <listitem>
      <para>
       You can declare pointers to the most common types. Note however that
       you can not use pointers as target variables of queries without
       auto-allocation. See <xref linkend="ecpg-descriptors"> for more
       information on auto-allocation.
      </para>
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
    int   *intp;
    char **charp;
EXEC SQL END DECLARE SECTION;
</programlisting>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>Special types of variables</term>
      <listitem>
       <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
542
        ECPG contains some special types that help you to interact easily with
543
        data from the SQL server. For example it has implemented support for
Peter Eisentraut's avatar
Peter Eisentraut committed
544
        the <type>varchar</>, <type>numeric</>, <type>date</>, <type>timestamp</>, and <type>interval</> types.
545 546 547 548 549 550 551
        <xref linkend="ecpg-pgtypes"> contains basic functions to deal with
        those types, such that you do not need to send a query to the SQL
        server just for adding an interval to a timestamp for example.
       </para>
       <para>
        The special type <type>VARCHAR</type> 
        is converted into a named <type>struct</> for every variable. A
552
        declaration like:
553 554 555
<programlisting>
VARCHAR var[180];
</programlisting>
556
         is converted into:
557 558 559
<programlisting>
struct varchar_var { int len; char arr[180]; } var;
</programlisting>
560 561 562 563 564 565
        This structure is suitable for interfacing with SQL datums of type
        <type>varchar</type>.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
   </para>
  </sect2>

  <sect2>
   <title><command>SELECT INTO</command> and <command>FETCH INTO</command></title>

   <para>
    Now you should be able to pass data generated by your program into
    an SQL command.  But how do you retrieve the results of a query?
    For that purpose, embedded SQL provides special variants of the
    usual commands <command>SELECT</command> and
    <command>FETCH</command>.  These commands have a special
    <literal>INTO</literal> clause that specifies which host variables
    the retrieved values are to be stored in.
   </para>

   <para>
    Here is an example:
<programlisting>
/*
 * assume this table:
 * CREATE TABLE test1 (a int, b varchar(50));
 */

EXEC SQL BEGIN DECLARE SECTION;
int v1;
VARCHAR v2;
EXEC SQL END DECLARE SECTION;

 ...

EXEC SQL SELECT a, b INTO :v1, :v2 FROM test;
</programlisting>
    So the <literal>INTO</literal> clause appears between the select
    list and the <literal>FROM</literal> clause.  The number of
    elements in the select list and the list after
    <literal>INTO</literal> (also called the target list) must be
    equal.
   </para>

   <para>
    Here is an example using the command <command>FETCH</command>:
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
int v1;
VARCHAR v2;
EXEC SQL END DECLARE SECTION;

 ...

EXEC SQL DECLARE foo CURSOR FOR SELECT a, b FROM test;

 ...

do {
    ...
    EXEC SQL FETCH NEXT FROM foo INTO :v1, :v2;
    ...
} while (...);
</programlisting>
    Here the <literal>INTO</literal> clause appears after all the
    normal clauses.
   </para>

   <para>
    Both of these methods only allow retrieving one row at a time.  If
    you need to process result sets that potentially contain more than
    one row, you need to use a cursor, as shown in the second example.
   </para>
  </sect2>

  <sect2>
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 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
   <title>Indicators</title>

   <para>
    The examples above do not handle null values.  In fact, the
    retrieval examples will raise an error if they fetch a null value
    from the database.  To be able to pass null values to the database
    or retrieve null values from the database, you need to append a
    second host variable specification to each host variable that
    contains data.  This second host variable is called the
    <firstterm>indicator</firstterm> and contains a flag that tells
    whether the datum is null, in which case the value of the real
    host variable is ignored.  Here is an example that handles the
    retrieval of null values correctly:
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
VARCHAR val;
int val_ind;
EXEC SQL END DECLARE SECTION:

 ...

EXEC SQL SELECT b INTO :val :val_ind FROM test1;
</programlisting>
    The indicator variable <varname>val_ind</varname> will be zero if
    the value was not null, and it will be negative if the value was
    null.
   </para>

   <para>
    The indicator has another function: if the indicator value is
    positive, it means that the value is not null, but it was
    truncated when it was stored in the host variable.
   </para>
  </sect2>
 </sect1>

 <sect1 id="ecpg-dynamic">
  <title>Dynamic SQL</title>

  <para>
   In many cases, the particular SQL statements that an application
   has to execute are known at the time the application is written.
   In some cases, however, the SQL statements are composed at run time
   or provided by an external source.  In these cases you cannot embed
   the SQL statements directly into the C source code, but there is a
   facility that allows you to call arbitrary SQL statements that you
   provide in a string variable.
  </para>

  <para>
   The simplest way to execute an arbitrary SQL statement is to use
   the command <command>EXECUTE IMMEDIATE</command>.  For example:
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
const char *stmt = "CREATE TABLE test1 (...);";
EXEC SQL END DECLARE SECTION;

EXEC SQL EXECUTE IMMEDIATE :stmt;
</programlisting>
697
   You cannot execute statements that retrieve data (e.g.,
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
   <command>SELECT</command>) this way.
  </para>

  <para>
   A more powerful way to execute arbitrary SQL statements is to
   prepare them once and execute the prepared statement as often as
   you like.  It is also possible to prepare a generalized version of
   a statement and then execute specific versions of it by
   substituting parameters.  When preparing the statement, write
   question marks where you want to substitute parameters later.  For
   example:
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
const char *stmt = "INSERT INTO test1 VALUES(?, ?);";
EXEC SQL END DECLARE SECTION;

EXEC SQL PREPARE mystmt FROM :stmt;
 ...
EXEC SQL EXECUTE mystmt USING 42, 'foobar';
</programlisting>
   If the statement you are executing returns values, then add an
   <literal>INTO</literal> clause:
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
const char *stmt = "SELECT a, b, c FROM test1 WHERE a &gt; ?";
int v1, v2;
VARCHAR v3;
EXEC SQL END DECLARE SECTION;

EXEC SQL PREPARE mystmt FROM :stmt;
 ...
EXEC SQL EXECUTE mystmt INTO v1, v2, v3 USING 37;
</programlisting>
731
   An <command>EXECUTE</command> command can have an
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 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 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
   <literal>INTO</literal> clause, a <literal>USING</literal> clause,
   both, or neither.
  </para>

  <para>
   When you don't need the prepared statement anymore, you should
   deallocate it:
<programlisting>
EXEC SQL DEALLOCATE PREPARE <replaceable>name</replaceable>;
</programlisting>
  </para>
 </sect1>


 <sect1 id="ecpg-pgtypes">
  <title>pgtypes library</title>

  <para>
   The pgtypes library maps <productname>PostgreSQL</productname> database
   types to C equivalents that can be used in C programs. It also offers
   functions to do basic calculations with those types within C, i.e. without
   the help of the <productname>PostgreSQL</productname> server. See the
   following example:
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
   date date1;
   timestamp ts1, tsout;
   interval iv1;
   char *out;
EXEC SQL END DECLARE SECTION;

PGTYPESdate_today(&amp;date1);
EXEC SQL SELECT started, duration INTO :ts1, :iv1 FROM datetbl WHERE d=:date1;
PGTYPEStimestamp_add_interval(&amp;ts1, &amp;iv1, &amp;tsout);
out = PGTYPEStimestamp_to_asc(&amp;tsout);
printf("Started + duration: %s\n", out);
free(out);
</programlisting>
  </para>

  <sect2>
   <title>The numeric type</title>
   <para>
    The numeric type offers to do calculations with arbitrary precision. See
    <xref linkend="datatype-numeric"> for the equivalent type in the
    <productname>PostgreSQL</> server. Because of the arbitrary precision this
    variable needs to be able to expand and shrink dynamically. That's why you
    can only create variables on the heap by means of the
    <function>PGTYPESnumeric_new</> and <function>PGTYPESnumeric_free</>
    functions. The decimal type, which is similar but limited in the precision,
    can be created on the stack as well as on the heap.
   </para>
   <para>
   The following functions can be used to work with the numeric type:
   <variablelist>
    <varlistentry>
     <term><function>PGTYPESnumeric_new</function></term>
     <listitem>
      <para>
      Request a pointer to a newly allocated numeric variable.
<synopsis>
numeric *PGTYPESnumeric_new(void);
</synopsis>
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_free</function></term>
     <listitem>
      <para>
      Free a numeric type, release all of its memory.
<synopsis>
void PGTYPESnumeric_free(numeric *var);
</synopsis>
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_from_asc</function></term>
     <listitem>
      <para>
       Parse a numeric type from its string notation.
<synopsis>
numeric *PGTYPESnumeric_from_asc(char *str, char **endptr);
</synopsis>
       Valid formats are for example:
        <literal>-2</literal>,
        <literal>.794</literal>,
        <literal>+3.44</literal>,
        <literal>592.49E07</literal> or
        <literal>-32.84e-4</literal>.
       If the value could be parsed successfully, a valid pointer is returned,
       else the NULL pointer. At the moment ecpg always parses the complete
       string and so it currently does not support to store the address of the
       first invalid character in <literal>*endptr</literal>. You can safely
       set <literal>endptr</literal> to NULL.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_to_asc</function></term>
     <listitem>
      <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
838
       Returns a pointer to a string allocated by <function>malloc</function> that contains the string
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
       representation of the numeric type <literal>num</literal>.
<synopsis>
char *PGTYPESnumeric_to_asc(numeric *num, int dscale);
</synopsis>
       The numeric value will be printed with <literal>dscale</literal> decimal
       digits, with rounding applied if necessary.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_add</function></term>
     <listitem>
      <para>
       Add two numeric variables into a third one.
<synopsis>
int PGTYPESnumeric_add(numeric *var1, numeric *var2, numeric *result);
</synopsis>
       The function adds the variables <literal>var1</literal> and
       <literal>var2</literal> into the result variable
       <literal>result</literal>.
       The function returns 0 on success and -1 in case of error.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_sub</function></term>
     <listitem>
      <para>
       Subtract two numeric variables and return the result in a third one.
<synopsis>
int PGTYPESnumeric_sub(numeric *var1, numeric *var2, numeric *result);
</synopsis>
       The function subtracts the variable <literal>var2</literal> from
       the variable <literal>var1</literal>. The result of the operation is
       stored in the variable <literal>result</literal>.
       The function returns 0 on success and -1 in case of error.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_mul</function></term>
     <listitem>
      <para>
       Multiply two numeric variables and return the result in a third one.
<synopsis>
int PGTYPESnumeric_mul(numeric *var1, numeric *var2, numeric *result);
</synopsis>
       The function multiplies the variables <literal>var1</literal> and
       <literal>var2</literal>. The result of the operation is stored in the
       variable <literal>result</literal>.
       The function returns 0 on success and -1 in case of error.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_div</function></term>
     <listitem>
      <para>
       Divide two numeric variables and return the result in a third one.
<synopsis>
int PGTYPESnumeric_div(numeric *var1, numeric *var2, numeric *result);
</synopsis>
       The function divides the variables <literal>var1</literal> by
       <literal>var2</literal>. The result of the operation is stored in the
       variable <literal>result</literal>.
       The function returns 0 on success and -1 in case of error.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_cmp</function></term>
     <listitem>
      <para>
       Compare two numeric variables.
<synopsis>
int PGTYPESnumeric_cmp(numeric *var1, numeric *var2)
</synopsis>
       This function compares two numeric variables. In case of error,
       <literal>INT_MAX</literal> is returned. On success, the function
       returns one of three possible results:
       <itemizedlist>
        <listitem>
         <para>
          1, if <literal>var1</> is bigger than <literal>var2</>
         </para>
        </listitem>
        <listitem>
         <para>
          -1, if <literal>var1</> is smaller than <literal>var2</>
         </para>
        </listitem>
        <listitem>
         <para>
          0, if <literal>var1</> and <literal>var2</> are equal
         </para>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_from_int</function></term>
     <listitem>
      <para>
       Convert an int variable to a numeric variable.
<synopsis>
int PGTYPESnumeric_from_int(signed int int_val, numeric *var);
</synopsis>
       This function accepts a variable of type signed int and stores it
       in the numeric variable <literal>var</>. Upon success, 0 is returned and
       -1 in case of a failure.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_from_long</function></term>
     <listitem>
      <para>
       Convert a long int variable to a numeric variable.
<synopsis>
int PGTYPESnumeric_from_long(signed long int long_val, numeric *var);
</synopsis>
       This function accepts a variable of type signed long int and stores it
       in the numeric variable <literal>var</>. Upon success, 0 is returned and
       -1 in case of a failure.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_copy</function></term>
     <listitem>
      <para>
       Copy over one numeric variable into another one.
<synopsis>
int PGTYPESnumeric_copy(numeric *src, numeric *dst);
</synopsis>
       This function copies over the value of the variable that
       <literal>src</literal> points to into the variable that <literal>dst</>
       points to. It returns 0 on success and -1 if an error occurs.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_from_double</function></term>
     <listitem>
      <para>
       Convert a variable of type double to a numeric.
<synopsis>
int  PGTYPESnumeric_from_double(double d, numeric *dst);
</synopsis>
       This function accepts a variable of type double and stores the result
       in the variable that <literal>dst</> points to. It returns 0 on success
       and -1 if an error occurs.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_to_double</function></term>
     <listitem>
      <para>
       Convert a variable of type numeric to double.
<synopsis>
int PGTYPESnumeric_to_double(numeric *nv, double *dp)
</synopsis>
       The function converts the numeric value from the variable that
       <literal>nv</> points to into the double variable that <literal>dp</> points
Peter Eisentraut's avatar
Peter Eisentraut committed
1015
       to. It returns 0 on success and -1 if an error occurs, including
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
       overflow. On overflow, the global variable <literal>errno</> will be set
       to <literal>PGTYPES_NUM_OVERFLOW</> additionally.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_to_int</function></term>
     <listitem>
      <para>
       Convert a variable of type numeric to int.
<synopsis>
int PGTYPESnumeric_to_int(numeric *nv, int *ip);
</synopsis>
       The function converts the numeric value from the variable that
       <literal>nv</> points to into the integer variable that <literal>ip</>
Peter Eisentraut's avatar
Peter Eisentraut committed
1032
       points to. It returns 0 on success and -1 if an error occurs, including
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
       overflow. On overflow, the global variable <literal>errno</> will be set
       to <literal>PGTYPES_NUM_OVERFLOW</> additionally.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_to_long</function></term>
     <listitem>
      <para>
       Convert a variable of type numeric to long.
<synopsis>
int PGTYPESnumeric_to_long(numeric *nv, long *lp);
</synopsis>
       The function converts the numeric value from the variable that
       <literal>nv</> points to into the long integer variable that
Peter Eisentraut's avatar
Peter Eisentraut committed
1049
       <literal>lp</> points to. It returns 0 on success and -1 if an error
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
       occurs, including overflow. On overflow, the global variable
       <literal>errno</> will be set to <literal>PGTYPES_NUM_OVERFLOW</>
       additionally.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_to_decimal</function></term>
     <listitem>
      <para>
       Convert a variable of type numeric to decimal.
<synopsis>
int PGTYPESnumeric_to_decimal(numeric *src, decimal *dst);
</synopsis>
       The function converts the numeric value from the variable that
       <literal>src</> points to into the decimal variable that
Peter Eisentraut's avatar
Peter Eisentraut committed
1067
       <literal>dst</> points to. It returns 0 on success and -1 if an error
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
       occurs, including overflow. On overflow, the global variable
       <literal>errno</> will be set to <literal>PGTYPES_NUM_OVERFLOW</>
       additionally.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><function>PGTYPESnumeric_from_decimal</function></term>
     <listitem>
      <para>
       Convert a variable of type decimal to numeric.
<synopsis>
int PGTYPESnumeric_from_decimal(decimal *src, numeric *dst);
</synopsis>
       The function converts the decimal value from the variable that
       <literal>src</> points to into the numeric variable that
Peter Eisentraut's avatar
Peter Eisentraut committed
1085
       <literal>dst</> points to. It returns 0 on success and -1 if an error
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
       occurs. Since the decimal type is implemented as a limited version of
       the numeric type, overflow can not occur with this conversion.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
   </para>
  </sect2>

  <sect2>
   <title>The date type</title>
   <para>
    The date type in C enables your programs to deal with data of the SQL type
    date. See <xref linkend="datatype-datetime"> for the equivalent type in the
    <productname>PostgreSQL</> server.
   </para>
   <para>
    The following functions can be used to work with the date type:
    <variablelist>
     <varlistentry id="PGTYPESdatefromtimestamp">
      <term><function>PGTYPESdate_from_timestamp</function></term>
      <listitem>
       <para>
        Extract the date part from a timestamp.
<synopsis>
date PGTYPESdate_from_timestamp(timestamp dt);
</synopsis>
	The function receives a timestamp as its only argument and returns the
	extracted date part from this timestamp.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESdatefromasc">
      <term><function>PGTYPESdate_from_asc</function></term>
      <listitem>
       <para>
       Parse a date from its textual representation.
<synopsis>
date PGTYPESdate_from_asc(char *str, char **endptr);
</synopsis>
	The function receives a C char* string <literal>str</> and a pointer to
	a C char* string <literal>endptr</>. At the moment ecpg always parses
	the complete string and so it currently does not support to store the
	address of the first invalid character in <literal>*endptr</literal>.
	You can safely set <literal>endptr</literal> to NULL.
       </para>
       <para>
	Note that the function always assumes MDY-formatted dates and there is
	currently no variable to change that within ecpg.
       </para>
       <para>
        The following input formats are allowed:
        <table>
Tom Lane's avatar
Tom Lane committed
1140
	 <title>Valid input formats for <function>PGTYPESdate_from_asc</function></title>
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
	 <tgroup cols="2">
	  <thead>
	   <row>
	    <entry>Input</entry>
	    <entry>Result</entry>
	   </row>
	  </thead>
	  <tbody>
	   <row>
	    <entry><literal>January 8, 1999</literal></entry>
	    <entry><literal>January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>1999-01-08</literal></entry>
	    <entry><literal>January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>1/8/1999</literal></entry>
	    <entry><literal>January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>1/18/1999</literal></entry>
	    <entry><literal>January 18, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>01/02/03</literal></entry>
	    <entry><literal>February 1, 2003</literal></entry>
	   </row>
	   <row>
	    <entry><literal>1999-Jan-08</literal></entry>
	    <entry><literal>January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>Jan-08-1999</literal></entry>
	    <entry><literal>January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>08-Jan-1999</literal></entry>
	    <entry><literal>January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>99-Jan-08</literal></entry>
	    <entry><literal>January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>08-Jan-99</literal></entry>
	    <entry><literal>January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>08-Jan-06</literal></entry>
	    <entry><literal>January 8, 2006</literal></entry>
	   </row>
	   <row>
	    <entry><literal>Jan-08-99</literal></entry>
	    <entry><literal>January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>19990108</literal></entry>
	    <entry><literal>ISO 8601; January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>990108</literal></entry>
	    <entry><literal>ISO 8601; January 8, 1999</literal></entry>
	   </row>
	   <row>
	    <entry><literal>1999.008</literal></entry>
	    <entry><literal>year and day of year</literal></entry>
	   </row>
	   <row>
	    <entry><literal>J2451187</literal></entry>
	    <entry><literal>Julian day</literal></entry>
	   </row>
	   <row>
	    <entry><literal>January 8, 99 BC</literal></entry>
	    <entry><literal>year 99 before the Common Era</literal></entry>
	   </row>
          </tbody>
         </tgroup>
        </table>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESdatetoasc">
      <term><function>PGTYPESdate_to_asc</function></term>
      <listitem>
       <para>
        Return the textual representation of a date variable.
<synopsis>
char *PGTYPESdate_to_asc(date dDate);
</synopsis>
	The function receives the date <literal>dDate</> as its only parameter.
	It will output the date in the form <literal>1999-01-18</>, i.e. in the
	<literal>YYYY-MM-DD</> format.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESdatejulmdy">
      <term><function>PGTYPESdate_julmdy</function></term>
      <listitem>
       <para>
	Extract the values for the day, the month and the year from a variable
	of type date.
<synopsis>
void PGTYPESdate_julmdy(date d, int *mdy);
</synopsis>
       <!-- almost same description as for rjulmdy() -->
	The function receives the date <literal>d</> and a pointer to an array
	of 3 integer values <literal>mdy</>. The variable name indicates
	the sequential order: <literal>mdy[0]</> will be set to contain the
	number of the month, <literal>mdy[1]</> will be set to the value of the
	day and <literal>mdy[2]</> will contain the year.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESdatemdyjul">
      <term><function>PGTYPESdate_mdyjul</function></term>
      <listitem>
       <para>
	Create a date value from an array of 3 integers that specify the
	day, the month and the year of the date.
<synopsis>
void PGTYPESdate_mdyjul(int *mdy, date *jdate);
</synopsis>
	The function receives the array of the 3 integers (<literal>mdy</>) as
	its first argument and as its second argument a pointer to a variable
	of type date that should hold the result of the operation.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESdatedayofweek">
      <term><function>PGTYPESdate_dayofweek</function></term>
      <listitem>
       <para>
        Return a number representing the day of the week for a date value.
<synopsis>
int PGTYPESdate_dayofweek(date d);
</synopsis>
	The function receives the date variable <literal>d</> as its only
	argument and returns an integer that indicates the day of the week for
	this date.
        <itemizedlist>
         <listitem>
          <para>
	   0 - Sunday
          </para>
         </listitem>
         <listitem>
          <para>
	   1 - Monday
          </para>
         </listitem>
         <listitem>
          <para>
	   2 - Tuesday
          </para>
         </listitem>
         <listitem>
          <para>
	   3 - Wednesday
          </para>
         </listitem>
         <listitem>
          <para>
	   4 - Thursday
          </para>
         </listitem>
         <listitem>
          <para>
	   5 - Friday
          </para>
         </listitem>
         <listitem>
          <para>
	   6 - Saturday
          </para>
         </listitem>
        </itemizedlist>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESdatetoday">
      <term><function>PGTYPESdate_today</function></term>
      <listitem>
       <para>
        Get the current date.
<synopsis>
void PGTYPESdate_today(date *d);
</synopsis>
	The function receives a pointer to a date variable (<literal>d</>)
	that it sets to the current date.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESdatefmtasc">
      <term><function>PGTYPESdate_fmt_asc</function></term>
      <listitem>
       <para>
	Convert a variable of type date to its textual representation using a
	format mask.
<synopsis>
int PGTYPESdate_fmt_asc(date dDate, char *fmtstring, char *outbuf);
</synopsis>
	The function receives the date to convert (<literal>dDate</>), the
	format mask (<literal>fmtstring</>) and the string that will hold the
	textual representation of the date (<literal>outbuf</>).
       </para>
       <para>
        On success, 0 is returned and a negative value if an error occurred.
       </para>
       <para>
        The following literals are the field specifiers you can use:
        <itemizedlist>
         <listitem>
          <para>
           <literal>dd</literal> - The number of the day of the month.
          </para>
         </listitem>
         <listitem>
          <para>
           <literal>mm</literal> - The number of the month of the year.
          </para>
         </listitem>
         <listitem>
          <para>
           <literal>yy</literal> - The number of the year as a two digit number.
          </para>
         </listitem>
         <listitem>
          <para>
           <literal>yyyy</literal> - The number of the year as a four digit number.
          </para>
         </listitem>
         <listitem>
          <para>
           <literal>ddd</literal> - The name of the day (abbreviated).
          </para>
         </listitem>
         <listitem>
          <para>
           <literal>mmm</literal> - The name of the month (abbreviated).
          </para>
         </listitem>
        </itemizedlist>
	All other characters are copied 1:1 to the output string.
       </para>
       <para>
	The following table indicates a few possible formats. This will give
	you an idea of how to use this function. All output lines are based on
	the same date: November, 23rd, 1959.
        <table>
Tom Lane's avatar
Tom Lane committed
1397
	 <title>Valid input formats for <function>PGTYPESdate_fmt_asc</function></title>
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
	 <tgroup cols="2">
	  <thead>
	   <row>
	    <entry>fmt</entry>
	    <entry>result</entry>
	   </row>
	  </thead>
	  <tbody>
	   <row>
	    <entry><literal>mmddyy</literal></entry>
	    <entry><literal>112359</literal></entry>
	   </row>
	   <row>
	    <entry><literal>ddmmyy</literal></entry>
	    <entry><literal>231159</literal></entry>
	   </row>
	   <row>
	    <entry><literal>yymmdd</literal></entry>
	    <entry><literal>591123</literal></entry>
	   </row>
	   <row>
	    <entry><literal>yy/mm/dd</literal></entry>
	    <entry><literal>59/11/23</literal></entry>
	   </row>
	   <row>
	    <entry><literal>yy mm dd</literal></entry>
	    <entry><literal>59 11 23</literal></entry>
	   </row>
	   <row>
	    <entry><literal>yy.mm.dd</literal></entry>
	    <entry><literal>59.11.23</literal></entry>
	   </row>
	   <row>
	    <entry><literal>.mm.yyyy.dd.</literal></entry>
	    <entry><literal>.11.1959.23.</literal></entry>
	   </row>
	   <row>
	    <entry><literal>mmm. dd, yyyy</literal></entry>
	    <entry><literal>Nov. 23, 1959</literal></entry>
	   </row>
	   <row>
	    <entry><literal>mmm dd yyyy</literal></entry>
	    <entry><literal>Nov 23 1959</literal></entry>
	   </row>
	   <row>
	    <entry><literal>yyyy dd mm</literal></entry>
	    <entry><literal>1959 23 11</literal></entry>
	   </row>
	   <row>
	    <entry><literal>ddd, mmm. dd, yyyy</literal></entry>
	    <entry><literal>Mon, Nov. 23, 1959</literal></entry>
	   </row>
	   <row>
	    <entry><literal>(ddd) mmm. dd, yyyy</literal></entry>
	    <entry><literal>(Mon) Nov. 23, 1959</literal></entry>
	   </row>
          </tbody>
         </tgroup>
        </table>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESdatedefmtasc">
      <term><function>PGTYPESdate_defmt_asc</function></term>
      <listitem>
       <para>
	Use a format mask to convert a C char* string to a value of type
	date.
<synopsis>
int PGTYPESdate_defmt_asc(date *d, char *fmt, char *str);
</synopsis>
	<!-- same description as rdefmtdate -->
	The function receives a pointer to the date value that should hold the
	result of the operation (<literal>d</>), the format mask to use for
	parsing the date (<literal>fmt</>) and the C char* string containing
	the textual representation of the date (<literal>str</>). The textual
	representation is expected to match the format mask. However you do not
	need to have a 1:1 mapping of the string to the format mask. The
	function only analyzes the sequential order and looks for the literals
	<literal>yy</literal> or <literal>yyyy</literal> that indicate the
	position of the year, <literal>mm</literal> to indicate the position of
	the month and <literal>dd</literal> to indicate the position of the
	day.
       </para>
       <para>
	The following table indicates a few possible formats. This will give
	you an idea of how to use this function.
        <table>
Tom Lane's avatar
Tom Lane committed
1487
	 <title>Valid input formats for <function>rdefmtdate</function></title>
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
	 <tgroup cols="2">
	  <thead>
	   <row>
	    <entry>fmt</entry>
	    <entry>str</entry>
	    <entry>result</entry>
	   </row>
	  </thead>
	  <tbody>
	   <row>
	    <entry><literal>ddmmyy</literal></entry>
	    <entry><literal>21-2-54</literal></entry>
	    <entry><literal>1954-02-21</literal></entry>
	   </row>
	   <row>
	    <entry><literal>ddmmyy</literal></entry>
	    <entry><literal>2-12-54</literal></entry>
	    <entry><literal>1954-12-02</literal></entry>
	   </row>
	   <row>
	    <entry><literal>ddmmyy</literal></entry>
	    <entry><literal>20111954</literal></entry>
	    <entry><literal>1954-11-20</literal></entry>
	   </row>
	   <row>
	    <entry><literal>ddmmyy</literal></entry>
	    <entry><literal>130464</literal></entry>
	    <entry><literal>1964-04-13</literal></entry>
	   </row>
	   <row>
	    <entry><literal>mmm.dd.yyyy</literal></entry>
	    <entry><literal>MAR-12-1967</literal></entry>
	    <entry><literal>1967-03-12</literal></entry>
	   </row>
	   <row>
	    <entry><literal>yy/mm/dd</literal></entry>
	    <entry><literal>1954, February 3rd</literal></entry>
	    <entry><literal>1954-02-03</literal></entry>
	   </row>
	   <row>
	    <entry><literal>mmm.dd.yyyy</literal></entry>
	    <entry><literal>041269</literal></entry>
	    <entry><literal>1969-04-12</literal></entry>
	   </row>
	   <row>
	    <entry><literal>yy/mm/dd</literal></entry>
	    <entry><literal>In the year 2525, in the month of July, mankind will be alive on the 28th day</literal></entry>
	    <entry><literal>2525-07-28</literal></entry>
	   </row>
	   <row>
	    <entry><literal>dd-mm-yy</literal></entry>
	    <entry><literal>I said on the 28th of July in the year 2525</literal></entry>
	    <entry><literal>2525-07-28</literal></entry>
	   </row>
	   <row>
	    <entry><literal>mmm.dd.yyyy</literal></entry>
	    <entry><literal>9/14/58</literal></entry>
	    <entry><literal>1958-09-14</literal></entry>
	   </row>
	   <row>
	    <entry><literal>yy/mm/dd</literal></entry>
	    <entry><literal>47/03/29</literal></entry>
	    <entry><literal>1947-03-29</literal></entry>
	   </row>
	   <row>
	    <entry><literal>mmm.dd.yyyy</literal></entry>
	    <entry><literal>oct 28 1975</literal></entry>
	    <entry><literal>1975-10-28</literal></entry>
	   </row>
	   <row>
	    <entry><literal>mmddyy</literal></entry>
	    <entry><literal>Nov 14th, 1985</literal></entry>
	    <entry><literal>1985-11-14</literal></entry>
	   </row>
          </tbody>
         </tgroup>
        </table>
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect2>
 
  <sect2>
   <title>The timestamp type</title>
   <para>
    The timestamp type in C enables your programs to deal with data of the SQL
    type timestamp. See <xref linkend="datatype-datetime"> for the equivalent
    type in the <productname>PostgreSQL</> server.
   </para>
   <para>
    The following functions can be used to work with the timestamp type:
    <variablelist>
     <varlistentry id="PGTYPEStimestampfromasc">
      <term><function>PGTYPEStimestamp_from_asc</function></term>
      <listitem>
       <para>
	Parse a timestamp from its textual representation into a timestamp
	variable.
<synopsis>
timestamp PGTYPEStimestamp_from_asc(char *str, char **endptr);
</synopsis>
	The function receives the string to parse (<literal>str</>) and a
	pointer to a C char* (<literal>endptr</>).
	At the moment ecpg always parses
	the complete string and so it currently does not support to store the
	address of the first invalid character in <literal>*endptr</literal>.
	You can safely set <literal>endptr</literal> to NULL.
       </para>
       <para>
	The function returns the parsed timestamp on success. On error,
	<literal>PGTYPESInvalidTimestamp</literal> is returned and errno is
	set to <literal>PGTYPES_TS_BAD_TIMESTAMP</>. See <xref linkend="PGTYPESInvalidTimestamp"> for important notes on this value.
	
       </para>
       <para>
	In general, the input string can contain any combination of an allowed
	date specification, a whitespace character and an allowed time
	specification. Note that timezones are not supported by ecpg. It can
	parse them but does not apply any calculation as the
	<productname>PostgreSQL</> server does for example. Timezone
Peter Eisentraut's avatar
Peter Eisentraut committed
1610
	specifiers are silently discarded.
1611 1612 1613 1614
       </para>
       <para>
        The following table contains a few examples for input strings:
        <table>
Tom Lane's avatar
Tom Lane committed
1615
	 <title>Valid input formats for <function>PGTYPEStimestamp_from_asc</function></title>
1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196
	 <tgroup cols="2">
	  <thead>
	   <row>
	    <entry>Input</entry>
	    <entry>Result</entry>
	   </row>
	  </thead>
	  <tbody>
	   <row>
	    <entry><literal>1999-01-08 04:05:06</literal></entry>
	    <entry><literal>1999-01-08 04:05:06</literal></entry>
	   </row>
	   <row>
	    <entry><literal>January 8 04:05:06 1999 PST</literal></entry>
	    <entry><literal>1999-01-08 04:05:06</literal></entry>
	   </row>
	   <row>
	    <entry><literal>1999-Jan-08 04:05:06.789-8</literal></entry>
	    <entry><literal>1999-01-08 04:05:06.789 (time zone specifier ignored)</literal></entry>
	   </row>
	   <row>
	    <entry><literal>J2451187 04:05-08:00</literal></entry>
	    <entry><literal>1999-01-08 04:05:00 (time zone specifier ignored)</literal></entry>
	   </row>
          </tbody>
         </tgroup>
        </table>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPEStimestamptoasc">
      <term><function>PGTYPEStimestamp_to_asc</function></term>
      <listitem>
       <para>
        Converts a date to a C char* string.
<synopsis>
char *PGTYPEStimestamp_to_asc(timestamp tstamp);
</synopsis>
	The function receives the timestamp <literal>tstamp</> as
	its only argument and returns an allocated string that contains the
	textual representation of the timestamp.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPEStimestampcurrent">
      <term><function>PGTYPEStimestamp_current</function></term>
      <listitem>
       <para>
        Retrieve the current timestamp.
<synopsis>
void PGTYPEStimestamp_current(timestamp *ts);
</synopsis>
	The function retrieves the current timestamp and saves it into the
	timestamp variable that <literal>ts</> points to.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPEStimestampfmtasc">
      <term><function>PGTYPEStimestamp_fmt_asc</function></term>
      <listitem>
       <para>
        Convert a timestamp variable to a C char* using a format mask.
<synopsis>
int PGTYPEStimestamp_fmt_asc(timestamp *ts, char *output, int str_len, char *fmtstr);
</synopsis>
	The function receives a pointer to the timestamp to convert as its
	first argument (<literal>ts</>), a pointer to the output buffer
	(<literal>output</>), the maximal length that has been allocated for
	the output buffer (<literal>str_len</literal>) and the format mask to
	use for the conversion (<literal>fmtstr</literal>).
       </para>
       <para>
	Upon success, the function returns 0 and a negative value if an
	error occurred.
       </para>
       <para>
	You can use the following format specifiers for the format mask. The
	format specifiers are the same ones that are used in the
	<function>strftime</> function in <productname>libc</productname>. Any
	non-format specifier will be copied into the output buffer. 
	<!-- This is from the FreeBSD man page:
	     http://www.freebsd.org/cgi/man.cgi?query=strftime&apropos=0&sektion=3&manpath=FreeBSD+7.0-current&format=html
	-->
        <itemizedlist>
         <listitem>
          <para>
	   <literal>%A</literal> - is replaced by national representation of
	   the full weekday name.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%a</literal> - is replaced by national representation of
	   the abbreviated weekday name.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%B</literal> - is replaced by national representation of
	   the full month name.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%b</literal> - is replaced by national representation of
	   the abbreviated month name.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%C</literal> - is replaced by (year / 100) as decimal
	   number; single digits are preceded by a zero.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%c</literal> - is replaced by national representation of
	   time and date.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%D</literal> - is equivalent to
	   <literal>%m/%d/%y</literal>.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%d</literal> - is replaced by the day of the month as a
	   decimal number (01-31).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%E*</literal> <literal>%O*</literal> -  POSIX locale
	   extensions. The sequences
	   <literal>%Ec</literal>
	   <literal>%EC</literal> 
	   <literal>%Ex</literal> 
	   <literal>%EX</literal> 
	   <literal>%Ey</literal> 
	   <literal>%EY</literal> 
	   <literal>%Od</literal> 
	   <literal>%Oe</literal>
	   <literal>%OH</literal> 
	   <literal>%OI</literal> 
	   <literal>%Om</literal> 
	   <literal>%OM</literal> 
	   <literal>%OS</literal> 
	   <literal>%Ou</literal> 
	   <literal>%OU</literal> 
	   <literal>%OV</literal> 
	   <literal>%Ow</literal> 
	   <literal>%OW</literal> 
	   <literal>%Oy</literal> 
	   are supposed to provide alternate representations.
          </para>
          <para>
	   Additionally <literal>%OB</literal> implemented to represent
	   alternative months names (used standalone, without day mentioned).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%e</literal> - is replaced by the day of month as a decimal
	   number (1-31); single digits are preceded by a blank.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%F</literal> - is equivalent to <literal>%Y-%m-%d</literal>.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%G</literal> - is replaced by a year as a decimal number
	   with century. This year is the one that contains the greater part of
	   the week (Monday as the first day of the week).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%g</literal> - is replaced by the same year as in
	   <literal>%G</literal>, but as a decimal number without century
	   (00-99).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%H</literal> - is replaced by the hour (24-hour clock) as a
	   decimal number (00-23).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%h</literal> - the same as <literal>%b</literal>.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%I</literal> - is replaced by the hour (12-hour clock) as a
	   decimal number (01-12).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%j</literal> - is replaced by the day of the year as a
	   decimal number (001-366).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%k</literal> - is replaced by the hour (24-hour clock) as a
	   decimal number (0-23); single digits are preceded by a blank.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%l</literal> - is replaced by the hour (12-hour clock) as a
	   decimal number (1-12); single digits are preceded by a blank.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%M</literal> - is replaced by the minute as a decimal
	   number (00-59).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%m</literal> - is replaced by the month as a decimal number
	   (01-12).
          </para>
         </listitem>
         <listitem>
          <para>
	  <literal>%n</literal> - is replaced by a newline.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%O*</literal> - the same as <literal>%E*</literal>.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%p</literal> - is replaced by national representation of
	   either "ante meridiem" or "post meridiem" as appropriate.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%R</literal> - is equivalent to <literal>%H:%M</literal>.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%r</literal> - is equivalent to <literal>%I:%M:%S
	   %p</literal>.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%S</literal> - is replaced by the second as a decimal
	   number (00-60).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%s</literal> - is replaced by the number of seconds since
	   the Epoch, UTC.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%T</literal> - is equivalent to <literal>%H:%M:%S</literal>
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%t</literal> - is replaced by a tab.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%U</literal> - is replaced by the week number of the year
	   (Sunday as the first day of the week) as a decimal number (00-53).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%u</literal> - is replaced by the weekday (Monday as the
	   first day of the week) as a decimal number (1-7).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%V</literal> - is replaced by the week number of the year
	   (Monday as the first day of the week) as a decimal number (01-53).
	   If the week containing January 1 has four or more days in the new
	   year, then it is week 1; otherwise it is the last week of the
	   previous year, and the next week is week 1.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%v</literal> - is equivalent to
	   <literal>%e-%b-%Y</literal>.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%W</literal> - is replaced by the week number of the year
	   (Monday as the first day of the week) as a decimal number (00-53).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%w</literal> - is replaced by the weekday (Sunday as the
	   first day of the week) as a decimal number (0-6).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%X</literal> - is replaced by national representation of
	   the time.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%x</literal> - is replaced by national representation of
	   the date.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%Y</literal> - is replaced by the year with century as a
	   decimal number.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%y</literal> - is replaced by the year without century as a
	   decimal number (00-99).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%Z</literal> - is replaced by the time zone name.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%z</literal> - is replaced by the time zone offset from
	   UTC; a leading plus sign stands for east of UTC, a minus sign for
	   west of UTC, hours and minutes follow with two digits each and no
	   delimiter between them (common form for RFC 822 date headers).
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%+</literal> - is replaced by national representation of
	   the date and time.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%-*</literal> - GNU libc extension.	Do not do any padding
	   when performing numerical outputs.
          </para>
         </listitem>
         <listitem>
          <para>
	   $_* - GNU libc extension.	Explicitly specify space for padding.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%0*</literal> - GNU libc extension.	Explicitly specify zero
	   for padding.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>%%</literal> - is replaced by <literal>%</literal>.
          </para>
         </listitem>
        </itemizedlist>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPEStimestampsub">
      <term><function>PGTYPEStimestamp_sub</function></term>
      <listitem>
       <para>
	Subtract one timestamp from another one and save the result in a
	variable of type interval.
<synopsis>
int PGTYPEStimestamp_sub(timestamp *ts1, timestamp *ts2, interval *iv);
</synopsis>
	The function will subtract the timestamp variable that <literal>ts2</>
	points to from the timestamp variable that <literal>ts1</> points to
	and will store the result in the interval variable that <literal>iv</>
	points to.
       </para>
       <para>
	Upon success, the function returns 0 and a negative value if an
	error occurred.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPEStimestampdefmtasc">
      <term><function>PGTYPEStimestamp_defmt_asc</function></term>
      <listitem>
       <para>
	Parse a timestamp value from its textual representation using a
	formatting mask.
<synopsis>
int PGTYPEStimestamp_defmt_asc(char *str, char *fmt, timestamp *d);
</synopsis>
	The function receives the textual representation of a timestamp in the
	variable <literal>str</> as well as the formatting mask to use in the
	variable <literal>fmt</>. The result will be stored in the variable
	that <literal>d</> points to.
       </para>
       <para>
	If the formatting mask <literal>fmt</> is NULL, the function will fall
	back to the default formatting mask which is <literal>%Y-%m-%d
	%H:%M:%S</literal>.
       </para>
       <para>
	This is the reverse function to <xref
	linkend="PGTYPEStimestampfmtasc">.  See the documentation there in
	order to find out about the possible formatting mask entries.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPEStimestampaddinterval">
      <term><function>PGTYPEStimestamp_add_interval</function></term>
      <listitem>
       <para>
        Add an interval variable to a timestamp variable.
<synopsis>
int PGTYPEStimestamp_add_interval(timestamp *tin, interval *span, timestamp *tout);
</synopsis>
	The function receives a pointer to a timestamp variable <literal>tin</>
	and a pointer to an interval variable <literal>span</>. It adds the
	interval to the timestamp and saves the resulting timestamp in the
	variable that <literal>tout</> points to.
       </para>
       <para>
	Upon success, the function returns 0 and a negative value if an
	error occurred.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPEStimestampsubinterval">
      <term><function>PGTYPEStimestamp_sub_interval</function></term>
      <listitem>
       <para>
        Subtract an interval variable from a timestamp variable.
<synopsis>
int PGTYPEStimestamp_sub_interval(timestamp *tin, interval *span, timestamp *tout);
</synopsis>
	The function subtracts the interval variable that <literal>span</>
	points to from the timestamp variable that <literal>tin</> points to
	and saves the result into the variable that <literal>tout</> points
	to.
       </para>
       <para>
	Upon success, the function returns 0 and a negative value if an
	error occurred.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect2>

  <sect2>
   <title>The interval type</title>
   <para>
    The interval type in C enables your programs to deal with data of the SQL
    type interval. See <xref linkend="datatype-datetime"> for the equivalent
    type in the <productname>PostgreSQL</> server.
   </para>
   <para>
    The following functions can be used to work with the interval type:
    <variablelist>

     <varlistentry id="PGTYPESintervalnew">
      <term><function>PGTYPESinterval_new</function></term>
      <listitem>
       <para>
        Return a pointer to a newly allocated interval variable.
<synopsis>
interval *PGTYPESinterval_new(void);
</synopsis>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESintervalfree">
      <term><function>PGTYPESinterval_free</function></term>
      <listitem>
       <para>
        Release the memory of a previously allocated interval variable.
<synopsis>
void PGTYPESinterval_new(interval *intvl);
</synopsis>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESintervalfromasc">
      <term><function>PGTYPESinterval_from_asc</function></term>
      <listitem>
       <para>
        Parse an interval from its textual representation.
<synopsis>
interval *PGTYPESinterval_from_asc(char *str, char **endptr);
</synopsis>
	The function parses the input string <literal>str</> and returns a
	pointer to an allocated interval variable.
	At the moment ecpg always parses
	the complete string and so it currently does not support to store the
	address of the first invalid character in <literal>*endptr</literal>.
	You can safely set <literal>endptr</literal> to NULL.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESintervaltoasc">
      <term><function>PGTYPESinterval_to_asc</function></term>
      <listitem>
       <para>
        Convert a variable of type interval to its textual representation.
<synopsis>
char *PGTYPESinterval_to_asc(interval *span);
</synopsis>
	The function converts the interval variable that <literal>span</>
	points to into a C char*. The output looks like this example:
	<literal>@ 1 day 12 hours 59 mins 10 secs</literal>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="PGTYPESintervalcopy">
      <term><function>PGTYPESinterval_copy</function></term>
      <listitem>
       <para>
        Copy a variable of type interval.
<synopsis>
int PGTYPESinterval_copy(interval *intvlsrc, interval *intvldest);
</synopsis>
	The function copies the interval variable that <literal>intvlsrc</>
	points to into the variable that <literal>intvldest</> points to. Note
	that you need to allocate the memory for the destination variable
	before.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect2>

  <sect2>
   <title>The decimal type</title>
   <para>
     The decimal type is similar to the numeric type. However it is limited to
     a maximal precision of 30 significant digits. In contrast to the numeric
     type which can be created on the heap only, the decimal type can be
     created either on the stack or on the heap (by means of the functions
     PGTYPESdecimal_new() and PGTYPESdecimal_free(). There are a lot of other
Peter Eisentraut's avatar
Peter Eisentraut committed
2197
     functions that deal with the decimal type in the <productname>Informix</productname> compatibility
2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377
     mode described in <xref linkend="ecpg-informix-compat">.
   </para>
   <para>
    The following functions can be used to work with the decimal type and are
    not only contained in the <literal>libcompat</> library.
    <variablelist>
     <varlistentry>
      <term><function>PGTYPESdecimal_new</function></term>
      <listitem>
       <para>
       Request a pointer to a newly allocated decimal variable.
<synopsis>
decimal *PGTYPESdecimal_new(void);
</synopsis>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>PGTYPESdecimal_free</function></term>
      <listitem>
       <para>
       Free a decimal type, release all of its memory.
<synopsis>
void PGTYPESdecimal_free(decimal *var);
</synopsis>
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect2>
 
   <sect2>
    <title>errno values of pgtypeslib </title>
   <para>
    <variablelist>
     <varlistentry>
      <term><literal>PGTYPES_NUM_BAD_NUMERIC</literal></term>
      <listitem>
       <para>
	An argument should contain a numeric variable (or point to a numeric
	variable) but in fact its in-memory representation was invalid.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_NUM_OVERFLOW</literal></term>
      <listitem>
       <para>
	An overflow occurred. Since the numeric type can deal with almost
	arbitrary precision, converting a numeric variable into other types
	might cause overflow.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_NUM_OVERFLOW</literal></term>
      <listitem>
       <para>
	An underflow occurred. Since the numeric type can deal with almost
	arbitrary precision, converting a numeric variable into other types
	might cause underflow.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_NUM_DIVIDE_ZERO</literal></term>
      <listitem>
       <para>
        A division by zero has been attempted.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_DATE_BAD_DATE</literal></term>
      <listitem>
       <para>
        
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_DATE_ERR_EARGS</literal></term>
      <listitem>
       <para>
        
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_DATE_ERR_ENOSHORTDATE</literal></term>
      <listitem>
       <para>
        
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_INTVL_BAD_INTERVAL</literal></term>
      <listitem>
       <para>
        
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_DATE_ERR_ENOTDMY</literal></term>
      <listitem>
       <para>
        
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_DATE_BAD_DAY</literal></term>
      <listitem>
       <para>
        
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_DATE_BAD_MONTH</literal></term>
      <listitem>
       <para>
        
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>PGTYPES_TS_BAD_TIMESTAMP</literal></term>
      <listitem>
       <para>
        
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect2>

   <sect2>
    <title>Special constants of pgtypeslib </title>
   <para>
    <variablelist>
     <varlistentry id="PGTYPESInvalidTimestamp">
      <term><literal>PGTYPESInvalidTimestamp</literal></term>
      <listitem>
       <para>
	A value of type timestamp representing an invalid time stamp. This is
	returned by the function <function>PGTYPEStimestamp_from_asc</> on
	parse error.
	Note that due to the internal representation of the timestamp datatype,
	<literal>PGTYPESInvalidTimestamp</literal> is also a valid timestamp at
	the same time. It is set to <literal>1899-12-31 23:59:59</>. In order
	to detect errors, make sure that your application does not only test
	for <literal>PGTYPESInvalidTimestamp</literal> but also for
	<literal>errno != 0</> after each call to
	<function>PGTYPEStimestamp_from_asc</>.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect2>
 </sect1>

 <sect1 id="ecpg-informix-compat">
Peter Eisentraut's avatar
Peter Eisentraut committed
2378
  <title><productname>Informix</productname> compatibility mode</title>
2379 2380
  <para>
   ecpg can be run in a so-called <firstterm>Informix compatibility mode</>. If
Peter Eisentraut's avatar
Peter Eisentraut committed
2381 2382
   this mode is active, it tries to behave as if it were the <productname>Informix</productname>
   precompiler for <productname>Informix</productname> E/SQL. Generally spoken this will allow you to use
2383
   the dollar sign instead of the <literal>EXEC SQL</> primitive to introduce
2384
   embedded SQL commands.:
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400
<programlisting>
   $int j = 3;
   $CONNECT TO :dbname;
   $CREATE TABLE test(i INT PRIMARY KEY, j INT);
   $INSERT INTO test(i, j) VALUES (7, :j);
   $COMMIT;
</programlisting>
  </para>
  <para>
   There are two compatiblity modes: INFORMIX, INFORMIX_SE
  </para>
  <para>
   When linking programs that use this compatibility mode, remember to link
   against <literal>libcompat</> that is shipped with ecpg.
  </para>
  <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
2401
   Besides the previously explained syntactic sugar, the <productname>Informix</productname> compatibility
2402 2403 2404 2405
   mode ports some functions for input, output and transformation of data as
   well as embedded SQL statements known from E/SQL to ecpg.
  </para>
  <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
2406
   <productname>Informix</productname> compatibility mode is closely connected to the pgtypeslib library
2407
   of ecpg. pgtypeslib maps SQL data types to data types within the C host
Peter Eisentraut's avatar
Peter Eisentraut committed
2408
   program and most of the additional functions of the <productname>Informix</productname> compatibility
2409
   mode allow you to operate on those C host program types. Note however that
Peter Eisentraut's avatar
Peter Eisentraut committed
2410
   the extent of the compatibility is limited. It does not try to copy <productname>Informix</productname>
Tom Lane's avatar
Tom Lane committed
2411
   behaviour; it allows you to do more or less the same operations and gives
2412
   you functions that have the same name and the same basic behavior but it is
Peter Eisentraut's avatar
Peter Eisentraut committed
2413
   no drop-in replacement if you are using <productname>Informix</productname> at the moment. Moreover,
2414
   some of the data types are different. For example,
Tom Lane's avatar
Tom Lane committed
2415
   <productname>PostgreSQL's</productname> datetime and interval types do not
2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428
   know about ranges like for example <literal>YEAR TO MINUTE</> so you won't
   find support in ecpg for that either.
  </para>

  <sect2>
   <title>Additional embedded SQL statements</title>
   <para>
    <variablelist>
     <varlistentry>
      <term><literal>CLOSE DATABASE</></term>
      <listitem>
       <para>
	This statement closes the current connection. In fact, this is a
2429
	synonym for ecpg's <literal>DISCONNECT CURRENT</>.:
2430 2431
<programlisting>
    $CLOSE DATABASE;                /* close the current connection */
Tom Lane's avatar
Tom Lane committed
2432
    EXEC SQL CLOSE DATABASE;
2433 2434 2435 2436
</programlisting>
       </para>
      </listitem>
     </varlistentry>
Tom Lane's avatar
Tom Lane committed
2437
    </variablelist>
2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542
   </para>
  </sect2>

  <sect2>
   <title>Additional functions</title>
   <para>
    <variablelist>
     <varlistentry>
      <term><function>decadd</></term>
      <listitem>
       <para>
        Add two decimal type values.
<synopsis>
int decadd(decimal *arg1, decimal *arg2, decimal *sum);
</synopsis>
	The function receives a pointer to the first operand of type decimal
	(<literal>arg1</>), a pointer to the second operand of type decimal
	(<literal>arg2</>) and a pointer to a value of type decimal that will
	contain the sum (<literal>sum</>). On success, the function returns 0.
	ECPG_INFORMIX_NUM_OVERFLOW is returned in case of overflow and 
	ECPG_INFORMIX_NUM_UNDERFLOW in case of underflow. -1 is returned for
	other failures and errno is set to the respective errno number of the
	pgtypeslib.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>deccmp</></term>
      <listitem>
       <para>
        Compare two variables of type decimal.
<synopsis>
int deccmp(decimal *arg1, decimal *arg2);
</synopsis>
	The function receives a pointer to the first decimal value
	(<literal>arg1</>), a pointer to the second decimal value
	(<literal>arg2</>) and returns an integer value that indicates which is
	the bigger value.
        <itemizedlist>
         <listitem>
          <para>
	   1, if the value that <literal>arg1</> points to is bigger than the
	   value that <literal>var2</> points to
          </para>
         </listitem>
         <listitem>
          <para>
	   -1, if the value that <literal>arg1</> points to is smaller than the
	   value that <literal>arg2</> points to </para>
         </listitem>
         <listitem>
          <para>
	   0, if the value that <literal>arg1</> points to and the value that
	   <literal>arg2</> points to are equal
          </para>
         </listitem>
        </itemizedlist>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>deccopy</></term>
      <listitem>
       <para>
        Copy a decimal value.
<synopsis>
void deccopy(decimal *src, decimal *target);
</synopsis>
	The function receives a pointer to the decimal value that should be
	copied as the first argument (<literal>src</>) and a pointer to the
	target structure of type decimal (<literal>target</>) as the second
	argument.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>deccvasc</></term>
      <listitem>
       <para>
        Convert a value from its ASCII representation into a decimal type.
<synopsis>
int deccvasc(char *cp, int len, decimal *np);
</synopsis>
	The function receives a pointer to string that contains the string
	representation of the number to be converted (<literal>cp</>) as well
	as its length <literal>len</>. <literal>np</> is a pointer to the
	decimal value that saves the result of the operation.
       </para>
       <para>
        Valid formats are for example:
         <literal>-2</literal>,
         <literal>.794</literal>,
         <literal>+3.44</literal>,
         <literal>592.49E07</literal> or
         <literal>-32.84e-4</literal>.
       </para>
       <para>
	The function returns 0 on success. If overflow or underflow occurred,
	<literal>ECPG_INFORMIX_NUM_OVERFLOW</> or
	<literal>ECPG_INFORMIX_NUM_UNDERFLOW</> is returned. If the ASCII
	representation could not be parsed,
	<literal>ECPG_INFORMIX_BAD_NUMERIC</> is returned or
Peter Eisentraut's avatar
Peter Eisentraut committed
2543
	<literal>ECPG_INFORMIX_BAD_EXPONENT</> if this problem occurred while
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743
	parsing the exponent.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>deccvdbl</></term>
      <listitem>
       <para>
        Convert a value of type double to a value of type decimal.
<synopsis>
int deccvdbl(double dbl, decimal *np);
</synopsis>
	The function receives the variable of type double that should be
	converted as its first argument (<literal>dbl</>). As the second
	argument (<literal>np</>), the function receives a pointer to the
	decimal variable that should hold the result of the operation.
       </para>
       <para>
	The function returns 0 on success and a negative value if the
	conversion failed.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>deccvint</></term>
      <listitem>
       <para>
        Convert a value of type int to a value of type decimal.
<synopsis>
int deccvint(int in, decimal *np);
</synopsis>
	The function receives the variable of type int that should be
	converted as its first argument (<literal>in</>). As the second
	argument (<literal>np</>), the function receives a pointer to the
	decimal variable that should hold the result of the operation.
       </para>
       <para>
	The function returns 0 on success and a negative value if the
	conversion failed.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>deccvlong</></term>
      <listitem>
       <para>
        Convert a value of type long to a value of type decimal.
<synopsis>
int deccvlong(long lng, decimal *np);
</synopsis>
	The function receives the variable of type long that should be
	converted as its first argument (<literal>lng</>). As the second
	argument (<literal>np</>), the function receives a pointer to the
	decimal variable that should hold the result of the operation.
       </para>
       <para>
	The function returns 0 on success and a negative value if the
	conversion failed.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>decdiv</></term>
      <listitem>
       <para>
        Divide two variables of type decimal.
<synopsis>
int decdiv(decimal *n1, decimal *n2, decimal *result);
</synopsis>
	The function receives pointers to the variables that are the first
	(<literal>n1</>) and the second (<literal>n2</>) operands and
	calculates <literal>n1</>/<literal>n2</>. <literal>result</> is a
	pointer to the variable that should hold the result of the operation.
       </para>
       <para>
	On success, 0 is returned and a negative value if the division fails.
	If overflow or underflow occurred, the function returns
	<literal>ECPG_INFORMIX_NUM_OVERFLOW</> or
	<literal>ECPG_INFORMIX_NUM_UNDERFLOW</> respectively. If an attempt to
	divide by zero is observed, the function returns
	<literal>ECPG_INFORMIX_DIVIDE_ZERO</literal>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>decmul</></term>
      <listitem>
       <para>
        Multiply two decimal values.
<synopsis>
int decmul(decimal *n1, decimal *n2, decimal *result);
</synopsis>
	The function receives pointers to the variables that are the first
	(<literal>n1</>) and the second (<literal>n2</>) operands and
	calculates <literal>n1</>*<literal>n2</>. <literal>result</> is a
	pointer to the variable that should hold the result of the operation.
       </para>
       <para>
	On success, 0 is returned and a negative value if the multiplication
	fails. If overflow or underflow occurred, the function returns
	<literal>ECPG_INFORMIX_NUM_OVERFLOW</> or
	<literal>ECPG_INFORMIX_NUM_UNDERFLOW</> respectively.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>decsub</></term>
      <listitem>
       <para>
        Subtract one decimal value from another.
<synopsis>
int decsub(decimal *n1, decimal *n2, decimal *result);
</synopsis>
	The function receives pointers to the variables that are the first
	(<literal>n1</>) and the second (<literal>n2</>) operands and
	calculates <literal>n1</>-<literal>n2</>. <literal>result</> is a
	pointer to the variable that should hold the result of the operation.
       </para>
       <para>
	On success, 0 is returned and a negative value if the subtraction
	fails. If overflow or underflow occurred, the function returns
	<literal>ECPG_INFORMIX_NUM_OVERFLOW</> or
	<literal>ECPG_INFORMIX_NUM_UNDERFLOW</> respectively.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dectoasc</></term>
      <listitem>
       <para>
	Convert a variable of type decimal to its ASCII representation in a C
	char* string.
<synopsis>
int dectoasc(decimal *np, char *cp, int len, int right)
</synopsis>
	The function receives a pointer to a variable of type decimal
	(<literal>np</>) that it converts to its textual representation.
	<literal>cp</> is the buffer that should hold the result of the
	operation. The parameter <literal>right</> specifies, how many digits
	right of the decimal point should be included in the output. The result
	will be rounded to this number of decimal digits. Setting
	<literal>right</> to -1 indicates that all available decimal digits
	should be included in the output. If the length of the output buffer,
	which is indicated by <literal>len</> is not sufficient to hold the
	textual representation including the trailing NUL character, only a
	single <literal>*</> character is stored in the result and -1 is
	returned.
       </para>
       <para>
	The function returns either -1 if the buffer <literal>cp</> was too
	small or <literal>ECPG_INFORMIX_OUT_OF_MEMORY</> if memory was
	exhausted. 
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dectodbl</></term>
      <listitem>
       <para>
        Convert a variable of type decimal to a double.
<synopsis>
int dectodbl(decimal *np, double *dblp);
</synopsis>
	The function receives a pointer to the decimal value to convert
	(<literal>np</>) and a pointer to the double variable that
	should hold the result of the operation (<literal>dblp</>).
       </para>
       <para>
	On success, 0 is returned and a negative value if the conversion
	failed.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dectoint</></term>
      <listitem>
       <para>
        Convert a variable to type decimal to an integer.
<synopsis>
int dectoint(decimal *np, int *ip);
</synopsis>
	The function receives a pointer to the decimal value to convert
	(<literal>np</>) and a pointer to the integer variable that
	should hold the result of the operation (<literal>ip</>).
       </para>
       <para>
	On success, 0 is returned and a negative value if the conversion
	failed. If an overflow occurred, <literal>ECPG_INFORMIX_NUM_OVERFLOW</>
	is returned.
       </para>
       <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
2744 2745
	Note that the ecpg implementation differs from the <productname>Informix</productname>
	implementation. <productname>Informix</productname> limits an integer to the range from -32767 to
2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769
	32767, while the limits in the ecpg implementation depend on the
	architecture (<literal>-INT_MAX .. INT_MAX</>).
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dectolong</></term>
      <listitem>
       <para>
        Convert a variable to type decimal to a long integer.
<synopsis>
int dectolong(decimal *np, long *lngp);
</synopsis>
	The function receives a pointer to the decimal value to convert
	(<literal>np</>) and a pointer to the long variable that
	should hold the result of the operation (<literal>lngp</>).
       </para>
       <para>
	On success, 0 is returned and a negative value if the conversion
	failed. If an overflow occurred, <literal>ECPG_INFORMIX_NUM_OVERFLOW</>
	is returned.
       </para>
       <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
2770 2771
	Note that the ecpg implementation differs from the <productname>Informix</productname>
	implementation. <productname>Informix</productname> limits a long integer to the range from
2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797
	-2,147,483,647 to 2,147,483,647, while the limits in the ecpg
	implementation depend on the architecture (<literal>-LONG_MAX ..
	LONG_MAX</>).
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rdatestr</></term>
      <listitem>
       <para>
        Converts a date to a C char* string.
<synopsis>
int rdatestr(date d, char *str);
</synopsis>
	The function receives two arguments, the first one is the date to
	convert (<literal>d</> and the second one is a pointer to the target
	string. The output format is always <literal>yyyy-mm-dd</>, so you need
	to allocate at least 11 bytes (including the NUL-terminator) for the
	string.
       </para>
       <para>
	The function returns 0 on success and a negative value in case of
	error.
       </para>
       <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
2798 2799
	Note that ecpg's implementation differs from the <productname>Informix</productname>
	implementation. In <productname>Informix</productname> the format can be influenced by setting
2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816
	environment variables. In ecpg however, you cannot change the output
	format.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rstrdate</></term>
      <listitem>
       <para>
        Parse the textual representation of a date.
<synopsis>
int rstrdate(char *str, date *d);
</synopsis>
	The function receives the textual representation of the date to convert
	(<literal>str</>) and a pointer to a variable of type date
	(<literal>d</>). This function does not allow you to specify a format
Peter Eisentraut's avatar
Peter Eisentraut committed
2817
	mask. It uses the default format mask of <productname>Informix</productname> which is
2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169
	<literal>mm/dd/yyyy</>. Internally, this function is implemented by
	means of <function>rdefmtdate</>. Therefore, <function>rstrdate</> is
	not faster and if you have the choice you should opt for
	<function>rdefmtdate</> which allows you to specify the format mask
	explicitly.
       </para>
       <para>
        The function returns the same values as <function>rdefmtdate</>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rtoday</></term>
      <listitem>
       <para>
        Get the current date.
<synopsis>
void rtoday(date *d);
</synopsis>
	The function receives a pointer to a date variable (<literal>d</>)
	that it sets to the current date.
       </para>
       <para>
	Internally this function uses the <xref linkend="PGTYPESdatetoday">
	function.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rjulmdy</></term>
      <listitem>
       <para>
	Extract the values for the day, the month and the year from a variable
	of type date.
<synopsis>
int rjulmdy(date d, short mdy[3]);
</synopsis>
	The function receives the date <literal>d</> and a pointer to an array
	of 3 short integer values <literal>mdy</>. The variable name indicates
	the sequential order: <literal>mdy[0]</> will be set to contain the
	number of the month, <literal>mdy[1]</> will be set to the value of the
	day and <literal>mdy[2]</> will contain the year.
       </para>
       <para>
        The function always returns 0 at the moment.
       </para>
       <para>
	Internally the function uses the <xref linkend="PGTYPESdatejulmdy">
	function.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rdefmtdate</></term>
      <listitem>
       <para>
	Use a format mask to convert a character string to a value of type
	date.
<synopsis>
int rdefmtdate(date *d, char *fmt, char *str);
</synopsis>
	The function receives a pointer to the date value that should hold the
	result of the operation (<literal>d</>), the format mask to use for
	parsing the date (<literal>fmt</>) and the C char* string containing
	the textual representation of the date (<literal>str</>). The textual
	representation is expected to match the format mask. However you do not
	need to have a 1:1 mapping of the string to the format mask. The
	function only analyzes the sequential order and looks for the literals
	<literal>yy</literal> or <literal>yyyy</literal> that indicate the
	position of the year, <literal>mm</literal> to indicate the position of
	the month and <literal>dd</literal> to indicate the position of the
	day.
       </para>
       <para>
        The function returns the following values:
        <itemizedlist>
         <listitem>
          <para>
           0 - The function terminated successfully.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>ECPG_INFORMIX_ENOSHORTDATE</> - The date does not contain
	   delimiters between day, month and year. In this case the input
	   string must be exactly 6 or 8 bytes long but isn't.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>ECPG_INFORMIX_ENOTDMY</> - The format string did not
	   correctly indicate the sequential order of year, month and day.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>ECPG_INFORMIX_BAD_DAY</> - The input string does not
	   contain a valid day.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>ECPG_INFORMIX_BAD_MONTH</> - The input string does not
	   contain a valid month.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>ECPG_INFORMIX_BAD_YEAR</> - The input string does not
	   contain a valid year.
          </para>
         </listitem>
	</itemizedlist>
       </para>
       <para>
	Internally this function is implemented to use the <xref
	linkend="PGTYPESdatedefmtasc"> function. See the reference there for a
	table of example input.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rfmtdate</></term>
      <listitem>
       <para>
	Convert a variable of type date to its textual representation using a
	format mask.
<synopsis>
int rfmtdate(date d, char *fmt, char *str);
</synopsis>
	The function receives the date to convert (<literal>d</>), the format
	mask (<literal>fmt</>) and the string that will hold the textual
	representation of the date (<literal>str</>).
       </para>
       <para>
        On success, 0 is returned and a negative value if an error occurred.
       </para>
       <para>
	Internally this function uses the <xref linkend="PGTYPESdatefmtasc">
	function, see the reference there for examples.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rmdyjul</></term>
      <listitem>
       <para>
	Create a date value from an array of 3 short integers that specify the
	day, the month and the year of the date.
<synopsis>
int rmdyjul(short mdy[3], date *d);
</synopsis>
	The function receives the array of the 3 short integers
	(<literal>mdy</>) and a pointer to a variable of type date that should
	hold the result of the operation.
       </para>
       <para>
        Currently the function returns always 0.
       </para>
       <para>
	Internally the function is implemented to use the function <xref
	linkend="PGTYPESdatemdyjul">.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rdayofweek</></term>
      <listitem>
       <para>
        Return a number representing the day of the week for a date value.
<synopsis>
int rdayofweek(date d);
</synopsis>
	The function receives the date variable <literal>d</> as its only
	argument and returns an integer that indicates the day of the week for
	this date.
        <itemizedlist>
         <listitem>
          <para>
	   0 - Sunday
          </para>
         </listitem>
         <listitem>
          <para>
	   1 - Monday
          </para>
         </listitem>
         <listitem>
          <para>
	   2 - Tuesday
          </para>
         </listitem>
         <listitem>
          <para>
	   3 - Wednesday
          </para>
         </listitem>
         <listitem>
          <para>
	   4 - Thursday
          </para>
         </listitem>
         <listitem>
          <para>
	   5 - Friday
          </para>
         </listitem>
         <listitem>
          <para>
	   6 - Saturday
          </para>
         </listitem>
        </itemizedlist>
       </para>
       <para>
	Internally the function is implemented to use the function <xref
	linkend="PGTYPESdatedayofweek">.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dtcurrent</></term>
      <listitem>
       <para>
        Retrieve the current timestamp.
<synopsis>
void dtcurrent(timestamp *ts);
</synopsis>
	The function retrieves the current timestamp and saves it into the
	timestamp variable that <literal>ts</> points to.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dtcvasc</></term>
      <listitem>
       <para>
	Parses a timestamp from its textual representation in ANSI standard
	into a timestamp variable.
<synopsis>
int dtcvasc(char *str, timestamp *ts);
</synopsis>
	The function receives the string to parse (<literal>str</>) and a
	pointer to the timestamp variable that should hold the result of the
	operation (<literal>ts</>).
       </para>
       <para>
	The function returns 0 on success and a negative value in case of
	error.
       </para>
       <para>
	Internally this function uses the <xref
	linkend="PGTYPEStimestampfromasc"> function. See the reference there
	for a table with example inputs.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dtcvfmtasc</></term>
      <listitem>
       <para>
	Parses a timestamp from its textual representation in ANSI standard
	using a format mask into a timestamp variable.
<synopsis>
dtcvfmtasc(char *inbuf, char *fmtstr, timestamp *dtvalue)
</synopsis>
	The function receives the string to parse (<literal>inbuf</>), the
	format mask to use (<literal>fmtstr</>) and a pointer to the timestamp
	variable that should hold the result of the operation (<literal>ts</>).
       </para>
       <para>
	This functions is implemented by means of the <xref
	linkend="PGTYPEStimestampdefmtasc">. See the documentation
	there for a list of format specifiers that can be used.
       </para>
       <para>
	The function returns 0 on success and a negative value in case of
	error.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dtsub</></term>
      <listitem>
       <para>
	Subtract one timestamp from another and return a variable of type
	interval.
<synopsis>
int dtsub(timestamp *ts1, timestamp *ts2, interval *iv);
</synopsis>
	The function will subtract the timestamp variable that <literal>ts2</>
	points to from the timestamp variable that <literal>ts1</> points to
	and will store the result in the interval variable that <literal>iv</>
	points to.
       </para>
       <para>
	Upon success, the function returns 0 and a negative value if an
	error occurred.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dttoasc</></term>
      <listitem>
       <para>
        Convert a timestamp variable to a C char* string.
<synopsis>
int dttoasc(timestamp *ts, char *output);
</synopsis>
	The function receives a pointer to the timestamp variable to convert
	(<literal>ts</>) and the string that should hold the result of the
	operation <literal>output</>). It converts <literal>ts</> to its
	textual representation in the ANSI SQL standard which is defined to
	be <literal>YYYY-MM-DD HH:MM:SS</literal>.
       </para>
       <para>
	Upon success, the function returns 0 and a negative value if an
	error occurred.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>dttofmtasc</></term>
      <listitem>
       <para>
        Convert a timestamp variable to a C char* using a format mask.
<synopsis>
int dttofmtasc(timestamp *ts, char *output, int str_len, char *fmtstr);
</synopsis>
	The function receives a pointer to the timestamp to convert as its
	first argument (<literal>ts</>), a pointer to the output buffer
	(<literal>output</>), the maximal length that has been allocated for
	the output buffer (<literal>str_len</literal>) and the format mask to
	use for the conversion (<literal>fmtstr</literal>).
       </para>
       <para>
	Upon success, the function returns 0 and a negative value if an
	error occurred.
       </para>
       <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3170
	Internally, this function uses the <xref
3171
	linkend="PGTYPEStimestampfmtasc"> function. See the reference there for
Peter Eisentraut's avatar
Peter Eisentraut committed
3172
	information on what format mask specifiers can be used.
3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>intoasc</></term>
      <listitem>
       <para>
        Convert an interval variable to a C char* string.
<synopsis>
int intoasc(interval *i, char *str);
</synopsis>
	The function receives a pointer to the interval variable to convert
	(<literal>i</>) and the string that should hold the result of the
	operation <literal>str</>). It converts <literal>i</> to its
	textual representation in the ANSI SQL standard which is defined to
	be <literal>YYYY-MM-DD HH:MM:SS</literal>.
       </para>
       <para>
	Upon success, the function returns 0 and a negative value if an
	error occurred.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rfmtlong</></term>
      <listitem>
       <para>
	Convert a long integer value to its textual representation using a
	format mask.
<synopsis>
int rfmtlong(long lng_val, char *fmt, char *outbuf);
</synopsis>
	The function receives the long value <literal>lng_val</>, the format
	mask <literal>fmt</> and a pointer to the output buffer
	<literal>outbuf</>. It converts the long value according to the format
	mask to its textual representation.
       </para>
       <para>
	The format mask can be composed of the following format specifying
	characters:
        <itemizedlist>
         <listitem>
          <para>
	   <literal>*</literal> (asterisk) - if this position would be blank
	   otherwise, fill it with an asterisk.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>&amp;</literal> (ampersand) - if this position would be
	   blank otherwise, fill it with a zero.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>#</literal> - turn leading zeroes into blanks.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>&lt;</literal> - left-justify the number in the string.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>,</literal> (comma) - group numbers of four or more digits
	   into groups of three digits separated by a comma.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>.</literal> (period) - this character separates the
	   whole-number part of the number from the fractional part.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>-</literal> (minus) - the minus sign appears if the number
	   is a negative value.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>+</literal> (plus) - the plus sign appears if the number is
	   a positive value.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>(</literal> - this replaces the minus sign in front of the
	   negative number. The minus sign will not appear.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>)</literal> - this character replaces the minus and is
	   printed behind the negative value.
          </para>
         </listitem>
         <listitem>
          <para>
	   <literal>$</literal> - the currency symbol.
          </para>
         </listitem>
	</itemizedlist>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rupshift</></term>
      <listitem>
       <para>
        Convert a string to upper case.
<synopsis>
void rupshift(char *str);
</synopsis>
	The function receives a pointer to the string and transforms every
	lower case character to upper case.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>byleng</></term>
      <listitem>
       <para>
	Return the number of characters in a string without counting trailing
	blanks.
<synopsis>
int byleng(char *str, int len);
</synopsis>
	The function expects a fixed-length string as its first argument
	(<literal>str</>) and its length as its second argument
	(<literal>len</>). It returns the number of significant characters,
	that is the length of the string without trailing blanks.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>ldchar</></term>
      <listitem>
       <para>
        Copy a fixed-length string into a null-terminated string.
<synopsis>
void ldchar(char *src, int len, char *dest);
</synopsis>
	The function receives the fixed-length string to copy
	(<literal>src</>), its length (<literal>len</>) and a pointer to the
	destination memory (<literal>dest</>). Note that you need to reserve at
	least <literal>len+1</> bytes for the string that <literal>dest</>
	points to. The function copies at most <literal>len</> bytes to the new
	location (less if the source string has trailing blanks) and adds the
	null-terminator.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rgetmsg</></term>
      <listitem>
       <para>
<synopsis>
int rgetmsg(int msgnum, char *s, int maxsize);
</synopsis>
        This function exists but is not implemented at the moment!
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rtypalign</></term>
      <listitem>
       <para>
<synopsis>
int rtypalign(int offset, int type);
</synopsis>
        This function exists but is not implemented at the moment!
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rtypmsize</></term>
      <listitem>
       <para>
<synopsis>
int rtypmsize(int type, int len);
</synopsis>
        This function exists but is not implemented at the moment!
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>rtypwidth</></term>
      <listitem>
       <para>
<synopsis>
int rtypwidth(int sqltype, int sqllen);
</synopsis>
        This function exists but is not implemented at the moment!
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="rsetnull">
      <term><function>rsetnull</></term>
      <listitem>
       <para>
        Set a variable to NULL.
<synopsis>
int rsetnull(int t, char *ptr);
</synopsis>
	The function receives an integer that indicates the type of the
	variable and a pointer to the variable itself that is casted to a C
	char* pointer.
       </para>
       <para>
        The following types exist:
        <itemizedlist>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3399
	   <literal>CCHARTYPE</literal> - For a variable of type <type>char</type> or <type>char*</type>
3400 3401 3402 3403
          </para>
         </listitem>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3404
	   <literal>CSHORTTYPE</literal> - For a variable of type <type>short int</type>
3405 3406 3407 3408
          </para>
         </listitem>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3409
	   <literal>CINTTYPE</literal> - For a variable of type <type>int</type>
3410 3411 3412 3413
          </para>
         </listitem>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3414
	   <literal>CBOOLTYPE</literal> - For a variable of type <type>boolean</type>
3415 3416 3417 3418
          </para>
         </listitem>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3419
	   <literal>CFLOATTYPE</literal> - For a variable of type <type>float</type>
3420 3421 3422 3423
          </para>
         </listitem>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3424
	   <literal>CLONGTYPE</literal> - For a variable of type <type>long</type>
3425 3426 3427 3428
          </para>
         </listitem>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3429
	   <literal>CDOUBLETYPE</literal> - For a variable of type <type>double</type>
3430 3431 3432 3433
          </para>
         </listitem>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3434
	   <literal>CDECIMALTYPE</literal> - For a variable of type <type>decimal</type>
3435 3436 3437 3438
          </para>
         </listitem>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3439
	   <literal>CDATETYPE</literal> - For a variable of type <type>date</type>
3440 3441 3442 3443
          </para>
         </listitem>
         <listitem>
          <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
3444
	   <literal>CDTIMETYPE</literal> - For a variable of type <type>timestamp</type>
3445 3446 3447
          </para>
         </listitem>
        </itemizedlist>
Tom Lane's avatar
Tom Lane committed
3448 3449
       </para>

3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497
       <para>
        Here is an example of a call to this function:
<programlisting>
$char c[] = "abc       ";
$short s = 17;
$int i = -74874;

rsetnull(CCHARTYPE, (char *) c);
rsetnull(CSHORTTYPE, (char *) &amp;s);
rsetnull(CINTTYPE, (char *) &amp;i);
</programlisting>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><function>risnull</></term>
      <listitem>
       <para>
        Test if a variable is NULL.
<synopsis>
int risnull(int t, char *ptr);
</synopsis>
	The function receives the type of the variable to test (<literal>t</>)
	as well a pointer to this variable (<literal>ptr</>). Note that the
	latter needs to be casted to a char*. See the function <xref
	linkend="rsetnull"> for a list of possible variable types.
       </para>
       <para>
        Here is an example of how to use this function:
<programlisting>
$char c[] = "abc       ";
$short s = 17;
$int i = -74874;

risnull(CCHARTYPE, (char *) c);
risnull(CSHORTTYPE, (char *) &amp;s);
risnull(CINTTYPE, (char *) &amp;i);
</programlisting>
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect2>

  <sect2>
   <title>Additional constants</title>
3498
   <para>
3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510
    Note that all constants here describe errors and all of them are defined
    to represent negative values. In the descriptions of the different
    constants you can also find the value that the constants represent in the
    current implementation. However you should not rely on this number. You can
    however rely on the fact all of them are defined to represent negative
    values.
    <variablelist>
     <varlistentry>
      <term><literal>ECPG_INFORMIX_NUM_OVERFLOW</></term>
      <listitem>
       <para>
	Functions return this value if an overflow occurred in a
Peter Eisentraut's avatar
Peter Eisentraut committed
3511
	calculation. Internally it is defined to -1200 (the <productname>Informix</productname>
3512 3513 3514 3515
	definition).
       </para>
      </listitem>
     </varlistentry>
3516

3517 3518 3519 3520 3521
     <varlistentry>
      <term><literal>ECPG_INFORMIX_NUM_UNDERFLOW</></term>
      <listitem>
       <para>
	Functions return this value if an underflow occurred in a calculation.
Peter Eisentraut's avatar
Peter Eisentraut committed
3522
	Internally it is defined to -1201 (the <productname>Informix</productname> definition).
3523 3524 3525
       </para>
      </listitem>
     </varlistentry>
3526

3527 3528 3529 3530 3531
     <varlistentry>
      <term><literal>ECPG_INFORMIX_DIVIDE_ZERO</></term>
      <listitem>
       <para>
	Functions return this value if an attempt to divide by zero is
Peter Eisentraut's avatar
Peter Eisentraut committed
3532
	observed. Internally it is defined to -1202 (the <productname>Informix</productname> definition).
3533 3534 3535
       </para>
      </listitem>
     </varlistentry>
3536

3537 3538 3539 3540 3541
     <varlistentry>
      <term><literal>ECPG_INFORMIX_BAD_YEAR</></term>
      <listitem>
       <para>
	Functions return this value if a bad value for a year was found while
Peter Eisentraut's avatar
Peter Eisentraut committed
3542
	parsing a date. Internally it is defined to -1204 (the <productname>Informix</productname>
3543 3544 3545 3546
	definition).
       </para>
      </listitem>
     </varlistentry>
3547

3548 3549 3550 3551 3552
     <varlistentry>
      <term><literal>ECPG_INFORMIX_BAD_MONTH</></term>
      <listitem>
       <para>
	Functions return this value if a bad value for a month was found while
Peter Eisentraut's avatar
Peter Eisentraut committed
3553
	parsing a date. Internally it is defined to -1205 (the <productname>Informix</productname>
3554 3555 3556 3557
	definition).
       </para>
      </listitem>
     </varlistentry>
3558

3559 3560 3561 3562 3563
     <varlistentry>
      <term><literal>ECPG_INFORMIX_BAD_DAY</></term>
      <listitem>
       <para>
	Functions return this value if a bad value for a day was found while
Peter Eisentraut's avatar
Peter Eisentraut committed
3564
	parsing a date. Internally it is defined to -1206 (the <productname>Informix</productname>
3565 3566 3567 3568
	definition).
       </para>
      </listitem>
     </varlistentry>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
3569

3570 3571 3572 3573 3574 3575
     <varlistentry>
      <term><literal>ECPG_INFORMIX_ENOSHORTDATE</></term>
      <listitem>
       <para>
	Functions return this value if a parsing routine needs a short date
	representation but did not get the date string in the right length.
Peter Eisentraut's avatar
Peter Eisentraut committed
3576
	Internally it is defined to -1209 (the <productname>Informix</productname> definition).
3577 3578 3579
       </para>
      </listitem>
     </varlistentry>
3580

3581 3582 3583 3584 3585
     <varlistentry>
      <term><literal>ECPG_INFORMIX_DATE_CONVERT</></term>
      <listitem>
       <para>
	Functions return this value if Internally it is defined to -1210 (the
Peter Eisentraut's avatar
Peter Eisentraut committed
3586
	<productname>Informix</productname> definition).
3587 3588 3589
       </para>
      </listitem>
     </varlistentry>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
3590

3591 3592 3593 3594 3595
     <varlistentry>
      <term><literal>ECPG_INFORMIX_OUT_OF_MEMORY</></term>
      <listitem>
       <para>
	Functions return this value if Internally it is defined to -1211 (the
Peter Eisentraut's avatar
Peter Eisentraut committed
3596
	<productname>Informix</productname> definition).
3597 3598 3599
       </para>
      </listitem>
     </varlistentry>
3600

3601 3602 3603 3604 3605 3606
     <varlistentry>
      <term><literal>ECPG_INFORMIX_ENOTDMY</></term>
      <listitem>
       <para>
	Functions return this value if a parsing routine was supposed to get a
	format mask (like <literal>mmddyy</>) but not all fields were listed
Peter Eisentraut's avatar
Peter Eisentraut committed
3607
	correctly. Internally it is defined to -1212 (the <productname>Informix</productname> definition).
3608 3609 3610
       </para>
      </listitem>
     </varlistentry>
3611

3612 3613 3614 3615 3616 3617 3618 3619
     <varlistentry>
      <term><literal>ECPG_INFORMIX_BAD_NUMERIC</></term>
      <listitem>
       <para>
	Functions return this value either if a parsing routine cannot parse
	the textual representation for a numeric value because it contains
	errors or if a routine cannot complete a calculation involving numeric
	variables because at least one of the numeric variables is invalid.
Peter Eisentraut's avatar
Peter Eisentraut committed
3620
	Internally it is defined to -1213 (the <productname>Informix</productname> definition).
3621 3622 3623
       </para>
      </listitem>
     </varlistentry>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
3624

3625 3626 3627 3628 3629
     <varlistentry>
      <term><literal>ECPG_INFORMIX_BAD_EXPONENT</></term>
      <listitem>
       <para>
	Functions return this value if Internally it is defined to -1216 (the
Peter Eisentraut's avatar
Peter Eisentraut committed
3630
	<productname>Informix</productname> definition).
3631 3632 3633 3634 3635 3636 3637 3638 3639
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>ECPG_INFORMIX_BAD_DATE</></term>
      <listitem>
       <para>
	Functions return this value if Internally it is defined to -1218 (the
Peter Eisentraut's avatar
Peter Eisentraut committed
3640
	<productname>Informix</productname> definition).
3641 3642 3643 3644 3645 3646 3647 3648 3649
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>ECPG_INFORMIX_EXTRA_CHARS</></term>
      <listitem>
       <para>
	Functions return this value if Internally it is defined to -1264 (the
Peter Eisentraut's avatar
Peter Eisentraut committed
3650
	<productname>Informix</productname> definition).
3651 3652 3653 3654 3655 3656
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </sect2>
3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667
 </sect1>

 <sect1 id="ecpg-descriptors">
  <title>Using SQL Descriptor Areas</title>

  <para>
   An SQL descriptor area is a more sophisticated method for
   processing the result of a <command>SELECT</command> or
   <command>FETCH</command> statement.  An SQL descriptor area groups
   the data of one row of data together with metadata items into one
   data structure.  The metadata is particularly useful when executing
3668
   dynamic SQL statements, where the nature of the result columns might
3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682
   not be known ahead of time.
  </para>

  <para>
   An SQL descriptor area consists of a header, which contains
   information concerning the entire descriptor, and one or more item
   descriptor areas, which basically each describe one column in the
   result row.
  </para>

  <para>
   Before you can use an SQL descriptor area, you need to allocate one:
<programlisting>
EXEC SQL ALLOCATE DESCRIPTOR <replaceable>identifier</replaceable>;
3683
</programlisting>
3684
   The identifier serves as the <quote>variable name</quote> of the
3685
   descriptor area.  <remark>The scope of the allocated descriptor is WHAT?.</remark>
3686 3687
   When you don't need the descriptor anymore, you should deallocate
   it:
3688
<programlisting>
3689
EXEC SQL DEALLOCATE DESCRIPTOR <replaceable>identifier</replaceable>;
3690 3691
</programlisting>
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
3692

3693
  <para>
3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722
   To use a descriptor area, specify it as the storage target in an
   <literal>INTO</literal> clause, instead of listing host variables:
<programlisting>
EXEC SQL FETCH NEXT FROM mycursor INTO DESCRIPTOR mydesc;
</programlisting>
  </para>

  <para>
   Now how do you get the data out of the descriptor area?  You can
   think of the descriptor area as a structure with named fields.  To
   retrieve the value of a field from the header and store it into a
   host variable, use the following command:
<programlisting>
EXEC SQL GET DESCRIPTOR <replaceable>name</replaceable> :<replaceable>hostvar</replaceable> = <replaceable>field</replaceable>;
</programlisting>
   Currently, there is only one header field defined:
   <replaceable>COUNT</replaceable>, which tells how many item
   descriptor areas exist (that is, how many columns are contained in
   the result).  The host variable needs to be of an integer type.  To
   get a field from the item descriptor area, use the following
   command:
<programlisting>
EXEC SQL GET DESCRIPTOR <replaceable>name</replaceable> VALUE <replaceable>num</replaceable> :<replaceable>hostvar</replaceable> = <replaceable>field</replaceable>;
</programlisting>
   <replaceable>num</replaceable> can be a literal integer or a host
   variable containing an integer. Possible fields are:

   <variablelist>
    <varlistentry>
3723
     <term><literal>CARDINALITY</literal> (integer)</term>
3724 3725 3726 3727 3728 3729 3730 3731
     <listitem>
      <para>
       number of rows in the result set
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3732
     <term><literal>DATA</literal></term>
3733 3734 3735 3736 3737 3738 3739 3740 3741
     <listitem>
      <para>
       actual data item (therefore, the data type of this field
       depends on the query)
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3742
     <term><literal>DATETIME_INTERVAL_CODE</literal> (integer)</term>
3743 3744 3745 3746 3747 3748 3749 3750
     <listitem>
      <para>
       ?
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3751
     <term><literal>DATETIME_INTERVAL_PRECISION</literal> (integer)</term>
3752 3753 3754 3755 3756 3757 3758 3759
     <listitem>
      <para>
       not implemented
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3760
     <term><literal>INDICATOR</literal> (integer)</term>
3761 3762 3763 3764 3765 3766 3767 3768
     <listitem>
      <para>
       the indicator (indicating a null value or a value truncation)
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3769
     <term><literal>KEY_MEMBER</literal> (integer)</term>
3770 3771 3772 3773 3774 3775 3776 3777
     <listitem>
      <para>
       not implemented
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3778
     <term><literal>LENGTH</literal> (integer)</term>
3779 3780 3781 3782 3783 3784 3785 3786
     <listitem>
      <para>
       length of the datum in characters
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3787
     <term><literal>NAME</literal> (string)</term>
3788 3789 3790 3791 3792 3793 3794 3795
     <listitem>
      <para>
       name of the column
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3796
     <term><literal>NULLABLE</literal> (integer)</term>
3797 3798 3799 3800 3801 3802 3803 3804
     <listitem>
      <para>
       not implemented
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3805
     <term><literal>OCTET_LENGTH</literal> (integer)</term>
3806 3807 3808 3809 3810 3811 3812 3813
     <listitem>
      <para>
       length of the character representation of the datum in bytes
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3814
     <term><literal>PRECISION</literal> (integer)</term>
3815 3816 3817 3818 3819 3820 3821 3822
     <listitem>
      <para>
       precision (for type <type>numeric</type>)
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3823
     <term><literal>RETURNED_LENGTH</literal> (integer)</term>
3824 3825 3826 3827 3828 3829 3830 3831
     <listitem>
      <para>
       length of the datum in characters
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3832
     <term><literal>RETURNED_OCTET_LENGTH</literal> (integer)</term>
3833 3834 3835 3836 3837 3838 3839 3840
     <listitem>
      <para>
       length of the character representation of the datum in bytes
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3841
     <term><literal>SCALE</literal> (integer)</term>
3842 3843 3844 3845 3846 3847 3848 3849
     <listitem>
      <para>
       scale (for type <type>numeric</type>)
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
3850
     <term><literal>TYPE</literal> (integer)</term>
3851 3852 3853 3854 3855 3856 3857
     <listitem>
      <para>
       numeric code of the data type of the column
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
3858 3859
  </para>
 </sect1>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
3860

3861 3862
 <sect1 id="ecpg-errors">
  <title>Error Handling</title>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
3863

3864
  <para>
3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876
   This section describes how you can handle exceptional conditions
   and warnings in an embedded SQL program.  There are several
   nonexclusive facilities for this.
  </para>

  <sect2>
   <title>Setting Callbacks</title>

   <para>
    One simple method to catch errors and warnings is to set a
    specific action to be executed whenever a particular condition
    occurs.  In general:
3877
<programlisting>
3878
EXEC SQL WHENEVER <replaceable>condition</replaceable> <replaceable>action</replaceable>;
3879
</programlisting>
3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965
   </para>

   <para>
    <replaceable>condition</replaceable> can be one of the following:

    <variablelist>
     <varlistentry>
      <term><literal>SQLERROR</literal></term>
      <listitem>
       <para>
        The specified action is called whenever an error occurs during
        the execution of an SQL statement.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>SQLWARNING</literal></term>
      <listitem>
       <para>
        The specified action is called whenever a warning occurs
        during the execution of an SQL statement.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>NOT FOUND</literal></term>
      <listitem>
       <para>
        The specified action is called whenever an SQL statement
        retrieves or affects zero rows.  (This condition is not an
        error, but you might be interested in handling it specially.)
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>

   <para>
    <replaceable>action</replaceable> can be one of the following:

    <variablelist>
     <varlistentry>
      <term><literal>CONTINUE</literal></term>
      <listitem>
       <para>
        This effectively means that the condition is ignored.  This is
        the default.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>GOTO <replaceable>label</replaceable></literal></term>
      <term><literal>GO TO <replaceable>label</replaceable></literal></term>
      <listitem>
       <para>
        Jump to the specified label (using a C <literal>goto</literal>
        statement).
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>SQLPRINT</literal></term>
      <listitem>
       <para>
        Print a message to standard error.  This is useful for simple
        programs or during prototyping.  The details of the message
        cannot be configured.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>STOP</literal></term>
      <listitem>
       <para>
        Call <literal>exit(1)</literal>, which will terminate the
        program.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
3966
      <term><literal>DO BREAK</literal></term>
3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993
      <listitem>
       <para>
        Execute the C statement <literal>break</literal>.  This should
        only be used in loops or <literal>switch</literal> statements.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><literal>CALL <replaceable>name</replaceable> (<replaceable>args</replaceable>)</literal></term>
      <term><literal>DO <replaceable>name</replaceable> (<replaceable>args</replaceable>)</literal></term>
      <listitem>
       <para>
        Call the specified C functions with the specified arguments.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>

    The SQL standard only provides for the actions
    <literal>CONTINUE</literal> and <literal>GOTO</literal> (and
    <literal>GO TO</literal>).
   </para>

   <para>
    Here is an example that you might want to use in a simple program.
    It prints a simple message when a warning occurs and aborts the
3994
    program when an error happens:
3995
<programlisting>
3996 3997
EXEC SQL WHENEVER SQLWARNING SQLPRINT;
EXEC SQL WHENEVER SQLERROR STOP;
3998
</programlisting>
3999
   </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4000

4001
   <para>
4002 4003 4004 4005 4006 4007 4008
    The statement <literal>EXEC SQL WHENEVER</literal> is a directive
    of the SQL preprocessor, not a C statement.  The error or warning
    actions that it sets apply to all embedded SQL statements that
    appear below the point where the handler is set, unless a
    different action was set for the same condition between the first
    <literal>EXEC SQL WHENEVER</literal> and the SQL statement causing
    the condition, regardless of the flow of control in the C program.
4009
    So neither of the two following C program excerpts will have the
4010
    desired effect:
4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044
<programlisting>
/*
 * WRONG
 */
int main(int argc, char *argv[])
{
    ...
    if (verbose) {
        EXEC SQL WHENEVER SQLWARNING SQLPRINT;
    }
    ...
    EXEC SQL SELECT ...;
    ...
}
</programlisting>

<programlisting>
/*
 * WRONG
 */
int main(int argc, char *argv[])
{
    ...
    set_error_handler();
    ...
    EXEC SQL SELECT ...;
    ...
}

static void set_error_handler(void)
{
    EXEC SQL WHENEVER SQLERROR STOP;
}
</programlisting>
4045
   </para>
4046
  </sect2>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4047

4048 4049 4050 4051
  <sect2>
   <title>sqlca</title>

   <para>
4052
    For more powerful error handling, the embedded SQL interface
4053 4054
    provides a global variable with the name <varname>sqlca</varname>
    that has the following structure:
4055
<programlisting>
4056
struct
4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068
{
    char sqlcaid[8];
    long sqlabc;
    long sqlcode;
    struct
    {
        int sqlerrml;
        char sqlerrmc[70];
    } sqlerrm;
    char sqlerrp[8];
    long sqlerrd[6];
    char sqlwarn[8];
4069
    char sqlstate[5];
4070 4071
} sqlca;
</programlisting>
4072
    (In a multithreaded program, every thread automatically gets its
4073
    own copy of <varname>sqlca</varname>.  This works similarly to the
4074 4075 4076
    handling of the standard C global variable
    <varname>errno</varname>.)
   </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4077

4078 4079 4080 4081 4082 4083
   <para>
    <varname>sqlca</varname> covers both warnings and errors.  If
    multiple warnings or errors occur during the execution of a
    statement, then <varname>sqlca</varname> will only contain
    information about the last one.
   </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4084

4085 4086 4087 4088
   <para>
    If no error occurred in the last <acronym>SQL</acronym> statement,
    <literal>sqlca.sqlcode</literal> will be 0 and
    <literal>sqlca.sqlstate</literal> will be
4089
    <literal>"00000"</literal>.  If a warning or error occurred, then
4090 4091 4092 4093 4094 4095 4096 4097
    <literal>sqlca.sqlcode</literal> will be negative and
    <literal>sqlca.sqlstate</literal> will be different from
    <literal>"00000"</literal>.  A positive
    <literal>sqlca.sqlcode</literal> indicates a harmless condition,
    such as that the last query returned zero rows.
    <literal>sqlcode</literal> and <literal>sqlstate</literal> are two
    different error code schemes; details appear below.
   </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4098

4099 4100 4101 4102 4103 4104 4105
   <para>
    If the last SQL statement was successful, then
    <literal>sqlca.sqlerrd[1]</literal> contains the OID of the
    processed row, if applicable, and
    <literal>sqlca.sqlerrd[2]</literal> contains the number of
    processed or returned rows, if applicable to the command.
   </para>
4106

4107 4108 4109 4110 4111 4112 4113 4114
   <para>
    In case of an error or warning,
    <literal>sqlca.sqlerrm.sqlerrmc</literal> will contain a string
    that describes the error.  The field
    <literal>sqlca.sqlerrm.sqlerrml</literal> contains the length of
    the error message that is stored in
    <literal>sqlca.sqlerrm.sqlerrmc</literal> (the result of
    <function>strlen()</function>, not really interesting for a C
4115 4116
    programmer).  Note that some messages are too long to fit in the
    fixed-size <literal>sqlerrmc</literal> array; they will be truncated.
4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141
   </para>

   <para>
    In case of a warning, <literal>sqlca.sqlwarn[2]</literal> is set
    to <literal>W</literal>.  (In all other cases, it is set to
    something different from <literal>W</literal>.)  If
    <literal>sqlca.sqlwarn[1]</literal> is set to
    <literal>W</literal>, then a value was truncated when it was
    stored in a host variable.  <literal>sqlca.sqlwarn[0]</literal> is
    set to <literal>W</literal> if any of the other elements are set
    to indicate a warning.
   </para>

   <para>
    The fields <structfield>sqlcaid</structfield>,
    <structfield>sqlcabc</structfield>,
    <structfield>sqlerrp</structfield>, and the remaining elements of
    <structfield>sqlerrd</structfield> and
    <structfield>sqlwarn</structfield> currently contain no useful
    information.
   </para>

   <para>
    The structure <varname>sqlca</varname> is not defined in the SQL
    standard, but is implemented in several other SQL database
4142
    systems.  The definitions are similar at the core, but if you want
4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153
    to write portable applications, then you should investigate the
    different implementations carefully.
   </para>
  </sect2>

  <sect2>
   <title><literal>SQLSTATE</literal> vs <literal>SQLCODE</literal></title>

   <para>
    The fields <literal>sqlca.sqlstate</literal> and
    <literal>sqlca.sqlcode</literal> are two different schemes that
4154 4155
    provide error codes.  Both are derived from the SQL standard, but
    <literal>SQLCODE</literal> has been marked deprecated in the SQL-92
4156
    edition of the standard and has been dropped in later editions.
4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168
    Therefore, new applications are strongly encouraged to use
    <literal>SQLSTATE</literal>.
   </para>

   <para>
    <literal>SQLSTATE</literal> is a five-character array.  The five
    characters contain digits or upper-case letters that represent
    codes of various error and warning conditions.
    <literal>SQLSTATE</literal> has a hierarchical scheme: the first
    two characters indicate the general class of the condition, the
    last three characters indicate a subclass of the general
    condition.  A successful state is indicated by the code
4169 4170
    <literal>00000</literal>.  The <literal>SQLSTATE</literal> codes are for
    the most part defined in the SQL standard.  The
4171 4172 4173
    <productname>PostgreSQL</productname> server natively supports
    <literal>SQLSTATE</literal> error codes; therefore a high degree
    of consistency can be achieved by using this error code scheme
4174 4175
    throughout all applications.  For further information see
    <xref linkend="errcodes-appendix">.
4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186
   </para>

   <para>
    <literal>SQLCODE</literal>, the deprecated error code scheme, is a
    simple integer.  A value of 0 indicates success, a positive value
    indicates success with additional information, a negative value
    indicates an error.  The SQL standard only defines the positive
    value +100, which indicates that the last command returned or
    affected zero rows, and no specific negative values.  Therefore,
    this scheme can only achieve poor portability and does not have a
    hierarchical code assignment.  Historically, the embedded SQL
4187 4188 4189 4190 4191
    processor for <productname>PostgreSQL</productname> has assigned
    some specific <literal>SQLCODE</literal> values for its use, which
    are listed below with their numeric value and their symbolic name.
    Remember that these are not portable to other SQL implementations.
    To simplify the porting of applications to the
4192 4193 4194 4195
    <literal>SQLSTATE</literal> scheme, the corresponding
    <literal>SQLSTATE</literal> is also listed.  There is, however, no
    one-to-one or one-to-many mapping between the two schemes (indeed
    it is many-to-many), so you should consult the global
4196 4197
    <literal>SQLSTATE</literal> listing in <xref linkend="errcodes-appendix">
    in each case.
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209
   </para>

   <para>
    These are the assigned <literal>SQLCODE</literal> values:

    <variablelist>
     <varlistentry>
      <term>-12 (<symbol>ECPG_OUT_OF_MEMORY</symbol>)</term>
      <listitem>
       <para>
        Indicates that your virtual memory is exhausted. (SQLSTATE
        YE001)
4210 4211 4212 4213 4214
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4215
     <term>-200 (<symbol>ECPG_UNSUPPORTED</symbol>)</term>
4216 4217
     <listitem>
      <para>
4218 4219 4220 4221
       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. (SQLSTATE YE002)
4222 4223 4224 4225 4226
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4227
     <term>-201 (<symbol>ECPG_TOO_MANY_ARGUMENTS</symbol>)</term>
4228 4229
     <listitem>
      <para>
4230 4231
       This means that the command specified more host variables than
       the command expected.  (SQLSTATE 07001 or 07002)
4232 4233 4234 4235 4236
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4237
     <term>-202 (<symbol>ECPG_TOO_FEW_ARGUMENTS</symbol>)</term>
4238 4239
     <listitem>
      <para>
4240 4241 4242
       This means that the command specified fewer host variables than
       the command expected.  (SQLSTATE 07001 or 07002)
      </para>
4243 4244 4245 4246
     </listitem>
    </varlistentry>

    <varlistentry>
4247
     <term>-203 (<symbol>ECPG_TOO_MANY_MATCHES</symbol>)</term>
4248 4249
     <listitem>
      <para>
4250 4251 4252
       This means a query has returned multiple rows but the statement
       was only prepared to store one result row (for example, because
       the specified variables are not arrays).  (SQLSTATE 21000)
4253 4254 4255 4256 4257
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4258
     <term>-204 (<symbol>ECPG_INT_FORMAT</symbol>)</term>
4259 4260
     <listitem>
      <para>
4261 4262 4263 4264 4265
       The host variable is of type <type>int</type> and the datum in
       the database is of a different type and contains a value that
       cannot be interpreted as an <type>int</type>.  The library uses
       <function>strtol()</function> for this conversion.  (SQLSTATE
       42804)
4266 4267 4268 4269 4270
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4271
     <term>-205 (<symbol>ECPG_UINT_FORMAT</symbol>)</term>
4272 4273
     <listitem>
      <para>
4274 4275 4276 4277 4278
       The host variable is of type <type>unsigned int</type> and the
       datum in the database is of a different type and contains a
       value that cannot be interpreted as an <type>unsigned
       int</type>.  The library uses <function>strtoul()</function>
       for this conversion.  (SQLSTATE 42804)
4279 4280 4281 4282 4283
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4284
     <term>-206 (<symbol>ECPG_FLOAT_FORMAT</symbol>)</term>
4285 4286
     <listitem>
      <para>
4287 4288 4289 4290 4291
       The host variable is of type <type>float</type> and the datum
       in the 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.
       (SQLSTATE 42804)
4292 4293 4294 4295 4296
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4297
     <term>-207 (<symbol>ECPG_CONVERT_BOOL</symbol>)</term>
4298 4299 4300
     <listitem>
      <para>
       This means the host variable is of type <type>bool</type> and
4301 4302
       the datum in the database is neither <literal>'t'</> nor
       <literal>'f'</>.  (SQLSTATE 42804)
4303 4304 4305 4306 4307
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4308
     <term>-208 (<symbol>ECPG_EMPTY</symbol>)</term>
4309 4310
     <listitem>
      <para>
4311 4312
       The statement sent to the <productname>PostgreSQL</productname>
       server was empty.  (This cannot normally happen in an embedded
4313
       SQL program, so it might point to an internal error.)  (SQLSTATE
4314
       YE002)
4315 4316 4317 4318 4319
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4320
     <term>-209 (<symbol>ECPG_MISSING_INDICATOR</symbol>)</term>
4321 4322 4323
     <listitem>
      <para>
       A null value was returned and no null indicator variable was
4324
       supplied.  (SQLSTATE 22002)
4325 4326 4327 4328 4329
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4330
     <term>-210 (<symbol>ECPG_NO_ARRAY</symbol>)</term>
4331 4332 4333
     <listitem>
      <para>
       An ordinary variable was used in a place that requires an
4334
       array.  (SQLSTATE 42804)
4335 4336 4337 4338 4339
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4340
     <term>-211 (<symbol>ECPG_DATA_NOT_ARRAY</symbol>)</term>
4341 4342 4343
     <listitem>
      <para>
       The database returned an ordinary variable in a place that
4344
       requires array value.  (SQLSTATE 42804)
4345 4346 4347 4348 4349
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4350
     <term>-220 (<symbol>ECPG_NO_CONN</symbol>)</term>
4351 4352 4353
     <listitem>
      <para>
       The program tried to access a connection that does not exist.
4354
       (SQLSTATE 08003)
4355 4356 4357 4358 4359
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4360
     <term>-221 (<symbol>ECPG_NOT_CONN</symbol>)</term>
4361 4362 4363
     <listitem>
      <para>
       The program tried to access a connection that does exist but is
4364
       not open.  (This is an internal error.)  (SQLSTATE YE002)
4365 4366 4367 4368 4369
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4370
     <term>-230 (<symbol>ECPG_INVALID_STMT</symbol>)</term>
4371 4372 4373
     <listitem>
      <para>
       The statement you are trying to use has not been prepared.
4374
       (SQLSTATE 26000)
4375 4376 4377 4378 4379
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4380
     <term>-240 (<symbol>ECPG_UNKNOWN_DESCRIPTOR</symbol>)</term>
4381 4382
     <listitem>
      <para>
4383 4384
       The descriptor specified was not found.  The statement you are
       trying to use has not been prepared.  (SQLSTATE 33000)
4385 4386 4387 4388 4389
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4390
     <term>-241 (<symbol>ECPG_INVALID_DESCRIPTOR_INDEX</symbol>)</term>
4391 4392
     <listitem>
      <para>
4393 4394
       The descriptor index specified was out of range.  (SQLSTATE
       07009)
4395 4396 4397 4398 4399
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4400
     <term>-242 (<symbol>ECPG_UNKNOWN_DESCRIPTOR_ITEM</symbol>)</term>
4401 4402
     <listitem>
      <para>
4403 4404
       An invalid descriptor item was requested.  (This is an internal
       error.)  (SQLSTATE YE002)
4405 4406 4407 4408 4409
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4410
     <term>-243 (<symbol>ECPG_VAR_NOT_NUMERIC</symbol>)</term>
4411 4412
     <listitem>
      <para>
4413 4414 4415
       During the execution of a dynamic statement, the database
       returned a numeric value and the host variable was not numeric.
       (SQLSTATE 07006)
4416 4417 4418 4419 4420
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4421
     <term>-244 (<symbol>ECPG_VAR_NOT_CHAR</symbol>)</term>
4422 4423
     <listitem>
      <para>
4424 4425 4426
       During the execution of a dynamic statement, the database
       returned a non-numeric value and the host variable was numeric.
       (SQLSTATE 07006)
4427 4428 4429 4430 4431
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4432
     <term>-400 (<symbol>ECPG_PGSQL</symbol>)</term>
4433 4434
     <listitem>
      <para>
4435 4436
       Some error caused by the <productname>PostgreSQL</productname>
       server.  The message contains the error message from the
4437
       <productname>PostgreSQL</productname> server.
4438 4439 4440 4441 4442
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4443
     <term>-401 (<symbol>ECPG_TRANS</symbol>)</term>
4444 4445
     <listitem>
      <para>
4446 4447 4448
       The <productname>PostgreSQL</productname> server signaled that
       we cannot start, commit, or rollback the transaction.
       (SQLSTATE 08007)
4449 4450 4451 4452 4453
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4454
     <term>-402 (<symbol>ECPG_CONNECT</symbol>)</term>
4455 4456
     <listitem>
      <para>
4457 4458
       The connection attempt to the database did not succeed.
       (SQLSTATE 08001)
4459 4460 4461 4462 4463
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
4464
     <term>100 (<symbol>ECPG_NOT_FOUND</symbol>)</term>
4465 4466
     <listitem>
      <para>
4467 4468 4469
       This is a harmless condition indicating that the last command
       retrieved or processed zero rows, or that you are at the end of
       the cursor.  (SQLSTATE 02000)
4470 4471 4472 4473 4474
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
4475
  </sect2>
4476
 </sect1>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4477

4478 4479
 <sect1 id="ecpg-preproc">
  <title>Preprocessor directives</title>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4480

4481 4482 4483 4484 4485
  <sect2>
   <title>Including files</title>

   <para>
    To include an external file into your embedded SQL program, use:
4486 4487 4488
<programlisting>
EXEC SQL INCLUDE <replaceable>filename</replaceable>;
</programlisting>
4489 4490 4491 4492 4493
    The embedded SQL preprocessor will look for a file named
    <literal><replaceable>filename</replaceable>.h</literal>,
    preprocess it, and include it in the resulting C output.  Thus,
    embedded SQL statements in the included file are handled correctly.
   </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4494

4495
   <para>
4496
    Note that this is <emphasis>not</emphasis> the same as:
4497 4498 4499
<programlisting>
#include &lt;<replaceable>filename</replaceable>.h&gt;
</programlisting>
4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537
    because this file would not be subject to SQL command preprocessing.
    Naturally, you can continue to use the C
    <literal>#include</literal> directive to include other header
    files.
   </para>

   <note>
    <para>
     The include file name is case-sensitive, even though the rest of
     the <literal>EXEC SQL INCLUDE</literal> command follows the normal
     SQL case-sensitivity rules.
    </para>
   </note>
  </sect2>

  <sect2>
   <title>The #define and #undef directives</title>
   <para>
    Similar to the directive <literal>#define</literal> that is known from C,
    embedded SQL has a similar concept:
<programlisting>
EXEC SQL DEFINE <replaceable>name</>;
EXEC SQL DEFINE <replaceable>name</> <replaceable>value</>;
</programlisting>
    So you can define a name:
<programlisting>
EXEC SQL DEFINE HAVE_FEATURE;
</programlisting>
    And you can also define constants:
<programlisting>
EXEC SQL DEFINE MYNUMBER 12;
EXEC SQL DEFINE MYSTRING 'abc';
</programlisting>
    Use <literal>undef</> to remove a previous definition:
<programlisting>
EXEC SQL UNDEF MYNUMBER;
</programlisting>
   </para>
4538

4539
   <para>
4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554
    Of course you can continue to use the C versions <literal>#define</literal>
    and <literal>#undef</literal> in your embedded SQL program. The difference
    is where your defined values get evaluated. If you use <literal>EXEC SQL
    DEFINE</> then the ecpg preprocessor evaluates the defines and substitutes
    the values. For example if you write:
<programlisting>
EXEC SQL DEFINE MYNUMBER 12;
...
EXEC SQL UPDATE Tbl SET col = MYNUMBER;
</programlisting>
    then ecpg will already do the substitution and your C compiler will never
    see any name or identifier <literal>MYNUMBER</>. Note that you can not use
    <literal>#define</literal> for a constant that you are going to use in an
    embedded SQL query because in this case the embedded SQL precompiler is not
    able to see this declaration.
4555
   </para>
4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616
  </sect2>

  <sect2>
   <title>ifdef, ifndef, else, elif and endif directives</title>
   <para>
   You can use the following directives to compile code sections conditionally:

   <variablelist>
    <varlistentry>
     <term><literal>EXEC SQL ifdef <replaceable>name</>;</literal></term>
     <listitem>
     <para>
      Checks a <replaceable>name</> and processes subsequent lines if
      <replaceable>name</> has been created with <literal>EXEC SQL define
      <replaceable>name</></literal>.
     </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><literal>EXEC SQL ifndef <replaceable>name</>;</literal></term>
     <listitem>
     <para>
      Checks a <replaceable>name</> and processes subsequent lines if
      <replaceable>name</> has <emphasis>not</emphasis> been created with
      <literal>EXEC SQL define <replaceable>name</></literal>.
     </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><literal>EXEC SQL else;</literal></term>
     <listitem>
     <para>
      Starts processing an alternative section to a section introduced by
      either <literal>EXEC SQL ifdef <replaceable>name</></literal> or
      <literal>EXEC SQL ifndef <replaceable>name</></literal>.
     </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><literal>EXEC SQL elif <replaceable>name</>;</literal></term>
     <listitem>
     <para>
      Checks <replaceable>name</> and starts an alternative section if
      <replaceable>name</> has been created with <literal>EXEC SQL define
      <replaceable>name</></literal>.
     </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><literal>EXEC SQL endif;</literal></term>
     <listitem>
     <para>
      Ends an alternative section.
     </para>
     </listitem>
    </varlistentry>
   </variablelist>
Tom Lane's avatar
Tom Lane committed
4617
   </para>
4618

4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635
   <para>
    Example:
<programlisting>
   exec sql ifndef TZVAR;
   exec sql SET TIMEZONE TO 'GMT';
   exec sql elif TZNAME;
   exec sql SET TIMEZONE TO TZNAME;
   exec sql else;
   exec sql SET TIMEZONE TO TZVAR;
   exec sql endif;
</programlisting>
   </para>

  </sect2>
 </sect1>
 
  <sect1 id="ecpg-process">
4636
  <title>Processing Embedded SQL Programs</title>
4637

4638 4639 4640 4641 4642 4643 4644 4645
  <para>
   Now that you have an idea how to form embedded SQL C programs, you
   probably want to know how to compile them.  Before compiling you
   run the file through the embedded <acronym>SQL</acronym>
   <acronym>C</acronym> preprocessor, which converts the
   <acronym>SQL</acronym> statements you used to special function
   calls.  After compiling, you must link with a special library that
   contains the needed functions. These functions fetch information
4646
   from the arguments, perform the <acronym>SQL</acronym> command using
4647 4648 4649
   the <application>libpq</application> interface, and put the result
   in the arguments specified for output.
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4650

4651 4652
  <para>
   The preprocessor program is called <filename>ecpg</filename> and is
Bruce Momjian's avatar
Bruce Momjian committed
4653 4654
   included in a normal <productname>PostgreSQL</> installation.
   Embedded SQL programs are typically named with an extension
4655 4656
   <filename>.pgc</filename>.  If you have a program file called
   <filename>prog1.pgc</filename>, you can preprocess it by simply
4657
   calling:
4658 4659 4660 4661 4662 4663 4664 4665
<programlisting>
ecpg prog1.pgc
</programlisting>
   This will create a file called <filename>prog1.c</filename>.  If
   your input files do not follow the suggested naming pattern, you
   can specify the output file explicitly using the
   <option>-o</option> option.
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4666

4667
  <para>
4668
   The preprocessed file can be compiled normally, for example:
4669 4670 4671
<programlisting>
cc -c prog1.c
</programlisting>
4672
   The generated C source files include header files from the
Bruce Momjian's avatar
Bruce Momjian committed
4673 4674 4675 4676 4677
   <productname>PostgreSQL</> installation, so if you installed
   <productname>PostgreSQL</> in a location that is not searched by
   default, you have to add an option such as
   <literal>-I/usr/local/pgsql/include</literal> to the compilation
   command line.
4678
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4679

4680 4681 4682 4683 4684 4685 4686 4687 4688
  <para>
   To link an embedded SQL program, you need to include the
   <filename>libecpg</filename> library, like so:
<programlisting>
cc -o myprog prog1.o prog2.o ... -lecpg
</programlisting>
   Again, you might have to add an option like
   <literal>-L/usr/local/pgsql/lib</literal> to that command line.
  </para>
4689

4690 4691
  <para>
   If you manage the build process of a larger project using
4692
   <application>make</application>, it might be convenient to include
4693 4694 4695
   the following implicit rule to your makefiles:
<programlisting>
ECPG = ecpg
4696

4697 4698 4699 4700
%.c: %.pgc
        $(ECPG) $<
</programlisting>
  </para>
4701

4702 4703
  <para>
   The complete syntax of the <command>ecpg</command> command is
4704
   detailed in <xref linkend="app-ecpg">.
4705
  </para>
4706 4707

  <para>
4708 4709 4710
   The <application>ecpg</application> library is thread-safe if it is built
   using the <option>--enable-thread-safety</> command-line option to
   <filename>configure</filename>.  (You might need to use other threading
4711 4712
   command-line options to compile your client code.)
  </para>
4713
 </sect1>
4714

4715 4716
 <sect1 id="ecpg-library">
  <title>Library Functions</title>
4717

4718 4719 4720 4721 4722 4723 4724
  <para>
   The <filename>libecpg</filename> library primarily contains
   <quote>hidden</quote> functions that are used to implement the
   functionality expressed by the embedded SQL commands.  But there
   are some functions that can usefully be called directly.  Note that
   this makes your code unportable.
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4725

4726 4727 4728 4729 4730 4731
  <itemizedlist>
   <listitem>
    <para>
     <function>ECPGdebug(int <replaceable>on</replaceable>, FILE
     *<replaceable>stream</replaceable>)</function> turns on debug
     logging if called with the first argument non-zero. Debug logging
4732 4733 4734 4735 4736 4737
     is done on <replaceable>stream</replaceable>.  The log contains
     all <acronym>SQL</acronym> statements with all the input
     variables inserted, and the results from the
     <productname>PostgreSQL</productname> server. This can be very
     useful when searching for errors in your <acronym>SQL</acronym>
     statements.
4738
    </para>
4739 4740
    <note>
    <para>
4741
    On Windows, if the <application>ecpg</> libraries and an application are
Bruce Momjian's avatar
Bruce Momjian committed
4742 4743
    compiled with different flags, this function call will crash the 
    application because the internal representation of the 
4744
    <literal>FILE</> pointers differ.  Specifically,
4745
    multithreaded/single-threaded, release/debug, and static/dynamic 
4746 4747
    flags should be the same for the library and all applications using
    that library.
4748 4749
    </para>
    </note>
4750
   </listitem>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4751

4752 4753
   <listitem>
    <para>
4754 4755 4756 4757 4758
     <function>ECPGstatus(int <replaceable>lineno</replaceable>,
     const char* <replaceable>connection_name</replaceable>)</function>
     returns true if you are connected to a database and false if not.
     <replaceable>connection_name</replaceable> can be <literal>NULL</> 
     if a single connection is being used.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4759
    </para>
4760 4761 4762
   </listitem>
  </itemizedlist>
 </sect1>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4763

4764
 <sect1 id="ecpg-develop">
4765
  <title>Internals</title>
4766 4767

  <para>
4768
   This section explains how <application>ECPG</application> works
4769
   internally. This information can occasionally be useful to help
4770
   users understand how to use <application>ECPG</application>.
4771
  </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4772 4773

   <para>
4774 4775 4776 4777 4778
    The first four lines written by <command>ecpg</command> to the
    output are fixed lines.  Two are comments and two are include
    lines necessary to interface to the library.  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
4779 4780 4781
   </para>

   <para>
4782
    When it sees an <command>EXEC SQL</command> statement, it
4783 4784
    intervenes and changes it. The command starts with <command>EXEC
    SQL</command> and ends with <command>;</command>. Everything in
4785 4786
    between is treated as an <acronym>SQL</acronym> statement and
    parsed for variable substitution.
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4787 4788 4789
   </para>

   <para>
4790 4791 4792
    Variable substitution occurs when a symbol starts with a colon
    (<literal>:</literal>). The variable with that name is looked up
    among the variables that were previously declared within a
4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868
    <literal>EXEC SQL DECLARE</> section.
   </para>

   <para>
    The most important function in the library is
    <function>ECPGdo</function>, which takes care of executing most
    commands. It takes a variable number of arguments. This can easily
    add up to 50 or so arguments, and we hope this will not be a
    problem on any platform.
   </para>

   <para>
    The arguments are:

    <variablelist>
     <varlistentry>
      <term>A line number</term>
      <listitem>
       <para>
        This is the line number of the original line; used in error
        messages only.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>A string</term>
      <listitem>
       <para>
        This is the <acronym>SQL</acronym> command 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
        command. Where the variables should go the string contains
        <literal>?</literal>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>Input variables</term>
      <listitem>
       <para>
        Every input variable causes ten arguments to be created.  (See below.)
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><parameter>ECPGt_EOIT</></term>
      <listitem>
       <para>
        An <type>enum</> telling that there are no more input
        variables.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>Output variables</term>
      <listitem>
       <para>
        Every output variable causes ten arguments to be created.
        (See below.)  These variables are filled by the function.
       </para>
      </listitem>
     </varlistentry>

      <varlistentry>
       <term><parameter>ECPGt_EORT</></term>
       <listitem>
       <para>
        An <type>enum</> telling that there are no more variables.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4869 4870 4871
   </para>

   <para>
4872
    For every variable that is part of the <acronym>SQL</acronym>
4873
    command, the function gets ten arguments:
4874

4875
    <orderedlist>
4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913
     <listitem>
      <para>
       The type as a special symbol.
      </para>
     </listitem>

     <listitem>
      <para> 
       A pointer to the value or a pointer to the pointer.
      </para>
     </listitem>

     <listitem>
      <para>
       The size of the variable if it is a <type>char</type> or <type>varchar</type>.
      </para>
     </listitem>

     <listitem>
      <para>
       The number of elements in the array (for array fetches).
      </para>
     </listitem>

     <listitem>
      <para>
       The offset to the next element in the array (for array fetches).
      </para>
     </listitem>

     <listitem>
      <para>
       The type of the indicator variable as a special symbol.
      </para>
     </listitem>

     <listitem>
      <para>
4914
       A pointer to the indicator variable.
4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925
      </para>
     </listitem>

     <listitem>
      <para>
       0
      </para>
     </listitem>

     <listitem>
      <para>
4926
       The number of elements in the indicator array (for array fetches).
4927 4928 4929 4930 4931 4932 4933 4934 4935
      </para>
     </listitem>

     <listitem>
      <para>
       The offset to the next element in the indicator array (for
       array fetches).
      </para>
     </listitem>
4936
    </orderedlist>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4937 4938
   </para>

4939 4940
   <para>
    Note that not all SQL commands are treated in this way.  For
4941
    instance, an open cursor statement like:
4942
<programlisting>
4943
EXEC SQL OPEN <replaceable>cursor</replaceable>;
4944
</programlisting>
4945
    is not copied to the output. Instead, the cursor's
4946 4947
    <command>DECLARE</> command is used at the position of the <command>OPEN</> command
    because it indeed opens the cursor.
4948
   </para>
Thomas G. Lockhart's avatar
Thomas G. Lockhart committed
4949

4950 4951
   <para>
    Here is a complete example describing the output of the
4952
    preprocessor of a file <filename>foo.pgc</filename> (details might
4953
    change with each particular version of the preprocessor):
4954
<programlisting>
4955
EXEC SQL BEGIN DECLARE SECTION;
4956 4957
int index;
int result;
4958
EXEC SQL END DECLARE SECTION;
4959
...
4960
EXEC SQL SELECT res INTO :result FROM mytable WHERE index = :index;
4961
</programlisting>
4962
    is translated into:
4963
<programlisting>
Michael Meskes's avatar
Michael Meskes committed
4964
/* Processed by ecpg (2.6.0) */
4965
/* These two include files are added by the preprocessor */
Michael Meskes's avatar
Michael Meskes committed
4966 4967 4968
#include &lt;ecpgtype.h&gt;;
#include &lt;ecpglib.h&gt;;

4969 4970
/* exec sql begin declare section */

Michael Meskes's avatar
Michael Meskes committed
4971 4972
#line 1 "foo.pgc"

4973 4974 4975 4976
 int index;
 int result;
/* exec sql end declare section */
...
4977
ECPGdo(__LINE__, NULL, "SELECT res FROM mytable WHERE index = ?     ",
4978
        ECPGt_int,&amp;(index),1L,1L,sizeof(int),
Michael Meskes's avatar
Michael Meskes committed
4979 4980 4981 4982
        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"
4983
</programlisting>
4984
    (The indentation here is added for readability and not
4985 4986 4987 4988
    something the preprocessor does.)
   </para>
 </sect1>
</chapter>