Home/ Manual/ ibm_db2 / functions/ db2_tables

db2_tables

PHP function Edit on GitHub ✎

(PECL ibm_db2 >= 1.0.0)

Returns a result set listing the tables and associated metadata in a database

Description

db2_tables(resource $connection, string|null $qualifier = null, string|null $schema = null, string|null $table_name = null, string|null $table_type = null): resource

Returns a result set listing the tables and associated metadata in a database.

Parameters

connection: A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
qualifier: A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass null or an empty string.
schema: The schema which contains the tables. This parameter accepts a search pattern containing _ and % as wildcards.
table_name: The name of the table. This parameter accepts a search pattern containing _ and % as wildcards.
table_type: A list of comma-delimited table type identifiers. To match all table types, pass null or an empty string. Valid table type identifiers include: ALIAS, HIERARCHY TABLE, INOPERATIVE VIEW, NICKNAME, MATERIALIZED QUERY TABLE, SYSTEM TABLE, TABLE, TYPED TABLE, TYPED VIEW, and VIEW.

Return Values

Returns a statement resource with a result set containing rows describing the tables that match the specified parameters. The rows are composed of the following columns:

Column name	Description
TABLE_CAT	The catalog that contains the table. The value is null if this table does not have catalogs.
TABLE_SCHEM	Name of the schema that contains the table.
TABLE_NAME	Name of the table.
TABLE_TYPE	Table type identifier for the table.
REMARKS	Description of the table.

db2_tables

Description

Parameters

Return Values

See Also