PHP: Hypertext Preprocessor (original) (raw)

odbc_statistics

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

odbc_statistics — Retrieve statistics about a table

Parameters

odbc

The ODBC connection object, 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](uodbc.constants.php#constant.sql-index-unique) or [SQL_INDEX_ALL](uodbc.constants.php#constant.sql-index-all).

accuracy

One of [SQL_ENSURE](uodbc.constants.php#constant.sql-ensure) or [SQL_QUICK](uodbc.constants.php#constant.sql-quick). The latter requests that the driver retrieve the CARDINALITY andPAGES only if they are readily available from the server.

Return Values

Returns an ODBC result object or [false](reserved.constants.php#constant.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.

Changelog

Version	Description
8.4.0	odbc expects an Odbc\Connection instance now; previously, a resource was expected.
8.4.0	This function returns an Odbc\Result instance now; previously, a resource was returned.

Examples

Example #1 List Statistics of a Table

<?php <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>c</mi><mi>o</mi><mi>n</mi><mi>n</mi><mo>=</mo><mi>o</mi><mi>d</mi><mi>b</mi><msub><mi>c</mi><mi>c</mi></msub><mi>o</mi><mi>n</mi><mi>n</mi><mi>e</mi><mi>c</mi><mi>t</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">conn = odbc_connect(</annotation></semantics></math>conn=odbcconnect(dsn, <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>u</mi><mi>s</mi><mi>e</mi><mi>r</mi><mo separator="true">,</mo></mrow><annotation encoding="application/x-tex">user, </annotation></semantics></math>user,pass); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>s</mi><mi>t</mi><mi>a</mi><mi>t</mi><mi>i</mi><mi>s</mi><mi>t</mi><mi>i</mi><mi>c</mi><mi>s</mi><mo>=</mo><mi>o</mi><mi>d</mi><mi>b</mi><msub><mi>c</mi><mi>s</mi></msub><mi>t</mi><mi>a</mi><mi>t</mi><mi>i</mi><mi>s</mi><mi>t</mi><mi>i</mi><mi>c</mi><mi>s</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">statistics = odbc_statistics(</annotation></semantics></math>statistics=odbcstatistics(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: