Reactive Couchbase repository

Introduction

This chapter describes the reactive repository support for couchbase. This builds on the core repository support explained in Couchbase repositories. So make sure you’ve got a sound understanding of the basic concepts explained there.spring-doc.cn

Reactive Composition Libraries

The Couchbase Java SDK 3.x moved from RxJava to Reactor, so it blends in very nicely with the reactive spring ecosystem.spring-doc.cn

Reactive Couchbase repositories provide project Reactor wrapper types and can be used by simply extending from one of the library-specific repository interfaces:spring-doc.cn

ReactiveCrudRepositoryspring-doc.cn
ReactiveSortingRepositoryspring-doc.cn

Usage

Let’s create a simple entity to start with:spring-doc.cn

Example 1. Sample Person entity

public class Person {

  @Id
  private String id;
  private String firstname;
  private String lastname;
  private Address address;

  // … getters and setters omitted
}

A corresponding repository implementation may look like this:spring-doc.cn

Example 2. Basic repository interface to persist Person entities

public interface ReactivePersonRepository extends ReactiveSortingRepository<Person, Long> {

  Flux<Person> findByFirstname(String firstname);

  Flux<Person> findByFirstname(Publisher<String> firstname);

  Flux<Person> findByFirstnameOrderByLastname(String firstname, Pageable pageable);

  Mono<Person> findByFirstnameAndLastname(String firstname, String lastname);
}

For JavaConfig use the @EnableReactiveCouchbaseRepositories annotation. The annotation carries the very same attributes like the namespace element. If no base package is configured the infrastructure will scan the package of the annotated configuration class.spring-doc.cn

Also note that if you are using it in a spring boot setup you likely can omit the annotation since it is autoconfigured for you.spring-doc.cn

Example 3. JavaConfig for repositories

@Configuration
@EnableReactiveCouchbaseRepositories
class ApplicationConfig extends AbstractCouchbaseConfiguration {
	// ... (see configuration for details)
}

As our domain repository extends ReactiveSortingRepository it provides you with CRUD operations as well as methods for sorted access to the entities. Working with the repository instance is just a matter of dependency injecting it into a client.spring-doc.cn

Example 4. Sorted access to Person entities

public class PersonRepositoryTests {

    @Autowired
    ReactivePersonRepository repository;

    @Test
    public void sortsElementsCorrectly() {
      Flux<Person> persons = repository.findAll(Sort.by(new Order(ASC, "lastname")));
      assertNotNull(perons);
    }
}

Repositories and Querying

Spring Data’s Reactive Couchbase comes with full querying support already provided by the blocking Repositories and Querying spring-doc.cn