odbc_tables
(PHP 4, PHP 5, PHP 7, PHP 8)
odbc_tables — Get the list of table names stored in a specific data source
Description
resource
$odbc,?string
$catalog = null,?string
$schema = null,?string
$table = null,?string
$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
catalogis a single percent character (%) andschemaandtableare 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
schemais a single percent character (%) andcatalogandtableare 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_typeis a single percent character (%) andcatalog,schemaandtableare 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_typeis 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'orTABLE, 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_CATTABLE_SCHEMTABLE_NAMETABLE_TYPEREMARKS
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.
|
Examples
Example #1 List Tables in a Catalog
<?php
$conn = odbc_connect($dsn, $user, $pass);
$tables = odbc_tables($conn, 'SalesOrders', 'dbo', '%', 'TABLE');
while (($row = odbc_fetch_array($tables))) {
print_r($row);
break; // further rows omitted for brevity
}
?>
The above example will output something similar to:
Array
(
[TABLE_CAT] => SalesOrders
[TABLE_SCHEM] => dbo
[TABLE_NAME] => Orders
[TABLE_TYPE] => TABLE
[REMARKS] =>
)
See Also
- odbc_tableprivileges() - Lists tables and the privileges associated with each table
- odbc_columns() - Lists the column names in specified tables
- odbc_specialcolumns() - Retrieves special columns
- odbc_statistics() - Retrieve statistics about a table
- odbc_procedures() - Get the list of procedures stored in a specific data source
