PHP - Manual: db2_tables
2024-11-13
(PECL ibm_db2 >= 1.0.0)
db2_tables — Returns a result set listing the tables and associated metadata in a database
$connection
,$qualifier
= ?,$schema
= ?,$table-name
= ?,$table-type
= ?Returns a result set listing the tables and associated metadata in a database.
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.
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. |