Class RelationalCommandBuilder

Namespace

Microsoft.EntityFrameworkCore.Storage

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

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 : IRelationalCommandBuilder

Inheritance

object

RelationalCommandBuilder

Implements

IRelationalCommandBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

RelationalCommandBuilderExtensions.AddCompositeParameter(IRelationalCommandBuilder, string, IReadOnlyList<IRelationalParameter>)

RelationalCommandBuilderExtensions.AddParameter(IRelationalCommandBuilder, string, string, IProperty)

RelationalCommandBuilderExtensions.AddParameter(IRelationalCommandBuilder, string, string, RelationalTypeMapping, bool)

RelationalCommandBuilderExtensions.AddParameter(IRelationalCommandBuilder, string, string, RelationalTypeMapping, bool?)

RelationalCommandBuilderExtensions.AddParameter(IRelationalCommandBuilder, string, string)

RelationalCommandBuilderExtensions.AddPropertyParameter(IRelationalCommandBuilder, string, string, IProperty)

RelationalCommandBuilderExtensions.AddRawParameter(IRelationalCommandBuilder, string, DbParameter)

RelationalCommandBuilderExtensions.AppendLine(IRelationalCommandBuilder, string)

RelationalCommandBuilderExtensions.AppendLines(IRelationalCommandBuilder, string, bool)

RelationalCommandBuilderExtensions.Indent(IRelationalCommandBuilder)

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.

public RelationalCommandBuilder(RelationalCommandBuilderDependencies dependencies)

Parameters

dependencies RelationalCommandBuilderDependencies

Parameter object containing dependencies for this service.

Properties

CommandTextLength

Gets the length of the command text.

public virtual int CommandTextLength { get; }

Property Value

int

Dependencies

Dependencies for this service.

public virtual RelationalCommandBuilderDependencies Dependencies { get; }

Property Value

RelationalCommandBuilderDependencies

Parameters

The collection of parameters.

public virtual IReadOnlyList<IRelationalParameter> Parameters { get; }

Property Value

IReadOnlyList<IRelationalParameter>

TypeMappingSource

The source for RelationalTypeMappings to use.

public virtual IRelationalTypeMappingSource TypeMappingSource { get; }

Property Value

IRelationalTypeMappingSource

Methods

AddParameter(IRelationalParameter)

Adds the given parameter to this command.

public virtual IRelationalCommandBuilder AddParameter(IRelationalParameter parameter)

Parameters

parameter IRelationalParameter

The parameter.

Returns

IRelationalCommandBuilder

The same builder instance so that multiple calls can be chained.

Append(string)

Appends an object to the command text.

public virtual IRelationalCommandBuilder Append(string value)

Parameters

value string

The object to be written.

Returns

IRelationalCommandBuilder

The same builder instance so that multiple calls can be chained.

AppendLine()

Appends a blank line to the command text.

public virtual IRelationalCommandBuilder AppendLine()

Returns

IRelationalCommandBuilder

The same builder instance so that multiple calls can be chained.

Build()

Creates the command.

public virtual IRelationalCommand Build()

Returns

IRelationalCommand

The newly created command.

DecrementIndent()

Decrements the indent of subsequent lines.

public virtual IRelationalCommandBuilder DecrementIndent()

Returns

IRelationalCommandBuilder

The same builder instance so that multiple calls can be chained.

IncrementIndent()

Increments the indent of subsequent lines.

public virtual IRelationalCommandBuilder IncrementIndent()

Returns

IRelationalCommandBuilder

The same builder instance so that multiple calls can be chained.

ToString()

Gets the command text.

public override string ToString()

Returns

string