db2_statistics

    (PECL ibm_db2 >= 1.0.0)

    db2_statistics — Returns a result set listing the index and statistics for a table

    Descripción

    db2_statistics(
        resource$connection,
        ?string$qualifier,
        ?string$schema,
        string$table_name,
        bool$unique
    ): resource

    Returns a result set listing the index and statistics for a table.

    Parámetros

    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 null or 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

    When unique is true, the information for all indexes in the table are returned. Otherwise, only the information for unique indexes in the table are returned.

    Valores devueltos

    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 nameDescription
    TABLE_CATThe catalog that contains the table. The value is null if this table does not have catalogs.
    TABLE_SCHEMName of the schema that contains the table.
    TABLE_NAMEName 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:

    Return valueParameter type
    0 (SQL_FALSE)The index allows duplicate values.
    1 (SQL_TRUE)The index values must be unique.
    nullThis row is statistics information for the table itself.
    INDEX_QUALIFIERA string value representing the qualifier that would have to be prepended to INDEX_NAME to fully qualify the index.
    INDEX_NAMEA string representing the name of the index.
    TYPE

    An integer value representing the type of information contained in this row of the result set:

    Return valueParameter type
    0 (SQL_TABLE_STAT)The row contains statistics about the table itself.
    1 (SQL_INDEX_CLUSTERED)The row contains information about a clustered index.
    2 (SQL_INDEX_HASH)The row contains information about a hashed index.
    3 (SQL_INDEX_OTHER)The row contains information about a type of index that is neither clustered nor hashed.
    ORDINAL_POSITIONThe 1-indexed position of the column in the index. null if the row contains statistics information about the table itself.
    COLUMN_NAMEThe name of the column in the index. null if the row contains statistics information about the table itself.
    ASC_OR_DESCA 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_CONDITIONAlways returns null.

    Ver también

    • db2_column_privileges() - Obtiene la lista de columnas y permisos asociados a una tabla
    • db2_columns() - Devuelve los campos de una tabla y sus metadatos asociados.
    • db2_foreign_keys() - Devolver un resultado que contenga las llaves foraneas de una tabla
    • db2_primary_keys() - Devolver un resultado con las llaves primarias de una tabla
    • db2_procedure_columns() - Devolver un resultado con los parámetros de los procedimientos almacenados
    • db2_procedures() - Devolver un resultado con los procedimientos almacenados registrados en la base de datos
    • 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
    To Top