ReturnSynonymSchema CLI/ODBC and IBM data server driver 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
IBM data server driver configuration file (db2dsdriver.cfg) syntax:
<parameter name="ReturnSynonymSchema" value="0 | 1"/>
Attention: The IBM data server driver configuration file (db2dsdriver.cfg) syntax is available in Db2 11.5.4 and later.
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 server.

The following CLI APIs are affected by this keyword:
  • SQLColumns()
  • SQLColumnPrivileges()
  • SQLTables()
  • SQLTablePrivileges()
  • SQLStatistics()
  • SQLSpecialColumns()
  • SQLForeignKeys()
  • SQLPrimaryKeys()

If you are connecting to a Db2 for z/OS Version 8 server, the program temporary fix (PTF) UK13644 must be installed on the Db2 for z/OS Version 8 server.