“Automatic indexing” is a problematic name because:
# It’s too generic. Mass indexing can also be called “automatic”, since it automatically load entities from the database. # In a way, it’s too specific. For example we document the synchronization strategy, or the coordination, as affecting automatic indexing, but they also affect manual indexing through an indexing plan, which is not technically speaking “automatic”.
So, we need to come up with two names:
# One for indexing that relies on an indexing plan, as opposed to indexing that relies on an Indexer/MassIndexer. # One for indexing that happens as a consequence of Hibernate ORM entities being modified, as opposed to indexing requested explicitly by the user (explicit call to an indexing plan, mass indexer, JSR-352 indexing job, …). Note this indexing is specific to the ORM mapper: the Standalone POJO mapper doesn’t have that.
When we have those two names, we will have to use them in documentation (reference, README, …) and configuration properties (taking care to keep the old ones and deprecate them).
Note we may also need to restructure the documentation, in particular to clarify that manual indexing using indexing plans does follow similar rules as “automatic” indexing using indexing plans (synchronization, coordination). |
|