CosmosQueryExecutedEventData Class

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore.Diagnostics
Assembly:
Microsoft.EntityFrameworkCore.Cosmos.dll
Package:
Microsoft.EntityFrameworkCore.Cosmos v6.0.0
Package:
Microsoft.EntityFrameworkCore.Cosmos v7.0.0
Package:
Microsoft.EntityFrameworkCore.Cosmos v8.0.0

A DiagnosticSource event payload class for Cosmos query events.

public class CosmosQueryExecutedEventData : Microsoft.EntityFrameworkCore.Diagnostics.EventData
type CosmosQueryExecutedEventData = class
    inherit EventData
Public Class CosmosQueryExecutedEventData
Inherits EventData
Inheritance
Object
EventData
CosmosQueryExecutedEventData

Remarks

See Logging, events, and diagnostics for more information and examples.

Constructors

CosmosQueryExecutedEventData(EventDefinitionBase, Func<EventDefinitionBase, EventData,String>, TimeSpan, Double, String, String, String, IReadOnlyList<ValueTuple<String, Object>>, String, Boolean)

Constructs the event payload.

Properties

ActivityId

The activity ID.
ContainerId

The ID of the Cosmos container being queried.
Elapsed

The time elapsed since the command was sent to the database.
EventId

The EventId that defines the message ID and name.

(Inherited from EventData)
EventIdCode

A string representing the code where this event is defined.

(Inherited from EventData)
LogLevel

The LogLevel that would be used to log message for this event.

(Inherited from EventData)
LogSensitiveData

Indicates whether the application allows logging of sensitive data.
Parameters

Name/values for each parameter in the Cosmos Query.
PartitionKey

The key of the Cosmos partition that the query is using.
QuerySql

The SQL representing the query.
RequestCharge

The request charge in RU.

Methods

ToString()

A logger message describing this event.

(Inherited from EventData)

Applies to