Search:

Manual

Couchbase Client Library Ruby 1.0

Additional Resources

Community Forums

Chapters

1 Getting Started

2 Couchbase and Rails Tutorial

3 Ruby Method Summary

4 Ruby — Connection Operations

5 Ruby — Storage Operations

6 Ruby — Retrieve Operations

7 Ruby — Update Operations

8 Ruby — Statistics Operations

9 Ruby — Troubleshooting

A Release Notes

Couchbase Client Library Ruby 1.0
		Next

Couchbase Client Library Ruby 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 Ruby client library, which is compatible with Couchbase Server 1.8.

This manual provides a reference to the key features and best practices for using the Ruby Couchbase Client Library . 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 Ruby

Product	Compatible	All Features
Couchbase Server 1.8	✓	✓
Couchbase Server 2.0	✓	✗

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

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

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. Installing the Couchbase Client Library
1.2. Hello Couchbase
1.3. Conclusion

2. Couchbase and Rails Tutorial

2.1. Installing the Couchbase Client Library Dependencies

2.2. Example Rails Application (Squish)

2.3. Not your mother's ActiveRecord

2.3.1. Connecting to Couchbase
2.3.2. Defining an API
2.3.3. Defining a Couchbase Model

2.4. Conclusion

3. Ruby Method Summary

3.1. Synchronous Method Calls
3.2. Asynchronous Method Calls

4. Ruby — Connection Operations

5. Ruby — Storage Operations

5.1. Add Operations
5.2. Replace Operations
5.3. Set Operations
5.4. Flush Operation

6. Ruby — Retrieve Operations

7. Ruby — Update Operations

7.1. Append Methods
7.2. Compare and Swap
7.3. Decrement Methods
7.4. Delete Methods
7.5. Increment Methods
7.6. Prepend Methods
7.7. Touch Methods

8. Ruby — Statistics Operations

9. Ruby — Troubleshooting

9.1. Creating Timed Operations

A. Release Notes

A.1. Release Notes for Couchbase Client Library Ruby 1.0.0 GA (23 January 2012)

List of Figures

2.1. Ruby Squish Homepage

List of Tables

1. Product Compatibility for Couchbase SDK Ruby
3.1. Ruby Client Library Method Summary
4.1. Ruby Client Library Connection Methods
5.1. Ruby Client Library Store Methods
6.1. Ruby Client Library Retrieval Methods
7.1. Ruby Client Library Update Methods
8.1. Ruby Client Library Statistics Methods

		Next
		Chapter 1. Getting Started

Copyright (c) 2010-2013Couchbase, Inc.