Php/docs/function.db2-tables

• PHP Manual
• IBM DB2 Functions
• Returns a result set listing the tables and associated metadata in a database

db2_tables

(PECL ibm_db2 >= 1.0.0)

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

Description

db2_tables ( resource $connection [, string $qualifier [, string $schema [, string $table-name [, string $table-type ]]]] ) : 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.

See Also

• db2_column_privileges() - Returns a result set listing the columns and associated privileges for a table
• db2_columns() - Returns a result set listing the columns and associated metadata for a table
• db2_foreign_keys() - Returns a result set listing the foreign keys for a table
• db2_primary_keys() - Returns a result set listing primary keys for a table
• db2_procedure_columns() - Returns a result set listing stored procedure parameters
• db2_procedures() - Returns a result set listing the stored procedures registered in a database
• db2_special_columns() - Returns a result set listing the unique row identifier columns for a table
• db2_statistics() - Returns a result set listing the index and statistics for a table
• db2_table_privileges() - Returns a result set listing the tables and associated privileges in a database