RelationalQueryContext RelationalQueryContext Class

Definition

The principal data structure used by a compiled relational query during execution.

public class RelationalQueryContext : QueryContext
Public Class RelationalQueryContext
    Inherits QueryContext
Inheritance
System.ObjectSystem.Object
RelationalQueryContextRelationalQueryContext

Inherited Members

Microsoft.EntityFrameworkCore.Query.QueryContext

System.Object

System.Object.ToString()System.Object.ToString()
System.Object.Equals(System.Object)System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()System.Object.GetHashCode()
System.Object.GetType()System.Object.GetType()
System.Object.MemberwiseClone()System.Object.MemberwiseClone()

Constructors

RelationalQueryContext(Func, IRelationalConnection, LazyRef, IConcurrencyDetector, IExecutionStrategyFactory) RelationalQueryContext(Func(Of IQueryBuffer), IRelationalConnection, LazyRef(Of IStateManager), IConcurrencyDetector, IExecutionStrategyFactory)

This API supports the Entity Framework Core infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

public RelationalQueryContext(Func<IQueryBuffer> queryBufferFactory, IRelationalConnection connection, LazyRef<IStateManager> stateManager, IConcurrencyDetector concurrencyDetector, IExecutionStrategyFactory executionStrategyFactory)
Public Sub New(queryBufferFactory As Func(Of IQueryBuffer), connection As IRelationalConnection, stateManager As LazyRef(Of IStateManager), concurrencyDetector As IConcurrencyDetector, executionStrategyFactory As IExecutionStrategyFactory)
Parameters
queryBufferFactory
System.Func<IQueryBuffer> System.Func(Of IQueryBuffer)

Properties

Connection Connection

Gets the active relational connection.

public virtual IRelationalConnection Connection { get; }
Public Overridable ReadOnly Property Connection As IRelationalConnection

ExecutionStrategyFactory ExecutionStrategyFactory

The execution strategy factory.

public virtual IExecutionStrategyFactory ExecutionStrategyFactory { get; }
Public Overridable ReadOnly Property ExecutionStrategyFactory As IExecutionStrategyFactory
Value
IExecutionStrategyFactory IExecutionStrategyFactory

The execution strategy factory.

Semaphore Semaphore

Gets a semaphore used to serialize async queries.

public virtual SemaphoreSlim Semaphore { get; }
Public Overridable ReadOnly Property Semaphore As SemaphoreSlim
Value
System.Threading.SemaphoreSlim System.Threading.SemaphoreSlim

The semaphore.

Methods

BeginIncludeScope() BeginIncludeScope()

Begins an include scope.

public virtual void BeginIncludeScope()
Public Overridable Sub BeginIncludeScope

DeregisterValueBufferCursor(IValueBufferCursor) DeregisterValueBufferCursor(IValueBufferCursor)

Deregisters the value buffer cursor described by valueBufferCursor.

public virtual void DeregisterValueBufferCursor(IValueBufferCursor valueBufferCursor)
Public Overridable Sub DeregisterValueBufferCursor(valueBufferCursor As IValueBufferCursor)
Parameters
valueBufferCursor
IValueBufferCursor IValueBufferCursor

The value buffer cursor.

EndIncludeScope() EndIncludeScope()

Ends an include scope.

public virtual void EndIncludeScope()
Public Overridable Sub

GetIncludeValueBuffer(Int32) GetIncludeValueBuffer(Int32)

Gets the include value buffer for a given query index.

public virtual ValueBuffer GetIncludeValueBuffer(int queryIndex)
Public Overridable Function GetIncludeValueBuffer(queryIndex As Integer) As ValueBuffer
Parameters
queryIndex
System.Int32 System.Int32

Zero-based index of the query.

Returns

The include value buffer.

RegisterValueBufferCursor(IValueBufferCursor, Nullable) RegisterValueBufferCursor(IValueBufferCursor, Nullable(Of Int32))

Registers a value buffer cursor.

public virtual void RegisterValueBufferCursor(IValueBufferCursor valueBufferCursor, int ? queryIndex)
Public Overridable Sub RegisterValueBufferCursor(valueBufferCursor As IValueBufferCursor, queryIndex As Integer?)
Parameters
valueBufferCursor
IValueBufferCursor IValueBufferCursor

The value buffer cursor.

queryIndex
System.Nullable<System.Int32> System.Nullable(Of System.Int32)

Zero-based index of the query.

RegisterValueBufferCursorAsync(IValueBufferCursor, Nullable, CancellationToken) RegisterValueBufferCursorAsync(IValueBufferCursor, Nullable(Of Int32), CancellationToken)

Asynchronously registers a value buffer cursor.

public virtual Task RegisterValueBufferCursorAsync(IValueBufferCursor valueBufferCursor, int ? queryIndex, CancellationToken cancellationToken)
Public Overridable Function RegisterValueBufferCursorAsync(valueBufferCursor As IValueBufferCursor, queryIndex As Integer?, cancellationToken As CancellationToken) As Task
Parameters
valueBufferCursor
IValueBufferCursor IValueBufferCursor

The value buffer cursor.

queryIndex
System.Nullable<System.Int32> System.Nullable(Of System.Int32)

Zero-based index of the query.

cancellationToken
System.Threading.CancellationToken System.Threading.CancellationToken

The cancellation token.

Returns
System.Threading.Tasks.Task System.Threading.Tasks.Task

A Task.