Skip to main content
Keel Docs Showcase

Search & the search index

Keel can search through Pimcore's own search index (the Generic Data Index, running on OpenSearch or Elasticsearch). It is used automatically when your project has it – there is nothing to switch on in Keel.

What it improves

  • the search box in lists – both lists that are paged on the server and lists that load in the browser
  • Select all N matching in a list
  • the search in Link existing… (adding existing items to a related list)

With the index, a search:

  • forgives typos – one wrong letter in words of 4 or more letters (Marlinn finds Marlin)
  • matches word beginnings – mar finds Marlin
  • shows the best matches first – unless you have chosen a column to sort by

Keel searches whole-word text fields and the item's key.

What is used when

SituationSearch uses
The search index is installed and up to datethe index
The index is not installed, switched off, or has many updates still waitingthe database, as before
The index is unreachable or returns an errorthe database – editors see no error
The index finds nothingthe database – it also finds text inside words (illa in Villa, parts of codes or e-mails)
10,000 or more items matchthe database, so the list and Select all always agree
Quick find (⌘K), relation fields in a form, assets, image librarythe database (not part of this feature)

The index only proposes items. Keel then applies its normal rules in the database – list conditions, markets, workspace permissions and the published / draft filter – so nobody sees more than before.

New and changed items

The index catches up a few seconds after an item is saved. Keel also finds everything saved in the last 5 minutes through the database, so new or renamed items show up immediately.

Settings

There is nothing to set in the admin. Your developer can switch the index off or change when it counts as out of date in keel.yaml (search.index, search.max_queue): see Setup → Search.

If search results look wrong

Results missing for items older than a few minutes mean the index is behind or incomplete. Your developer can rebuild it with bin/console generic-data-index:update:index -r and check progress with bin/console generic-data-index:status, which also shows how many updates are waiting. Meanwhile Keel keeps searching the database when the queue is too long, so editors can continue working.