db2_statistics
(PECL ibm_db2 >= 1.0.0)
db2_statistics — Returns a result set listing the index and statistics for a table
Description
$connection
, string $qualifier
, string $schema
, string $table-name
, bool $unique
) : resourceReturns a result set listing the index and statistics for a table.
Parameters
-
connection -
A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
-
qualifier -
A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass
NULLor an empty string. -
schema -
The schema that contains the targeted table. If this parameter is
NULL, the statistics and indexes are returned for the schema of the current user. -
table_name -
The name of the table.
-
unique -
An integer value representing the type of index information to return.
-
0 -
Return only the information for unique indexes on the table.
-
1 -
Return the information for all indexes on the table.
-
Return Values
Returns a statement resource with a result set containing rows describing the statistics and indexes for the base tables matching the specified parameters. The rows are composed of the following columns:
| Column name | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| TABLE_CAT | The catalog that contains the table. The value is NULL if
this table does not have catalogs. |
||||||||||
| TABLE_SCHEM | Name of the schema that contains the table. | ||||||||||
| TABLE_NAME | Name of the table. | ||||||||||
| NON_UNIQUE |
An integer value representing whether the index prohibits unique values, or whether the row represents statistics on the table itself:
|
||||||||||
| INDEX_QUALIFIER | A string value representing the qualifier that would have to be prepended to INDEX_NAME to fully qualify the index. | ||||||||||
| INDEX_NAME | A string representing the name of the index. | ||||||||||
| TYPE |
An integer value representing the type of information contained in this row of the result set:
|
||||||||||
| ORDINAL_POSITION | The 1-indexed position of the column in the index. NULL if
the row contains statistics information about the table itself. |
||||||||||
| COLUMN_NAME | The name of the column in the index. NULL if the row
contains statistics information about the table itself. |
||||||||||
| ASC_OR_DESC |
A if the column is sorted in ascending order,
D if the column is sorted in descending order,
NULL if the row contains statistics information about the table
itself.
|
||||||||||
| CARDINALITY |
If the row contains information about an index, this column contains an integer value representing the number of unique values in the index. If the row contains information about the table itself, this column contains an integer value representing the number of rows in the table. |
||||||||||
| PAGES |
If the row contains information about an index, this column contains an integer value representing the number of pages used to store the index. If the row contains information about the table itself, this column contains an integer value representing the number of pages used to store the table. |
||||||||||
| FILTER_CONDITION | Always returns NULL. |
See Also
- db2_column_privileges() - Returns a result set listing the columns and associated privileges for a table
- db2_columns() - Returns a result set listing the columns and associated metadata for a table
- db2_foreign_keys() - Returns a result set listing the foreign keys for a table
- db2_primary_keys() - Returns a result set listing primary keys for a table
- db2_procedure_columns() - Returns a result set listing stored procedure parameters
- db2_procedures() - Returns a result set listing the stored procedures registered in a database
- db2_special_columns() - Returns a result set listing the unique row identifier columns for a table
- db2_table_privileges() - Returns a result set listing the tables and associated privileges in a database
- db2_tables() - Returns a result set listing the tables and associated metadata in a database
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.db2-statistics.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
