| Server IP : 104.21.25.180 / Your IP : 162.159.115.41 Web Server : Apache/2.4.37 System : Linux almalinux.duckdns.org 4.18.0-553.111.1.el8_10.x86_64 #1 SMP Sun Mar 8 20:06:07 EDT 2026 x86_64 User : ricodeal ( 1046) PHP Version : 7.4.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/postgresql-docs/html/ |
Upload File : |
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>35.9. Preprocessor Directives</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="[email protected]" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="ecpg-errors.html" title="35.8. Error Handling" /><link rel="next" href="ecpg-process.html" title="35.10. Processing Embedded SQL Programs" /></head><body><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">35.9. Preprocessor Directives</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="ecpg-errors.html" title="35.8. Error Handling">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="ecpg.html" title="Chapter 35. ECPG - Embedded SQL in C">Up</a></td><th width="60%" align="center">Chapter 35. <span xmlns="http://www.w3.org/1999/xhtml" class="application">ECPG</span> - Embedded <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">SQL</acronym> in C</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 10.23 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="ecpg-process.html" title="35.10. Processing Embedded SQL Programs">Next</a></td></tr></table><hr></hr></div><div class="sect1" id="ECPG-PREPROC"><div class="titlepage"><div><div><h2 class="title" style="clear: both">35.9. Preprocessor Directives</h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="sect2"><a href="ecpg-preproc.html#ECPG-INCLUDE">35.9.1. Including Files</a></span></dt><dt><span class="sect2"><a href="ecpg-preproc.html#ECPG-DEFINE">35.9.2. The define and undef Directives</a></span></dt><dt><span class="sect2"><a href="ecpg-preproc.html#ECPG-IFDEF">35.9.3. ifdef, ifndef, else, elif, and endif Directives</a></span></dt></dl></div><p> Several preprocessor directives are available that modify how
the <code class="command">ecpg</code> preprocessor parses and processes a
file.
</p><div class="sect2" id="ECPG-INCLUDE"><div class="titlepage"><div><div><h3 class="title">35.9.1. Including Files</h3></div></div></div><p> To include an external file into your embedded SQL program, use:
</p><pre class="programlisting">EXEC SQL INCLUDE <em class="replaceable"><code>filename</code></em>;
EXEC SQL INCLUDE <<em class="replaceable"><code>filename</code></em>>;
EXEC SQL INCLUDE "<em class="replaceable"><code>filename</code></em>";</pre><p>
The embedded SQL preprocessor will look for a file named
<code class="literal"><em class="replaceable"><code>filename</code></em>.h</code>,
preprocess it, and include it in the resulting C output. Thus,
embedded SQL statements in the included file are handled correctly.
</p><p> The <code class="command">ecpg</code> preprocessor will search a file at
several directories in following order:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">current directory</li><li class="listitem"><code class="filename">/usr/local/include</code></li><li class="listitem">PostgreSQL include directory, defined at build time (e.g., <code class="filename">/usr/local/pgsql/include</code>)</li><li class="listitem"><code class="filename">/usr/include</code></li></ul></div><p>
But when <code class="literal">EXEC SQL INCLUDE
"<em class="replaceable"><code>filename</code></em>"</code> is used, only the
current directory is searched.
</p><p> In each directory, the preprocessor will first look for the file
name as given, and if not found will append <code class="literal">.h</code>
to the file name and try again (unless the specified file name
already has that suffix).
</p><p> Note that <code class="command">EXEC SQL INCLUDE</code> is <span class="emphasis"><em>not</em></span> the same as:
</p><pre class="programlisting">#include <<em class="replaceable"><code>filename</code></em>.h></pre><p>
because this file would not be subject to SQL command preprocessing.
Naturally, you can continue to use the C
<code class="literal">#include</code> directive to include other header
files.
</p><div class="note"><h3 class="title">Note</h3><p> The include file name is case-sensitive, even though the rest of
the <code class="literal">EXEC SQL INCLUDE</code> command follows the normal
SQL case-sensitivity rules.
</p></div></div><div class="sect2" id="ECPG-DEFINE"><div class="titlepage"><div><div><h3 class="title">35.9.2. The define and undef Directives</h3></div></div></div><p> Similar to the directive <code class="literal">#define</code> that is known from C,
embedded SQL has a similar concept:
</p><pre class="programlisting">EXEC SQL DEFINE <em class="replaceable"><code>name</code></em>;
EXEC SQL DEFINE <em class="replaceable"><code>name</code></em> <em class="replaceable"><code>value</code></em>;</pre><p>
So you can define a name:
</p><pre class="programlisting">EXEC SQL DEFINE HAVE_FEATURE;</pre><p>
And you can also define constants:
</p><pre class="programlisting">EXEC SQL DEFINE MYNUMBER 12;
EXEC SQL DEFINE MYSTRING 'abc';</pre><p>
Use <code class="literal">undef</code> to remove a previous definition:
</p><pre class="programlisting">EXEC SQL UNDEF MYNUMBER;</pre><p>
</p><p> Of course you can continue to use the C versions <code class="literal">#define</code>
and <code class="literal">#undef</code> in your embedded SQL program. The difference
is where your defined values get evaluated. If you use <code class="literal">EXEC SQL
DEFINE</code> then the <code class="command">ecpg</code> preprocessor evaluates the defines and substitutes
the values. For example if you write:
</p><pre class="programlisting">EXEC SQL DEFINE MYNUMBER 12;
...
EXEC SQL UPDATE Tbl SET col = MYNUMBER;</pre><p>
then <code class="command">ecpg</code> will already do the substitution and your C compiler will never
see any name or identifier <code class="literal">MYNUMBER</code>. Note that you cannot use
<code class="literal">#define</code> 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.
</p></div><div class="sect2" id="ECPG-IFDEF"><div class="titlepage"><div><div><h3 class="title">35.9.3. ifdef, ifndef, else, elif, and endif Directives</h3></div></div></div><p> You can use the following directives to compile code sections conditionally:
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">EXEC SQL ifdef <em class="replaceable"><code>name</code></em>;</code></span></dt><dd><p> Checks a <em class="replaceable"><code>name</code></em> and processes subsequent lines if
<em class="replaceable"><code>name</code></em> has been created with <code class="literal">EXEC SQL define
<em class="replaceable"><code>name</code></em></code>.
</p></dd><dt><span class="term"><code class="literal">EXEC SQL ifndef <em class="replaceable"><code>name</code></em>;</code></span></dt><dd><p> Checks a <em class="replaceable"><code>name</code></em> and processes subsequent lines if
<em class="replaceable"><code>name</code></em> has <span class="emphasis"><em>not</em></span> been created with
<code class="literal">EXEC SQL define <em class="replaceable"><code>name</code></em></code>.
</p></dd><dt><span class="term"><code class="literal">EXEC SQL else;</code></span></dt><dd><p> Starts processing an alternative section to a section introduced by
either <code class="literal">EXEC SQL ifdef <em class="replaceable"><code>name</code></em></code> or
<code class="literal">EXEC SQL ifndef <em class="replaceable"><code>name</code></em></code>.
</p></dd><dt><span class="term"><code class="literal">EXEC SQL elif <em class="replaceable"><code>name</code></em>;</code></span></dt><dd><p> Checks <em class="replaceable"><code>name</code></em> and starts an alternative section if
<em class="replaceable"><code>name</code></em> has been created with <code class="literal">EXEC SQL define
<em class="replaceable"><code>name</code></em></code>.
</p></dd><dt><span class="term"><code class="literal">EXEC SQL endif;</code></span></dt><dd><p> Ends an alternative section.
</p></dd></dl></div><p>
</p><p> Example:
</p><pre class="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;</pre><p>
</p></div></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ecpg-errors.html" title="35.8. Error Handling">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ecpg.html" title="Chapter 35. ECPG - Embedded SQL in C">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ecpg-process.html" title="35.10. Processing Embedded SQL Programs">Next</a></td></tr><tr><td width="40%" align="left" valign="top">35.8. Error Handling </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 10.23 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 35.10. Processing Embedded SQL Programs</td></tr></table></div></body></html>