34.9. Preprocessor Directives
Several preprocessor directives are available that modify how theecpg preprocessor parses and processes a file.
34.9.1. Including Files
To include an external file into your embedded SQL program, use:
EXEC SQL INCLUDEfilename;EXEC SQL INCLUDE <filename>;EXEC SQL INCLUDE "filename";
The embedded SQL preprocessor will look for a file named, preprocess it, and include it in the resulting C output. Thus, embedded SQL statements in the included file are handled correctly.filename.h
Theecpg preprocessor will search a file at several directories in following order:
- current directory
/usr/local/include- Postgres Pro include directory, defined at build time (e.g.,
/usr/local/pgsql/include) /usr/include
But whenEXEC SQL INCLUDE " is used, only the current directory is searched.filename"
In each directory, the preprocessor will first look for the file name as given, and if not found will append.h to the file name and try again (unless the specified file name already has that suffix).
Note thatEXEC SQL INCLUDE isnot the same as:
#include <filename.h> because this file would not be subject to SQL command preprocessing. Naturally, you can continue to use the C#include directive to include other header files.
Note
The include file name is case-sensitive, even though the rest of theEXEC SQL INCLUDE command follows the normal SQL case-sensitivity rules.
34.9.2. The define and undef Directives
Similar to the directive#define that is known from C, embedded SQL has a similar concept:
EXEC SQL DEFINEname;EXEC SQL DEFINEnamevalue;
So you can define a name:
EXEC SQL DEFINE HAVE_FEATURE;
And you can also define constants:
EXEC SQL DEFINE MYNUMBER 12;EXEC SQL DEFINE MYSTRING 'abc';
Useundef to remove a previous definition:
EXEC SQL UNDEF MYNUMBER;
Of course you can continue to use the C versions#define and#undef in your embedded SQL program. The difference is where your defined values get evaluated. If you useEXEC SQL DEFINE then theecpg preprocessor evaluates the defines and substitutes the values. For example if you write:
EXEC SQL DEFINE MYNUMBER 12;...EXEC SQL UPDATE Tbl SET col = MYNUMBER;
thenecpg will already do the substitution and your C compiler will never see any name or identifierMYNUMBER. Note that you cannot use#define 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.
If multiple input files are named on theecpg preprocessor's command line, the effects ofEXEC SQL DEFINE andEXEC SQL UNDEF do not carry across files: each file starts with only the symbols defined by-D switches on the command line.
34.9.3. ifdef, ifndef, elif, else, and endif Directives
You can use the following directives to compile code sections conditionally:
EXEC SQL ifdefname;Checks a
nameand processes subsequent lines ifnamehas been defined viaEXEC SQL define.nameEXEC SQL ifndefname;Checks a
nameand processes subsequent lines ifnamehasnot been defined viaEXEC SQL define.nameEXEC SQL elifname;Begins an optional alternative section after an
EXEC SQL ifdefornameEXEC SQL ifndefdirective. Any number ofnameelifsections can appear. Lines following anelifwill be processed ifnamehas been definedand no previous section of the sameifdef/ifndef...endifconstruct has been processed.EXEC SQL else;Begins an optional, final alternative section after an
EXEC SQL ifdefornameEXEC SQL ifndefdirective. Subsequent lines will be processed if no previous section of the samenameifdef/ifndef...endifconstruct has been processed.EXEC SQL endif;Ends an
ifdef/ifndef...endifconstruct. Subsequent lines are processed normally.
ifdef/ifndef...endif constructs can be nested, up to 127 levels deep.
This example will compile exactly one of the threeSET TIMEZONE commands:
EXEC SQL ifdef TZVAR;EXEC SQL SET TIMEZONE TO TZVAR;EXEC SQL elif TZNAME;EXEC SQL SET TIMEZONE TO TZNAME;EXEC SQL else;EXEC SQL SET TIMEZONE TO 'GMT';EXEC SQL endif;