Module: Couchbase

Defined in:
lib/couchbase.rb,
lib/couchbase/view.rb,
lib/couchbase/utils.rb,
lib/couchbase/bucket.rb,
lib/couchbase/result.rb,
lib/couchbase/cluster.rb,
lib/couchbase/version.rb,
lib/couchbase/view_row.rb,
lib/couchbase/constants.rb,
lib/couchbase/transcoder.rb,
lib/couchbase/connection_pool.rb,
ext/couchbase_ext/couchbase_ext.c

Overview

Author

Couchbase <[email protected]>

Copyright

2011-2012 Couchbase, Inc.

License

Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Defined Under Namespace

Modules: Constants, EM, Error, Transcoder Classes: Bucket, Cluster, ConnectionPool, DesignDoc, Result, Timer, Utils, View, ViewRow

Constant Summary collapse

VERSION = 
"1.3.1"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.connection_options ⇒ Hash, String

Default connection options

Examples:

Using connection_options to change the bucket

Couchbase.connection_options = {:bucket => 'blog'}
Couchbase.bucket.name     #=> "blog"

Returns:

  • (Hash, String)

Since:

  • 1.1.0



74
75
76
 
# File 'lib/couchbase.rb', line 74

def connection_options
  @connection_options
end

Class Method Details

.bucket ⇒ Bucket

The connection instance for current thread

Examples:

Couchbase.bucket.set("foo", "bar")

Returns:

See Also:

Since:

  • 1.1.0



102
103
104
105
 
# File 'lib/couchbase.rb', line 102

def bucket
  verify_connection!
  thread_storage[:bucket] ||= connect(connection_options)
end

.bucket=(connection) ⇒ Bucket

Set a connection instance for current thread

Returns:

Since:

  • 1.1.0



112
113
114
115
 
# File 'lib/couchbase.rb', line 112

def bucket=(connection)
  verify_connection!
  thread_storage[:bucket] = connection
end

.connect(*options) ⇒ Bucket Also known as: new

The method connect initializes new Bucket instance with all arguments passed.

Examples:

Use default values for all options

Couchbase.connect

Establish connection with couchbase default pool and default bucket

Couchbase.connect("http://localhost:8091/pools/default")

Select custom bucket

Couchbase.connect("http://localhost:8091/pools/default", :bucket => 'blog')

Specify bucket credentials

Couchbase.connect("http://localhost:8091/pools/default", :bucket => 'blog', :username => 'bucket', :password => 'secret')

Use URL notation

Couchbase.connect("http://bucket:secret@localhost:8091/pools/default/buckets/blog")

Returns:

  • (Bucket) —

    connection instance

See Also:

Since:

  • 1.0.0



60
61
62
 
# File 'lib/couchbase.rb', line 60

def connect(*options)
  Bucket.new(*(options.flatten))
end