Spring Data Examples

https://github.com/spring-projects/spring-data-examples
Admin
Spring Data Examples provides sample projects showcasing how to use the APIs and features of various...
Tokens:36,719
Snippets:375
Trust Score:9.7
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start Elasticsearch

Source: https://github.com/spring-projects/spring-data-examples/blob/main/elasticsearch/reactive/README.md

Starts Elasticsearch locally from the elasticsearch directory. Required before running the reactive examples.

```bash
$ cd elasticsearch
$ ./bin/elasticsearch
```

--------------------------------

### Run Redis Container

Source: https://github.com/spring-projects/spring-data-examples/blob/main/README.adoc

Command to start a Redis 5.0 container for the pubsub example.

```bash
$ docker run -p 6379:6379 redis:5.0
```

--------------------------------

### Install GraalVM and native-image tooling

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jdbc/graalvm-native/README.adoc

Use SDKMAN! to install a recent GraalVM Java 17 distribution and then install the native-image tool with `gu install native-image`.

```bash
$> sdk install java <recent version>.r17-grl
$> gu install native-image
```

--------------------------------

### Using Example and ExampleMatcher with repository

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/query-by-example/README.md

Shows how to create an Example and use it with a repository, including a custom ExampleMatcher for matching criteria.

```java
Example<Person> example = Example.of(new Person("Jon", "Snow"));
repo.findAll(example);


ExampleMatcher matcher = ExampleMatcher.matching().
    .withMatcher("firstname", endsWith())
    .withMatcher("lastname", startsWith().ignoreCase());

Example<Person> example = Example.of(new Person("Jon", "Snow"), matcher); 
repo.count(example);
```

--------------------------------

### Redis Keys Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/redis/repositories/README.md

Example of Redis keys created for the entity, including the keyspace and secondary indexes.

```bash
redis/src $ ./redis-cli keys *
   1) "persons"                                             <1>
   2) "persons:9b0ed8ee-14be-46ec-b5fa-79570aadb91d"        <2>
   3) "persons:firstname:eddard"                            <3>
   4) "persons:firstname:eddard"                            <4>
   5) "persons:lastname:stark"                              <5>
   6) "persons:address.city:winterfell"                     <6>
```

--------------------------------

### Start Redis cluster with create-cluster start

Source: https://github.com/spring-projects/spring-data-examples/blob/main/redis/cluster/readme.md

Starts a 6-node Redis cluster (3 masters, 3 slaves) using the create-cluster utility. The output shows the nodes starting on ports 30001-30006.

```bash
redis/utils/create-cluster $ ./create-cluster start
  Starting 30001
  Starting 30002
  Starting 30003
  Starting 30004
  Starting 30005
  Starting 30006
```

--------------------------------

### Spring Boot JPA deferred mode startup log

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/deferred/README.adoc

Example output from a Spring Boot application started with the 'deferred' profile, showing DEBUG-level logs that indicate Spring Data repositories are bootstrapped in DEFERRED mode. The log shows the scanning of 2000 repository interfaces and the creation of the EntityManagerFactory asynchronously.

```bash
  .   ____          _            __ _ _
 /\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v2.1.0.BUILD-SNAPSHOT)

2018-08-16 14:51:15.294  INFO 45068 --- [           main] example.Application                      : Starting Application v4.0.0-SNAPSHOT on Serendipity-3.local with PID 45068 (/Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred/target/spring-data-jpa-deferred-4.0.0-SNAPSHOT.jar started by olivergierke in /Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred)
2018-08-11 14:51:15.294  INFO 45068 --- [           main] example.Application                      : The following profiles are active: deferred
2018-08-11 14:51:15.294 DEBUG 45068 --- [           main] o.s.b.c.c.ConfigFileApplicationListener  : Loading config file 'classpath:/application.properties'
2018-08-11 14:51:15.325 DEBUG 45068 --- [           main] o.s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@71f2a7d1
2018-08-11 14:51:15.342 DEBUG 45068 --- [           main] o.s.b.f.s.DefaultListableBeanFactory     : Creating shared instance of singleton bean 'org.springframework.context.annotation.internalConfigurationAnnotationProcessor'
2018-08-11 14:51:15.354 DEBUG 45068 --- [           main] o.s.b.f.s.DefaultListableBeanFactory     : Creating shared instance of singleton bean 'org.springframework.boot.autoconfigure.internalCachingMetadataReaderFactory'
2018-08-11 14:51:15.596 DEBUG 45068 --- [           main] o.s.c.a.ClassPathBeanDefinitionScanner   : Identified candidate component class: URL [jar:file:/Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred/target/spring-data-jpa-deferred-4.0.0-SNAPSHOT.jar!/BOOT-INF/classes!/example/Application$LazyJpaConfiguration.class]
2018-08-11 14:51:15.644 DEBUG 45068 --- [           main] o.s.c.a.ClassPathBeanDefinitionScanner   : Identified candidate component class: URL [jar:file:/Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred/target/spring-data-jpa-deferred-4.0.0-SNAPSHOT.jar!/BOOT-INF/classes!/example/service/Customer1803Service.class]
… (truncated log output)

```

--------------------------------

### Use Example and ExampleMatcher for Query-by-Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/r2dbc/query-by-example/README.adoc

Shows how to create an Example from a Person instance and use it with findAll. Also demonstrates using ExampleMatcher to customize matching (endsWith, startsWith, ignoreCase) and then using count.

