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:
1
bin/magento indexer:info
The list displays as follows:
1
2
3
4
5
6
7
8
9
10
11
design_config_grid Design Config Grid
customer_grid Customer Grid
catalog_category_product Category Products
catalog_product_category Product Categories
catalogrule_rule Catalog Rule Product
catalog_product_attribute Product EAV
inventory Inventory
catalogrule_product Catalog Product Rule
cataloginventory_stock Stock
catalog_product_price Product Price
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:
1
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:
1
bin/magento indexer:info
A sample follows:
1
bin/magento indexer:status
Sample result:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
+----------------------+------------------+-----------+---------------------+---------------------+
| Title | Status | Update On | Schedule Status | Schedule Updated |
+----------------------+------------------+-----------+---------------------+---------------------+
| Catalog Product Rule | Reindex required | Save | | |
| Catalog Rule Product | Reindex required | Save | | |
| Catalog Search | Ready | Save | | |
| Category Products | Reindex required | Schedule | idle (0 in backlog) | 2018-06-28 09:45:53 |
| Customer Grid | Ready | Schedule | idle (0 in backlog) | 2018-06-28 09:45:52 |
| Design Config Grid | Ready | Schedule | idle (0 in backlog) | 2018-06-28 09:45:52 |
| Inventory | Ready | Save | |
| Product Categories | Reindex required | Schedule | idle (0 in backlog) | 2018-06-28 09:45:53 |
| Product EAV | Reindex required | Save | | |
| Product Price | Reindex required | Save | | |
| Stock | Reindex required | Save | | |
+----------------------+------------------+-----------+---------------------+---------------------+
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:
1
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:
1
bin/magento indexer:info
A sample follows:
1
bin/magento indexer:reindex
Sample result:
1
2
3
4
5
6
7
8
9
10
11
Design Config Grid index has been rebuilt successfully in <time>
Customer Grid index has been rebuilt successfully in <time>
Category Products index has been rebuilt successfully in <time>
Product Categories index has been rebuilt successfully in <time>
Catalog Rule Product index has been rebuilt successfully in <time>
Product EAV index has been rebuilt successfully in <time>
Inventory index has been rebuilt successfully in <time>
Catalog Product Rule index has been rebuilt successfully in <time>
Stock index has been rebuilt successfully in <time>
Product Price 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.
Reset indexer
Use this command to invalidate the status of all indexers or specific indexers.
Command options:
1
bin/magento indexer:reset [indexer]
Where [indexer] is a space-separated list of indexers. Omit [indexer] to invalidate all indexers.
A sample follows:
1
bin/magento indexer:reset
Sample result:
1
2
3
4
5
6
7
8
9
10
11
Design Config Grid indexer has been invalidated.
Customer Grid indexer has been invalidated.
Category Products indexer has been invalidated.
Product Categories indexer has been invalidated.
Catalog Rule Product indexer has been invalidated.
Product EAV indexer has been invalidated.
Inventory indexer has been invalidated.
Catalog Product Rule indexer has been invalidated.
Stock indexer has been invalidated.
Product Price indexer has been invalidated.
Catalog Search indexer has been invalidated.
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.
Display the current configuration
To view the current indexer configuration:
1
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:
1
bin/magento indexer:show-mode
Sample result:
1
2
3
4
5
6
7
8
9
10
11
Design Config Grid: Update on Save
Customer Grid: Update on Save
Category Products: Update on Save
Product Categories: Update on Save
Catalog Rule Product: Update on Save
Product EAV: Update on Save
Inventory: Update on Save
Catalog Product Rule: Update on Save
Stock: Update on Save
Product Price: Update on Save
Catalog Search: Update on Save
Configure indexers
Before switching indexer modes, we recommend putting your website to maintenance mode and disable cron. This will ensure you do not suffer database locks.
To specify the indexer configuration:
1
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. Omitindexerto configure all indexers the same way.
To view the list of indexers:
1
bin/magento indexer:info
For example, to change only the category products and product categories indexers to update on schedule, enter:
1
bin/magento indexer:set-mode schedule catalog_category_product catalog_product_category
Sample result:
1
2
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'
The indexers-related database triggers are added when the indexer mode is set to schedule and removed when the indexer mode is set to realtime. If the triggers are missing from your database while the indexers are set to schedule, change the indexers to realtime and then change them back to schedule. This resets the triggers.
Related topics