DB2 Version 9.7 for Linux, UNIX, and Windows

ReturnSynonymSchema CLI/ODBC configuration keyword

Controls whether CLI schema APIs report the schema name for DB2® for z/OS® synonyms in the TABLE_SCHEM column of the schema procedure result sets.

db2cli.ini keyword syntax:

ReturnSynonymSchema = 0 | 1

Default setting:

1: By default, the creator of the synonym will be returned in the TABLE_SCHEM column.

Usage notes:

Valid settings:

0 : the TABLE_SCHEM column of the procedure result set will be NULL.
1 : the TABLE_SCHEM column of the procedure result set will contain the creator of the synonym.

You cannot access a synonym on a DB2 for z/OS server using a name qualified with a schema. For this reason, the meaning of the TABLE_SCHEM column of a CLI schema API result set is different, with respect to synonyms, when you are running against a DB2 for z/OS server.

This CLI keyword has no effect when you use CLI schema APIs against a DB2 for Linux, UNIX, and Windows server.

The following CLI APIs are affected by this keyword:

SQLColumns()
SQLColumnPrivileges()
SQLTables()
SQLTablePrivileges()
SQLStatistics()
SQLSpecialColumns()
SQLForeignKeys()
SQLPrimaryKeys()

You must have the following program temporary fixes (PTFs) on the DB2 for z/OS database server to use this keyword:

Table 1. DB2 for z/OS PTFs for ReturnSynonymSchema
DB2 for z/OS	PTF or APAR numbers
Version 7	UK13643
Version 8	UK13644
Version 9