Package org.springframework.data.elasticsearch.repository.config

Annotation Interface EnableElasticsearchRepositories

@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited @Import(org.springframework.data.elasticsearch.repository.config.ElasticsearchRepositoriesRegistrar.class) public @interface EnableElasticsearchRepositories
Annotation to enable Elasticsearch repositories. Will scan the package of the annotated configuration class for Spring Data repositories by default.
Author:
Rizwan Idrees, Mohsin Husen, Kevin Leturc, Peter-Josef Meisch

  • Element Details

    • value

      String[] value
      Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @EnableElasticsearchRepositories("org.my.pkg") instead of @EnableElasticsearchRepositories(basePackages="org.my.pkg").
      Default:
      {}

    • basePackages

      String[] basePackages
      Base packages to scan for annotated components. value() is an alias for (and mutually exclusive with) this attribute. Use basePackageClasses() for a type-safe alternative to text-based package names.
      Default:
      {}

    • basePackageClasses

      Class<?>[] basePackageClasses
      Type-safe alternative to basePackages() for specifying the packages to scan for annotated components. The package of each class specified will be scanned. Consider creating a special no-op marker class or interface in each package that serves no purpose other than being referenced by this attribute.
      Default:
      {}

    • includeFilters

      ComponentScan.Filter[] includeFilters
      Specifies which types are eligible for component scanning. Further narrows the set of candidate components from everything in basePackages() to everything in the base packages that matches the given filter or filters.
      Default:
      {}

    • excludeFilters

      ComponentScan.Filter[] excludeFilters
      Specifies which types are not eligible for component scanning.
      Default:
      {}

    • repositoryImplementationPostfix

      String repositoryImplementationPostfix
      Returns the postfix to be used when looking up custom repository implementations. Defaults to Impl. So for a repository named PersonRepository the corresponding implementation class will be looked up scanning for PersonRepositoryImpl.
      Returns:
      Default:
      "Impl"

    • namedQueriesLocation

      String namedQueriesLocation
      Configures the location of where to find the Spring Data named queries properties file. Will default to META-INFO/elasticsearch-named-queries.properties.
      Returns:
      Default:
      ""

    • queryLookupStrategy

      QueryLookupStrategy.Key queryLookupStrategy
      Returns the key of the QueryLookupStrategy to be used for lookup queries for query methods. Defaults to QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND.
      Returns:
      Default:
      CREATE_IF_NOT_FOUND

    • repositoryFactoryBeanClass

      Class<?> repositoryFactoryBeanClass
      Returns the FactoryBean class to be used for each repository instance. Defaults to ElasticsearchRepositoryFactoryBean.
      Returns:
      Default:
      org.springframework.data.elasticsearch.repository.support.ElasticsearchRepositoryFactoryBean.class

    • repositoryBaseClass

      Class<?> repositoryBaseClass
      Configure the repository base class to be used to create repository proxies for this particular configuration.
      Returns:
      Default:
      org.springframework.data.repository.config.DefaultRepositoryBaseClass.class

    • elasticsearchTemplateRef

      String elasticsearchTemplateRef
      Configures the name of the ElasticsearchOperations bean definition to be used to create repositories discovered through this annotation. Defaults to elasticsearchTemplate.
      Returns:
      Default:
      "elasticsearchTemplate"

    • considerNestedRepositories

      boolean considerNestedRepositories
      Configures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.
      Default:
      false