odbc_statistics
Retrieve statistics about a table
Description
resourcefalse odbc_statistics(
resource $odbc
,
stringnull $catalog
,
string $schema
,
string $table
,
int $unique
,
int $accuracy
)
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).
-
table
-
The table name.
-
unique
-
The type of the index.
One of SQL_INDEX_UNIQUE
or SQL_INDEX_ALL
.
-
accuracy
-
One of SQL_ENSURE
or SQL_QUICK
.
The latter requests that the driver retrieve the CARDINALITY
and
PAGES
only if they are readily available from the server.
Return Values
Returns an ODBC result identifier or false
on failure.
The result set has the following columns:
TABLE_CAT
TABLE_SCHEM
TABLE_NAME
NON_UNIQUE
INDEX_QUALIFIER
INDEX_NAME
TYPE
ORDINAL_POSITION
COLUMN_NAME
ASC_OR_DESC
CARDINALITY
PAGES
FILTER_CONDITION
Drivers can report additional columns.
The result set is ordered by NON_UNIQUE
, TYPE
, INDEX_QUALIFIER
,
INDEX_NAME
and ORDINAL_POSITION
.
Examples
Example #1 List Statistics of a Table
<?php
$conn = odbc_connect($dsn, $user, $pass);
$statistics = odbc_statistics($conn, 'TutorialDB', 'dbo', 'TEST', SQL_INDEX_UNIQUE, SQL_QUICK);
while (($row = odbc_fetch_array($statistics))) {
print_r($row);
break; // further rows omitted for brevity
}
?>
The above example will output
something similar to:
Array
(
[TABLE_CAT] => TutorialDB
[TABLE_SCHEM] => dbo
[TABLE_NAME] => TEST
[NON_UNIQUE] =>
[INDEX_QUALIFIER] =>
[INDEX_NAME] =>
[TYPE] => 0
[ORDINAL_POSITION] =>
[COLUMN_NAME] =>
[ASC_OR_DESC] =>
[CARDINALITY] => 15
[PAGES] => 3
[FILTER_CONDITION] =>
)