Package com.google.cloud.spring.data.spanner.repository.config

Annotation Interface EnableSpannerRepositories

@Target(TYPE) @Retention(RUNTIME) @Inherited @Documented @Import(SpannerRepositoriesRegistrar.class) public @interface EnableSpannerRepositories
Annotation that enables Spanner's Query Method functionality.
Since:
1.1

  • Element Details

    • value

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

    • includeFilters

      org.springframework.context.annotation.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.
      Returns:
      an empty array.
      Default:
      {}

    • excludeFilters

      org.springframework.context.annotation.ComponentScan.Filter[] excludeFilters
      Specifies which types are not eligible for component scanning.
      Returns:
      an empty array
      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 String-based package names.
      Returns:
      an empty array
      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.
      Returns:
      an empty array
      Default:
      {}

    • repositoryBaseClass

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

    • considerNestedRepositories

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

    • repositoryFactoryBeanClass

      Class repositoryFactoryBeanClass
      Returns the FactoryBean class to be used for each repository instance. Defaults to SpannerRepositoryFactoryBean.
      Returns:
      the factory bean class used to create factories
      Default:
      com.google.cloud.spring.data.spanner.repository.support.SpannerRepositoryFactoryBean.class

    • namedQueriesLocation

      String namedQueriesLocation
      Configures the location of where to read the Spring Data named queries properties file. Will default to META-INF/spanner-named-queries.properties
      Returns:
      the location of the file holding named queries' strings.
      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:
      the default suffix that will cause classes to be assumed to be implementations
      Default:
      ""

    • spannerTemplateRef

      String spannerTemplateRef
      Configures the name of the SpannerOperations bean to be used by default with the repositories detected.
      Returns:
      the name of the Cloud Spanner template class
      Default:
      "spannerTemplate"

    • spannerMappingContextRef

      String spannerMappingContextRef
      Configures the name of the SpannerMappingContext bean to be used by default with the repositories detected.
      Returns:
      the name of the Cloud Spanner mapping context class
      Default:
      "spannerMappingContext"