{NOTE: }
-
All the Counters for a document are deleted when the document is deleted.
-
You can also use the CountersFor.
Delete
method to remove a specific Counter from a document. -
In this page:
Delete
SyntaxDelete
Usage- Code Sample {NOTE/}
{PANEL: Delete
Syntax}
{CODE Delete-definition@DocumentExtensions\Counters\Counters.cs /}
Parameter | Type | Description |
---|---|---|
counterName |
string | Counter's name |
{PANEL/} |
{PANEL: 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
-
Execute
CountersFor.Delete
-
Execute
session.SaveChanges
for the changes to take effect -
Note:
- A Counter you deleted will be removed only after the execution of
SaveChanges()
. - Deleting a document deletes its Counters as well.
Delete
will not generate an error if the Counter doesn't exist.
- A Counter you deleted will be removed only after the execution of
{PANEL/}
{PANEL: Code Sample}
{CODE counters_region_Delete@DocumentExtensions\Counters\Counters.cs /} {PANEL/}
Studio Articles:
Studio Counters Management
Client-API - Session Articles:
Counters Overview
Creating and Modifying Counters
Retrieving Counter Values
Counters and other features
Counters In Clusters
Client-API - Operations Articles:
Counters Operations