ReturnAliases CLI/ODBC and IBM data server driver configuration keyword

Controls whether the CLI schema APIs report aliases in the metadata results.

db2cli.ini keyword syntax:
ReturnAliases = 0 | 1
IBM® data server driver configuration file (db2dsdriver.cfg) syntax:
<parameter name="ReturnAliases" 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, aliases will be considered when qualifying rows for metadata procedures.
Usage notes:

This keyword specifies whether aliases (or synonyms) should be considered when qualifying rows for metadata procedures. Not considering aliases can provide significant performance benefits by avoided costly joins with the base tables to determine the addition tables that should qualify for a given query.

  • 0 : Aliases will not be considered when qualifying rows for metadata procedures (better performance.)
  • 1 : Aliases will be considered when qualifying rows for metadata procedures.

The following CLI APIs are affected by this keyword :

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