Annotation Interface EnableMongoRepositories
@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Inherited
@Import(org.springframework.data.mongodb.repository.config.MongoRepositoriesRegistrar.class)
public @interface EnableMongoRepositories
Annotation to activate MongoDB repositories. If no base package is configured through either
value()
,
basePackages()
or basePackageClasses()
it will trigger scanning of the package of annotated class.- Author:
- Oliver Gierke, Thomas Darimont
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionClass<?>[]
Type-safe alternative tobasePackages()
for specifying the packages to scan for annotated components.String[]
Base packages to scan for annotated components.boolean
Configures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.boolean
Whether to automatically create indexes for query methods defined in the repository interface.Specifies which types are not eligible for component scanning.Specifies which types are eligible for component scanning.Configures the name of theMongoTemplate
bean to be used with the repositories detected.Configures the location of where to find the Spring Data named queries properties file.Returns the key of theQueryLookupStrategy
to be used for lookup queries for query methods.Class<?>
Configure the repository base class to be used to create repository proxies for this particular configuration.Class<?>
Returns theFactoryBean
class to be used for each repository instance.Returns the postfix to be used when looking up custom repository implementations.String[]
Alias for thebasePackages()
attribute.
-
Element Details
-
value
String[] valueAlias for thebasePackages()
attribute. Allows for more concise annotation declarations e.g.:@EnableMongoRepositories("org.my.pkg")
instead of@EnableMongoRepositories(basePackages="org.my.pkg")
.- Default:
- {}
-
basePackages
String[] basePackagesBase packages to scan for annotated components.value()
is an alias for (and mutually exclusive with) this attribute. UsebasePackageClasses()
for a type-safe alternative to String-based package names.- Default:
- {}
-
basePackageClasses
Class<?>[] basePackageClassesType-safe alternative tobasePackages()
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[] includeFiltersSpecifies which types are eligible for component scanning. Further narrows the set of candidate components from everything inbasePackages()
to everything in the base packages that matches the given filter or filters.- Default:
- {}
-
excludeFilters
ComponentScan.Filter[] excludeFiltersSpecifies which types are not eligible for component scanning.- Default:
- {}
-
repositoryImplementationPostfix
String repositoryImplementationPostfixReturns the postfix to be used when looking up custom repository implementations. Defaults to Impl. So for a repository namedPersonRepository
the corresponding implementation class will be looked up scanning forPersonRepositoryImpl
.- Returns:
- Impl by default.
- Default:
- "Impl"
-
namedQueriesLocation
String namedQueriesLocationConfigures the location of where to find the Spring Data named queries properties file. Will default toMETA-INFO/mongo-named-queries.properties
.- Returns:
- empty
String
by default.
- Default:
- ""
-
queryLookupStrategy
QueryLookupStrategy.Key queryLookupStrategyReturns the key of theQueryLookupStrategy
to be used for lookup queries for query methods. Defaults toQueryLookupStrategy.Key.CREATE_IF_NOT_FOUND
.- Returns:
QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND
by default.
- Default:
- CREATE_IF_NOT_FOUND
-
repositoryFactoryBeanClass
Class<?> repositoryFactoryBeanClassReturns theFactoryBean
class to be used for each repository instance. Defaults toMongoRepositoryFactoryBean
.- Returns:
MongoRepositoryFactoryBean
by default.
- Default:
- org.springframework.data.mongodb.repository.support.MongoRepositoryFactoryBean.class
-
repositoryBaseClass
Class<?> repositoryBaseClassConfigure the repository base class to be used to create repository proxies for this particular configuration.- Returns:
DefaultRepositoryBaseClass
by default.- Since:
- 1.8
- Default:
- org.springframework.data.repository.config.DefaultRepositoryBaseClass.class
-
mongoTemplateRef
String mongoTemplateRefConfigures the name of theMongoTemplate
bean to be used with the repositories detected.- Returns:
- mongoTemplate by default.
- Default:
- "mongoTemplate"
-
createIndexesForQueryMethods
boolean createIndexesForQueryMethodsWhether to automatically create indexes for query methods defined in the repository interface.- Returns:
- false by default.
- Default:
- false
-
considerNestedRepositories
boolean considerNestedRepositoriesConfigures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.- Returns:
- false by default.
- Default:
- false
-