ReaderModificationCommandBatch Class

Definition

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
ReaderModificationCommandBatch
Derived

Remarks

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

Constructors

ReaderModificationCommandBatch(IRelationalCommandBuilderFactory, ISqlGenerationHelper, IUpdateSqlGenerator, IRelationalValueBufferFactoryFactory)

Creates a new ReaderModificationCommandBatch instance.

ReaderModificationCommandBatch(ModificationCommandBatchFactoryDependencies, Nullable<Int32>)

Creates a new ReaderModificationCommandBatch instance.

ReaderModificationCommandBatch(ModificationCommandBatchFactoryDependencies)

Creates a new ReaderModificationCommandBatch instance.

Properties

AreMoreBatchesExpected

Indicates whether more batches are expected after this one.

AreMoreBatchesExpected

Indicates whether more batches are expected after this one.

(Inherited from ModificationCommandBatch)
CachedCommandText

Gets or sets the cached command text for the commands in the batch.

CommandResultSet

The ResultSetMappings for each command in ModificationCommands.

Dependencies

Relational provider-specific dependencies for this service.

IsCommandTextEmpty

Whether any SQL has already been added to the batch command text.

LastCachedCommandIndex

The ordinal of the last command for which command text was built.

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.

RequiresTransaction

Indicates whether the batch requires a transaction in order to execute correctly.

(Inherited from ModificationCommandBatch)
ResultSetMappings

The ResultSetMappings for each command in ModificationCommands.

SqlBuilder

Gets the command text builder for the commands in the batch.

SqlGenerationHelper

A helper for SQL generation.

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(IReadOnlyModificationCommand)

Adds the given insert/update/delete ModificationCommands to the batch.

(Inherited from ModificationCommandBatch)
AddCommand(ModificationCommand)

Adds the given insert/update/delete ModificationCommands to the batch.

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.

CanAddCommand(IReadOnlyModificationCommand)

Checks whether a new command can be added to the batch.

CanAddCommand(ModificationCommand)

Checks whether or not a new command can be added to the batch.

Complete(Boolean)

Indicates that no more commands will be added to this batch, and prepares it for execution.

Complete(Boolean)

Indicates that no more commands will be added to this batch, and prepares it for execution.

(Inherited from ModificationCommandBatch)
Consume(DbDataReader)
Consume(RelationalDataReader)

Consumes the data reader created by Execute(IRelationalConnection).

ConsumeAsync(DbDataReader, CancellationToken)
ConsumeAsync(RelationalDataReader, CancellationToken)

Consumes the data reader created by ExecuteAsync(IRelationalConnection, CancellationToken).

CreateStoreCommand()

Generates a RawSqlCommand for the batch.

CreateValueBufferFactory(IReadOnlyList<ColumnModification>)

Creates the IRelationalValueBufferFactory that will be used for creating a ValueBuffer to consume the data reader.

CreateValueBufferFactory(IReadOnlyList<IColumnModification>)

Creates the IRelationalValueBufferFactory that will be used for creating a ValueBuffer to consume the data reader.

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.

GetCommandText()

Gets the command text for all the commands in the current batch and also caches it on CachedCommandText.

GetParameterCount()

Gets the total number of parameters needed for the batch.

IsCommandTextValid()

Checks whether the command text is valid.

IsValid()

Checks whether the command text is valid.

ResetCommandText()

Resets the builder to start building a new batch.

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.

TryAddCommand(IReadOnlyModificationCommand)

Attempts to adds the given insert/update/delete modificationCommand to the batch.

(Inherited from ModificationCommandBatch)
UpdateCachedCommandText(Int32)

Updates the command text for the command at the given position in the ModificationCommands list.

Applies to