Manage the indexers

In addition to the command arguments described in this topic, see Common arguments.

Run all Magento CLI commands as the Magento file system owner.

View a list of indexers

To view a list of all indexers:

bin/magento indexer:info

The list displays as follows:

catalog_category_product                 Category Products
catalog_product_category                 Product Categories
catalog_product_price                    Product Price
catalog_product_attribute                Product EAV
cataloginventory_stock                   Stock
catalogrule_rule                         Catalog Rule Product
catalogrule_product                      Catalog Product Rule
catalogsearch_fulltext                   Catalog Search

View indexer status

Use this command to view the status of all indexers or specific indexers. For example, find out if an indexer needs to be reindexed.

Command options:

bin/magento indexer:status [indexer]

Where [indexer] is a space-separated list of indexers. Omit [indexer] to view the status of all indexers.

To list all indexers:

bin/magento indexer:info

A sample follows:

bin/magento indexer:status

Sample result:

Category Products:                                 Reindex required
Product Categories:                                Reindex required
Product Price:                                     Reindex required
Product EAV:                                       Reindex required
Stock:                                             Reindex required
Catalog Rule Product:                              Reindex required
Catalog Product Rule:                              Reindex required
Catalog Search:                                    Reindex required

Reindex

Use this command to reindex all or selected indexers one time only.

This command reindexes one time only. To keep indexers up-to-date, you must set up a cron job.

Command options:

bin/magento indexer:reindex [indexer]

Where [indexer] is a space-separated list of indexers. Omit [indexer] to reindex all indexers.

To view a list of all indexers:

bin/magento indexer:info

A sample follows:

bin/magento indexer:reindex

Sample result:

Category Products index has been rebuilt successfully in <time>
Product Categories index has been rebuilt successfully in <time>
Product Price index has been rebuilt successfully in <time>
Product EAV index has been rebuilt successfully in <time>
Stock index has been rebuilt successfully in <time>
Catalog Rule Product index has been rebuilt successfully in <time>
Catalog Product Rule index has been rebuilt successfully in <time>
Catalog Search index has been rebuilt successfully in <time>

Reindexing all indexers can take a long time for stores with large numbers of products, customers, categories, and promotional rules.

Configure indexers

Use this command to set the following indexer options:

  • Update on save (realtime): Indexed data is updated as soon as a change is made in the Admin . (For example, the category products index is reindex after products are added to a category in the Admin.) This is the default.
  • Update by schedule (schedule): Data is indexed according to the schedule set by your Magento cron job.

Learn more about indexing

Display the current configuration

To view the current indexer configuration:

bin/magento indexer:show-mode [indexer]

Where [indexer] is a space-separated list of indexers. Omit [indexer] to show all indexers’ modes. For example, to show the mode of all indexers:

bin/magento indexer:show-mode

Sample result:

Category Products:                                 Update on Save
Product Categories:                                Update on Save
Product Price:                                     Update on Save
Product EAV:                                       Update on Save
Stock:                                             Update on Save
Catalog Rule Product:                              Update on Save
Catalog Product Rule:                              Update on Save
Catalog Search:                                    Update on Save

Configure indexers

To specify the indexer configuration:

bin/magento indexer:set-mode {realtime|schedule} [indexer]

Where:

  • realtime - Sets the selected indexers to update on save.
  • schedule - Sets the specified indexers to save according to the cron schedule.
  • indexer - Is a space-separated list of indexers. Omit indexer to configure all indexers the same way.

To view the list of indexers:

bin/magento indexer:info

For example, to change only the category products and product categories indexers to update on schedule, enter

bin/magento indexer:set-mode schedule catalog_category_product catalog_product_category

Sample result:

Index mode for Indexer Category Products was changed from 'Update on Save' to 'Update by Schedule'
Index mode for Indexer Product Categories was changed from 'Update on Save' to 'Update by Schedule'