Search Docs
Console Commands
update or queue update command depending on your
preference.Update
This command will run all tasks relating to updating your search index.
php craft xsearch/results
Options
--site-id
The ID of a site to limit this operation to.
--force-update-pages
Force update pages that have not changed.
--force-update-assets
Force update assets that have not changed.
Queue Update
This command will also run all tasks relating to updating your search index only it will use the Craft CMS Job Queue system. It is equivalent to running update under Utilities.
php craft xsearch/results/queue-update
Options
--site-id
The ID of a site to limit this operation to.
--force-update-pages
Force update pages that have not changed.
--force-update-assets
Force update assets that have not changed.
Add Assets
This command will add or remove assets based on whether they are marked as searchable or not.
php craft xsearch/results/add-assets
Options
--site-id
The ID of a site to limit this operation to.
Add Known Pages
This command will add or remove known pages based on your entries and products.
php craft xsearch/results/add-known-pages
Options
--site-id
The ID of a site to limit this operation to.
Add New Pages
This command will add new pages found from hit tracking.
php craft xsearch/results/add-new-pages
Options
--site-id
The ID of a site to limit this operation to.
Update Page Score
This command will update the page score of your results.
php craft xsearch/results/update-page-score
Options
--site-id
The ID of a site to limit this operation to.
Update Results
This command will update the status of your results. The status is determined based on your rules and settings you have set.
For example if you updated your ignore rules, you would need to run this task for those changes to take effect.
php craft xsearch/results/update-results
Options
--site-id
The ID of a site to limit this operation to.
--force-update-pages
Force update pages that have not changed.
--force-update-assets
Force update assets that have not changed.
Update Term Priorities Index
For speed considerations, search term priorities need to be indexed. This task takes care of that.
If you update your term priorities, you will need to run this task for those changes to take effect.
php craft xsearch/results/update-term-priorities-index
Options
--site-id
The ID of a site to limit this operation to.