Include files for COBOL embedded SQL applications

The host-language-specific include files for COBOL have the file extension .cbl. If you use the "System/390® host data type support" feature of the IBM® COBOL compiler, the Db2® include files for your applications are in the $HOME/sqllib/include/cobol_i directory.

If you build the Db2 sample programs with the supplied script files, you must change the include file path specified in the script files to the cobol_i directory and not the cobol_a directory.

If you do not use the "System/390 host data type support" feature of the IBM COBOL compiler, or you use an earlier version of this compiler, the Db2 include files for your applications are in the following directory:

   $HOME/sqllib/include/cobol_a

To locate INCLUDE files, the Db2 COBOL precompiler searches the current directory first, then the directories specified by the DB2INCLUDE environment variable. Consider the following examples:

EXEC SQL INCLUDE payroll END-EXEC.
If the file specified in the INCLUDE statement is not enclosed in quotation marks, as shown previously, the precompiler searches for payroll.sqb, then payroll.cpy, then payroll.cbl, in each directory in which it looks.
EXEC SQL INCLUDE 'pay/payroll.cbl' END-EXEC.
If the file name is enclosed in quotation marks, as shown previously, no extension is added to the name.

If the file name in quotation marks does not contain an absolute path, the contents of DB2INCLUDE are used to search for the file, prepended to whatever path is specified in the INCLUDE file name. For example, with Db2 database systems for AIX®, if DB2INCLUDE is set to '/disk2:myfiles/cobol', the precompiler searches for './pay/payroll.cbl', then '/disk2/pay/payroll.cbl', and finally './myfiles/cobol/pay/payroll.cbl'. The path where the file is actually found is displayed in the precompiler messages. On Windows platforms, substitute back slashes (\) for the forward slashes in the previously shown example.

Note: The setting of DB2INCLUDE is cached by the Db2 command line processor. To change the setting of DB2INCLUDE after any CLP commands have been issued, enter the TERMINATE command, then reconnect to the database and precompile.

The include files that are intended to be used in your applications are described here:

SQLCA (sqlca.cbl): This file defines the SQL Communication Area (SQLCA) structure. The SQLCA contains variables that are used by the database manager to provide an application with error information about the execution of SQL statements and API calls.
SQLCA_92 (sqlca_92.cbl): This file contains a FIPS SQL92 Entry Level compliant version of the SQL Communications Area (SQLCA) structure. This file should be included in place of the sqlca.cbl file when writing Db2 applications that conform to the FIPS SQL92 Entry Level standard. The sqlca_92.cbl file is automatically included by the Db2 precompiler when the LANGLEVEL precompiler option is set to SQL92E.
SQLCODES (sqlcodes.cbl): This file defines constants for the SQLCODE field of the SQLCA structure.
SQLDA (sqlda.cbl): This file defines the SQL Descriptor Area (SQLDA) structure. The SQLDA is used to pass data between an application and the database manager.
SQLEAU (sqleau.cbl): This file contains constant and structure definitions required for the Db2 security audit APIs. If you use these APIs, you need to include this file in your program. This file also contains constant and keyword value definitions for fields in the audit trail record. These definitions can be used by external or vendor audit trail extract programs.
SQLETSD (sqletsd.cbl): This file defines the Table Space Descriptor structure, SQLETSDESC, which is passed to the Create Database API, sqlgcrea.
SQLE819A (sqle819a.cbl): If the code page of the database is 819 (ISO Latin-1), this sequence sorts character strings that are not FOR BIT DATA according to the host CCSID 500 (EBCDIC International) binary collation. This file is used by the CREATE DATABASE API.
SQLE819B (sqle819b.cbl): If the code page of the database is 819 (ISO Latin-1), this sequence sorts character strings that are not FOR BIT DATA according to the host CCSID 037 (EBCDIC US English) binary collation. This file is used by the CREATE DATABASE API.
SQLE850A (sqle850a.cbl): If the code page of the database is 850 (ASCII Latin-1), this sequence sorts character strings that are not FOR BIT DATA according to the host CCSID 500 (EBCDIC International) binary collation. This file is used by the CREATE DATABASE API.
SQLE850B (sqle850b.cbl): If the code page of the database is 850 (ASCII Latin-1), this sequence sorts character strings that are not FOR BIT DATA according to the host CCSID 037 (EBCDIC US English) binary collation. This file is used by the CREATE DATABASE API.
SQLE932A (sqle932a.cbl): If the code page of the database is 932 (ASCII Japanese), this sequence sorts character strings that are not FOR BIT DATA according to the host CCSID 5035 (EBCDIC Japanese) binary collation. This file is used by the CREATE DATABASE API.
SQLE932B (sqle932b.cbl): If the code page of the database is 932 (ASCII Japanese), this sequence sorts character strings that are not FOR BIT DATA according to the host CCSID 5026 (EBCDIC Japanese) binary collation. This file is used by the CREATE DATABASE API.
SQL1252A (sql1252a.cbl): If the code page of the database is 1252 (Windows Latin-1), this sequence sorts character strings that are not FOR BIT DATA according to the host CCSID 500 (EBCDIC International) binary collation. This file is used by the CREATE DATABASE API.
SQL1252B (sql1252b.cbl): If the code page of the database is 1252 (Windows Latin-1), this sequence sorts character strings that are not FOR BIT DATA according to the host CCSID 037 (EBCDIC US English) binary collation. This file is used by the CREATE DATABASE API.
SQLSTATE (sqlstate.cbl): This file defines constants for the SQLSTATE field of the SQLCA structure.
SQLUDF (sqludf.cbl): This file defines constants and interface structures for writing user-defined functions (UDFs).
SQLUTBCQ (sqlutbcq.cbl): This file defines the Table Space Container Query data structure, SQLB-TBSCONTQRY-DATA, which is used with the table space container query APIs, sqlgstsc, sqlgftcq, and sqlgtcq.
SQLUTBSQ (sqlutbsq.cbl): This file defines the Table Space Query data structure, SQLB-TBSQRY-DATA, which is used with the table space query APIs, sqlgstsq, sqlgftsq, and sqlgtsq.