Delete Counter
-
Use the
countersFor.delete
method to remove a specific Counter from a document. -
All the document's Counters are deleted when the document itself is deleted.
-
For all other
countersFor
methods see this Overview. -
In this page:
delete
usage
Flow:
- 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
documentCounters.delete
. - Call
session.saveChanges
for the changes to take effect.
Note:
- A Counter you deleted will be removed only after the execution of
saveChanges()
. delete
will not generate an error if the Counter doesn't exist.- Deleting a document deletes all its Counters as well.
Syntax
public function delete(?string $counter): void;
Parameter | Type | Description |
---|---|---|
counter | string |
Counter name (see example) |