-----------------------------------------
PTMDB MODULE - get_index_stats() FUNCTION
-----------------------------------------

  ------------
  USAGE FORMAT
  ------------

    Where @stats is an array of array references:

    @stats = &get_index_stats($db_object, $table_name);
    @stats = &get_index_stats($db_object, $table_name, db_name);

  -----------
  DESCRIPTION
  -----------

    Retreives Index column statistics from a given database table. If a database
    has already been selected, the only required parameters are the database
    object and a table name. If a database has not been selected, or you wish to
    list Index column information from a table in another database, a database
    name is required as well. Returns an array of array references, each
    containing one Index column's stats.

  ---------
  ARGUMENTS
  ---------

    $db_object

      REQUIRED

      A database handler object. This object stores connection information and
      is returned from a db_connect() function call. This object is of the same
      type as is returned by a DBI->connect function call.

    $table_name

      REQUIRED

      The name of the table from which you would like to pull Index column
      information.

    $db_name

      OPTIONAL / REQUIRED

      The name of the database from which to pull table Index data. This is
      only required if a database has not yet been selected using the
      db_select_database() function or an SQL 'USE' statement, or alternately if
      you wish to pull table column headers from a different database than the
      one currently selected.

    -------
    RETURNS
    -------

      An array of array references. Each array reference contains information
      about one Index column from the selected table. This information can vary
      depending on database type. See your database documentation for the
      "SHOW INDEXES" SQL query. MySQL, for example, returns Index column
      information in the following order:

        Table Name, Non-Unique, Key Name, Seq in Index, Column Name, Collation,
        Cardinality, Sub-part, Packed, Null, Index Type, Comment

    --------
    SEE ALSO
    --------

      MODULES

        PTMDB

      FUNCTIONS

        PTMDB - db_select_database()