Navigation

Search

smf_db_list_indexes

Description

Returns information about the indexes in a table

Syntax

mixed smf_db_list_indexes (string $table_name[, bool $detail[, array $parameters]])



Parameter $table_name

Expected type: String
Description: The name of the table to get indexes for



Parameter $detail

Expected type: Boolean
Description: Whether or not to return detailed index info. Defaults to false.



Parameter $parameters

Expected type: Array
Description: An array of parameters

Array Elements of $parameters
Key Optional Expected type Description
no_prefix yes Boolean If true, SMF won't add the db_prefix to the table name



Return value

Expected type: Mixed
Description: An array of index names or an array of arrays containing detailed info about each index

Possible types
Allowed values Description
Array An array of index names
Array of arrays An array of arrays containing detailed index info (keys are index names)


Notes

  • Returns an array of index names if $detail is false
  • Returns an array of index_name => array(details) pairs if $detail is true (keys in details array: 'key_name' (index name, 'primary' for primary keys), 'type' (index type: 'primary', 'unique', 'fulltext' or 'index') and 'columns' (array of column names (includes "sub-part" if applicable))
View all versions of this function