Represents an in-memory bucket for storing Key/Value pairs. Most often used as a distributed cache.
Inheritance HierarchyAssembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 0.0.0.0 (0.0.0.0)
SyntaxThe MemcachedBucket type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddRef |
Increments the reference counter for this IBucket instance.
|
| Append(String,Byte[]) |
Appends a value to a give key.
|
| Append(String, String) |
Appends a value to a give key.
|
| AppendAsync(String,Byte[]) |
Appends a value to a given key as an asynchronous operation.
|
| AppendAsync(String, String) |
Appends a value to a given key as an asynchronous operation.
|
| CreateManager |
Creates a MemcachedBucketManager instance for managing buckets.
|
| CreateQuery(Boolean) | |
| CreateQuery(String, String) | |
| CreateQuery(String, String, Boolean) | |
| Decrement(String) |
Decrements the value of a key by one. If the key doesn't exist, it will be created
and seeded with 1.
|
| Decrement(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.
|
| Decrement(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.
|
| Decrement(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.
|
| Decrement(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.
|
| DecrementAsync(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.
|
| DecrementAsync(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.
|
| DecrementAsync(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.
|
| DecrementAsync(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.
|
| DecrementAsync(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.
|
| Dispose |
Closes this MemcachedBucket instance, shutting down and releasing all resources,
removing it from it's ClusterController instance.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Exists |
Checks for the existance of a given key.
|
| ExistsAsync |
Checks for the existance of a given key as an asynchronous operation.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Get<T>(IList<String>) |
Gets a range of values for a given set of keys
|
| Get<T>(String) |
Gets a value for a given key from a Memcached Bucket on a Couchbase Server.
|
| Get<T>(IList<String>, ParallelOptions) |
Gets a range of values for a given set of keys
|
| Get<T>(IList<String>, ParallelOptions, Int32) |
Gets a range of values for a given set of keys
|
| GetAndLock<T>(String, TimeSpan) | |
| GetAndLock<T>(String, UInt32) | |
| GetAndLockAsync<T>(String, TimeSpan) | |
| GetAndLockAsync<T>(String, UInt32) | |
| GetAndTouch<T> |
Retrieves a value by key and additionally updates the expiry with a new value.
|
| GetAndTouchAsync<T> |
Retrieves a value by key and additionally updates the expiry with a new value as an asynchronous operation.
|
| GetAndTouchDocument<T> |
Retrieves a document by key and additionally updates the expiry with a new value.
|
| GetAndTouchDocumentAsync<T> |
Retrieves a document by key and additionally updates the expiry with a new value as an asynchronous operation.
|
| GetAsync<T> | |
| GetDocument<T> |
Gets a document by it's given id.
|
| GetDocumentAsync<T> |
Gets a document by it's given id asynchronously.
|
| GetDocumentsAsync<T> |
Gets a list of documents by there given id as an asynchronous operation.
|
| GetFromReplica<T> | |
| GetFromReplicaAsync<T> | |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetWithLock<T>(String, TimeSpan) | |
| GetWithLock<T>(String, UInt32) | |
| GetWithLockAsync<T>(String, TimeSpan) |
Gets a document and locks it for a specified time period as an asynchronous operation.
|
| GetWithLockAsync<T>(String, UInt32) |
Gets a document and locks it for a specified time period as an asynchronous operation.
|
| Increment(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.
|
| Increment(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.
|
| Increment(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.
|
| Increment(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.
|
| Increment(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.
|
| IncrementAsync(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.
|
| IncrementAsync(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.
|
| IncrementAsync(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.
|
| IncrementAsync(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.
|
| IncrementAsync(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.
|
| Insert<T>(IDocument<T>) |
Inserts a JSON document into the IBucketfailing if it exists.
|
| Insert<T>(String, T) |
Inserts a document into the database for a given key, failing if it exists.
|
| Insert<T>(IDocument<T>, ReplicateTo) | |
| Insert<T>(String, T, ReplicateTo) | |
| Insert<T>(String, T, TimeSpan) |
Inserts a document into the database for a given key, failing if it exists.
|
| Insert<T>(String, T, UInt32) |
Inserts a document into the database for a given key, failing if it exists.
|
| Insert<T>(IDocument<T>, ReplicateTo, PersistTo) | |
| Insert<T>(String, T, ReplicateTo, PersistTo) | |
| Insert<T>(String, T, TimeSpan, ReplicateTo, PersistTo) | |
| Insert<T>(String, T, UInt32, ReplicateTo, PersistTo) | |
| InsertAsync<T>(IDocument<T>) |
Inserts a JSON document into the IBucketfailing if it exists as an asynchronous operation.
|
| InsertAsync<T>(List<IDocument<T>>) |
Inserts a list of JSON documents asynchronously, each document failing if it already exists.
|
| InsertAsync<T>(String, T) | |
| InsertAsync<T>(IDocument<T>, ReplicateTo) | |
| InsertAsync<T>(List<IDocument<T>>, ReplicateTo) |
Inserts a list of JSON documents asynchronously, each document failing if it already exists.
|
| InsertAsync<T>(String, T, ReplicateTo) | |
| InsertAsync<T>(String, T, TimeSpan) |
Inserts a document into the database for a given key, failing if it exists as an asynchronous operation.
|
| InsertAsync<T>(String, T, UInt32) |
Inserts a document into the database for a given key, failing if it exists as an asynchronous operation.
|
| InsertAsync<T>(IDocument<T>, ReplicateTo, PersistTo) | |
| InsertAsync<T>(List<IDocument<T>>, ReplicateTo, PersistTo) |
Inserts a list of JSON documents asynchronously, each document failing if it already exists.
|
| InsertAsync<T>(String, T, ReplicateTo, PersistTo) | |
| InsertAsync<T>(String, T, TimeSpan, ReplicateTo, PersistTo) | |
| InsertAsync<T>(String, T, UInt32, ReplicateTo, PersistTo) | |
| LookupIn<TDocument> | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MutateIn<TDocument> | |
| Observe | |
| ObserveAsync | |
| Prepend(String,Byte[]) |
Prepends a value to a give key.
|
| Prepend(String, String) |
Prepends a value to a give key.
|
| PrependAsync(String,Byte[]) |
Prepends a value to a given key as an asynchronous operation.
|
| PrependAsync(String, String) |
Prepends a value to a given key as an asynchronous operation.
|
| Query(SearchQuery) | |
| Query<T>(String) | |
| Query<T>(IQueryRequest) | |
| Query<T>(IViewQueryable) | |
| QueryAsync(SearchQuery) | |
| QueryAsync<T>(String) | |
| QueryAsync<T>(IQueryRequest) | |
| QueryAsync<T>(IViewQueryable) | |
| Release |
Decrements the reference counter and calls Dispose() if the count is zero.
|
| Remove(IList<String>) |
Removes a range of documents for a given set of keys
|
| Remove(String) |
For a given key, removes a document from the database.
|
| Remove(IList<String>, ParallelOptions) |
Removes a range of documents for a given set of keys
|
| Remove(String, ReplicateTo) | |
| Remove(String, UInt64) |
Removes a document for a given key from the database.
|
| Remove(IList<String>, ParallelOptions, Int32) |
Removes a range of documents for a given set of keys
|
| Remove(String, ReplicateTo, PersistTo) | |
| Remove(String, UInt64, ReplicateTo) | |
| Remove(String, UInt64, ReplicateTo, PersistTo) | |
| Remove<T>(IDocument<T>) |
Removes a document from the database.
|
| Remove<T>(IDocument<T>, ReplicateTo) | |
| Remove<T>(IDocument<T>, ReplicateTo, PersistTo) | |
| RemoveAsync(String) | |
| RemoveAsync(String, ReplicateTo) |
Removes a document for a given key from the database as an asynchronous operation.
|
| RemoveAsync(String, UInt64) |
Removes a document for a given key from the database as an asynchronous operation.
|
| RemoveAsync(String, ReplicateTo, PersistTo) |
Removes a document for a given key from the database as an asynchronous operation.
|
| RemoveAsync(String, UInt64, ReplicateTo) |
Removes a document for a given key from the database as an asynchronous operation.
|
| RemoveAsync(String, UInt64, ReplicateTo, PersistTo) |
Removes a document for a given key from the database as an asynchronous operation.
|
| RemoveAsync<T>(IDocument<T>) |
Removes a document from the database as an asynchronous operation.
|
| RemoveAsync<T>(List<IDocument<T>>) |
Removes a list of IDocument from the bucket asynchronously.
|
| RemoveAsync<T>(IDocument<T>, ReplicateTo) |
Removes a document from the database as an asynchronous operation.
|
| RemoveAsync<T>(List<IDocument<T>>, ReplicateTo) |
Removes a list of IDocument from the bucket asynchronously.
|
| RemoveAsync<T>(IDocument<T>, ReplicateTo, PersistTo) |
Removes a document from the database as an asynchronous operation.
|
| RemoveAsync<T>(List<IDocument<T>>, ReplicateTo, PersistTo) |
Removes a list of IDocument from the bucket asynchronously.
|
| Replace<T>(IDocument<T>) |
Replaces a document if it exists, otherwise fails.
|
| Replace<T>(String, T) |
Replaces a value for a key if it exists, otherwise fails.
|
| Replace<T>(IDocument<T>, ReplicateTo) | |
| Replace<T>(String, T, ReplicateTo) | |
| Replace<T>(String, T, TimeSpan) |
Replaces a document for a given key if it exists, otherwise fails.
|
| Replace<T>(String, T, UInt32) |
Replaces a document for a given key if it exists, otherwise fails.
|
| Replace<T>(String, T, UInt64) |
Replaces a document for a given key if it exists, otherwise fails.
|
| Replace<T>(IDocument<T>, ReplicateTo, PersistTo) |
Replaces a document if it exists, otherwise fails.
|
| Replace<T>(String, T, ReplicateTo, PersistTo) |
Replaces a document for a given key if it exists, otherwise fails.
|
| Replace<T>(String, T, UInt64, ReplicateTo) | |
| Replace<T>(String, T, UInt64, TimeSpan) |
Replaces a document for a given key if it exists, otherwise fails.
|
| Replace<T>(String, T, UInt64, UInt32) |
Replaces a document for a given key if it exists, otherwise fails.
|
| Replace<T>(String, T, UInt64, ReplicateTo, PersistTo) | |
| Replace<T>(String, T, UInt64, TimeSpan, ReplicateTo, PersistTo) | |
| Replace<T>(String, T, UInt64, UInt32, ReplicateTo, PersistTo) | |
| ReplaceAsync<T>(IDocument<T>) |
Replaces a document if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(List<IDocument<T>>) |
Replaces a list of IDocument<T> into a bucket asynchronously.
|
| ReplaceAsync<T>(String, T) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(IDocument<T>, ReplicateTo) | |
| ReplaceAsync<T>(List<IDocument<T>>, ReplicateTo) |
Replaces a list of IDocument<T> into a bucket asynchronously.
|
| ReplaceAsync<T>(String, T, ReplicateTo) | |
| ReplaceAsync<T>(String, T, TimeSpan) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(String, T, UInt32) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(String, T, UInt64) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(IDocument<T>, ReplicateTo, PersistTo) | |
| ReplaceAsync<T>(List<IDocument<T>>, ReplicateTo, PersistTo) |
Replaces a list of IDocument<T> into a bucket asynchronously.
|
| ReplaceAsync<T>(String, T, ReplicateTo, PersistTo) | |
| ReplaceAsync<T>(String, T, UInt64, ReplicateTo) | |
| ReplaceAsync<T>(String, T, UInt64, TimeSpan) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(String, T, UInt64, UInt32) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(String, T, UInt64, ReplicateTo, PersistTo) | |
| ReplaceAsync<T>(String, T, UInt64, TimeSpan, ReplicateTo, PersistTo) | |
| ReplaceAsync<T>(String, T, UInt64, UInt32, ReplicateTo, PersistTo) | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Touch |
Updates the expiration a key without modifying or returning it's value.
|
| TouchAsync |
Updates the expiration a key without modifying or returning it's value as an asynchronous operation.
|
| Unlock | |
| UnlockAsync |
Unlocks a key that was locked with GetWithLock<T>(String, UInt32) as an asynchronous operation.
|
| Upsert<T>(IDictionary<String, T>) |
Inserts or replaces a range of items into Couchbase Server.
|
| Upsert<T>(IDocument<T>) |
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server.
|
| Upsert<T>(IDictionary<String, T>, ParallelOptions) |
Inserts or replaces a range of items into Couchbase Server.
|
| Upsert<T>(String, T) |
Inserts or replaces an existing document into a Memcached Bucket on a Couchbase Server.
|
| Upsert<T>(IDocument<T>, ReplicateTo) | |
| Upsert<T>(IDictionary<String, T>, ParallelOptions, Int32) |
Inserts or replaces a range of items into Couchbase Server.
|
| Upsert<T>(String, T, ReplicateTo) | |
| Upsert<T>(String, T, TimeSpan) |
Inserts or replaces an existing document into Couchbase Server.
|
| Upsert<T>(String, T, UInt32) |
Inserts or replaces an existing document into Couchbase Server.
|
| Upsert<T>(String, T, UInt64) |
Inserts or replaces an existing document into Couchbase Server.
|
| Upsert<T>(IDocument<T>, ReplicateTo, PersistTo) | |
| Upsert<T>(String, T, ReplicateTo, PersistTo) | |
| Upsert<T>(String, T, UInt64, TimeSpan) |
Inserts or replaces an existing document into Couchbase Server.
|
| Upsert<T>(String, T, UInt64, UInt32) |
Inserts or replaces an existing document into Couchbase Server.
|
| Upsert<T>(String, T, TimeSpan, ReplicateTo, PersistTo) | |
| Upsert<T>(String, T, UInt32, ReplicateTo, PersistTo) | |
| Upsert<T>(String, T, UInt64, TimeSpan, ReplicateTo, PersistTo) | |
| Upsert<T>(String, T, UInt64, UInt32, ReplicateTo, PersistTo) | |
| UpsertAsync<T>(IDocument<T>) |
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(List<IDocument<T>>) |
Upserts a list of IDocument<T> into a bucket asynchronously.
|
| UpsertAsync<T>(String, T) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(IDocument<T>, ReplicateTo) |
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(List<IDocument<T>>, ReplicateTo) |
Upserts a list of IDocument<T> into a bucket asynchronously.
|
| UpsertAsync<T>(String, T, ReplicateTo) | |
| UpsertAsync<T>(String, T, TimeSpan) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(String, T, UInt32) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(String, T, UInt64) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(IDocument<T>, ReplicateTo, PersistTo) | |
| UpsertAsync<T>(List<IDocument<T>>, ReplicateTo, PersistTo) |
Upserts a list of IDocument<T> into a bucket asynchronously.
|
| UpsertAsync<T>(String, T, ReplicateTo, PersistTo) | |
| UpsertAsync<T>(String, T, UInt64, TimeSpan) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(String, T, UInt64, UInt32) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(String, T, TimeSpan, ReplicateTo, PersistTo) | |
| UpsertAsync<T>(String, T, UInt32, ReplicateTo, PersistTo) | |
| UpsertAsync<T>(String, T, UInt64, TimeSpan, ReplicateTo, PersistTo) | |
| UpsertAsync<T>(String, T, UInt64, UInt32, ReplicateTo, PersistTo) |
Properties| Name | Description | |
|---|---|---|
 | BucketType |
Returns type of the bucket. In this implementation the value is constant: Memcached.
|
| Cluster |
Returns the ICluster that this bucket belongs to
|
| IsSecure |
Returns true if bucket is using SSL encryption between the client and the server.
|
| Name |
The Bucket's name. You can view this from the Couchbase Management Console.
|
| SupportsEnhancedDurability |
Gets a value indicating whether enhanced durability is enabled.
|
See Also