The primary goal of theSpring Data project is to make it easier to buildSpring-powered applications that use new data access technologies such as non-relational databases, map-reduceframeworks, and cloud based data services.

The Spring Data Couchbase project aims to provide a familiar and consistent Spring-based programming model for CouchbaseServer as a document database and cache while retaining store-specific features and capabilities. Key functional areasof Spring Data Couchbase are a POJO centric model for interacting with a Couchbase Server Bucket and easily writing arepository style data access layer.

Integration tests require a couchbase server with a bucket name "protected" with "password" as the password set.If the server allows users, then an user with username "protected" with "password" as the password should also be set.The recommended way to run tests is to install docker and use container in server.properties.

This project is lead and maintained by Couchbase, Inc.

• Spring configuration support using Java based@Configuration classes or an XML namespace for the Couchbase driver (Java SDK version 2.x).

• CouchbaseTemplate helper class that increases productivity performing common Couchbase operations. Includes integrated object mapping between documents and POJOs.

• Exception translation into Spring’s portable Data Access Exception hierarchy.

• Feature Rich Object Mapping integrated with Spring’s Conversion Service.

• Annotation based mapping metadata but extensible to support other metadata formats.

• Automatic implementation ofRepository interfaces including support for custom finder methods (backed by Couchbase’s query language,N1QL) andPagingAndSortingRepository.

• For Couchbase server versions < 4.0, repositories can still be backed by Couchbase Views.

• Support for geospatial and multidimensional querying (backed by Couchbase Spatial Views)

• JMX administration and monitoring

• Can serve as the backend for@Cacheable support, to cache any objects you need for high performance access (see sibling Spring Cache project in Couchbase’s github,couchbaselabs/couchbase-spring-cache).

Spring-Data Couchbase is the Spring Data connector for theCouchbase Java SDK 2.x generation.

Both the SDK and this Spring Data community project are major version changes with lots of differences from their respective previous versions.

Notably, this version is compatible withCouchbase Server 4.0, bringing support for theN1QL query language.

This project is governed by theSpring Code of Conduct.By participating, you are expected to uphold this code of conduct.Please report unacceptable behavior tospring-code-of-conduct@pivotal.io.

Here is a quick teaser of an application using Spring Data Repositories in Java:

Having trouble with Spring Data? We’d love to help!

• Check thereference documentation, andJavadocs.

• Learn the Spring basics – Spring Data builds on Spring Framework, check thespring.io web-site for a wealth of reference documentation.If you are just starting out with Spring, try one of theguides.

• Ask a question - we monitorstackoverflow.com for questions tagged withspring-data-couchbase.You can also chat with the community onGitter.

• Report bugs with Spring Data Couchbase atjira.spring.io/browse/DATACOUCH.

Spring Data uses GitHub as issue tracking system to record bugs and feature requests.If you want to raise an issue, please follow the recommendations below:

• Before you log a bug, please search theissue tracker to see if someone has already reported the problem.

• If the issue does not already exist,create a new issue.

• Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using and JVM version.

• If you need to paste code, or include a stack trace use Markdown ``` escapes before and after your text.

• If possible try to create a test-case or project that replicates the issue.Attach a link to your code or a compressed file containing your code.

You don’t need to build from source to use Spring Data (binaries inrepo.spring.io), but if you want to try out the latest and greatest, Spring Data can be easily built with themaven wrapper.You also need JDK 17 or above.

If you want to build with the regularmvn command, you will needMaven v3.5.0 or above.

Also seeCONTRIBUTING.adoc if you wish to submit pull requests, and in particular please sign theContributor’s Agreement before your first non-trivial change.

• Spring Data Examples contains example projects that explain specific features in more detail.

Spring Data Couchbase is Open Source software released under theApache 2.0 license.