```java
Example<Person> example = Example.of(new Person("Jon", "Snow"));
repo.findAll(example);


ExampleMatcher matcher = ExampleMatcher.matching().
    .withMatcher("firstname", endsWith())
    .withMatcher("lastname", startsWith().ignoreCase());

Example<Person> example = Example.of(new Person("Jon", "Snow"), matcher);
repo.count(example);
```

--------------------------------

### SqlResultSetMapping examples

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/jpa21/README.md

Examples for custom SqlResultSetMapping with ConstructorResult: entity mapping, value object, and repository method.

```java
@Entity
@NoArgsConstructor
@SqlResultSetMapping(
  name = "subscriptionSummary",
  classes = @ConstructorResult(
    targetClass = SubscriptionSummary.class,
    columns = {
      @ColumnResult(name = "productName", type = String.class),
      @ColumnResult(name = "subscriptions", type = long.class)
}))
@NamedNativeQuery(
  name = "Subscription.findAllSubscriptionSummaries",
  query = "select product_name as productName, count(user_id) as subscriptions from subscription group by product_name order by productName",
  resultSetMapping = "subscriptionSummary"
)
@Data
public class Subscription {
  // ...
}
```

```java
@Value
public class SubscriptionSummary {

  String product;
  Long usageCount;
}
```

```java
interface SubscriptionRepository extends CrudRepository<Subscription,Long> {

  @Query(nativeQuery = true)
  List<SubscriptionSummary> findAllSubscriptionSummaries();
}
```

--------------------------------

### AOT Repository Examples

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jdbc/aot-optimization/README.adoc

Code examples demonstrating AOT repository usage, generated repository implementation, and metadata JSON.

```bash
$ mvn clean package
$ java -Dspring.aot.enabled=true -jar target/spring-data-jdbc-aot-optimization-4.0.0-SNAPSHOT.jar
```

```java
@Generated
public class CategoryRepositoryImpl__AotRepository extends AotRepositoryFragmentSupport {
  public CategoryRepositoryImpl__AotRepository(JdbcAggregateOperations operations,
      RowMapperFactory rowMapperFactory,
      RepositoryFactoryBeanSupport.FragmentCreationContext context) {
    super(operations, rowMapperFactory, context);
  }

  public List<Category> findAllByNameContaining(String name) {
    Criteria criteria = Criteria.where("name").like("%" + escape(name) + "%");
    StatementFactory.SelectionBuilder builder = getStatementFactory().select(Category.class).filter(criteria);

    RowMapper rowMapper = getRowMapperFactory().create(Category.class);
    List result = (List) builder.executeWith((sql, paramSource) -> getJdbcOperations().query(sql, paramSource, new RowMapperResultSetExtractor<>(rowMapper)));
    return (List<Category>) convertMany(result, Category.class);
  }

  public List<Category> findWithDeclaredQuery(String name) {
    class ExpressionMarker{};
    String query = "SELECT * FROM category WHERE name = :name";
    MapSqlParameterSource parameterSource = new MapSqlParameterSource();
    getBindableValue(ExpressionMarker.class.getEnclosingMethod(), name, 0).bind("name", parameterSource);

    RowMapper rowMapper = getRowMapperFactory().create(Category.class);
    List result = (List) getJdbcOperations().query(query, parameterSource, new RowMapperResultSetExtractor<>(rowMapper));
    return (List<Category>) convertMany(result, Category.class);
  }
}
```

```json
{
  "name": "example.springdata.aot.CategoryRepository",
  "module": "JDBC",
  "type": "IMPERATIVE",
  "methods": [
    {
      "name": "findProjectedByNameContaining",
      "signature": "public abstract java.util.List<example.springdata.aot.CategoryProjection> example.springdata.aot.CategoryRepository.findProjectedByNameContaining(java.lang.String)",
      "query": {
        "query": "SELECT \"CATEGORY\".\"NAME\" AS \"NAME\", \"CATEGORY\".\"DESCRIPTION\" AS \"DESCRIPTION\" FROM \"CATEGORY\" WHERE \"CATEGORY\".\"NAME\" LIKE :name"
      }
    },
    {
      "name": "findWithDeclaredQuery",
      "signature": "public abstract java.util.List<example.springdata.aot.Category> example.springdata.aot.CategoryRepository.findWithDeclaredQuery(java.lang.String)",
      "query": {
        "query": "SELECT * FROM category WHERE name = :name"
      }
    },
    {
      "name": "save",
      "signature": "org.springframework.data.jdbc.repository.support.SimpleJdbcRepository",
      "fragment": {
        "interface": "org.springframework.data.jdbc.repository.support.SimpleJdbcRepository",
        "fragment": "org.springframework.data.jdbc.repository.support.SimpleJdbcRepository"
      }
    }
  ]
}
```

--------------------------------

### Redis Configuration Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/redis/repositories/README.md

Configuration class using Lettuce connection factory and enabling Redis repositories.

```java
@Configuration
@EnableRedisRepositories
class AppConfig {

  @Bean
  RedisConnectionFactory connectionFactory() {
    return new LettuceConnectionFactory();
  }

  @Bean
  RedisTemplate<?, ?> redisTemplate(RedisConnectionFactory connectionFactory) {

    RedisTemplate<byte[], byte[]> template = new RedisTemplate<>();
    template.setConnectionFactory(connectionFactory);

    return template;
  }
}
```

--------------------------------

### Run in Lazy Mode

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/deferred/README.adoc

Command to run the example in lazy mode with the 'lazy' profile activated.

