</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
The <command>TYPE</command> command is a PostgreSQL extension.
</para>
</refsect1>
</refentry>
<refentry id="ecpg-sql-var">
<refnamediv>
<refname>VAR</refname>
<refpurpose>define a variable</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
VAR <replaceable>varname</replaceable> IS <replaceable>ctype</replaceable>
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>VAR</command> command assigns a new C data type
to a host variable. The host variable must be previously
declared in a declare section.
</para>
</refsect1>
<refsect1>
<title>Parameters</title>
<variablelist>
<varlistentry id="ecpg-sql-var-varname">
<term><replaceable class="parameter">varname</replaceable></term>
<listitem>
<para>
A C variable name.
</para>
</listitem>
</varlistentry>
<varlistentry id="ecpg-sql-var-ctype">
<term><replaceable class="parameter">ctype</replaceable></term>
<listitem>
<para>
A C type specification.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<programlisting>
Exec sql begin declare section;
short a;
exec sql end declare section;
EXEC SQL VAR a IS int;
</programlisting>
</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
The <command>VAR</command> command is a PostgreSQL extension.
</para>
</refsect1>
</refentry>
<refentry id="ecpg-sql-whenever">
<refnamediv>
<refname>WHENEVER</refname>
<refpurpose>specify the action to be taken when an SQL statement causes a specific class condition to be raised</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
WHENEVER { NOT FOUND | SQLERROR | SQLWARNING } <replaceable class="parameter">action</replaceable>
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Define a behavior which is called on the special cases (Rows not
found, SQL warnings or errors) in the result of SQL execution.
</para>
</refsect1>
<refsect1>
<title>Parameters</title>
<para>
See <xref linkend="ecpg-whenever"/> for a description of the
parameters.
</para>
</refsect1>
<refsect1>
<title>Examples</title>
<programlisting>
EXEC SQL WHENEVER NOT FOUND CONTINUE;
EXEC SQL WHENEVER NOT FOUND DO BREAK;
EXEC SQL WHENEVER NOT FOUND DO CONTINUE;
EXEC SQL WHENEVER SQLWARNING SQLPRINT;
EXEC SQL WHENEVER SQLWARNING DO warn();
EXEC SQL WHENEVER SQLERROR sqlprint;
EXEC SQL WHENEVER SQLERROR CALL print2();
EXEC SQL WHENEVER SQLERROR DO handle_error("select");
EXEC SQL WHENEVER SQLERROR DO sqlnotice(NULL, NONO);
EXEC SQL WHENEVER SQLERROR DO sqlprint();
EXEC SQL WHENEVER SQLERROR GOTO error_label;
EXEC SQL WHENEVER SQLERROR STOP;
</programlisting>
<para>
A typical application is the use of <literal>WHENEVER NOT FOUND
BREAK</literal> to handle looping through result sets:
<programlisting>
int
main(void)
{
EXEC SQL CONNECT TO testdb AS con1;
EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT;
EXEC SQL ALLOCATE DESCRIPTOR d;
EXEC SQL DECLARE cur CURSOR FOR SELECT current_database(), 'hoge', 256;
EXEC SQL OPEN cur;
/* when end of result set reached, break out of while loop */
EXEC SQL WHENEVER NOT FOUND DO BREAK;
while (1)
{
EXEC SQL FETCH NEXT FROM cur INTO SQL DESCRIPTOR d;
...
}
EXEC SQL CLOSE cur;
EXEC SQL COMMIT;
EXEC SQL DEALLOCATE DESCRIPTOR d;
EXEC SQL DISCONNECT ALL;
return 0;
}
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Compatibility</title>
<para>
<command>WHENEVER</command> is specified in the SQL standard, but
most of the actions are PostgreSQL extensions.