| DbFunctionCall Class |
Class which implements a function call to a database function and which is used on an EntityField(2) in a query.
Inheritance HierarchySystemObject
SD.LLBLGen.Pro.ORMSupportClassesDbFunctionCall
SD.LLBLGen.Pro.ORMSupportClassesProjectionLiteral
SD.LLBLGen.Pro.ORMSupportClassesDbFunctionCall
SD.LLBLGen.Pro.ORMSupportClassesProjectionLiteral
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.3.0.0 (5.3.0)
SyntaxThe DbFunctionCall type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DbFunctionCall |
Initializes a new instance of the DbFunctionCall class. For deserialization purposes only. Use other overloads in your own code.
|
| DbFunctionCall(String, Object) |
Initializes a new instance of the DbFunctionCall class.
|
| DbFunctionCall(String, String, Object) |
Initializes a new instance of the DbFunctionCall class.
|
| DbFunctionCall(String, String, String, Object) |
Initializes a new instance of the DbFunctionCall class.
|
Properties| Name | Description | |
|---|---|---|
 | CatalogName |
Gets or sets the name of the catalog the function is located in. Can be ignored on databases which don't support catalogs.
|
| DatabaseParameters |
The list of database parameters created when the DbFunctionCall was translated to text usable in a query. Only valid after a succesful call to ToQueryText
|
| DatabaseSpecificCreator |
Object which will be used to create valid parameter objects, field names, including prefix/postfix characters,
and conversion routines, and field names, including prefix/postfix characters.
Uses the strategy pattern so the generic code can work with more than one target database.
|
| FieldPersistenceInfos |
Per field in FunctionParameters, this list contains the fieldPersistenceinfo object. If a parameter in FunctionParameters is not an IEntityFieldCore implementing
object, the value for that parameter is null/Nothing.
|
| FunctionName |
Gets or sets the name of the function to call or pre-formatted function call string. This is without catalog or schema name.
|
| FunctionParameters |
Gets the function parameters to pass to the function. You can pass fields and values to the function as parameters. A field can have a function call and/or
expression applied to make nested function calls possible.
|
| SchemaName |
Gets or sets the name of the schema the function is located in. Can be ignored on databases which don't support schemas.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToQueryText |
Retrieves a ready to use text representation of the contained function call
|
| ToQueryText(Boolean) |
Retrieves a ready to use text representation of the contained function call
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Add |
Creates a new expression: leftoperand + rightoperand
(Defined by ExpressionExtensionMethods.) |
| AddDays |
Defines the mapping for the expression.AddDays(numberOfDays) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddHours |
Defines the mapping for the expression.AddHours(numberOfHours) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddMilliseconds |
Defines the mapping for the expression.AddMilliseconds(numberOfMilliseconds) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddMinutes |
Defines the mapping for the expression.AddMinutes(numberOfMinutes) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddMonths |
Defines the mapping for the expression.AddMonths(numberOfMonths) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddSeconds |
Defines the mapping for the expression.AddSeconds(numberOfSeconds) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| AddYears |
Defines the mapping for the expression.AddYears(numberOfYears) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| And |
Creates a new expression: leftoperand AND rightoperand
(Defined by ExpressionExtensionMethods.) |
| As |
Specifies the specified alias on the expression specified.
(Defined by ExpressionExtensionMethods.) |
| Ascending |
Creates an ascending sort clause for the expression specified
(Defined by SortClauseProducers.) |
| Avg |
Places the Avg aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| AvgDistinct |
Places the Avg(Distinct) aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| Between |
Creates a Between predicate which is true if the result of the expression specified is between valueBegin and valueEnd, valueBegin and valueEnd included.
(Defined by BetweenPredicateProducers.) |
| BitwiseAnd |
Creates a new expression: leftoperand BitwiseAnd rightoperand
(Defined by ExpressionExtensionMethods.) |
| BitwiseOr |
Creates a new expression: leftoperand BitwiseOr rightoperand
(Defined by ExpressionExtensionMethods.) |
| BitwiseXor |
Creates a new expression: leftoperand BitwiseXor rightoperand
(Defined by ExpressionExtensionMethods.) |
| CastToTResult |
Specifies the result type of the expression to be TResult
(Defined by ExpressionExtensionMethods.) |
| Char |
Defines the mapping for the expression.Char[index] property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Contains |
Creates a Like predicate using the pattern: '%pattern%' for the expression specified.
(Defined by StringMethodPredicateProducers.) |
| Count |
Places the Count aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| CountBig |
Places the CountBig aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| CountBigDistinct |
Places the CountBig(Distinct) aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| CountDistinct |
Places the Count(Distinct) aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| Date |
Defines the mapping for the expression.Date property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Day |
Defines the mapping for the expression.Day property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Descending |
Creates a descending sort clause for the expression specified
(Defined by SortClauseProducers.) |
| Div |
Creates a new expression: leftoperand / rightoperand
(Defined by ExpressionExtensionMethods.) |
| EndsWith |
Creates a Like predicate using the pattern: '%pattern' for the expression specified.
(Defined by StringMethodPredicateProducers.) |
| Equal(Object) | Overloaded.
Creates an equality comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by EqualOpPredicateProducers.) |
| Equal(IEntityFieldCore) | Overloaded.
Creates an equality comparison predicate between the expression and the field specified.
(Defined by EqualOpPredicateProducers.) |
| Equal(IExpression) | Overloaded.
Creates an equality comparison predicate between the two expressions specified.
(Defined by EqualOpPredicateProducers.) |
| GreaterEqual(Object) | Overloaded.
Creates a greater or equal comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by GreaterEqualOpPredicateProducers.) |
| GreaterEqual(IEntityFieldCore) | Overloaded.
Creates a greater or equal comparison predicate between the expression and the field specified.
(Defined by GreaterEqualOpPredicateProducers.) |
| GreaterEqual(IExpression) | Overloaded.
Creates a greater or equal comparison predicate between the two expressions specified.
(Defined by GreaterEqualOpPredicateProducers.) |
| GreaterThan(Object) | Overloaded.
Creates a greater than comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by GreaterThanOpPredicateProducers.) |
| GreaterThan(IEntityFieldCore) | Overloaded.
Creates a greater than comparison predicate between the expression and the field specified.
(Defined by GreaterThanOpPredicateProducers.) |
| GreaterThan(IExpression) | Overloaded.
Creates a greater than comparison predicate between the two expressions specified.
(Defined by GreaterThanOpPredicateProducers.) |
| Hour |
Defines the mapping for the expression.Hour property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| In(Object) | Overloaded.
Creates a Field IN (values) predicate
(Defined by InPredicateProducers.) |
| In(DynamicQuery) | Overloaded.
Creates a Field IN (query) predicate
(Defined by InPredicateProducers.) |
| IndexOf |
Defines the mapping for the expression.IndexOf(value) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| IsNotNull |
Generates a negated FieldCompareNull predicate on the expression specified.
(Defined by IsNullPredicateProducers.) |
| IsNull |
Generates a FieldCompareNull predicate on the expression specified.
(Defined by IsNullPredicateProducers.) |
| Length |
Defines the mapping for the expression.Length property to method mapping, if expression represents a string value.
(Defined by FunctionMappingExtensionMethods.) |
| LesserEqual(Object) | Overloaded.
Creates a lesser or equal comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by LesserEqualOpPredicateProducers.) |
| LesserEqual(IEntityFieldCore) | Overloaded.
Creates a lesser or equal comparison predicate between the expression and the field specified.
(Defined by LesserEqualOpPredicateProducers.) |
| LesserEqual(IExpression) | Overloaded.
Creates a lesser or equal comparison predicate between the two expressions specified.
(Defined by LesserEqualOpPredicateProducers.) |
| LesserThan(Object) | Overloaded.
Creates a lesser than comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by LesserThanOpPredicateProducers.) |
| LesserThan(IEntityFieldCore) | Overloaded.
Creates a lesser than comparison predicate between the expression and the field specified.
(Defined by LesserThanOpPredicateProducers.) |
| LesserThan(IExpression) | Overloaded.
Creates a lesser than comparison predicate between the two expressions specified.
(Defined by LesserThanOpPredicateProducers.) |
| Like |
Creates a Like predicate for the expression specified using the pattern specified. The pattern has to contain the wildcards required.
(Defined by StringMethodPredicateProducers.) |
| Max |
Places the Max aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| Millisecond |
Defines the mapping for the expression.Millisecond property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Min |
Places the Min aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| Minute |
Defines the mapping for the expression.Minute property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Mod |
Creates a new expression: leftoperand MOD rightoperand
(Defined by ExpressionExtensionMethods.) |
| Month |
Defines the mapping for the expression.Month property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Mul |
Creates a new expression: leftoperand * rightoperand
(Defined by ExpressionExtensionMethods.) |
| NotBetween |
Creates a Between predicate which is true if the result of the expression specified is not between valueBegin and valueEnd, valueBegin and valueEnd included.
(Defined by BetweenPredicateProducers.) |
| NotEqual(Object) | Overloaded.
Creates a negated equality comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by NotEqualOpPredicateProducers.) |
| NotEqual(IEntityFieldCore) | Overloaded.
Creates a negated equality comparison predicate between the expression and the field specified.
(Defined by NotEqualOpPredicateProducers.) |
| NotEqual(IExpression) | Overloaded.
Creates a negated equality comparison predicate between the two expressions specified.
(Defined by NotEqualOpPredicateProducers.) |
| NotIn(Object) | Overloaded.
Creates a NOT (Field IN (values)) predicate
(Defined by InPredicateProducers.) |
| NotIn(DynamicQuery) | Overloaded.
Creates a NOT (Field IN (query)) predicate
(Defined by InPredicateProducers.) |
| Or |
Creates a new expression: leftoperand Or rightoperand
(Defined by ExpressionExtensionMethods.) |
| Replace |
Defines the mapping for the expression.Replace(oldValue, newValue) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Second |
Defines the mapping for the expression.Second property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
| StartsWith |
Creates a Like predicate using the pattern: 'pattern%' for the expression specified.
(Defined by StringMethodPredicateProducers.) |
| StDev |
Places the StDev aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| StDevDistinct |
Places the StDev(Distinct) aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| Sub |
Creates a new expression: leftoperand - rightoperand
(Defined by ExpressionExtensionMethods.) |
| Substring(Int32) | Overloaded.
Defines the mapping for the expression.Substring(startIndex) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Substring(Int32, Int32) | Overloaded.
Defines the mapping for the expression.Substring(startIndex, length) method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Sum |
Places the Sum aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| SumDistinct |
Places the Sum(Distinct) aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| ToLower |
Defines the mapping for the expression.ToLower() method mapping
(Defined by FunctionMappingExtensionMethods.) |
| ToUnicode |
Defines the mapping for the expression.ToUnicode() method mapping
(Defined by FunctionMappingExtensionMethods.) |
| ToUpper |
Defines the mapping for the expression.ToUpper() method mapping
(Defined by FunctionMappingExtensionMethods.) |
| ToValueTValue |
Placeholder method which is used in a Select(lambda func) projection inside the lambda to specify the type of the result of the passed in expression.
(Defined by ExpressionExtensionMethods.) |
| Trim |
Defines the mapping for the expression.Trim() method mapping
(Defined by FunctionMappingExtensionMethods.) |
| Variance |
Places the Variance aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| VarianceDistinct |
Places the Variance(Distinct) aggregate function on the expression specified and returns a wrapping field with the expression.
(Defined by AggregateRelatedExtensionMethods.) |
| Year |
Defines the mapping for the expression.Year property to method mapping
(Defined by FunctionMappingExtensionMethods.) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | IXmlSerializableGetSchema |
This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.
|
| IXmlSerializableReadXml |
Generates an object from its XML representation.
|
| IXmlSerializableWriteXml |
Converts an object into its XML representation.
|
 | IExpressionDatabaseSpecificCreator |
Object which will be used to create valid parameter objects, field names, including prefix/postfix characters,
and conversion routines, and field names, including prefix/postfix characters.
Uses the strategy pattern so the generic code can work with more than one target database.
|
| IExpressionLeftOperand |
Gets the left expression operand. Set by the constructor used.
|
| IExpressionOperator |
Gets the operator of the expression. Not valid (ExOp.None) if RightOperand is null. Set by the constructor used.
|
| IExpressionParameters |
The list of parameters created when the Expression was translated to text usable in a query. Only valid after a succesful call to ToQueryText
|
| IExpressionReadXml |
Deserializes the data on the xml reader into an expression instance
|
| IExpressionRightOperand |
Gets the right expression operand. Set by the constructor used.
Can be null
|
| IExpressionToQueryText |
Retrieves a ready to use text representation of the contained function call
|
| IExpressionToQueryText(Boolean) |
Retrieves a ready to use text representation of the contained function call
|
| IExpressionWriteXml |
Serializes object as xml to the writer specified.
|
See Also