Search:

Search all manuals
Search this manual
Manual
Couchbase Client Library: Java 1.0
Community Wiki and Resources
Wiki: Java Client Library
Download Client Library
JavaDoc
Java Client Library
SDK Forum
Additional Resources
Community Wiki
Community Forums
Couchbase SDKs
Chapters

Couchbase Client Library: Java 1.0

Copyright © 2010-2013 Couchbase, Inc. Contact copyright@couchbase.com.

For documentation license information, see Documentation License. For all license information, see Licenses.

Abstract

This is the manual for 1.0 of the Couchbase Java client library, which is compatible with Couchbase Server 1.8.

This manual provides a reference to the key features and best practice for using the Java Couchbase Client libraries (couchbase-client and spymemcached). The content constitutes a reference to the core API, not a complete guide to the entire API functionality.

Table 1. Product Compatibility for Couchbase SDK Java

ProductCompatibleAll Features
Couchbase Server 1.8
Couchbase Server 2.0


External Community Resources. 

Wiki: Java Client Library
Download Client Library
JavaDoc
Java Client Library
SDK Forum

Note.  The following document is still in production, and is not considered complete or exhaustive.

Last document update: 20 May 2013 22:02; Document built: 20 May 2013 22:02.

Documentation Availability and Formats.  This documentation is available for download: HTML Zip, PDF, EPUB . For other documentation from Couchbase, see Couchbase Documentation Library

Contact: editors@couchbase.com or couchbase.com


Table of Contents

1. Getting Started
1.1. Downloading the Couchbase Client Libraries
1.2. Hello Couchbase
1.3. Couchbase API Overview
1.4. A More Substantial Program
1.5. How to Build and Run the Sample Application
1.6. Conclusion
2. Tutorial
2.1. Installation
2.2. Building a Chat Room Application
2.3. Connecting with the Server
2.4. Logging in the Chat Application
2.5. Shutting Down a Client Connection
2.6. Increment and Decrement Operations
2.7. Prepend and Append Operations
2.8. Using Buckets
2.9. Error Handling
2.10. Using Couchbase Cluster
2.11. The Tutorial Example Code
3. Using the APIs
3.1. Connecting to a Couchbase Bucket
3.2. Connecting using Hostname and Port with SASL
3.3. Shutting down the Connection
4. Java Method Summary
4.1. Synchronous Method Calls
4.2. Asynchronous Method Calls
4.3. Object Serialization (Transcoding)
4.4. Expiry Values
5. Connection Operations
6. Store Operations
6.1. Add Operations
6.2. Set Operations
7. Retrieve Operations
7.1. Synchronous get Methods
7.2. Asynchronous get Methods
7.3. Get-and-Touch Methods
7.4. CAS get Methods
7.5. Bulk get Methods
7.6. Get and Lock
7.7. Unlock
8. Update Operations
8.1. Append Methods
8.2. Prepend Methods
8.3. Check-and-Set Methods
8.4. Delete Methods
8.5. Decrement Methods
8.6. Increment Methods
8.7. Replace Methods
8.8. Touch Methods
9. Statistics Operations
10. Java Troubleshooting
10.1. Configuring Logging
10.2. Handling Timeouts
10.3. Timing-out and Blocking
10.4. Bulk Load and Exponential Backoff
10.5. Retrying After Receiving a Temporary Failure
10.6. Java Virtual Machine Tuning Guidelines
A. Release Notes
A.1. Release Notes for Couchbase Client Library Java 1.0.3 GA (30 July 2012)
A.2. Release Notes for Couchbase Client Library Java 1.0.2 GA (5 April 2012)
A.3. Release Notes for Couchbase Client Library Java 1.0.1 GA (25 January 2012)
A.4. Release Notes for Couchbase Client Library Java 1.0.0 GA (23 January 2012)

List of Figures

2.1. Figure 1: Creating a private bucket.

List of Tables

1. Product Compatibility for Couchbase SDK Java
1.1. Synchronous Methods
1.2. Synchronous Check And Set
1.3. Asynchronous Methods
1.4. Status Methods
4.1. Java Client Library Method Summary
5.1. Java Client Library Connection Methods
6.1. Java Client Library Store Methods
7.1. Java Client Library Retrieval Methods
8.1. Java Client Library Update Methods
9.1. Java Client Library Statistics Methods