Couchbase

[RCBC-120] Docs: Reference installation

Mon, 11 Feb 2013 05:36:16 -0600

Customers have lots of choices at their fingertips, and many of those choices will result in a non-functioning installation, or at least a lot of time spent figuring out what the right pieces are.

Can we please provide as much details as possible about a reference installation that we can be sure will work for a customer who is just getting started? This is outside of our support for any one operatin system, but more about telling the customer "if you install with these versions and packages, this code will work"

-OS
-"language" version (Ruby 1.9.3, etc)
-other packages/modules required and/or tested with

[RCBC-117] Write the getting started with Ruby on Linux section of the essential guide

Mon, 4 Feb 2013 11:19:47 -0600

Write the Getting started with Ruby on Linux (Redhat and Debian) section of the Essentials Guide

Needs to cover:

Installation of the Ruby gem/components and pre-requisites
Writing your first (small) app using Couchbase and Ruby

Submissions should be to MC, either through the couchbase/docs repo, or direct to MC in whatever format suits. Must include both the text and images.

[RCBC-116] Write the Getting Started with Ruby on Mac OS X section of the essentials guide

Mon, 4 Feb 2013 11:18:58 -0600

Write the Getting started with Ruby on Mac OS X section of the Essentials Guide

Needs to cover:

Installation of the Ruby gem/components and pre-requisites
Writing your first (small) app using Couchbase and Ruby

Submissions should be to MC, either through the couchbase/docs repo, or direct to MC in whatever format suits. Must include both the text and images.

[RCBC-93] Ruby Client does not handle the timeout appropriately

Thu, 15 Nov 2012 06:01:59 -0600

This is the problem that the customer is encountering
(Ruby code coming up):

Timeout::timeout(2) do
couch_client.get(key)
end

But we are seeing Couchbase::Error::Timeout exceptions being raised. I know the default timeout for the Couchbase client gem is greater than 2 seconds, so I'm wondering: what could cause Couchbase to return a timeout (0x16 error code) before it actually has time to timeout?

The complete ruby source code is attached , Please take a look at it.

------
support's analysis:
The client is not timing out fast enough it should time out in 2.5 sec or something but instead it's waiting a long time.

[RCBC-78] Need Alternative to Event Loop

Tue, 28 Aug 2012 16:18:40 -0500

Production Management (DiptiP), and Customer Support team request that we provide an alternative to the event loop for asynchronous operations, which takes a function/callback as a parameter in the method signature and has an explicit return.

[RCBC-75] Provide Consistent Order of Parameters

Wed, 2 Jan 2013 15:54:41 -0600

Provide consistent, predictable order for method parameters as other SDKS.

[RCBC-73] Provide Consistent Timeouts

Fri, 24 Aug 2012 16:36:10 -0500

Provides the consistent level of time outs with other SDKs. Provide ability to set timeouts at: 1) connection, 2) authentication, and 3) ops level.

[RCBC-72] Need Consistent Error Handling

Fri, 24 Aug 2012 16:33:11 -0500

Need error handling more consistent with other SDKs (error messages) and more consistent with underlying memcached protocol.

[RCBC-61] Allow response aggregation for multi-keyed operations in asynchronous mode

Thu, 19 Jul 2012 07:53:55 -0500

Mult-keyed operations behaves a bit different in async mode, they are yielding responses as far as they received. This is good, but it would be nice to have switch to force library to aggregate all of them.

Example:

Couchbase.bucket.run do |c|
  c.get("foo", "bar", "baz", :aggregate => true) do |results|
    results.each do |res|
       # ...
    end
  end
end

[RCBC-55] Update the getting started to match the Beer sample DB

Thu, 12 Jul 2012 00:47:53 -0500

Once the sample DB has been integrated into the server, update the getting started (both on the web page and in the documentation) to use the sample database.

[RCBC-56] Updated screencast for /develop pages

Thu, 12 Jul 2012 00:48:22 -0500

Create an updated screencast to ship with the new 2.0 developer SDKs

[RCBC-41] Integrate log4r and log interesting events for issue investigation

Duplicate — Fri, 8 Feb 2013 18:16:29 -0600

Integrate log4r and log interesting events for issue investigation

[RCBC-103] Improvements to the Getting Started Guide and the Tutorial

Thu, 2 May 2013 16:40:07 -0500

Ruby Docs

*** Getting Started ***

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/installing_the_couchbase_client_libraries.html
- link broken: ... is libcouchbase. Please consult [C Client Library page about w ...

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/hello_couchbase.html
- In the list where the conn params are explained, maybe explain why I need to ouse the list param
when I have more then one node (where I have to use host?)? Its not really obvious why I have two
different args for the same type.
- Maybe add a quick sentence what marhsal does? Serialzining ruby objects? Note that you cant use
views with it.

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/creating_and_updating_documents.html
- here it talks about the :plain mode and I'm confused, whats the different to :marshal? Maybe
good to explain in a sentence.

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/reading_documents.html
- Where basic view querying is explained, I think we need to add a sentence or two on how
a second HTTP request is maed when you access the design document. Since you ask an array here,
is it prefetched? how does it work? Would be good to know so that people dont use it in a loop
for example.

*** Tutorial **

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/_tl_dr.html
- I think you need to tell people how to install bundler? I have it, but I'm not sure if it comes
by default? If it is always there forget this comment :)

