EntityFrameworkQueryableExtensions.TagWith<T> Method

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v2.2.6

Package:: Microsoft.EntityFrameworkCore v3.0.0

Package:: Microsoft.EntityFrameworkCore v3.1.0

Package:: Microsoft.EntityFrameworkCore v5.0.0

Package:: Microsoft.EntityFrameworkCore v6.0.0

Package:: Microsoft.EntityFrameworkCore v7.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds a tag to the collection of tags associated with an EF LINQ query. Tags are query annotations that can provide contextual tracing information at different points in the query pipeline.

public static System.Linq.IQueryable<T> TagWith<T> (this System.Linq.IQueryable<T> source, string tag);

static member TagWith : System.Linq.IQueryable<'T> * string -> System.Linq.IQueryable<'T>

<Extension()>
Public Function TagWith(Of T) (source As IQueryable(Of T), tag As String) As IQueryable(Of T)

Type Parameters

T

The type of entity being queried.

Parameters

source: IQueryable<T>

The source query.

tag: String

The tag.

Returns

IQueryable<T>

A new query annotated with the given tag.

Exceptions

ArgumentNullException

source or tag is null.

ArgumentException

tag is empty or whitespace.

Remarks

See Tagging queries in EF Core for more information and examples.

Applies to