RelationalQueryContext RelationalQueryContext Class

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

Syntax

Declaration

public class RelationalQueryContext : QueryContextPublic Class RelationalQueryContext
    Inherits QueryContext

Inheritance Hierarchy

Inherited Members

QueryBuffer,
QueryBuffer,
StateManager,
StateManager,
QueryProvider,
QueryProvider,
ConcurrencyDetector,
ConcurrencyDetector,
CancellationToken,
CancellationToken,
ParameterValues,
ParameterValues,
AddParameter(String, Object),
AddParameter(String, Object),
RemoveParameter(String),
RemoveParameter(String),
BeginTrackingQuery(),
BeginTrackingQuery(),
StartTracking(Object, EntityTrackingInfo),
StartTracking(Object, EntityTrackingInfo),
ToString(),
ToString(),
Equals(Object),
Equals(Object),
Equals(Object, Object),
Equals(Object, Object),
ReferenceEquals(Object, Object),
ReferenceEquals(Object, Object),
GetHashCode(),
GetHashCode(),
GetType(),
GetType(),
MemberwiseClone()
MemberwiseClone()

Constructors summary

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.

Properties summary

Gets the active relational connection.

The execution strategy factory.

Gets a semaphore used to serialize async queries.

Methods summary

Begins an include scope.

Deregisters the value buffer cursor described by valueBufferCursor.

Ends an include scope.

Gets the include value buffer for a given query index.

Registers a value buffer cursor.

Asynchronously registers a value buffer cursor.

Constructors

  • RelationalQueryContext(Func<IQueryBuffer>, IRelationalConnection, LazyRef<IStateManager>, 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

Properties

  • Connection
    Connection

    Gets the active relational connection.

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

    Property Value

  • ExecutionStrategyFactory
    ExecutionStrategyFactory

    The execution strategy factory.

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

    Property Value

  • Semaphore
    Semaphore

    Gets a semaphore used to serialize async queries.

    public virtual SemaphoreSlim Semaphore { get; }Public Overridable ReadOnly Property Semaphore As SemaphoreSlim

    Property 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

  • 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

  • RegisterValueBufferCursor(IValueBufferCursor, Nullable<Int32>)
    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

      The value buffer cursor.

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

      Zero-based index of the query.

  • RegisterValueBufferCursorAsync(IValueBufferCursor, Nullable<Int32>, 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

      The value buffer cursor.

    • queryIndex
      System.Nullable<T><System.Int32>
      System.Nullable<T>(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.

Details

Assembly

Microsoft.EntityFrameworkCore.Relational.dll