```bash
$ java -jar -Dspring.profiles.active=lazy target/*.jar`
```

--------------------------------

### Items response

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Example response from fetching items with credentials.

```json
{
  "_embedded" : {
    "items" : [ {
      "description" : "Sting",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/items/1"
        }
      }
    }, {
      "description" : "the one ring",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/items/2"
        }
      }
    } ]
  }
}
```

--------------------------------

### EntityGraph examples

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/jpa21/README.md

Two examples of using the @EntityGraph annotation to specify fetch graphs for repository query methods.

```java
@EntityGraph("product-with-tags")
Product findOneById(Long id);
```

```java
@EntityGraph(attributePaths = "tags")
Product getOneById(Long id);
```

--------------------------------

### Stored procedure examples

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/jpa21/README.md

Examples for stored procedure execution: SQL declaration, JPA entity mapping, and Spring Data repository methods.

```sql
DROP procedure IF EXISTS plus1inout
/;
CREATE procedure plus1inout (IN arg int, OUT res int)
BEGIN ATOMIC
    set res = arg + 1;
END
/;
```

```java
@Entity
@NamedStoredProcedureQuery(name = "User.plus1", procedureName = "plus1inout", parameters = {
  @StoredProcedureParameter(mode = ParameterMode.IN, name = "arg", type = Long.class)
})
public class User {

    @Id @GeneratedValue
    private Long id;
}
```

```java
public interface UserRepository extends CrudRepository<User, Long> {

  // Explicitly mapped to named stored procedure {@code User.plus1} in the {@link EntityManager}.
  // By default, we would've tried to find a procedure declaration named User.plus1BackedByOtherNamedStoredProcedure
  @Procedure(name = "User.plus1")
  Integer plus1BackedByOtherNamedStoredProcedure(@Param("arg") Integer arg);

  // Directly map to the stored procedure named "plus1inout"
  @Procedure
  Integer plus1inout(@Param("arg") Integer arg);
}
```

--------------------------------

### Startup Log

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/deferred/README.adoc

Startup log output showing the application starting in lazy mode with Spring Data repositories bootstrapping in LAZY mode.

```text
  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ 
 \/ \___ \ '__| | | | '_ \| | | | \ \ 
  \___  | |  | |_| | | | | | |_| |  \ \ 
       |_|  |_| |_|_|_| |_\__,_|  \_\_\ 

 :: Spring Boot ::  (v2.1.0.BUILD-SNAPSHOT)

2018-08-16 15:02:50.642  INFO 45568 --- [           main] example.Application                      : Starting Application v4.0.0-SNAPSHOT on Serendipity-3.local with PID 45568 (/Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred/target/spring-data-jpa-deferred-4.0.0-SNAPSHOT.jar started by olivergierke in /Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred)
2018-08-16 15:02:50.642  INFO 45568 --- [           main] example.Application                      : The following profiles are active: lazy
2018-08-16 15:02:50.642 DEBUG 45568 --- [           main] o.s.boot.SpringApplication               : Loading source class example.Application
2018-08-16 15:02:50.684 DEBUG 45568 --- [           main] o.s.b.c.c.ConfigFileApplicationListener  : Activated activeProfiles lazy
2018-08-16 15:02:50.684 DEBUG 45568 --- [           main] o.s.b.c.c.ConfigFileApplicationListener  : Loading application config file [file:/Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred/target/spring-data-jpa-deferred-4.0.0-SNAPSHOT.jar!/BOOT-INF/classes!/application.properties] (classpath:/application.properties)
2018-08-16 15:02:50.684 DEBUG 45568 --- [           main] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@224aed64
2018-08-16 15:02:50.700 DEBUG 45568 --- [           main] o.s.b.f.s.DefaultListableBeanFactory     : Creating shared instance of singleton bean 'org.springframework.context.annotation.internalConfigurationAnnotationProcessor'
2018-08-16 15:02:50.713 DEBUG 45568 --- [           main] o.s.b.f.s.DefaultListableBeanFactory     : Creating shared instance of singleton bean 'org.springframework.boot.autoconfigure.internalCachingMetadataReaderFactory'
2018-08-16 15:02:50.945 DEBUG 45568 --- [           main] o.s.c.a.ClassPathBeanDefinitionScanner   : Identified candidate component class: URL [jar:file:/Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred/target/spring-data-jpa-deferred-4.0.0-SNAPSHOT.jar!/BOOT-INF/classes!/example/Application$LazyJpaConfiguration.class]
2018-08-16 15:02:50.989 DEBUG 45568 --- [           main] o.s.c.a.ClassPathBeanDefinitionScanner   : Identified candidate component class: URL [jar:file:/Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred/target/spring-data-jpa-deferred-4.0.0-SNAPSHOT.jar!/BOOT-INF/classes!/example/service/Customer1803Service.class]
… <1>
2018-08-16 15:02:51.442 DEBUG 45568 --- [           main] o.s.c.a.ClassPathBeanDefinitionScanner   : Identified candidate component class: URL [jar:file:/Users/olivergierke/Documents/workspace/spring-data-examples/jpa/deferred/target/spring-data-jpa-deferred-4.0.0-SNAPSHOT.jar!/BOOT-INF/classes!/example/service/Customer1830Service.class]
2018-08-16 15:02:51.907  INFO 45568 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Bootstrapping Spring Data repositories in LAZY mode.
2018-08-16 15:02:51.917 DEBUG 45568 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Scanning for repositories in packages example.
```

--------------------------------

### Redis HASH Storage Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/redis/repositories/README.md

Example of how the entity is stored in a Redis HASH, showing flattened complex types and reference keys.

```properties
_class=example.springdata.redis.domain.Person                <1>
id=9b0ed8ee-14be-46ec-b5fa-79570aadb91d
firstname=eddard                                             <2>
lastname=stark
gender=MALE
address.city=winterfell                                      <3>
address.country=the north
children.[0]=persons:41436096-aabe-42fa-bd5a-70aadb91d
```

--------------------------------

### DocumentReference by Property Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/linking/README.md

Example of linking documents via a non-_id property using @DocumentReference with a lookup query.

```java
class Manager {
	
