Package io.quarkus.hibernate.search.backend.elasticsearch.common.runtime

Interface HibernateSearchBackendElasticsearchBuildTimeConfig.SchemaManagementConfig

Enclosing interface:
HibernateSearchBackendElasticsearchBuildTimeConfig
public static interface HibernateSearchBackendElasticsearchBuildTimeConfig.SchemaManagementConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    mappingFile()
    Path to a file in the classpath holding a custom index mapping to be included in the index definition when creating an Elasticsearch index.
    Optional<String>
    settingsFile()
    Path to a file in the classpath holding custom index settings to be included in the index definition when creating an Elasticsearch index.

  • Method Details

    • settingsFile

      Optional<String> settingsFile()
      Path to a file in the classpath holding custom index settings to be included in the index definition when creating an Elasticsearch index. The provided settings will be merged with those generated by Hibernate Search, including analyzer definitions. When analysis is configured both through an analysis configurer and these custom settings, the behavior is undefined; it should not be relied upon. See link:{hibernate-search-docs-url}#backend-elasticsearch-configuration-index-settings[this section of the reference documentation] for more information.

    • mappingFile

      Optional<String> mappingFile()
      Path to a file in the classpath holding a custom index mapping to be included in the index definition when creating an Elasticsearch index. The file does not need to (and generally shouldn't) contain the full mapping: Hibernate Search will automatically inject missing properties (index fields) in the given mapping. See link:{hibernate-search-docs-url}#backend-elasticsearch-mapping-custom[this section of the reference documentation] for more information.