IRelationalParameterBuilder IRelationalParameterBuilder Interface

Definition

Builds a collection of IRelationalParameter.

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

public interface IRelationalParameterBuilder
Public Interface IRelationalParameterBuilder

Properties

Parameters Parameters

The collection of parameters.

IReadOnlyList<IRelationalParameter> Parameters { get; }
ReadOnly Property Parameters As IReadOnlyList(Of IRelationalParameter)
Value
System.Collections.Generic.IReadOnlyList<IRelationalParameter> System.Collections.Generic.IReadOnlyList(Of IRelationalParameter)

Methods

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

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

void AddCompositeParameter(string invariantName, Action<IRelationalParameterBuilder> buildAction)
Sub AddCompositeParameter(invariantName As String, buildAction As Action(Of IRelationalParameterBuilder))
Parameters
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.

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

Adds a parameter.

void AddParameter(string invariantName, string name)
Sub AddParameter(invariantName As String, name As String)
Parameters
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.

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

Adds a parameter.

void AddParameter(string invariantName, string name, IProperty property)
Sub AddParameter(invariantName As String, name As String, property As IProperty)
Parameters
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

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

Adds a parameter.

void AddParameter(string invariantName, string name, RelationalTypeMapping typeMapping, bool nullable)
Sub AddParameter(invariantName As String, name As String, typeMapping As RelationalTypeMapping, nullable As Boolean)
Parameters
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.

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

Adds a parameter.

void AddPropertyParameter(string invariantName, string name, IProperty property)
Sub AddPropertyParameter(invariantName As String, name As String, property As IProperty)
Parameters
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.