Quarkus Couchbase

Integrates Couchbase into Quarkus.

This extension is currently in beta status. It supports:

• Dependency injecting a Couchbase Cluster.
• Configuring the Cluster through application.properties. Currently, a minimal set of configuration options is provided.
• A dev service that starts a Couchbase server in a Docker container. With this you can develop your Quarkus app without having to install Couchbase on your machine.
• GraalVM/Mandrel/native-image.
• KV, Query, Transactions, Analytics, Search and Management operations.
• Micrometer metrics using quarkus-micrometer
• SmallRye Health checks (Readiness) using quarkus-smallrye-health

Please try it out and provide feedback, ideas and bug reports on Github.

Native Image

All main Cluster operations have been tested with our internal testing tools, however the extension remains in beta and some features may be missing or not be fully supported.

Usage

Add it to your project:

<dependency>
  <groupId>io.quarkiverse.couchbase</groupId>
  <artifactId>quarkus-couchbase</artifactId>
  <version>1.0.0.Beta2</version>
</dependency>

Provide the Couchbase configuration in application.properties:

quarkus.couchbase.connection-string=localhost
quarkus.couchbase.username=username
quarkus.couchbase.password=password

To disable TestContainers, add:

quarkus.devservices.enabled=false

Now you can @Inject a Couchbase Cluster into your project:

@Path("/couchbase")
public class TestCouchbaseResource {
    @Inject
    Cluster cluster;

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    @Path("/test")
    public String run() {
        // Get a reference to a particular Couchbase bucket and its default collection
        var bucket = cluster.bucket("travel-sample");
        var collection = bucket.defaultCollection() ;

        // Upsert a new document
        collection.upsert("test", JsonObject.create().put("foo", "bar"));

        // Fetch and print a document
        var doc = bucket.defaultCollection().get("test");
        System.out.println("Got doc " + doc.contentAsObject().toString());

        // Perform a N1QL query
        var queryResult = cluster.query("select * from `travel-sample` where url like 'http://marriot%' and country = 'United States';");

        queryResult.rowsAsObject().forEach(row -> {
            System.out.println(row.toString());
        });

        return "success!";
    }
}

And test http://localhost:8080/couchbase/test.

Additional Configuration

Please refer to the docs for additional configuration options.

Limitations

The Cluster configuration options are limited cluster credentials, and micrometer metrics emission rate.
This means that a Couchbase cluster configured securely and requiring TLS or a client or server certificate, cannot currently be connected to. Additional Cluster connections can be created and configured using Cluster.connect(...), however not all code paths have been tested and are therefore not officially supported.

License

All the files under nettyhandling directories, both in the runtime and deployment modules are taken as-were or modified from the official netty extension. Couchbase does not intend copyright infringement or claim ownership over these files or their content.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Graham Pople 💻 🚧

Emilien Bevierre 💻 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!