RelationalCommandBuilder Class

Definition

Builds a command to be executed against a relational database.

This type is typically used by database providers (and other extensions). It is generally not used in application code.

public class RelationalCommandBuilder : Microsoft.EntityFrameworkCore.Storage.IRelationalCommandBuilder
type RelationalCommandBuilder = class
    interface IRelationalCommandBuilder
Public Class RelationalCommandBuilder
Implements IRelationalCommandBuilder
Inheritance
RelationalCommandBuilder
Implements

Remarks

See Implementation of database providers and extensions for more information.

Constructors

RelationalCommandBuilder(RelationalCommandBuilderDependencies)

Constructs a new RelationalCommand.

This type is typically used by database providers (and other extensions). It is generally not used in application code.

Properties

CommandTextLength

Gets the length of the command text.

Dependencies

Relational provider-specific dependencies for this service.

Parameters

The collection of parameters.

TypeMappingSource
Obsolete.

The source for RelationalTypeMappings to use.

Methods

AddParameter(IRelationalParameter)

Adds the given parameter to this command.

Append(Object)

Appends an object to the command text.

Append(String)

Appends an object to the command text.

AppendLine()

Appends a blank line to the command text.

Build()

Creates the command.

DecrementIndent()

Decrements the indent of subsequent lines.

IncrementIndent()

Increments the indent of subsequent lines.

RemoveParameterAt(Int32)

Removes the parameter with the given index from this command.

ToString()

Gets the command text.

Extension Methods

AddCompositeParameter(IRelationalCommandBuilder, String, Action<IRelationalParameterBuilder>)

Adds a parameter that is ultimately represented as multiple DbParameters in the final command.

AddCompositeParameter(IRelationalCommandBuilder, String, IReadOnlyList<IRelationalParameter>)

Adds a parameter that is ultimately represented as multiple DbParameters in the final command.

AddParameter(IRelationalCommandBuilder, String, String)
Obsolete.

Adds a parameter.

AddParameter(IRelationalCommandBuilder, String, String, IProperty)
Obsolete.

Adds a parameter.

AddParameter(IRelationalCommandBuilder, String, String, RelationalTypeMapping, Boolean)

Adds a parameter.

AddParameter(IRelationalCommandBuilder, String, String, RelationalTypeMapping, Nullable<Boolean>)

Adds a parameter.

AddParameter(IRelationalCommandBuilder, String, String, RelationalTypeMapping, Nullable<Boolean>, ParameterDirection)

Adds a parameter.

AddPropertyParameter(IRelationalCommandBuilder, String, String, IProperty)
Obsolete.

Adds a parameter.

AddRawParameter(IRelationalCommandBuilder, String, DbParameter)

Adds a parameter.

Append(IRelationalCommandBuilder, Object)

Appends an object to the command text.

AppendLine(IRelationalCommandBuilder)

Appends a blank line to the command text.

AppendLine(IRelationalCommandBuilder, Object)

Appends an object to the command text on a new line.

AppendLine(IRelationalCommandBuilder, String)

Appends an object to the command text on a new line.

AppendLines(IRelationalCommandBuilder, Object)

Appends an object, that contains multiple lines of text, to the command text. Each line read from the object is appended on a new line.

AppendLines(IRelationalCommandBuilder, Object, Boolean)

Appends an object, that contains multiple lines of text, to the command text. Each line read from the object is appended on a new line.

AppendLines(IRelationalCommandBuilder, String, Boolean)

Appends an object, that contains multiple lines of text, to the command text. Each line read from the object is appended on a new line.

DecrementIndent(IRelationalCommandBuilder)

Decrements the indent of subsequent lines.

GetLength(IRelationalCommandBuilder)

Gets the length of the command text.

IncrementIndent(IRelationalCommandBuilder)

Increments the indent of subsequent lines.

Indent(IRelationalCommandBuilder)

Increases the indent of the command text.

Applies to