Get Counter Values
-
Use
countersFor.get
to retrieve the value of a single Counter,
orcountersFor.getAll
to retrieve the names and values of all Counters associated with a document. -
For all other
CountersFor
methods see this Overview. -
In this page:
Get a single Counter's value
- Open a session
-
Create an instance of
countersFor
.- Either pass
countersFor
an explicit document ID, -or- - Pass it an entity tracked by the session, e.g. a document object returned from
session.query
or fromsession.load
.
- Either pass
- Call
countersFor.get
to retrieve the current value of a single Counter.
// 1. Open a session
try (IDocumentSession session = docStore.openSession()) {
// 2. pass CountersFor's constructor a document ID
ISessionDocumentCounters documentCounters = session.countersFor("products/1-C");
// 3. Use `countersFor.get` to retrieve a Counter's value
Long daysLeft = documentCounters.get("daysLeftForSale");
System.out.println("Days Left For Sale: " + daysLeft);
}
Get all Counters of a document
- Open a session.
-
Create an instance of
countersFor
.- Either pass
countersFor
an explicit document ID, -or- - Pass it an entity tracked by the session, e.g. a document object returned from session.query or from session.load.
- Either pass
- Call
countersFor.getAll
to retrieve the names and values of all counters associated with the document.
// 1. Open a session
try (IDocumentSession session = docStore.openSession()) {
// 2. pass countersFor's constructor a document ID
ISessionDocumentCounters documentCounters = session.countersFor("products/1-C");
// 3. Use GetAll to retrieve all of the document's Counters' names and values.
Map<String, Long> counters = documentCounters.getAll();
// list counters' names and values
for (Map.Entry<String, Long> kvp : counters.entrySet()) {
System.out.println("counter name: " + kvp.getKey() + ", counter value: " + kvp.getValue());
}
}