ISqlExpressionFactory.Function Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
Function(String, Type, RelationalTypeMapping)
Caution
Use NiladicFunction method.
Creates a new SqlFunctionExpression which represents a function call in a SQL tree.
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string name, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use NiladicFunction method.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string name, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use NiladicFunction method.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string name, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping? typeMapping = default);abstract member Function : string * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression[<System.Obsolete("Use NiladicFunction method.")>]
abstract member Function : string * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpressionPublic Function Function (name As String, returnType As Type, Optional typeMapping As RelationalTypeMapping = Nothing) As SqlFunctionExpressionParameters
- name
- String
The name of the function.
- typeMapping
- RelationalTypeMapping
The RelationalTypeMapping associated with the expression.
Returns
An expression representing a function call in a SQL tree.
- Attributes
Applies to
Function(SqlExpression, String, Type, RelationalTypeMapping)
Caution
Use NiladicFunction method.
Creates a new SqlFunctionExpression which represents a function call in a SQL tree.
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression instance, string name, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use NiladicFunction method.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression instance, string name, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use NiladicFunction method.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression instance, string name, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping? typeMapping = default);abstract member Function : Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression * string * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression[<System.Obsolete("Use NiladicFunction method.")>]
abstract member Function : Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression * string * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpressionPublic Function Function (instance As SqlExpression, name As String, returnType As Type, Optional typeMapping As RelationalTypeMapping = Nothing) As SqlFunctionExpressionParameters
- instance
- SqlExpression
An expression on which the function is applied.
- name
- String
The name of the function.
- typeMapping
- RelationalTypeMapping
The RelationalTypeMapping associated with the expression.
Returns
An expression representing a function call in a SQL tree.
- Attributes
Applies to
Function(String, IEnumerable<SqlExpression>, Type, RelationalTypeMapping)
Caution
Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.
Creates a new SqlFunctionExpression which represents a function call in a SQL tree.
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping? typeMapping = default);abstract member Function : string * seq<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression[<System.Obsolete("Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.")>]
abstract member Function : string * seq<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpressionPublic Function Function (name As String, arguments As IEnumerable(Of SqlExpression), returnType As Type, Optional typeMapping As RelationalTypeMapping = Nothing) As SqlFunctionExpressionParameters
- name
- String
The name of the function.
- arguments
- IEnumerable<SqlExpression>
The arguments of the function.
- typeMapping
- RelationalTypeMapping
The RelationalTypeMapping associated with the expression.
Returns
An expression representing a function call in a SQL tree.
- Attributes
Applies to
Function(String, String, Type, RelationalTypeMapping)
Caution
Use NiladicFunction method.
Creates a new SqlFunctionExpression which represents a function call in a SQL tree.
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string schema, string name, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use NiladicFunction method.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string schema, string name, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use NiladicFunction method.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string schema, string name, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping? typeMapping = default);abstract member Function : string * string * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression[<System.Obsolete("Use NiladicFunction method.")>]
abstract member Function : string * string * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpressionPublic Function Function (schema As String, name As String, returnType As Type, Optional typeMapping As RelationalTypeMapping = Nothing) As SqlFunctionExpressionParameters
- schema
- String
The schema in which the function is defined.
- name
- String
The name of the function.
- typeMapping
- RelationalTypeMapping
The RelationalTypeMapping associated with the expression.
Returns
An expression representing a function call in a SQL tree.
- Attributes
Applies to
Function(SqlExpression, String, IEnumerable<SqlExpression>, Type, RelationalTypeMapping)
Caution
Use overload that explicitly specifies value for 'instancePropagatesNullability' and 'argumentsPropagateNullability' arguments.
Creates a new SqlFunctionExpression which represents a function call in a SQL tree.
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression instance, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use overload that explicitly specifies value for 'instancePropagatesNullability' and 'argumentsPropagateNullability' arguments.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression instance, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use overload that explicitly specifies value for 'instancePropagatesNullability' and 'argumentsPropagateNullability' arguments.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression instance, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping? typeMapping = default);abstract member Function : Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression * string * seq<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression[<System.Obsolete("Use overload that explicitly specifies value for 'instancePropagatesNullability' and 'argumentsPropagateNullability' arguments.")>]
abstract member Function : Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression * string * seq<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpressionPublic Function Function (instance As SqlExpression, name As String, arguments As IEnumerable(Of SqlExpression), returnType As Type, Optional typeMapping As RelationalTypeMapping = Nothing) As SqlFunctionExpressionParameters
- instance
- SqlExpression
An expression on which the function is applied.
- name
- String
The name of the function.
- arguments
- IEnumerable<SqlExpression>
The arguments of the function.
- typeMapping
- RelationalTypeMapping
The RelationalTypeMapping associated with the expression.
Returns
An expression representing a function call in a SQL tree.
- Attributes
Applies to
Function(String, String, IEnumerable<SqlExpression>, Type, RelationalTypeMapping)
Caution
Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.
Creates a new SqlFunctionExpression which represents a function call in a SQL tree.
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string schema, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string schema, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);[System.Obsolete("Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.")]
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string? schema, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping? typeMapping = default);abstract member Function : string * string * seq<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression[<System.Obsolete("Use overload that explicitly specifies value for 'argumentsPropagateNullability' argument.")>]
abstract member Function : string * string * seq<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpressionPublic Function Function (schema As String, name As String, arguments As IEnumerable(Of SqlExpression), returnType As Type, Optional typeMapping As RelationalTypeMapping = Nothing) As SqlFunctionExpressionParameters
- schema
- String
The schema in which the function is defined.
- name
- String
The name of the function.
- arguments
- IEnumerable<SqlExpression>
The arguments of the function.
- typeMapping
- RelationalTypeMapping
The RelationalTypeMapping associated with the expression.
Returns
An expression representing a function call in a SQL tree.
- Attributes
Applies to
Function(String, IEnumerable<SqlExpression>, Boolean, IEnumerable<Boolean>, Type, RelationalTypeMapping)
Creates a new SqlFunctionExpression which represents a function call in a SQL tree.
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, bool nullable, System.Collections.Generic.IEnumerable<bool> argumentsPropagateNullability, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, bool nullable, System.Collections.Generic.IEnumerable<bool> argumentsPropagateNullability, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping? typeMapping = default);abstract member Function : string * seq<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> * bool * seq<bool> * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpressionPublic Function Function (name As String, arguments As IEnumerable(Of SqlExpression), nullable As Boolean, argumentsPropagateNullability As IEnumerable(Of Boolean), returnType As Type, Optional typeMapping As RelationalTypeMapping = Nothing) As SqlFunctionExpressionParameters
- name
- String
The name of the function.
- arguments
- IEnumerable<SqlExpression>
The arguments of the function.
- nullable
- Boolean
A bool value indicating whether this function can return null.
- argumentsPropagateNullability
- IEnumerable<Boolean>
A list of bool values indicating whether individual arguments propagate null to result.
- typeMapping
- RelationalTypeMapping
The RelationalTypeMapping associated with the expression.
Returns
An expression representing a function call in a SQL tree.
Applies to
Function(String, String, IEnumerable<SqlExpression>, Boolean, IEnumerable<Boolean>, Type, RelationalTypeMapping)
Creates a new SqlFunctionExpression which represents a function call in a SQL tree.
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string schema, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, bool nullable, System.Collections.Generic.IEnumerable<bool> argumentsPropagateNullability, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (string? schema, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, bool nullable, System.Collections.Generic.IEnumerable<bool> argumentsPropagateNullability, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping? typeMapping = default);abstract member Function : string * string * seq<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> * bool * seq<bool> * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpressionPublic Function Function (schema As String, name As String, arguments As IEnumerable(Of SqlExpression), nullable As Boolean, argumentsPropagateNullability As IEnumerable(Of Boolean), returnType As Type, Optional typeMapping As RelationalTypeMapping = Nothing) As SqlFunctionExpressionParameters
- schema
- String
The schema in which the function is defined.
- name
- String
The name of the function.
- arguments
- IEnumerable<SqlExpression>
The arguments of the function.
- nullable
- Boolean
A bool value indicating whether this function can return null.
- argumentsPropagateNullability
- IEnumerable<Boolean>
A list of bool values indicating whether individual arguments propagate null to result.
- typeMapping
- RelationalTypeMapping
The RelationalTypeMapping associated with the expression.
Returns
An expression representing a function call in a SQL tree.
Applies to
Function(SqlExpression, String, IEnumerable<SqlExpression>, Boolean, Boolean, IEnumerable<Boolean>, Type, RelationalTypeMapping)
Creates a new SqlFunctionExpression which represents a function call in a SQL tree.
public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression instance, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, bool nullable, bool instancePropagatesNullability, System.Collections.Generic.IEnumerable<bool> argumentsPropagateNullability, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping typeMapping = default);public Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpression Function (Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression instance, string name, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> arguments, bool nullable, bool instancePropagatesNullability, System.Collections.Generic.IEnumerable<bool> argumentsPropagateNullability, Type returnType, Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping? typeMapping = default);abstract member Function : Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression * string * seq<Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlExpression> * bool * bool * seq<bool> * Type * Microsoft.EntityFrameworkCore.Storage.RelationalTypeMapping -> Microsoft.EntityFrameworkCore.Query.SqlExpressions.SqlFunctionExpressionPublic Function Function (instance As SqlExpression, name As String, arguments As IEnumerable(Of SqlExpression), nullable As Boolean, instancePropagatesNullability As Boolean, argumentsPropagateNullability As IEnumerable(Of Boolean), returnType As Type, Optional typeMapping As RelationalTypeMapping = Nothing) As SqlFunctionExpressionParameters
- instance
- SqlExpression
An expression on which the function is applied.
- name
- String
The name of the function.
- arguments
- IEnumerable<SqlExpression>
The arguments of the function.
- nullable
- Boolean
A bool value indicating whether this function can return null.
- instancePropagatesNullability
- Boolean
A value indicating if instance propagates null to result.
- argumentsPropagateNullability
- IEnumerable<Boolean>
A list of bool values indicating whether individual arguments propagate null to result.
- typeMapping
- RelationalTypeMapping
The RelationalTypeMapping associated with the expression.
Returns
An expression representing a function call in a SQL tree.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Entity Framework