MemcachedBucket ClassCouchbase .NET SDK 2.1.0 Documentation
Represents an in-memory bucket for storing Key/Value pairs. Most often used as a distributed cache.
Inheritance Hierarchy
System Object
  Couchbase MemcachedBucket

Namespace: Couchbase
Assembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 2.1.0.0 (2.1.0.0)
Syntax
public class MemcachedBucket : IBucket, 
	IConfigObserver, IDisposable, IRefCountable

The MemcachedBucket type exposes the following members.

Methods
  NameDescription
Public methodAddRef
Increments the reference counter for this IBucket instance.
Public methodAppend(String,  Byte )
Appends a value to a give key.
Public methodAppend(String, String)
Appends a value to a give key.
Public methodAppendAsync(String,  Byte )
Appends a value to a given key as an asynchronous operation.
Public methodAppendAsync(String, String)
Appends a value to a given key as an asynchronous operation.
Public methodCreateManager
Public methodCreateQuery(Boolean)
Public methodCreateQuery(String, String)
Public methodCreateQuery(String, String, Boolean)
Public methodDecrement(String)
Decrements the value of a key by one. If the key doesn't exist, it will be created and seeded with 1.
Public methodDecrement(String, UInt64)
Decrements the value of a key by the delta. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodDecrement(String, UInt64, UInt64)
Decrements the value of a key by the delta. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodDecrement(String, UInt64, UInt64, TimeSpan)
Decrements the value of a key by the delta. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodDecrement(String, UInt64, UInt64, UInt32)
Decrements the value of a key by the delta. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodDecrementAsync(String)
Decrements the value of a key by one as an asynchronous operation. If the key doesn't exist, it will be created and seeded with 1.
Public methodDecrementAsync(String, UInt64)
Decrements the value of a key by the delta as an asynchronous operation. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodDecrementAsync(String, UInt64, UInt64)
Decrements the value of a key by the delta as an asynchronous operation. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodDecrementAsync(String, UInt64, UInt64, TimeSpan)
Decrements the value of a key by the delta as an asynchronous operation. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodDecrementAsync(String, UInt64, UInt64, UInt32)
Decrements the value of a key by the delta as an asynchronous operation. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodDispose
Closes this MemcachedBucket instance, shutting down and releasing all resources, removing it from it's ClusterController instance.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExists
Checks for the existance of a given key.
Public methodExistsAsync
Checks for the existance of a given key as an asynchronous operation.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGet T (IList String )
Gets a range of values for a given set of keys
Public methodGet T (String)
Gets a value for a given key from a Memcached Bucket on a Couchbase Server.
Public methodGet T (IList String , ParallelOptions)
Gets a range of values for a given set of keys
Public methodGet T (IList String , ParallelOptions, Int32)
Gets a range of values for a given set of keys
Public methodGetAndTouch T 
Retrieves a value by key and additionally updates the expiry with a new value.
Public methodGetAndTouchAsync T 
Retrieves a value by key and additionally updates the expiry with a new value as an asynchronous operation.
Public methodGetAndTouchDocument T 
Retrieves a document by key and additionally updates the expiry with a new value.
Public methodGetAndTouchDocumentAsync T 
Retrieves a document by key and additionally updates the expiry with a new value as an asynchronous operation.
Public methodGetAsync T 
Public methodGetDocument T 
Gets a document by it's given id.
Public methodGetDocumentAsync T 
Gets a document by it's given id asynchronously.
Public methodGetFromReplica T 
Public methodGetFromReplicaAsync T 
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWithLock T (String, TimeSpan)
Public methodGetWithLock T (String, UInt32)
Public methodGetWithLockAsync T (String, TimeSpan)
Gets a document and locks it for a specified time period as an asynchronous operation.
Public methodGetWithLockAsync T (String, UInt32)
Gets a document and locks it for a specified time period as an asynchronous operation.
Public methodIncrement(String)
Increments the value of a key by one. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodIncrement(String, UInt64)
Increments the value of a key by the delta. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodIncrement(String, UInt64, UInt64)
Increments the value of a key by the delta. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodIncrement(String, UInt64, UInt64, TimeSpan)
Increments the value of a key by the delta. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodIncrement(String, UInt64, UInt64, UInt32)
Increments the value of a key by the delta. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodIncrementAsync(String)
Increments the value of a key by one as an asynchronous operation. If the key doesn't exist, it will be created. and seeded with 1.
Public methodIncrementAsync(String, UInt64)
Increments the value of a key by the delta as an asynchronous operation. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodIncrementAsync(String, UInt64, UInt64)
Increments the value of a key by the delta as an asynchronous operation. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodIncrementAsync(String, UInt64, UInt64, TimeSpan)
Increments the value of a key by the delta as an asynchronous operation. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodIncrementAsync(String, UInt64, UInt64, UInt32)
Increments the value of a key by the delta as an asynchronous operation. If the key doesn't exist, it will be created and seeded with the defaut initial value 1.
Public methodInsert T (IDocument T )
Inserts a JSON document into the IBucketfailing if it exists.
Public methodInsert T (String, T)
Inserts a document into the database for a given key, failing if it exists.
Public methodInsert T (IDocument T , ReplicateTo)
Public methodInsert T (String, T, ReplicateTo)
Public methodInsert T (String, T, TimeSpan)
Inserts a document into the database for a given key, failing if it exists.
Public methodInsert T (String, T, UInt32)
Inserts a document into the database for a given key, failing if it exists.
Public methodInsert T (IDocument T , ReplicateTo, PersistTo)
Public methodInsert T (String, T, ReplicateTo, PersistTo)
Public methodInsert T (String, T, TimeSpan, ReplicateTo, PersistTo)
Public methodInsert T (String, T, UInt32, ReplicateTo, PersistTo)
Public methodInsertAsync T (IDocument T )
Inserts a JSON document into the IBucketfailing if it exists as an asynchronous operation.
Public methodInsertAsync T (String, T)
Public methodInsertAsync T (IDocument T , ReplicateTo)
Public methodInsertAsync T (String, T, ReplicateTo)
Public methodInsertAsync T (String, T, TimeSpan)
Inserts a document into the database for a given key, failing if it exists as an asynchronous operation.
Public methodInsertAsync T (String, T, UInt32)
Inserts a document into the database for a given key, failing if it exists as an asynchronous operation.
Public methodInsertAsync T (IDocument T , ReplicateTo, PersistTo)
Public methodInsertAsync T (String, T, ReplicateTo, PersistTo)
Public methodInsertAsync T (String, T, TimeSpan, ReplicateTo, PersistTo)
Public methodInsertAsync T (String, T, UInt32, ReplicateTo, PersistTo)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodObserve
Public methodObserveAsync
Public methodPrepare(String)
Public methodPrepare(IQueryRequest)
Public methodPrepend(String,  Byte )
Prepends a value to a give key.
Public methodPrepend(String, String)
Prepends a value to a give key.
Public methodPrependAsync(String,  Byte )
Prepends a value to a given key as an asynchronous operation.
Public methodPrependAsync(String, String)
Prepends a value to a given key as an asynchronous operation.
Public methodQuery T (String)
Public methodQuery T (IQueryRequest)
Public methodQuery T (IViewQuery)
Public methodQueryAsync T (String)
Public methodQueryAsync T (IQueryRequest)
Public methodQueryAsync T (IViewQuery)
Public methodRelease
Decrements the reference counter and calls Dispose  if the count is zero.
Public methodRemove(IList String )
Removes a range of documents for a given set of keys
Public methodRemove(String)
For a given key, removes a document from the database.
Public methodRemove(IList String , ParallelOptions)
Removes a range of documents for a given set of keys
Public methodRemove(String, ReplicateTo)
Public methodRemove(String, UInt64)
Removes a document for a given key from the database.
Public methodRemove(IList String , ParallelOptions, Int32)
Removes a range of documents for a given set of keys
Public methodRemove(String, ReplicateTo, PersistTo)
Public methodRemove(String, UInt64, ReplicateTo)
Public methodRemove(String, UInt64, ReplicateTo, PersistTo)
Public methodRemove T (IDocument T )
Removes a document from the database.
Public methodRemove T (IDocument T , ReplicateTo)
Public methodRemove T (IDocument T , ReplicateTo, PersistTo)
Public methodRemoveAsync(String)
Public methodRemoveAsync(String, ReplicateTo)
Removes a document for a given key from the database as an asynchronous operation.
Public methodRemoveAsync(String, UInt64)
Removes a document for a given key from the database as an asynchronous operation.
Public methodRemoveAsync(String, ReplicateTo, PersistTo)
Removes a document for a given key from the database as an asynchronous operation.
Public methodRemoveAsync(String, UInt64, ReplicateTo)
Removes a document for a given key from the database as an asynchronous operation.
Public methodRemoveAsync(String, UInt64, ReplicateTo, PersistTo)
Removes a document for a given key from the database as an asynchronous operation.
Public methodRemoveAsync T (IDocument T )
Removes a document from the database as an asynchronous operation.
Public methodRemoveAsync T (IDocument T , ReplicateTo)
Removes a document from the database as an asynchronous operation.
Public methodRemoveAsync T (IDocument T , ReplicateTo, PersistTo)
Removes a document from the database as an asynchronous operation.
Public methodReplace T (IDocument T )
Replaces a document if it exists, otherwise fails.
Public methodReplace T (String, T)
Replaces a value for a key if it exists, otherwise fails.
Public methodReplace T (IDocument T , ReplicateTo)
Public methodReplace T (String, T, ReplicateTo)
Public methodReplace T (String, T, TimeSpan)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplace T (String, T, UInt32)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplace T (String, T, UInt64)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplace T (IDocument T , ReplicateTo, PersistTo)
Public methodReplace T (String, T, ReplicateTo, PersistTo)
Public methodReplace T (String, T, UInt64, ReplicateTo)
Public methodReplace T (String, T, UInt64, TimeSpan)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplace T (String, T, UInt64, UInt32)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplace T (String, T, UInt64, ReplicateTo, PersistTo)
Public methodReplace T (String, T, UInt64, TimeSpan, ReplicateTo, PersistTo)
Public methodReplace T (String, T, UInt64, UInt32, ReplicateTo, PersistTo)
Public methodReplaceAsync T (IDocument T )
Replaces a document if it exists, otherwise fails as an asynchronous operation.
Public methodReplaceAsync T (String, T)
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
Public methodReplaceAsync T (IDocument T , ReplicateTo)
Public methodReplaceAsync T (String, T, ReplicateTo)
Public methodReplaceAsync T (String, T, TimeSpan)
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
Public methodReplaceAsync T (String, T, UInt32)
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
Public methodReplaceAsync T (String, T, UInt64)
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
Public methodReplaceAsync T (IDocument T , ReplicateTo, PersistTo)
Public methodReplaceAsync T (String, T, ReplicateTo, PersistTo)
Public methodReplaceAsync T (String, T, UInt64, ReplicateTo)
Public methodReplaceAsync T (String, T, UInt64, TimeSpan)
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
Public methodReplaceAsync T (String, T, UInt64, UInt32)
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
Public methodReplaceAsync T (String, T, UInt64, ReplicateTo, PersistTo)
Public methodReplaceAsync T (String, T, UInt64, TimeSpan, ReplicateTo, PersistTo)
Public methodReplaceAsync T (String, T, UInt64, UInt32, ReplicateTo, PersistTo)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTouch
Updates the expiration a key without modifying or returning it's value.
Public methodTouchAsync
Updates the expiration a key without modifying or returning it's value as an asynchronous operation.
Public methodUnlock
Public methodUnlockAsync
Public methodUpsert T (IDictionary String, T )
Inserts or replaces a range of items into Couchbase Server.
Public methodUpsert T (IDocument T )
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server.
Public methodUpsert T (IDictionary String, T , ParallelOptions)
Inserts or replaces a range of items into Couchbase Server.
Public methodUpsert T (String, T)
Inserts or replaces an existing document into a Memcached Bucket on a Couchbase Server.
Public methodUpsert T (IDocument T , ReplicateTo)
Public methodUpsert T (IDictionary String, T , ParallelOptions, Int32)
Inserts or replaces a range of items into Couchbase Server.
Public methodUpsert T (String, T, ReplicateTo)
Public methodUpsert T (String, T, TimeSpan)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsert T (String, T, UInt32)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsert T (String, T, UInt64)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsert T (IDocument T , ReplicateTo, PersistTo)
Public methodUpsert T (String, T, ReplicateTo, PersistTo)
Public methodUpsert T (String, T, UInt64, TimeSpan)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsert T (String, T, UInt64, UInt32)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsert T (String, T, TimeSpan, ReplicateTo, PersistTo)
Public methodUpsert T (String, T, UInt32, ReplicateTo, PersistTo)
Public methodUpsert T (String, T, UInt64, TimeSpan, ReplicateTo, PersistTo)
Public methodUpsert T (String, T, UInt64, UInt32, ReplicateTo, PersistTo)
Public methodUpsertAsync T (IDocument T )
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server as an asynchronous operation.
Public methodUpsertAsync T (String, T)
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
Public methodUpsertAsync T (IDocument T , ReplicateTo)
Public methodUpsertAsync T (String, T, ReplicateTo)
Public methodUpsertAsync T (String, T, TimeSpan)
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
Public methodUpsertAsync T (String, T, UInt32)
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
Public methodUpsertAsync T (String, T, UInt64)
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
Public methodUpsertAsync T (IDocument T , ReplicateTo, PersistTo)
Public methodUpsertAsync T (String, T, ReplicateTo, PersistTo)
Public methodUpsertAsync T (String, T, UInt64, TimeSpan)
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
Public methodUpsertAsync T (String, T, UInt64, UInt32)
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
Public methodUpsertAsync T (String, T, TimeSpan, ReplicateTo, PersistTo)
Public methodUpsertAsync T (String, T, UInt32, ReplicateTo, PersistTo)
Public methodUpsertAsync T (String, T, UInt64, TimeSpan, ReplicateTo, PersistTo)
Public methodUpsertAsync T (String, T, UInt64, UInt32, ReplicateTo, PersistTo)
Top
Properties
  NameDescription
Public propertyBucketType
Returns type of the bucket. In this implementation the value is constant: Memcached.
Public propertyIsSecure
Returns true if bucket is using SSL encryption between the client and the server.
Public propertyName
The Bucket's name. You can view this from the Couchbase Management Console.
Top
See Also