$database->getIndexes() method

Get all indexes from given table

By default it returns an array of index names. Specify true for the verbose option to get index name, type and columns (array) for each index.

Available since version 3.0.182.

Usage

// basic usage
$array = $database->getIndexes(string $table);

// usage with all arguments
$array = $database->getIndexes(string $table, $verbose = false);

Arguments

NameType(s)Description
tablestring

Name of table to get indexes for or table.index (usually combined with verbose option).

verbose (optional)bool, int, string

Include array of verbose information for each? (default=false)

  • Omit or false (bool) to just get index names.
  • True (bool) or 1 (int) to get a verbose array of information for each index, indexed by index name.
  • 2 (int) to get regular PHP array of raw MySQL index information.
  • Index name (string) to get verbose array only for only that index.

Return value

array


$database methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer