API поиска и внутреннее устройство

Startup Index Synchronizer - автоматически проверяет и пересоздает нерелевантные или отсутствующие индексы при запуске приложения. Запускает фоновый процесс с постановкой в очередь всех экземпляров сущностей, связанных с созданными индексами.

Entity Tracking Listener - отслеживает изменения индексированных сущностей и ставит в очередь соответствующие элементы очереди.

Quartz Scheduler - планирует задачу, которая периодически обрабатывает элементы очереди индексации.

Indexing Queue Manager - ставит элементы в очередь индексации. Обрабатывает ранее поставленные в очередь элементы и выполняет соответствующие действия через Entity Indexer.

Entity Indexer - выполняет операции с данными индекса: сохраняет и удаляет экземпляры сущностей.

Index Manager - управляет метаданными индекса: создает и удаляет индексы, проверяет маппинги.

Entity Searcher - выполняет поиск по индексам и возвращает результат поиска, который может быть отображен на экране.

index(Object entityInstance) - сохраняет предоставленный экземпляр сущности в индекс.

indexCollection(Collection<Object> entityInstances) - сохраняет предоставленные экземпляры сущностей в индекс.

indexByEntityId(Id entityId) - сохраняет экземпляр сущности в индекс по предоставленному id.

indexCollectionByEntityIds(Collection<Id> entityIds) - сохраняет экземпляры сущностей в индекс по предоставленным id.

delete(Object entityInstance) - удаляет предоставленный экземпляр сущности из индекса.

deleteCollection(Collection<Object> entityInstances) - удаляет предоставленные экземпляры сущностей из индекса.

deleteByEntityId(Id entityId) - удаляет экземпляр сущности из индекса по предоставленному id.

deleteCollectionByEntityIds(Collection<Id> entityIds) - удаляет экземпляры сущностей из индекса по предоставленным id.

emptyQueue() - удаляет все элементы из очереди индексации.

emptyQueue(String entityName) - удаляет все элементы, связанные с предоставленной сущностью, из очереди индексации.

enqueueIndex(Object entityInstance) - ставит в очередь событие индексации для предоставленного экземпляра сущности.

enqueueIndexCollection(Collection<Object> entityInstances) - ставит в очередь события индексации для предоставленных экземпляров сущностей.

enqueueIndexByEntityId(Id entityId) - ставит в очередь событие индексации для предоставленного id сущности.

enqueueIndexCollectionByEntityIds(Collection<Id> entityIds) - ставит в очередь события индексации для предоставленных id сущностей.

enqueueIndexAll() - ставит в очередь события индексации для всех экземпляров всех сущностей, настроенных для индексации.

enqueueIndexAll(String entityName) - ставит в очередь события индексации для всех экземпляров предоставленной сущности. Эта сущность должна быть предварительно настроена для индексации.

enqueueDelete(Object entityInstance) - ставит в очередь событие удаления для предоставленного экземпляра сущности.

enqueueDeleteCollection(Collection<Object> entityInstances) - ставит в очередь события удаления для предоставленных экземпляров сущностей.

enqueueDeleteByEntityId(Id entityId) - ставит в очередь событие удаления для предоставленного id сущности.

enqueueDeleteCollectionByEntityIds(Collection<Id> entityIds) - ставит в очередь события удаления для предоставленных id сущностей.

processNextBatch() - извлекает следующую партию элементов из очереди индексации и обрабатывает их.

processNextBatch(int batchSize) - извлекает следующую партию (размером batchSize) элементов из очереди индексации и обрабатывает их.

processEntireQueue() - извлекает все элементы из очереди индексации и обрабатывает их.

SearchResult search(SearchContext searchContext, String searchStrategy) - выполняет поиск по поисковым индексам в соответствии с предоставленным SearchContext и именем стратегии поиска.

search(SearchContext searchContext) - аналогичен предыдущему, но использует стратегию поиска по умолчанию (SearchStrategy).

searchNextPage(SearchResult previousSearchResult) - выполняет поиск следующей страницы на основе SearchResult предыдущего поискового запроса. Возвращает собственный SearchResult, который может быть использован для следующего вызова.

SearchContext - описывает основные настройки текущего поиска:

SearchStrategy - описывает способ обработки searchText.

Collection<Object> loadEntityInstances(SearchResult searchResult)

Collection<Object> loadEntityInstances(SearchResult searchResult, Map<String, FetchPlan> fetchPlans)

emptyIndexingQueue - удаляет все элементы из очереди индексации. Доступны два варианта этой операции:

enqueueIndexAll - ставит в очередь все экземпляры индексированных сущностей. Доступны два варианта этой операции:

processEntireIndexingQueue - обрабатывает все элементы в очереди индексации.

processIndexingQueueNextBatch - обрабатывает следующую партию элементов в очереди индексации.

recreateIndex - удаляет и создает индекс, связанный с предоставленной сущностью. Все данные будут потеряны.

recreateIndexes - удаляет и создает все поисковые индексы, определенные в приложении. Все данные будут потеряны.

synchronizeIndexSchema - синхронизирует схему индекса, связанного с предоставленной сущностью. Это может привести к удалению этого индекса со всеми данными - зависит от стратегии управления схемой.

synchronizeIndexSchemas - синхронизирует схемы всех поисковых индексов, определенных в приложении. Это может привести к удалению индексов со всеми их данными - зависит от стратегии управления схемой.

validateIndex - проверяет схему поискового индекса, связанного с предоставленной сущностью, и отображает статус.

validateIndexes - проверяет схемы всех поисковых индексов, определенных в приложении, и отображает статус для всех индексов.

Предварительный поиск - проверяет политики сущностей и исключает индексы, связанные с запрещенными сущностями.

Пост-поиск - проверяет, есть ли политики на уровне строк, настроенные для найденных сущностей. Если они существуют, найденные экземпляры перезагружаются для применения политик безопасности.