    @DocumentReference(lookup = "{ 'name' : ?#{#target} }")
    private List<Employee> employees;

    // ...
}
```

--------------------------------

### Run deferred mode with profile

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/deferred/README.adoc

Command to start the application in deferred mode by activating the `deferred` profile. This enables background JPA initialization and deferred repository initialization.

```bash
$ java -jar -Dspring.profiles.active=deferred target/*.jar`
```

--------------------------------

### DBRef Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/linking/README.md

Example of using MongoDB native DBRef to store associations between documents.

```java
class Manager {
	
    @DBRef
    private List<Employee> employees;

    // ...
}
```

--------------------------------

### AOT Repository Examples

Source: https://github.com/spring-projects/spring-data-examples/blob/main/cassandra/aot-optimization/README.adoc

Code examples from the Spring Data Cassandra AOT optimization README: shell commands for building and running, a generated Java AOT repository class, and a JSON metadata file describing repository queries.

```bash
$ mvn clean package
$ java -Dspring.aot.enabled=true -jar target/spring-data-cassandra-aot-optimization-4.0.0-SNAPSHOT.jar

```

```java
@Generated
public class UserRepositoryImpl__AotRepository extends AotRepositoryFragmentSupport {
  private final CassandraOperations operations;

  public UserRepositoryImpl__AotRepository(CassandraOperations operations,
      RepositoryFactoryBeanSupport.FragmentCreationContext context) {
    // …
  }

  public User findUserByIdIn(long id) {
    Object[] args = new Object[1];
    args[0] = potentiallyConvertBindingValue(id);
    SimpleStatement query = SimpleStatement.newInstance("SELECT * from users where user_id in(?)", args);

    ExecutableSelectOperation.TerminatingResults<User> select = operations.query(query).as(User.class);
    return select.oneValue();
  }

  public User findUserByUsername(String username) {
    Query query = Query.query(Criteria.where("username").is(username));

    ExecutableSelectOperation.TerminatingSelect<User> select = operations.query(User.class).matching(query);
    return select.oneValue();
  }
}

```

```json
{
  "name": "example.springdata.cassandra.UserRepository",
  "module": "Cassandra",
  "type": "IMPERATIVE",
  "methods": [
    {
      "name": "findUserByIdIn",
      "signature": "public abstract example.springdata.cassandra.User example.springdata.cassandra.UserRepository.findUserByIdIn(long)",
      "query": {
        "query": "SELECT * from users where user_id in(?)"
      }
    },
    {
      "name": "findUserByUsername",
      "signature": "public abstract example.springdata.cassandra.User example.springdata.cassandra.UserRepository.findUserByUsername(java.lang.String)",
      "query": {
        "query": "SELECT * FROM users WHERE uname=?"
      }
    },
    {
      "name": "save",
      "signature": "org.springframework.data.cassandra.repository.support.SimpleCassandraRepository",
      "fragment": {
        "interface": "org.springframework.data.cassandra.repository.support.SimpleCassandraRepository",
        "fragment": "org.springframework.data.cassandra.repository.support.SimpleCassandraRepository"
      }
    }
  ]
}

```

--------------------------------

### DocumentReference by ID Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/linking/README.md

Example of linking documents via their id using @DocumentReference.

```java
class Manager {
	
    @DocumentReference
    private List<Employee> employees;

    // ...
}
```

--------------------------------

### Redis Hash Entity Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/redis/repositories/README.md

Example entity class annotated with @RedisHash, @Id, @Indexed, and @Reference to demonstrate Redis repository mapping.

```java
@RedisHash("persons")
class Person {

  @Id String id;

  @Indexed String firstname;
  @Indexed String lastname;

  Gender gender;
  Address address;

  @Reference List<Person> children;
}
```

--------------------------------

### Run tests with Maven

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jdbc/immutables/README.adoc

Command to run the tests for the Spring Data JDBC with Immutables example.

```shell
	$ mvn test

```

--------------------------------

### Running the AOT Optimization Application

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/aot-optimization/README.adoc

This example demonstrates how to run the Spring Data MongoDB AOT optimization application using Maven and Java, showing the build and execution commands with the AOT flag enabled.

```bash
$ mvn clean package
$ java -Dspring.aot.enabled=true -jar target/spring-data-mongodb-aot-optimization-4.0.0-SNAPSHOT.jar

```

```java
@Generated
public class UserRepositoryImpl__AotRepository extends MongoAotRepositoryFragmentSupport {
  private final MongoOperations operations;

  public UserRepositoryImpl__AotRepository(MongoOperations operations,
      RepositoryFactoryBeanSupport.FragmentCreationContext context) {
      // …
  }

  public Boolean existsByUsername(String username) {
    class ExpressionMarker{};

    BasicQuery filterQuery = createQuery(ExpressionMarker.class.getEnclosingMethod(), "{\"username\": ?0}", username);

    ExecutableFindOperation.FindWithQuery<User> finder = operations.query(User.class);
    return finder.matching(filterQuery).exists();
  }

  public List<User> findJustUsernameBy() {

    BasicQuery filterQuery = new BasicQuery(new Document());
    Document fields = parse("{ 'username' :  1 }");
    filterQuery.setFieldsObject(fields);
    Document sort = parse("{ 'username' :  -1 }");
    filterQuery.setSortObject(sort);

    ExecutableFindOperation.FindWithQuery<User> finder = operations.query(User.class);
    return finder.matching(filterQuery).all();
  }
}

```

```json
{
  "name": "example.springdata.aot.UserRepository",
  "module": "MongoDB",
  "type": "IMPERATIVE",
  "methods": [
    {
      "name": "countUsersByLastnameLike",
      "signature": "public abstract java.lang.Long example.springdata.aot.UserRepository.countUsersByLastnameLike(java.lang.String)",
      "query": {
        "filter": "{\"lastname\": ?0}"
      }
    },
    {
      "name": "save",
      "signature": "org.springframework.data.mongodb.repository.support.SimpleMongoRepository",
      "fragment": {
        "interface": "org.springframework.data.mongodb.repository.support.SimpleMongoRepository",
        "fragment": "org.springframework.data.mongodb.repository.support.SimpleMongoRepository"
      }
    }
  ]
}

```

--------------------------------

### Employees response

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Example response from fetching employees.

```json
{
  "_embedded" : {
    "employees" : [ {
      "firstName" : "Bilbo",
      "lastName" : "Baggins",
      "title" : "thief",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/employees/1"
        }
      }
    }, {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "title" : "ring bearer",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/employees/2"
        }
      }
    } ]
  }
}
```

--------------------------------

### Kotlin Extensions

Source: https://github.com/spring-projects/spring-data-examples/blob/main/cassandra/kotlin/README.md

Example showing Kotlin extensions for type-based operations.

```kotlin
operations.getTableName<Person>()
 
operations.getTableName(Person::class)
```

--------------------------------

### Nullability

Source: https://github.com/spring-projects/spring-data-examples/blob/main/cassandra/kotlin/README.md

Example showing nullability in repository interfaces.

```kotlin
interface PersonRepository : CrudRepository<Person, String> {

	/**
	 * Query method declaring a nullable return type that allows to return null values.
	 */
	fun findOneOrNoneByFirstname(firstname: String): Person?

	/**
	 * Query method declaring a nullable argument.
	 */
	fun findNullableByFirstname(firstname: String?): Person?

	/**
	 * Query method requiring a result. Throws [org.springframework.dao.EmptyResultDataAccessException] if no result is found.
	 */
	fun findOneByFirstname(firstname: String): Person
}
```

--------------------------------

### DocumentReference JPA Style Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/linking/README.md

Example of linking documents JPA style using @DocumentReference with a lookup query referencing the self _id.

```java
class Manager {

