Annotation Interface EnableJdbcRepositories
@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Inherited
@Import(org.springframework.data.jdbc.repository.config.JdbcRepositoriesRegistrar.class)
public @interface EnableJdbcRepositories
Annotation to enable JDBC repositories. Will scan the package of the annotated configuration class for Spring Data
repositories by default.
- Author:
- Jens Schauder, Greg Turnquist, Mark Paluch, Fei Dong, Antoine Sauray
- See Also:
-
Optional Element Summary
Optional ElementsModifier 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.Configures the name of theDataAccessStrategy
bean definition to be used to create repositories discovered through this annotation.Specifies which types are not eligible for component scanning.Specifies which types are eligible for component scanning.Configures the name of theNamedParameterJdbcOperations
bean definition to be used to create repositories discovered through this annotation.Configures the location of where to find the Spring Data named queries properties file.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.Configures the name of theDataSourceTransactionManager
bean definition to be used to create repositories discovered through this annotation.String[]
Alias for thebasePackages()
attribute.
-
Element Details
-
value
String[] valueAlias for thebasePackages()
attribute. Allows for more concise annotation declarations e.g.:@EnableJdbcRepositories("org.my.pkg")
instead of@EnableJdbcRepositories(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
.- Default:
- "Impl"
-
namedQueriesLocation
String namedQueriesLocationConfigures the location of where to find the Spring Data named queries properties file. Will default toMETA-INF/jdbc-named-queries.properties
.- Default:
- ""
-
repositoryFactoryBeanClass
Class<?> repositoryFactoryBeanClassReturns theFactoryBean
class to be used for each repository instance. Defaults toJdbcRepositoryFactoryBean
.- Default:
- org.springframework.data.jdbc.repository.support.JdbcRepositoryFactoryBean.class
-
repositoryBaseClass
Class<?> repositoryBaseClassConfigure the repository base class to be used to create repository proxies for this particular configuration.- Since:
- 2.1
- Default:
- org.springframework.data.repository.config.DefaultRepositoryBaseClass.class
-
considerNestedRepositories
boolean considerNestedRepositoriesConfigures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.- Default:
- false
-
jdbcOperationsRef
String jdbcOperationsRefConfigures the name of theNamedParameterJdbcOperations
bean definition to be used to create repositories discovered through this annotation. Defaults tonamedParameterJdbcTemplate
.- Default:
- ""
-
dataAccessStrategyRef
String dataAccessStrategyRefConfigures the name of theDataAccessStrategy
bean definition to be used to create repositories discovered through this annotation. Defaults todefaultDataAccessStrategy
.- Default:
- ""
-
transactionManagerRef
String transactionManagerRefConfigures the name of theDataSourceTransactionManager
bean definition to be used to create repositories discovered through this annotation. Defaults totransactionManager
.- Since:
- 2.1
- Default:
- "transactionManager"
-