Package io.quarkus.hibernate.search.standalone.elasticsearch.runtime

Interface HibernateSearchStandaloneRuntimeConfig.IndexingPlanSynchronizationConfig

Enclosing interface:
HibernateSearchStandaloneRuntimeConfig
public static interface HibernateSearchStandaloneRuntimeConfig.IndexingPlanSynchronizationConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    strategy()
    How to synchronize between application threads and indexing, in particular when relying on (implicit) listener-triggered indexing on entity change, but also when using a `SearchIndexingPlan` explicitly.

  • Method Details

    • strategy

      @ConfigDocDefault("write-sync") Optional<String> strategy()
      How to synchronize between application threads and indexing, in particular when relying on (implicit) listener-triggered indexing on entity change, but also when using a `SearchIndexingPlan` explicitly. Defines how complete indexing should be before resuming the application thread after a `SearchSession` is closed. Available values: [cols=5] !=== .2+h!Strategy .2+h!Throughput 3+^h!Guarantees when the application thread resumes h!Changes applied h!Changes safe from crash/power loss h!Changes visible on search !async !Best ^!icon:times[role=red] ^!icon:times[role=red] ^!icon:times[role=red] !write-sync (**default**) !Medium ^!icon:check[role=lime] ^!icon:check[role=lime] ^!icon:times[role=red] !read-sync !Medium to worst ^!icon:check[role=lime] ^!icon:times[role=red] ^!icon:check[role=lime] !sync !Worst ^!icon:check[role=lime] ^!icon:check[role=lime] ^!icon:check[role=lime] !=== This property also accepts a xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to a custom implementations of `IndexingPlanSynchronizationStrategy`. See link:{hibernate-search-docs-url}#indexing-plan-synchronization[this section of the reference documentation] for more information. [NOTE] ==== Instead of setting this configuration property, you can simply annotate your custom `IndexingPlanSynchronizationStrategy` implementation with `@SearchExtension` and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. ====