    @ReadOnlyProperty
    @DocumentReference(lookup="{'managerId':?#{#self._id} }")
    private List<Employee> employees;

    // ...
}
```

--------------------------------

### PersonRepository interface with QueryByExampleExecutor

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/query-by-example/README.md

Defines a repository interface that extends CrudRepository and QueryByExampleExecutor to enable Query by Example.

```java
public interface PersonRepository extends CrudRepository<Person, String>, QueryByExampleExecutor<Person> {
}
```

--------------------------------

### Rerun code generator with Maven

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jdbc/immutables/README.adoc

Command to manually rerun the code generator for the Immutables example.

```shell
	$ mvn clean generate-sources

```

--------------------------------

### Geo query with FluentMongoOperations

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/fluent-api/README.md

Uses the near() method to switch to the geo query path, requiring a NearQuery and returning GeoResults. The example queries for Jedi within 3 miles of a coordinate and executes with all().

```java
NearQuery alderaanWithin3Parsecs = NearQuery.near(-73.9667, 40.78)
  .maxDistance(new Distance(3, MILES))
  .spherical(true);

GeoResults<Jedi> results = mongoOps.query(SWCharacter.class)
  .as(Jedi.class)
  .near(alderaanWithin3Parsecs)
  .all();
```

--------------------------------

### SecurityConfiguration with user accounts and URL security

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Configures in-memory users (greg with USER role, ollie with USER and ADMIN roles) and URL-based security: POST/PUT/PATCH to /employees require ADMIN, GET is permitted by default, and CSRF is disabled for REST testing.

```java
@Configuration
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfiguration extends WebSecurityConfigurerAdapter {

  /**
   * This section defines the user accounts which can be used for
   * authentication as well as the roles each user has.
   */
  @Override
  public void configure(AuthenticationManagerBuilder auth) throws Exception {

    auth.inMemoryAuthentication()
      .withUser("greg").password("turnquist").roles("USER").and()
      .withUser("ollie").password("gierke").roles("USER", "ADMIN");
  }

  /**
   * This section defines the security policy for the app.
   * - BASIC authentication is supported (enough for this REST-based demo)
   * - /employees is secured using URL security shown below
   * - CSRF headers are disabled since we are only testing the REST interface,
   *   not a web one.
   *
   * NOTE: GET is not shown which defaults to permitted.
   */
  @Override
  protected void configure(HttpSecurity http) throws Exception {

    http
      .httpBasic().and()
      .authorizeRequests()
        .antMatchers(HttpMethod.POST, "/employees").hasRole("ADMIN")
        .antMatchers(HttpMethod.PUT, "/employees/**").hasRole("ADMIN")
        .antMatchers(HttpMethod.PATCH, "/employees/**").hasRole("ADMIN").and()
      .csrf().disable();
  }
}

