Skip to content

Commit

Permalink
HSEARCH-3849 Document the create-or-validate operation in the schema …
Browse files Browse the repository at this point in the history
…manager API of the ORM mapper
  • Loading branch information
yrodiere committed Mar 6, 2020
1 parent 2c3c1d5 commit 4098909
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
7 changes: 7 additions & 0 deletions documentation/src/main/asciidoc/mapper-orm-schema.asciidoc
Expand Up @@ -118,6 +118,13 @@ because <<mapper-orm-schema-management-concepts-lucene-schema,local Lucene index
|Creates missing indexes and their schema,
but does not touch existing indexes and assumes their schema is correct without validating it.
|<<mapper-orm-schema-management-concepts-massindexing,Creating a schema does not populate indexed data>>.
|[[mapper-orm-schema-management-manager-create-or-validate]]`createOrValidate()`
|Creates missing indexes and their schema,
and validates the schema of existing indexes.
|<<mapper-orm-schema-management-concepts-massindexing,Creating a schema does not populate indexed data>>.

With the Lucene backend, validation is limited to checking that the indexes exist,
because <<mapper-orm-schema-management-concepts-lucene-schema,local Lucene indexes don't have a schema>>.
|[[mapper-orm-schema-management-manager-create-or-update]]`createOrUpdate()`
|Creates missing indexes and their schema,
and updates the schema of existing indexes if possible.
Expand Down
Expand Up @@ -53,7 +53,8 @@ public interface SearchSchemaManager {
* but their schema does not match the requirements of the Hibernate Search mapping:
* missing fields, fields with incorrect type, missing analyzer definitions or normalizer definitions, ...
* <p>
* With Lucene, the schema of indexes is not validated.
* <strong>Warning:</strong> with the Lucene backend, validation is limited to checking that the indexes exist,
* because local Lucene indexes don't have a schema.
*/
void createOrValidate();

Expand Down

0 comments on commit 4098909

Please sign in to comment.