Represents a Couchbase Bucket object for performing CRUD operations on Documents and Key/Value pairs, View
queries, and executing N1QL queries.
Namespace: Couchbase.CoreAssembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 0.0.0.0 (0.0.0.0)
SyntaxThe IBucket type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | 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 give key as an asynchronous operation.
|
| AppendAsync(String, String) |
Appends a value to a give key as an asynchronous operation.
|
| CreateManager |
Creates a IBucketManager instance for managing buckets.
|
| CreateQuery(String, String) |
Creates an instance of an object that implements IViewQuery, which targets a given bucket, design document and a published view.
|
| CreateQuery(String, String, Boolean) |
Creates an instance of an object that implements IViewQuery, which targets a given bucket and design document.
|
| 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 | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| Exists |
Checks for the existance of a given key.
|
| ExistsAsync |
Checks for the existance of a given key as an asynchronous operation.
|
| Get<T>(IList<String>) |
Gets a range of values for a given set of keys
|
| Get<T>(String) |
Gets value for a given key
|
| 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) |
Gets a document and locks it for a specified time period.
|
| GetAndLock<T>(String, UInt32) |
Gets a document and locks it for a specified time period.
|
| GetAndLockAsync<T>(String, TimeSpan) |
Gets a document and locks it for a specified time period as an asynchronous operation.
|
| GetAndLockAsync<T>(String, UInt32) |
Gets a document and locks it for a specified time period as an asynchronous operation.
|
| 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> |
Gets a Task that can be awaited on for a given Key and value as an asynchronous operation.
|
| GetDocument<T> |
Gets a document by it's given id.
|
| GetDocumentAsync<T> |
Gets a document by it's given id as an asynchronous operation.
|
| GetDocumentsAsync<T> |
Gets a list of documents by their given id as an asynchronous operation.
|
| GetFromReplica<T> |
Returns a value for a
|
| GetFromReplicaAsync<T> |
Gets a value for key and checks it's replicas as an asynchronous operation.
|
| GetWithLock<T>(String, TimeSpan) | Obsolete.
Gets a document and locks it for a specified time period.
|
| GetWithLock<T>(String, UInt32) | Obsolete.
Gets a document and locks it for a specified time period.
|
| GetWithLockAsync<T>(String, TimeSpan) | Obsolete.
Gets a document and locks it for a specified time period as an asynchronous operation.
|
| GetWithLockAsync<T>(String, UInt32) | Obsolete.
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 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) |
Inserts a JSON document into the IBucketfailing if it exists.
|
| Insert<T>(String, T, ReplicateTo) |
Inserts a document into the database for a given key, failing if it exists.
|
| 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) |
Inserts a JSON document into the IBucketfailing if it exists.
|
| Insert<T>(String, T, ReplicateTo, PersistTo) |
Inserts a document into the database for a given key, failing if it exists.
|
| Insert<T>(String, T, TimeSpan, ReplicateTo, PersistTo) |
Inserts a document into the database for a given key, failing if it exists.
|
| Insert<T>(String, T, UInt32, ReplicateTo, PersistTo) |
Inserts a document into the database for a given key, failing if it exists.
|
| 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) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| InsertAsync<T>(IDocument<T>, ReplicateTo) |
Inserts a JSON document into the IBucketfailing if it exists as an asynchronous operation.
|
| 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) |
Inserts a document into the database for a given key, failing if it exists as an asynchronous operation.
|
| 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) |
Inserts a JSON document into the IBucketfailing if it exists as an asynchronous operation.
|
| 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) |
Inserts a document into the database for a given key, failing if it exists as an asynchronous operation.
|
| InsertAsync<T>(String, T, TimeSpan, ReplicateTo, PersistTo) |
Inserts a document into the database for a given key, failing if it exists as an asynchronous operation.
|
| InsertAsync<T>(String, T, UInt32, ReplicateTo, PersistTo) |
Inserts a document into the database for a given key, failing if it exists as an asynchronous operation.
|
| LookupIn<TDocument> | |
| MutateIn<TDocument> | |
| Observe |
Performs 'observe' on a given key to ensure that it's durability requirements with respect to persistence and replication are satisfied.
|
| ObserveAsync |
Performs 'observe' on a given key to ensure that it's durability requirements with respect to persistence and replication are satisfied asynchronously.
|
| 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 give key as an asynchronous operation.
|
| PrependAsync(String, String) |
Prepends a value to a give key as an asynchronous operation.
|
| Query(SearchQuery) | |
| Query<T>(String) |
Executes a N1QL query against the Couchbase Cluster.
|
| Query<T>(IQueryRequest) |
Executes a N1QL statement or prepared statement via a IQueryRequest against the Couchbase Cluster.
|
| Query<T>(IViewQueryable) |
Executes a View query and returns the result.
|
| QueryAsync(SearchQuery) | |
| QueryAsync<T>(String) |
Asynchronously executes a N1QL query against the Couchbase Cluster.
|
| QueryAsync<T>(IQueryRequest) |
Asynchronously executes a N1QL statement or prepared statement via a IQueryRequest against the Couchbase Cluster.
|
| QueryAsync<T>(IViewQueryable) |
Asynchronously Executes a View query and returns the result.
|
| Remove(IList<String>) |
Removes a range of documents for a given set of keys
|
| Remove(String) |
Removes a document for a given key from the database.
|
| Remove(IList<String>, ParallelOptions) |
Removes a range of documents for a given set of keys
|
| Remove(String, ReplicateTo) |
Removes a document for a given key from the database.
|
| 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) |
Removes a document for a given key from the database.
|
| Remove(String, UInt64, ReplicateTo) |
Removes a document for a given key from the database.
|
| Remove(String, UInt64, ReplicateTo, PersistTo) |
Removes a document for a given key from the database.
|
| Remove<T>(IDocument<T>) |
Removes a document from the database.
|
| Remove<T>(IDocument<T>, ReplicateTo) |
Removes a document from the database.
|
| Remove<T>(IDocument<T>, ReplicateTo, PersistTo) |
Removes a document from the database.
|
| RemoveAsync(String) |
Asynchronously removes a document for a given key from the database as an asynchronous operation.
|
| 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 document for a given key if it exists, otherwise fails.
|
| Replace<T>(IDocument<T>, ReplicateTo) |
Replaces a document if it exists, otherwise fails.
|
| Replace<T>(String, T, ReplicateTo) |
Replaces a document for a given key if it exists, otherwise fails.
|
| 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) |
Replaces a document for a given key if it exists, otherwise fails.
|
| 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) |
Replaces a document for a given key if it exists, otherwise fails.
|
| Replace<T>(String, T, UInt64, TimeSpan, ReplicateTo, PersistTo) |
Replaces a document for a given key if it exists, otherwise fails.
|
| Replace<T>(String, T, UInt64, UInt32, ReplicateTo, PersistTo) |
Replaces a document for a given key if it exists, otherwise fails.
|
| 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) |
Replaces a document if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(List<IDocument<T>>, ReplicateTo) |
Replaces a list of IDocument<T> into a bucket asynchronously.
|
| ReplaceAsync<T>(String, T, ReplicateTo) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| 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) |
Replaces a document if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(List<IDocument<T>>, ReplicateTo, PersistTo) |
Replaces a list of IDocument<T> into a bucket asynchronously.
|
| ReplaceAsync<T>(String, T, ReplicateTo, PersistTo) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(String, T, UInt64, ReplicateTo) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| 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) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(String, T, UInt64, TimeSpan, ReplicateTo, PersistTo) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| ReplaceAsync<T>(String, T, UInt64, UInt32, ReplicateTo, PersistTo) |
Replaces a document for a given key if it exists, otherwise fails as an asynchronous operation.
|
| 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 |
Unlocks a key that was locked with GetAndLock<T>(String, UInt32).
|
| UnlockAsync |
Unlocks a key that was locked with GetAndLock<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 Couchbase Server.
|
| Upsert<T>(IDocument<T>, ReplicateTo) |
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server.
|
| Upsert<T>(IDictionary<String, T>, ParallelOptions, Int32) |
Inserts or replaces a range of items into Couchbase Server.
|
| Upsert<T>(String, T, ReplicateTo) |
Inserts or replaces an existing document into Couchbase Server.
|
| 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) |
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server.
|
| Upsert<T>(String, T, ReplicateTo, PersistTo) |
Inserts or replaces an existing document into Couchbase Server.
|
| 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) |
Inserts or replaces an existing document into Couchbase Server.
|
| Upsert<T>(String, T, UInt32, ReplicateTo, PersistTo) |
Inserts or replaces an existing document into Couchbase Server.
|
| Upsert<T>(String, T, UInt64, TimeSpan, ReplicateTo, PersistTo) |
Inserts or replaces an existing document into Couchbase Server.
|
| Upsert<T>(String, T, UInt64, UInt32, ReplicateTo, PersistTo) |
Inserts or replaces an existing document into Couchbase Server.
|
| 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) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| 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) |
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(List<IDocument<T>>, ReplicateTo, PersistTo) |
Upserts a list of IDocument<T> into a bucket asynchronously.
|
| UpsertAsync<T>(String, T, ReplicateTo, PersistTo) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| 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) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(String, T, UInt32, ReplicateTo, PersistTo) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(String, T, UInt64, TimeSpan, ReplicateTo, PersistTo) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
| UpsertAsync<T>(String, T, UInt64, UInt32, ReplicateTo, PersistTo) |
Inserts or replaces an existing document into Couchbase Server as an asynchronous operation.
|
Properties| Name | Description | |
|---|---|---|
 | BucketType |
Returns type of the bucket (either Couchbase or Memcached)
|
| Cluster |
Returns the ICluster that this bucket belongs to
|
| Configuration |
Gets the configuration for the bucket
|
| IsSecure |
Returns true if bucket is using SSL encryption between the client and the server.
|
| Name |
The name of the Couchbase Bucket. This is visible from the Couchbase Server Management Console.
|
| SupportsEnhancedDurability |
Gets a value indicating whether enhanced durability is enabled.
|
See Also