RelationalCommandBuilderExtensions RelationalCommandBuilderExtensions Class

Definition

Extension methods for the IRelationalCommandBuilder class.

public static class RelationalCommandBuilderExtensions
Public Module RelationalCommandBuilderExtensions
Inheritance
System.ObjectSystem.Object
RelationalCommandBuilderExtensionsRelationalCommandBuilderExtensions

Methods

AddCompositeParameter(IRelationalCommandBuilder, String, Action) AddCompositeParameter(IRelationalCommandBuilder, String, Action(Of IRelationalParameterBuilder))

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

public static IRelationalCommandBuilder AddCompositeParameter(this IRelationalCommandBuilder commandBuilder, string invariantName, Action<IRelationalParameterBuilder> buildAction)
<ExtensionAttribute>
Public Shared Function AddCompositeParameter(commandBuilder As IRelationalCommandBuilder, invariantName As String, buildAction As Action(Of IRelationalParameterBuilder)) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

invariantName
System.String System.String

The key that identifies this parameter. Note that IRelationalParameter just represents a placeholder for a parameter and not the actual value. This is because the same command can be reused multiple times with different parameter values.

buildAction
System.Action<IRelationalParameterBuilder> System.Action(Of IRelationalParameterBuilder)

The action to add the multiple parameters that this placeholder represents.

Returns

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

AddParameter(IRelationalCommandBuilder, String, String) AddParameter(IRelationalCommandBuilder, String, String)

Adds a parameter.

public static IRelationalCommandBuilder AddParameter(this IRelationalCommandBuilder commandBuilder, string invariantName, string name)
<ExtensionAttribute>
Public Shared Function AddParameter(commandBuilder As IRelationalCommandBuilder, invariantName As String, name As String) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

invariantName
System.String System.String

The key that identifies this parameter. Note that IRelationalParameter just represents a placeholder for a parameter and not the actual value. This is because the same command can be reused multiple times with different parameter values.

name
System.String System.String

The name to be used for the parameter when the command is executed against the database.

Returns

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

AddParameter(IRelationalCommandBuilder, String, String, IProperty) AddParameter(IRelationalCommandBuilder, String, String, IProperty)

Adds a parameter.

public static IRelationalCommandBuilder AddParameter(this IRelationalCommandBuilder commandBuilder, string invariantName, string name, IProperty property)
<ExtensionAttribute>
Public Shared Function AddParameter(commandBuilder As IRelationalCommandBuilder, invariantName As String, name As String, property As IProperty) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

invariantName
System.String System.String

The key that identifies this parameter. Note that IRelationalParameter just represents a placeholder for a parameter and not the actual value. This is because the same command can be reused multiple times with different parameter values.

name
System.String System.String

The name to be used for the parameter when the command is executed against the database.

property
IProperty IProperty
Returns

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

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

Adds a parameter.

public static IRelationalCommandBuilder AddParameter(this IRelationalCommandBuilder commandBuilder, string invariantName, string name, RelationalTypeMapping typeMapping, bool nullable)
<ExtensionAttribute>
Public Shared Function AddParameter(commandBuilder As IRelationalCommandBuilder, invariantName As String, name As String, typeMapping As RelationalTypeMapping, nullable As Boolean) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

invariantName
System.String System.String

The key that identifies this parameter. Note that IRelationalParameter just represents a placeholder for a parameter and not the actual value. This is because the same command can be reused multiple times with different parameter values.

name
System.String System.String

The name to be used for the parameter when the command is executed against the database.

typeMapping
RelationalTypeMapping RelationalTypeMapping

The type mapping for the property that values for this parameter will come from.

nullable
System.Boolean System.Boolean

A value indicating whether the parameter can contain null values.

Returns

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

AddPropertyParameter(IRelationalCommandBuilder, String, String, IProperty) AddPropertyParameter(IRelationalCommandBuilder, String, String, IProperty)

Adds a parameter.

public static IRelationalCommandBuilder AddPropertyParameter(this IRelationalCommandBuilder commandBuilder, string invariantName, string name, IProperty property)
<ExtensionAttribute>
Public Shared Function AddPropertyParameter(commandBuilder As IRelationalCommandBuilder, invariantName As String, name As String, property As IProperty) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