```

--------------------------------

### Run integration tests with Maven

Source: https://github.com/spring-projects/spring-data-examples/blob/main/redis/pubsub-listener/README.md

Executes the integration tests that publish messages to Redis channels and verify annotated listeners. Requires Docker to be running because Testcontainers starts a Redis container.

```bash
cd redis/listener
mvn test
```

--------------------------------

### POST with USER credentials

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Command to POST with USER credentials.

```shell
$ curl -i -X POST -d '{"firstName": "Saruman", "lastName": "the evil one", "title": "the White"}' localhost:8080/employees -u greg:turnquist
```

--------------------------------

### Create Redis cluster with create-cluster create

Source: https://github.com/spring-projects/spring-data-examples/blob/main/redis/cluster/readme.md

Initializes the cluster by assigning hash slots and replicas. This must be done only once. The output shows the slot allocation and replica assignment.

```bash
redis/utils/create-cluster $ ./create-cluster create
  >>> Creating cluster
  >>> Performing hash slots allocation on 6 nodes...
  Using 3 masters:
    127.0.0.1:30001
    127.0.0.1:30002
    127.0.0.1:30003
  Adding replica 127.0.0.1:30004 to 127.0.0.1:30001
  Adding replica 127.0.0.1:30005 to 127.0.0.1:30002
  Adding replica 127.0.0.1:30006 to 127.0.0.1:30003

  M: 10696916f57e58c5edce34127b23ca7af1b669a0 127.0.0.1:30001
     slots:0-5460 (5461 slots) master
  M: 5b0e1b4cc87175326ba79d00ecfc6f5dbdb424a7 127.0.0.1:30002
     slots:5461-10922 (5462 slots) master
  M: 5f3e978fb40b1d9c910d904ea19a0494b78668aa 127.0.0.1:30003
     slots:10923-16383 (5461 slots) master
  S: d1717c418d03db93183ce2d791ba6f48be5cf028 127.0.0.1:30004
     replicates 10696916f57e58c5edce34127b23ca7af1b669a0
  S: c7dfcdb9cd1105e4251de51c4ade54de59bb063c 127.0.0.1:30005
     replicates 5b0e1b4cc87175326ba79d00ecfc6f5dbdb424a7
  S: 3219785a9145717f30648a27a2dd07359e9dd46f 127.0.0.1:30006
     replicates 5f3e978fb40b1d9c910d904ea19a0494b78668aa

  Can I set the above configuration? (type 'yes' to accept): yes

  [OK] All nodes agree about slots configuration.
       >>> Check for open slots...
       >>> Check slots coverage...
  [OK] All 16384 slots covered.
```

--------------------------------

### Compile to native image with Maven profile 'native'

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jdbc/graalvm-native/README.adoc

Run the Maven build with the `native` profile to trigger native image creation. The native executable is created in the target folder.

```bash
$> maven clean package -P native
```

--------------------------------

### Conditional GET using If-None-Match

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/headers/README.adoc

Issues a conditional GET request with the If-None-Match header to check if the resource has changed. The server responds with 304 Not Modified if the ETag matches.

```bash
$ curl http://localhost:8080/customers/1 -i -H "If-None-Match: 0"
```

```http
HTTP/1.1 304 Not Modified
```

--------------------------------

### JSON Schema validation example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/schema-validation/README.md

A JSON Schema (draft 4) example that defines an object requiring 'name' (a string with minimum length 1) and 'age' (an integer between 0 and 125 inclusive).

```json
{
  "type": "object",
  "required": [ "name", "age" ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "age": {
      "type": "int",
      "minimum" : 0,
      "exclusiveMinimum" : false,
      "maximum" : 125,
      "exclusiveMaximum" : false
    }
  }
}
```

--------------------------------

### Fetch items with USER credentials

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Command to fetch items with USER credentials.

```shell
$ curl localhost:8080/items -u greg:turnquist
```

--------------------------------

### Run the native image and observe CRUD output

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jdbc/graalvm-native/README.adoc

Execute the native executable from the console. The output shows Spring Boot startup and results of CRUD functions invoked via a CommandLineRunner, including inserted and listed authors.

```bash
$> ./target/spring-data-jdbc-graalvm-native

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::       (v3.0.0-SNAPSHOT)

INFO 82562 --- [           main] e.s.j.g.GraalvmNativeApplication         : Starting GraalvmNativeApplication using Java 17.0.4 with PID 82562
INFO 82562 --- [           main] e.s.j.g.GraalvmNativeApplication         : Started GraalvmNativeApplication in 0.042 seconds (process running for 0.061)
insertAuthors(): author1 = Author{name='Josh Long'}
insertAuthors(): author2 = Author{name='Martin Kleppmann'}
listAllAuthors(): author = Author{name='Josh Long'}
	Book{title='Reactive Spring'}
...
```

--------------------------------

### Conditional GET using If-Modified-Since

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/headers/README.adoc

Issues a conditional GET request with the If-Modified-Since header to check if the resource has changed. The server responds with 304 Not Modified if the resource has not been modified since the given date.

```bash
$ curl http://localhost:8080/customers/1 -i -H "If-Modified-Since: Wed, 08 Apr 2015 17:24:20 GMT"
```

```http
HTTP/1.1 304 Not Modified
```

--------------------------------

### Run the application

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Command to run the Spring Boot application.

```shell
$ mvn spring-boot:run
```

--------------------------------

### Get person by id

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/multi-store/README.adoc

Curl command to fetch a specific person and the JSON response.

```bash
$ curl http://localhost:8080/persons/3

