Get Counter Values



Get a single Counter's value

Get usage:

  • Open a session
  • Create an instance of counters_for.
  • Call counters_for.get to retrieve the current value of a single Counter.

Get example:

# 1. Open a session
with store.open_session() as session:
    # 2. pass CountersFor's constructor a document ID
    document_counters = session.counters_for("products/1-C")

    # 3. Use 'CountersFor.Get' to retrieve a Counter's value
    days_left = document_counters.get("DaysLeftForSale")
    print(f"Days Left For Sale: {days_left}")

Get syntax:

def get(self, counter) -> int: ...
Parameter Type Description
counter str Counter name
Return Type Description
int Counter's current value

Get all Counters of a document


GetAll usage:

  • Open a session.
  • Create an instance of counters_for.
  • Call counters_for.get_all to retrieve the names and values of all counters associated with the document.

GetAll example:

# 1. Open a session
with store.open_session() as session:
    # 2. pass CountersFor's constructor a document ID
    document_counters = session.counters_for("products/1-C")

    # 3. Use GetAll to retrieve all of the document's counters' names and values
    counters = document_counters.get_all()

    # list counters' names and values
    for counter_name, counter_value in counters.items():
        print(f"counter name: {counter_name}, counter value: {counter_value}")

GetAll syntax:

def get_all(self) -> Dict[str, int]: ...
Return Type Description
Dict[str, int] Map of Counter names and values