Home/ Manual/ uodbc / functions/ odbc_statistics

odbc_statistics

PHP function Edit on GitHub ✎

(PHP 4, PHP 5, PHP 7, PHP 8)

Retrieve statistics about a table

Description

odbc_statistics(Odbc\Connection $odbc, string|null $catalog, string $schema, string $table, int $unique, int $accuracy): Odbc\Result|false

Get statistics about a table and its indexes.

Parameters

odbc: Id
catalog: Catalog
schema: Schema
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

Object-return-falseforfailure

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

Driver-specific

The result set is ordered by NON_UNIQUE, TYPE, INDEX_QUALIFIER, INDEX_NAME and ORDINAL_POSITION.

Changelog

Version	Description

Examples

List Statistics of a Table

php

<?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:

output

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] =>
)