```

```javascript
{ "firstName" : "Greg",
  "lastName" : "Turnquist",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/persons/3"
    }
  }
}

```

--------------------------------

### Define a repository interface for Query-by-Example

Source: https://github.com/spring-projects/spring-data-examples/blob/main/r2dbc/query-by-example/README.adoc

Defines a repository interface that extends ReactiveCrudRepository and ReactiveQueryByExampleExecutor to enable Query-by-Example support for the Person entity.

```java
interface PersonRepository extends ReactiveCrudRepository<Person, Long>, ReactiveQueryByExampleExecutor<Person> {
}
```

--------------------------------

### Fetch items without credentials

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Command to fetch items without credentials.

```shell
$ curl localhost:8080/items
```

--------------------------------

### Value defaulting on entity construction

Source: https://github.com/spring-projects/spring-data-examples/blob/main/cassandra/kotlin/README.md

Example showing Kotlin defaulting on entity construction with Spring Data Cassandra.

```kotlin
@Table
data class Person(@PrimaryKeyColumn(type = PrimaryKeyType.PARTITIONED) val firstname: String? = "", val lastname: String = "White")

operations.cqlOperations.execute(QueryBuilder.insertInto("person").value("firstname", "Walter"))

val person = operations.query<Person>()
				.matching(query(where("firstname").isEqualTo("Walter")))
				.firstValue()!!

assertThat(person.lastname).isEqualTo("White")
```

--------------------------------

### POST employee without credentials

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Command to POST a new employee without credentials.

```shell
$ curl -X POST -d '{"firstName": "Saruman", "lastName": "the evil one", "title": "the White"}' localhost:8080/employees
```

--------------------------------

### Building JSON schema with Java API

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/schema-validation/README.md

Java code using Spring Data MongoDB's MongoJsonSchema builder to fluently define the same JSON schema as the previous example.

```java
MongoJsonSchema schema = MongoJsonSchema.builder() //
    .required("name", "age") //
    .properties( //
        string("name").minLength(1), //
        int32("age").gte(0).lte(125) //
    ).build();
```

--------------------------------

### Deferred repository initialization log output

Source: https://github.com/spring-projects/spring-data-examples/blob/main/jpa/deferred/README.adoc

Log output from a Spring Boot application with deferred repository initialization. Shows JPA bootstrap running in a background thread while Spring beans are instantiated with lazy injection proxies. The ContextRefreshedEvent triggers repository initialization after JPA bootstrap completes.

```text
2018-08-16 14:51:20.721 DEBUG 45068 --- [           main] ate$LazyRepositoryInjectionPointResolver : Creating lazy injection proxy for example.repo.Customer1803Repository…
… <4>
2018-08-16 14:51:26.118 DEBUG 45068 --- [           main] o.s.b.f.s.DefaultListableBeanFactory     : Creating shared instance of singleton bean 'customer1830Service'
2018-08-16 14:51:26.118 DEBUG 45068 --- [           main] ate$LazyRepositoryInjectionPointResolver : Creating lazy injection proxy for example.repo.Customer1830Repository…
… <5>
2018-08-16 14:51:27.489  INFO 45068 --- [lTaskExecutor-1] j.LocalContainerEntityManagerFactoryBean : Initialized JPA EntityManagerFactory for persistence unit 'default'
… <6>
2018-08-16 14:51:27.801  INFO 45068 --- [           main] DeferredRepositoryInitializationListener : Triggering deferred initialization of Spring Data repositories…
2018-08-16 14:51:27.806 DEBUG 45068 --- [           main] o.s.b.f.s.DefaultListableBeanFactory     : Creating shared instance of singleton bean 'customer1747Repository'
2018-08-16 14:51:27.842 DEBUG 45068 --- [           main] o.s.b.f.s.DefaultListableBeanFactory     : Creating shared instance of singleton bean 'jpaMappingContext'
2018-08-16 14:51:27.842 DEBUG 45068 --- [           main] .c.JpaMetamodelMappingContextFactoryBean : Initializing JpaMetamodelMappingContext…
2018-08-16 14:51:27.860 DEBUG 45068 --- [           main] .c.JpaMetamodelMappingContextFactoryBean : Finished initializing JpaMetamodelMappingContext!
2018-08-16 14:51:27.869 DEBUG 45068 --- [           main] tor$SharedEntityManagerInvocationHandler : Creating new EntityManager for shared EntityManager invocation
2018-08-16 14:51:27.936 DEBUG 45068 --- [           main] o.s.orm.jpa.EntityManagerFactoryUtils    : Closing JPA EntityManager
2018-08-16 14:51:27.938 DEBUG 45068 --- [           main] tor$SharedEntityManagerInvocationHandler : Creating new EntityManager for shared EntityManager invocation
2018-08-16 14:51:27.939 DEBUG 45068 --- [           main] o.s.orm.jpa.EntityManagerFactoryUtils    : Closing JPA EntityManager
2018-08-16 14:51:27.979 DEBUG 45068 --- [           main] o.s.d.r.c.s.RepositoryFactorySupport     : Initializing repository instance for example.repo.Customer1747Repository…
2018-08-16 14:51:27.995 DEBUG 45068 --- [           main] tor$SharedEntityManagerInvocationHandler : Creating new EntityManager for shared EntityManager invocation
2018-08-16 14:51:27.995 DEBUG 45068 --- [           main] o.s.orm.jpa.EntityManagerFactoryUtils    : Closing JPA EntityManager
2018-08-16 14:51:28.021 DEBUG 45068 --- [           main] tor$SharedEntityManagerInvocationHandler : Creating new EntityManager for shared EntityManager invocation
2018-08-16 14:51:28.021 DEBUG 45068 --- [           main] o.s.orm.jpa.EntityManagerFactoryUtils    : Closing JPA EntityManager
2018-08-16 14:51:28.038 DEBUG 45068 --- [           main] o.s.d.j.r.query.JpaQueryFactory          : Looking up query for method findByLastName
2018-08-16 14:51:28.041 DEBUG 45068 --- [           main] o.s.d.jpa.repository.query.NamedQuery    : Looking up named query Customer1747.findByLastName
2018-08-16 14:51:28.043 DEBUG 45068 --- [           main] o.s.d.jpa.repository.query.NamedQuery    : Did not find named query Customer1747.findByLastName
2018-08-16 14:51:28.045 DEBUG 45068 --- [           main] tor$SharedEntityManagerInvocationHandler : Creating new EntityManager for shared EntityManager invocation
2018-08-16 14:51:28.045 DEBUG 45068 --- [           main] o.s.orm.jpa.EntityManagerFactoryUtils    : Closing JPA EntityManager
2018-08-16 14:51:28.098 DEBUG 45068 --- [           main] o.s.d.r.c.s.RepositoryFactorySupport     : Finished creation of repository instance for example.repo.Customer1747Repository.
… <7>
2018-08-16 14:51:37.882  INFO 45068 --- [           main] DeferredRepositoryInitializationListener : Spring Data repositories initialized!
2018-08-16 14:51:37.894  INFO 45068 --- [           main] example.Application                      : Started Application in 22.961 seconds (JVM running for 23.438)
```

--------------------------------

### Building validation criteria with Java

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/schema-validation/README.md

Java code using Spring Data MongoDB's Validator.criteria() to build the same validation rule as the JSON example, using Criteria objects.

```java
Validator.criteria(where("name").exists(true).ne(null).type(2)
	.and("age").exists(true).ne(null).type(16).gte(0).lte(125));
