public interface CouchbaseOperations
CouchbaseTemplate
.Modifier and Type | Method and Description |
---|---|
<T> T |
execute(BucketCallback<T> action)
Executes a BucketCallback translating any exceptions as necessary.
|
boolean |
exists(String id)
Checks if the given document exists.
|
<T> T |
findById(String id,
Class<T> entityClass)
Find an object by its given Id and map it to the corresponding entity.
|
<T> List<T> |
findByView(String design,
String view,
com.couchbase.client.protocol.views.Query query,
Class<T> entityClass)
Query a View for a list of documents of type T.
|
CouchbaseConverter |
getConverter()
Returns the underlying
CouchbaseConverter . |
com.couchbase.client.CouchbaseClient |
getCouchbaseClient()
Returns the linked
CouchbaseClient to this template. |
void |
insert(Collection<?> batchToInsert)
Insert a list of objects.
|
void |
insert(Collection<?> batchToInsert,
net.spy.memcached.PersistTo persistTo,
net.spy.memcached.ReplicateTo replicateTo)
Insert a list of objects.
|
void |
insert(Object objectToInsert)
Insert the given object.
|
void |
insert(Object objectToInsert,
net.spy.memcached.PersistTo persistTo,
net.spy.memcached.ReplicateTo replicateTo)
Insert the given object.
|
com.couchbase.client.protocol.views.ViewResponse |
queryView(String design,
String view,
com.couchbase.client.protocol.views.Query query)
Query a View with direct access to the
ViewResponse . |
void |
remove(Collection<?> batchToRemove)
Remove a list of objects from the bucket by id.
|
void |
remove(Collection<?> batchToRemove,
net.spy.memcached.PersistTo persistTo,
net.spy.memcached.ReplicateTo replicateTo)
Remove a list of objects from the bucket by id.
|
void |
remove(Object objectToRemove)
Remove the given object from the bucket by id.
|
void |
remove(Object objectToRemove,
net.spy.memcached.PersistTo persistTo,
net.spy.memcached.ReplicateTo replicateTo)
Remove the given object from the bucket by id.
|
void |
save(Collection<?> batchToSave)
Save a list of objects.
|
void |
save(Collection<?> batchToSave,
net.spy.memcached.PersistTo persistTo,
net.spy.memcached.ReplicateTo replicateTo)
Save a list of objects.
|
void |
save(Object objectToSave)
Save the given object.
|
void |
save(Object objectToSave,
net.spy.memcached.PersistTo persistTo,
net.spy.memcached.ReplicateTo replicateTo)
Save the given object.
|
void |
update(Collection<?> batchToUpdate)
Insert a list of objects.
|
void |
update(Collection<?> batchToUpdate,
net.spy.memcached.PersistTo persistTo,
net.spy.memcached.ReplicateTo replicateTo)
Insert a list of objects.
|
void |
update(Object objectToUpdate)
Update the given object.
|
void |
update(Object objectToUpdate,
net.spy.memcached.PersistTo persistTo,
net.spy.memcached.ReplicateTo replicateTo)
Update the given object.
|
void save(Object objectToSave)
When the document already exists (specified by its unique id), then it will be overriden. Otherwise it will be created.
objectToSave
- the object to store in the bucket.void save(Object objectToSave, net.spy.memcached.PersistTo persistTo, net.spy.memcached.ReplicateTo replicateTo)
When the document already exists (specified by its unique id), then it will be overriden. Otherwise it will be created.
objectToSave
- the object to store in the bucket.void save(Collection<?> batchToSave)
When one of the documents already exists (specified by its unique id), then it will be overriden. Otherwise it will be created.
batchToSave
- the list of objects to store in the bucket.void save(Collection<?> batchToSave, net.spy.memcached.PersistTo persistTo, net.spy.memcached.ReplicateTo replicateTo)
When one of the documents already exists (specified by its unique id), then it will be overriden. Otherwise it will be created.
batchToSave
- the list of objects to store in the bucket.persistTo
- the persistence constraint setting.replicateTo
- the replication constraint setting.void insert(Object objectToInsert)
When the document already exists (specified by its unique id), then it will not be overriden. Use the
save(java.lang.Object)
method for this task.
objectToInsert
- the object to add to the bucket.void insert(Object objectToInsert, net.spy.memcached.PersistTo persistTo, net.spy.memcached.ReplicateTo replicateTo)
When the document already exists (specified by its unique id), then it will not be overriden. Use the
save(java.lang.Object)
method for this task.
objectToInsert
- the object to add to the bucket.persistTo
- the persistence constraint setting.replicateTo
- the replication constraint setting.void insert(Collection<?> batchToInsert)
When one of the documents already exists (specified by its unique id), then it will not be overriden. Use the
save(java.lang.Object)
method for this.
batchToInsert
- the list of objects to add to the bucket.void insert(Collection<?> batchToInsert, net.spy.memcached.PersistTo persistTo, net.spy.memcached.ReplicateTo replicateTo)
When one of the documents already exists (specified by its unique id), then it will not be overriden. Use the
save(java.lang.Object)
method for this.
batchToInsert
- the list of objects to add to the bucket.persistTo
- the persistence constraint setting.replicateTo
- the replication constraint setting.void update(Object objectToUpdate)
When the document does not exist (specified by its unique id) it will not be created. Use the
save(java.lang.Object)
method for this.
objectToUpdate
- the object to add to the bucket.void update(Object objectToUpdate, net.spy.memcached.PersistTo persistTo, net.spy.memcached.ReplicateTo replicateTo)
When the document does not exist (specified by its unique id) it will not be created. Use the
save(java.lang.Object)
method for this.
objectToUpdate
- the object to add to the bucket.persistTo
- the persistence constraint setting.replicateTo
- the replication constraint setting.void update(Collection<?> batchToUpdate)
If one of the documents does not exist (specified by its unique id), then it will not be created. Use the
save(java.lang.Object)
method for this.
batchToUpdate
- the list of objects to add to the bucket.void update(Collection<?> batchToUpdate, net.spy.memcached.PersistTo persistTo, net.spy.memcached.ReplicateTo replicateTo)
If one of the documents does not exist (specified by its unique id), then it will not be created. Use the
save(java.lang.Object)
method for this.
batchToUpdate
- the list of objects to add to the bucket.persistTo
- the persistence constraint setting.replicateTo
- the replication constraint setting.<T> T findById(String id, Class<T> entityClass)
id
- the unique ID of the document.entityClass
- the entity to map to.<T> List<T> findByView(String design, String view, com.couchbase.client.protocol.views.Query query, Class<T> entityClass)
There is no need to Query.setIncludeDocs(boolean)
explicitely, because it will be set to true all the
time. It is valid to pass in a empty constructed Query
object.
This method does not work with reduced views, because they by design do not contain references to original
objects. Use the provided queryView(java.lang.String, java.lang.String, com.couchbase.client.protocol.views.Query)
method for more flexibility and direct access.
design
- the name of the design document.view
- the name of the viewName.query
- the Query object to customize the viewName query.entityClass
- the entity to map to.com.couchbase.client.protocol.views.ViewResponse queryView(String design, String view, com.couchbase.client.protocol.views.Query query)
ViewResponse
.
This method is available to ease the working with views by still wrapping exceptions into the Spring infrastructure.
It is especially needed if you want to run reduced viewName queries, because they can't be mapped onto entities directly.
design
- the name of the designDocument document.view
- the name of the viewName.query
- the Query object to customize the viewName query.boolean exists(String id)
id
- the unique ID of the document.void remove(Object objectToRemove)
objectToRemove
- the Object to remove.void remove(Object objectToRemove, net.spy.memcached.PersistTo persistTo, net.spy.memcached.ReplicateTo replicateTo)
objectToRemove
- the Object to remove.persistTo
- the persistence constraint setting.replicateTo
- the replication constraint setting.void remove(Collection<?> batchToRemove)
batchToRemove
- the list of Objects to remove.void remove(Collection<?> batchToRemove, net.spy.memcached.PersistTo persistTo, net.spy.memcached.ReplicateTo replicateTo)
batchToRemove
- the list of Objects to remove.persistTo
- the persistence constraint setting.replicateTo
- the replication constraint setting.<T> T execute(BucketCallback<T> action)
T
- the return type.action
- the action to execute in the callback.CouchbaseConverter getConverter()
CouchbaseConverter
.com.couchbase.client.CouchbaseClient getCouchbaseClient()
CouchbaseClient
to this template.Copyright © 2011-2015–2015 Pivotal Software, Inc.. All rights reserved.