Welcome to the Couchbase Java SDK API Reference!

Here is a simple hello world that you can run and verify your installation works:

    // Connect to a cluster on localhost
    Cluster cluster = CouchbaseCluster.create();
    cluster.authenticate("username", "password");

    // Open the default bucket
    Bucket bucket = cluster.openBucket("myTestBucket");

    // Create a user and insert it
    JsonObject user = JsonObject.empty()
        .put("firstname", "Walter")
        .put("lastname", "White")
        .put("job", "chemistry teacher")
        .put("age", 50);
    JsonDocument doc = JsonDocument.create("walter", user);
    JsonDocument response = bucket.upsert(doc);

    // Read it back out
    JsonDocument walter = bucket.get("walter");
    System.out.println("Found: " + walter);

    // Disconnect from the cluster
    cluster.disconnect();
    

If you don't know where to go next, start at the CouchbaseCluster class!

Packages 
Package Description
com.couchbase.client.encryption  
com.couchbase.client.encryption.errors  
com.couchbase.client.java  
com.couchbase.client.java.analytics  
com.couchbase.client.java.auth  
com.couchbase.client.java.bucket  
com.couchbase.client.java.bucket.api  
com.couchbase.client.java.cluster  
com.couchbase.client.java.cluster.api  
com.couchbase.client.java.datastructures  
com.couchbase.client.java.datastructures.collections  
com.couchbase.client.java.datastructures.collections.iterators  
com.couchbase.client.java.document  
com.couchbase.client.java.document.json  
com.couchbase.client.java.env  
com.couchbase.client.java.error  
com.couchbase.client.java.error.subdoc  
com.couchbase.client.java.event.consumers  
com.couchbase.client.java.query  
com.couchbase.client.java.query.consistency  
com.couchbase.client.java.query.core  
com.couchbase.client.java.query.dsl  
com.couchbase.client.java.query.dsl.clause
Clauses are mini-DSL that can help you produce a well-formed Expression for specific parts of some N1QL statement, aka clauses.
com.couchbase.client.java.query.dsl.element  
com.couchbase.client.java.query.dsl.functions
Functions are Expressions that represent predefined utility functions in N1QL.
com.couchbase.client.java.query.dsl.path  
com.couchbase.client.java.query.dsl.path.index  
com.couchbase.client.java.query.util  
com.couchbase.client.java.repository  
com.couchbase.client.java.repository.annotation  
com.couchbase.client.java.repository.mapping  
com.couchbase.client.java.search  
com.couchbase.client.java.search.core  
com.couchbase.client.java.search.facet  
com.couchbase.client.java.search.queries  
com.couchbase.client.java.search.result  
com.couchbase.client.java.search.result.facets  
com.couchbase.client.java.search.result.hits  
com.couchbase.client.java.search.result.impl  
com.couchbase.client.java.search.sort  
com.couchbase.client.java.search.util  
com.couchbase.client.java.subdoc  
com.couchbase.client.java.transcoder  
com.couchbase.client.java.transcoder.crypto  
com.couchbase.client.java.transcoder.subdoc  
com.couchbase.client.java.util  
com.couchbase.client.java.util.features  
com.couchbase.client.java.util.rawQuerying  
com.couchbase.client.java.util.retry  
com.couchbase.client.java.view