```

--------------------------------

### Fetch employees

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Command to fetch the list of employees.

```shell
$ curl localhost:8080/employees
```

--------------------------------

### Create person

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/multi-store/README.adoc

Curl command to create a new person and the HTTP response headers.

```bash
$ curl -X POST -i -H "Content-Type:application/json" -d '{"firstName":"Greg", "lastName":"Turnquist"}' http://localhost:8080/persons

HTTP/1.1 201 Created
Server: Apache-Coyote/1.1
Location: http://localhost:8080/persons/3
Content-Length: 0
Date: Tue, 22 Jul 2014 22:26:17 GMT

```

--------------------------------

### Application.java

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/multi-store/README.adoc

The main application class that configures both JPA and Mongo repositories and demonstrates saving and retrieving entities.

```java
package example;

// …import statements …

@Configuration
@EnableAutoConfiguration
@EnableJpaRepositories
@EnableMongoRepositories
public class Application {

  private static final Logger log = LoggerFactory.getLogger(Application.class);

  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }

  @Autowired PersonRepository personRepository;
  @Autowired TreasureRepository treasureRepository;

  @PostConstruct
  void checkitOut() {

    personRepository.save(new Person("Frodo", "Baggins"));
    personRepository.save(new Person("Bilbo", "Baggins"));

    for (Person person : personRepository.findAll()) {
      log.info("Hello " + person.toString());
    }
  }
}

```

--------------------------------

### Access denied response

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/security/README.adoc

Error response when accessing items without credentials.

```json
{"timestamp":1412958853221,"status":401,"error":"Unauthorized","exception":"org.springframework.security.access.AccessDeniedException","message":"Access is denied","path":"/items"}
```

--------------------------------

### Create treasure

Source: https://github.com/spring-projects/spring-data-examples/blob/main/rest/multi-store/README.adoc

Curl command to create a new treasure.

```bash
$ curl -X POST -i -H "content-type:application/json" -d '{"name":"MacBook Pro", "description":"Tool of black magic"}' localhost:8080/treasures

```

--------------------------------

### Imperative: Register change stream MessageListener

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/change-streams/README.md

Registers a MessageListener to consume change stream events for the 'person' collection filtered to inserts using ChangeStreamRequest. The listener prints the person's firstname. The task requires a MessageListenerContainer as shown in the previous example.

```java
MessageListener<ChangeStreamDocument<Document>, Person> messageListener = (message) -> {
	System.out.println("Hello " + message.getBody().getFirstname());
};

ChangeStreamRequest<Person> request = ChangeStreamRequest.builder()
	.collection("person")
	.filter(newAggregation(match(where("operationType").is("insert"))))
	.publishTo(messageListener)
	.build();

Subscription subscription = messageListenerContainer.register(request, Person.class);

// ...
```

--------------------------------

### Store a file with metadata using GridFsOperations

Source: https://github.com/spring-projects/spring-data-examples/blob/main/mongodb/gridfs/README.md

Stores a file with additional metadata using GridFsOperations. The metadata is a Customer object.

```java
InputStream is = ...
Customer customerMetaData = new Customer("Hardy", "Lang");
gridFsOperations.store(is, "myCustomerFile.txt", customerMetaData);
```
Tokens:
Raw