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.

  • GraalVM/Mandrel/native-image.

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

Usage

Add it to your project:

<dependency>
  <groupId>io.quarkiverse.couchbase</groupId>
  <artifactId>quarkus-couchbase</artifactId>
  <version>{latest-version}</version>
</dependency>

Provide the Couchbase configuration in application.properties (usually located in your runtime/resources/META-INF/native-image directory).

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

You can now @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 it at http://localhost:8080/couchbase/test.

Limitations

In this early beta release the configuration options are limited to the three shown above. This means that a Couchbase cluster configured securely and requiring TLS or a client or server certificate, cannot currently be connected to.