- Sign in with twitter gives me 401 unauthorized.. do we really need this and is it supposed to
work? Otherwise the sample app works out of the box, cool work.

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/_create_application_skeleton.html
- Can you explain the --old-style-hash in a sentence? Dont know what it is?
- The short gem description only contains omniauth-twitter, but the full also omniauth?
- maybe mention to update the dependencies after the changes? bundle update?

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/_implement_controllers.html
- Where you explain the controller functionality: it's not really obvios how the methods map to the
views. What will happen when you access a different method that has no view defined? Just a few
words to explain how the "magical" vie access works would be good I think.

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/_bonus_spatial_queries_sessions_and_cache.html
- On caching: will it use the same couchbase client connection or instantiate a new one?

Otherwise good job! :)

[RCBC-122] Option to enable configuration cache on libcouchbase

Duplicate — Mon, 6 May 2013 01:16:02 -0500

Option to enable configuration cache on libcouchbase

[RCBC-105] Docs: What operating system versions does the ruby gem support?

Mon, 6 May 2013 11:30:58 -0500

I seem to be having problems installing this on CentOS 5.8. I'm not sure if that's the problem, but I tried to verify it via our documentation and couldn't find what versions were supported or not.

[RCBC-54] Add a unit/integration test validation of OBSERVE + view stale=false

Wed, 8 May 2013 07:28:05 -0500

Ensure that when a synchronous set is used with the new low-level observe, the index is fully updated when querying with view=false.

[RCBC-21] automatically backoff on TMP_OOM

Wed, 8 May 2013 18:33:26 -0500

When a server's memory is full it may start sending TMP_OOM errors to clients, which should be used by the client to temporarily back off (exponential backoff). This helps in bulk load situations where maybe many clients are loading data to a server which is also trying to flush to disk.

[RCBC-130] Complete Review of Ruby 1.3

Fri, 24 May 2013 13:11:15 -0500

Sent 5/8/2013:

Hi,

Here is the 1.3 for review. Please provide me any feedback/input by Wednesday end of day next week. After that time, any change requests or fixes will go through the standard maintenance-mode process: http://hub.internal.couchbase.com/confluence/display/techpubs/Doc+Fixes+and+Edits+Process+2013

You can provide any review feedback as a bullet list on this ticket http://www.couchbase.com/issues/browse/RCBC-127, or as annotations to the PDF.

Regards,

Karen

[RCBC-129] Complete Reviews

Fri, 24 May 2013 13:10:10 -0500

Send 5/8/2013:

Hi,

Here is the 1.3 for review. Please provide me any feedback/input by Wednesday end of day next week. After that time, any change requests or fixes will go through the standard maintenance-mode process: http://hub.internal.couchbase.com/confluence/display/techpubs/Doc+Fixes+and+Edits+Process+2013

You can provide any review feedback as a bullet list on this ticket http://www.couchbase.com/issues/browse/RCBC-127, or as annotations to the PDF.

Regards,

Karen

[RCBC-115] Writ the GettingStarted with Ruby section of the essentials guides

Wed, 29 May 2013 16:20:34 -0500

Write the Getting started with Ruby on Windows section of the Essentials Guide

Needs to cover:

Installation of the Ruby gem/components and pre-requisites
Writing your first (small) app using Couchbase and Ruby

Submissions should be to MC, either through the couchbase/docs repo, or direct to MC in whatever format suits. Must include both the text and images.

[RCBC-132] Specify which version of Ruby is required/supported

Tue, 11 Jun 2013 09:01:43 -0500

Please provide in the http://www.couchbase.com/develop/ruby/current page an indication of which version of Ruby we support. Apparently my 1.8.5 is not sufficient enough but nothing on the page dictates that.

[RCBC-109] Add Observe-methods into Rdoc TOC

Fri, 11 Jan 2013 12:56:27 -0600

Hi Sergey,

Can you add an item in the top-level RDoc table of content for the observe-methods in Ruby? A customer just asked about it in Rdoc. In general, the Rdoc is great language reference resource for the SDK, but this item that is hard to find from the first Rdoc page: http://www.couchbase.com/autodocs/couchbase-ruby-client-1.2.0/Couchbase/Bucket.html#observe_and_wait-instance_method

Thanks,

Karen

[RCBC-65] Accept only allowed options for the methods

Fri, 19 Oct 2012 22:57:00 -0500

It might be good to complain using ArgumentError on unsupported or invalid keys in options parameter for ruby API. Currently it is possible to pass any Hash as options and the library will silently pick only documented options ignoring all others. This could lead to some confusion (see ~~RCBC-47~~) when people will use deprecated options or invalid key types (only symbols allowed)

[RCBC-114] Code sample of Get and Lock in Ruby

Mon, 6 May 2013 11:29:16 -0500

One of our users asked for a code example demonstrating Get and Lock in Ruby for the Developer Guide.