Click or drag to resize
IBucket Interface
Represents a Couchbase Bucket object for performing CRUD operations on Documents and Key/Value pairs, View queries, and executing N1QL queries.

Namespace: Couchbase.Core
Assembly: Couchbase (in Couchbase.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public interface IBucket : IDisposable

The IBucket type exposes the following members.

Methods
  NameDescription
Public methodAppend
Appends a value to a give key.
Public methodCreateQuery(Boolean)
Creates an instance of an object that implements IViewQuery, which targets a given bucket.
Public methodCreateQuery(Boolean, String)
Creates an instance of an object that implements IViewQuery, which targets a given bucket, design document and view.
Public methodCreateQuery(Boolean, String, String)
Creates an instance of an object that implements IViewQuery, which targets a given bucket and design document.
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, 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 methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodGetT
Gets value for a given key
Public methodGetAsyncT
Gets a Task that can be awaited on for a given Key and value.
Public methodGetDocumentT
Gets a document by it's given id.
Public methodIncrement(String)
Increments the value of a key by one. If the key doesn't exist, it will be created and seeded with 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, 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 methodInsertT(IDocumentT)
Inserts a JSON document into the IBucketfailing if it exists.
Public methodInsertT(String, T)
Inserts a document into the database for a given key, failing if it exists.
Public methodInsertT(IDocumentT, ReplicateTo)
Inserts a JSON document into the IBucketfailing if it exists.
Public methodInsertT(String, T, ReplicateTo)
Inserts a document into the database for a given key, failing if it exists.
Public methodInsertT(String, T, UInt32)
Inserts a document into the database for a given key, failing if it exists.
Public methodInsertT(IDocumentT, ReplicateTo, PersistTo)
Inserts a JSON document into the IBucketfailing if it exists.
Public methodInsertT(String, T, ReplicateTo, PersistTo)
Inserts a document into the database for a given key, failing if it exists.
Public methodInsertT(String, T, UInt32, ReplicateTo, PersistTo)
Inserts a document into the database for a given key, failing if it exists.
Public methodInsertAsyncT
Inserts or replaces an existing document into Couchbase Server.
Public methodObserve
Performs 'observe' on a given key to ensure that it's durability requirements with respect to persistence and replication are satified.
Public methodPrepend
Prepends a value to a give key.
Public methodQueryT(String)
Executes a N1QL query against the Couchbase Cluster.
Public methodQueryT(IViewQuery)
Executes a View query and returns the result.
Public methodRemove(String)
Removes a document for a given key from the database.
Public methodRemove(String, ReplicateTo)
Removes a document for a given key from the database.
Public methodRemove(String, UInt64)
Removes a document for a given key from the database.
Public methodRemove(String, ReplicateTo, PersistTo)
Removes a document for a given key from the database.
Public methodRemove(String, UInt64, ReplicateTo)
Removes a document for a given key from the database.
Public methodRemove(String, UInt64, ReplicateTo, PersistTo)
Removes a document for a given key from the database.
Public methodRemoveT(IDocumentT)
Removes a document from the database.
Public methodRemoveT(IDocumentT, ReplicateTo)
Removes a document from the database.
Public methodRemoveT(IDocumentT, ReplicateTo, PersistTo)
Removes a document from the database.
Public methodReplaceT(IDocumentT)
Replaces a document if it exists, otherwise fails.
Public methodReplaceT(String, T)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplaceT(IDocumentT, ReplicateTo)
Replaces a document if it exists, otherwise fails.
Public methodReplaceT(String, T, ReplicateTo)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplaceT(String, T, UInt32)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplaceT(String, T, UInt64)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplaceT(IDocumentT, ReplicateTo, PersistTo)
Replaces a document if it exists, otherwise fails.
Public methodReplaceT(String, T, ReplicateTo, PersistTo)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplaceT(String, T, UInt32, UInt32)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplaceT(String, T, UInt64, ReplicateTo)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplaceT(String, T, UInt64, ReplicateTo, PersistTo)
Replaces a document for a given key if it exists, otherwise fails.
Public methodReplaceT(String, T, UInt64, UInt32, ReplicateTo, PersistTo)
Replaces a document for a given key if it exists, otherwise fails.
Public methodUpsertT(IDocumentT)
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server.
Public methodUpsertT(String, T)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsertT(IDocumentT, ReplicateTo)
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server.
Public methodUpsertT(String, T, ReplicateTo)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsertT(String, T, UInt32)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsertT(String, T, UInt64)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsertT(IDocumentT, ReplicateTo, PersistTo)
Inserts or replaces an existing JSON document into IBucket on a Couchbase Server.
Public methodUpsertT(String, T, ReplicateTo, PersistTo)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsertT(String, T, UInt64, UInt32)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsertT(String, T, UInt32, ReplicateTo, PersistTo)
Inserts or replaces an existing document into Couchbase Server.
Public methodUpsertT(String, T, UInt64, UInt32, ReplicateTo, PersistTo)
Inserts or replaces an existing document into Couchbase Server.
Top
Properties
  NameDescription
Public propertyIsSecure
Returns true if bucket is using SSL encryption between the client and the server.
Public propertyName
The name of the Couchbase Bucket. This is visible from the Couchbase Server Management Console.
Top
See Also