ReaderModificationCommandBatch Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Update

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

A base class for ModificationCommandBatch implementations that make use of a data reader.

This type is typically used by database providers; it is generally not used in application code.

public abstract class ReaderModificationCommandBatch : Microsoft.EntityFrameworkCore.Update.ModificationCommandBatch

type ReaderModificationCommandBatch = class
    inherit ModificationCommandBatch

Public MustInherit Class ReaderModificationCommandBatch
Inherits ModificationCommandBatch

Inheritance

Object

ModificationCommandBatch

ReaderModificationCommandBatch

Derived

Microsoft.EntityFrameworkCore.Update.AffectedCountModificationCommandBatch

Remarks

See Implementation of database providers and extensions for more information and examples.

Constructors

ReaderModificationCommandBatch(ModificationCommandBatchFactoryDependencies, Nullable<Int32>)

Creates a new ReaderModificationCommandBatch instance.

Properties

AreMoreBatchesExpected	Indicates whether more batches are expected after this one.
Dependencies	Relational provider-specific dependencies for this service.
IsCommandTextEmpty	Whether any SQL has already been added to the batch command text.
MaxBatchSize	The maximum number of ModificationCommand instances that can be added to a single batch.
ModificationCommands	The list of conceptual insert/update/delete ModificationCommandss in the batch.
ParameterValues	Gets the parameter values for the commands in the batch.
RelationalCommandBuilder	Gets the relational command builder for the commands in the batch.
RequiresTransaction	Indicates whether the batch requires a transaction in order to execute correctly.
ResultSetMappings	The ResultSetMappings for each command in ModificationCommands.
SqlBuilder	Gets the command text builder for the commands in the batch.
StoreCommand	The store command generated from this batch when Complete(Boolean) is called.
UpdateSqlGenerator	The update SQL generator.

Methods

AddCommand(IReadOnlyModificationCommand)	Adds Updates the command text for the command at the given position in the ModificationCommands list.
AddCommand(ModificationCommand)	Adds the given insert/update/delete ModificationCommands to the batch. (Inherited from ModificationCommandBatch)
AddParameter(IColumnModification)	Adds a parameter for the given columnModification to the relational command being built for this batch.
AddParameters(IReadOnlyModificationCommand)	Adds parameters for all column modifications in the given modificationCommand to the relational command being built for this batch.
Complete(Boolean)	Indicates that no more commands will be added to this batch, and prepares it for execution.
Consume(RelationalDataReader)	Consumes the data reader created by Execute(IRelationalConnection).
ConsumeAsync(RelationalDataReader, CancellationToken)	Consumes the data reader created by ExecuteAsync(IRelationalConnection, CancellationToken).
Execute(IRelationalConnection)	Executes the command generated by this batch against a database using the given connection.
ExecuteAsync(IRelationalConnection, CancellationToken)	Executes the command generated by this batch against a database using the given connection.
IsValid()	Checks whether the command text is valid.
RollbackLastCommand(IReadOnlyModificationCommand)	Rolls back the last command added. Used when adding a command caused the batch to become invalid (e.g. CommandText too long).
SetRequiresTransaction(Boolean)	Sets whether the batch requires a transaction in order to execute correctly.
TryAddCommand(IReadOnlyModificationCommand)	Attempts to adds the given insert/update/delete modificationCommand to the batch.