odbc_tables
resource$odbc,
[string|null$catalog = null],
[string|null$schema = null],
[string|null$table = null],
[string|null$types = null]
): resource|false
Lists all tables in the requested range.
To support enumeration of qualifiers, owners, and table types, the following special semantics for the catalog, schema, table, and table_type are available:
If catalog is a single percent character (%) and schema and table are empty strings, then the result set contains a list of valid qualifiers for the data source. (All columns except the TABLE_QUALIFIER column contain NULLs.)
If schema is a single percent character (%) and catalog and table are empty strings, then the result set contains a list of valid owners for the data source. (All columns except the TABLE_OWNER column contain NULLs.)
If table_type is a single percent character (%) and catalog, schema and table are empty strings, then the result set contains a list of valid table types for the data source. (All columns except the TABLE_TYPE column contain NULLs.)
Parameters
- odbc
-
The ODBC connection identifier, see odbc_connect for details.
- catalog
-
The catalog ('qualifier' in ODBC 2 parlance).
- schema
-
The schema ('owner' in ODBC 2 parlance). This parameter accepts the following search patterns: % to match zero or more characters, and _ to match a single character.
- table
-
The name. This parameter accepts the following search patterns: % to match zero or more characters, and _ to match a single character.
- types
-
If table_type is not an empty string, it must contain a list of comma-separated values for the types of interest; each value may be enclosed in single quotes (') or unquoted. For example, 'TABLE','VIEW' or TABLE, VIEW. If the data source does not support a specified table type, odbc_tables does not return any results for that type.
Return Values
Returns an ODBC result identifier containing the information or false on failure.
The result set has the following columns:
TABLE_CAT
TABLE_SCHEM
TABLE_NAME
TABLE_TYPE
REMARKS
The result set is ordered by TABLE_TYPE, TABLE_CAT, TABLE_SCHEM and TABLE_NAME.
Changelog
| Version | Description |
| 8.0.0 | schema, table and types are now nullable. |