invariantName
System.String System.String

The key that identifies this parameter. Note that IRelationalParameter just represents a placeholder for a parameter and not the actual value. This is because the same command can be reused multiple times with different parameter values.

name
System.String System.String

The name to be used for the parameter when the command is executed against the database.

property
IProperty IProperty

The property that values for this parameter will come from.

Returns

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

Append(IRelationalCommandBuilder, Object) Append(IRelationalCommandBuilder, Object)

Appends an object to the command text.

public static IRelationalCommandBuilder Append(this IRelationalCommandBuilder commandBuilder, object o)
<ExtensionAttribute>
Public Shared Function Append(commandBuilder As IRelationalCommandBuilder, o As Object) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

o
System.Object System.Object

The object to be written.

Returns

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

AppendLine(IRelationalCommandBuilder) AppendLine(IRelationalCommandBuilder)

Appends a blank line to the command text.

public static IRelationalCommandBuilder AppendLine(this IRelationalCommandBuilder commandBuilder)
<ExtensionAttribute>
Public Shared Function AppendLine(commandBuilder As IRelationalCommandBuilder) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

Returns

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

AppendLine(IRelationalCommandBuilder, Object) AppendLine(IRelationalCommandBuilder, Object)

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

public static IRelationalCommandBuilder AppendLine(this IRelationalCommandBuilder commandBuilder, object o)
<ExtensionAttribute>
Public Shared Function AppendLine(commandBuilder As IRelationalCommandBuilder, o As Object) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

o
System.Object System.Object

The object to be written.

Returns

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

AppendLines(IRelationalCommandBuilder, Object) 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.

public static IRelationalCommandBuilder AppendLines(this IRelationalCommandBuilder commandBuilder, object o)
<ExtensionAttribute>
Public Shared Function AppendLines(commandBuilder As IRelationalCommandBuilder, o As Object) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

o
System.Object System.Object

The object to be written.

Returns

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

DecrementIndent(IRelationalCommandBuilder) DecrementIndent(IRelationalCommandBuilder)

Decrements the indent of subsequent lines.

public static IRelationalCommandBuilder DecrementIndent(this IRelationalCommandBuilder commandBuilder)
<ExtensionAttribute>
Public Shared Function DecrementIndent(commandBuilder As IRelationalCommandBuilder) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

Returns

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

Equals(Object) Equals(Object)

Inherited from System.Object

Equals(Object, Object) Equals(Object, Object)

Inherited from System.Object

GetHashCode() GetHashCode()

Inherited from System.Object

GetLength(IRelationalCommandBuilder) GetLength(IRelationalCommandBuilder)

Gets the length of the command text.

public static int GetLength(this IRelationalCommandBuilder commandBuilder)
<ExtensionAttribute>
Public Shared Function GetLength(commandBuilder As IRelationalCommandBuilder) As Integer
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

Returns
System.Int32 System.Int32

The length of the command text.

GetType() GetType()

Inherited from System.Object

IncrementIndent(IRelationalCommandBuilder) IncrementIndent(IRelationalCommandBuilder)

Increments the indent of subsequent lines.

public static IRelationalCommandBuilder IncrementIndent(this IRelationalCommandBuilder commandBuilder)
<ExtensionAttribute>
Public Shared Function IncrementIndent(commandBuilder As IRelationalCommandBuilder) As IRelationalCommandBuilder
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

Returns

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

Indent(IRelationalCommandBuilder) Indent(IRelationalCommandBuilder)

Increases the indent of the command text.

public static IDisposable Indent(this IRelationalCommandBuilder commandBuilder)
<ExtensionAttribute>
Public Shared Function Indent(commandBuilder As IRelationalCommandBuilder) As IDisposable
Parameters
commandBuilder
IRelationalCommandBuilder IRelationalCommandBuilder

The command builder.

Returns
System.IDisposable System.IDisposable

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

MemberwiseClone() MemberwiseClone()

Inherited from System.Object

ReferenceEquals(Object, Object) ReferenceEquals(Object, Object)

Inherited from System.Object

ToString() ToString()

Inherited from System.Object