Class CustomQueryFunction
Custom function.
Inherited Members
Namespace: Terrasoft.Core.DB
Assembly: Terrasoft.Core.dll
Syntax
public class CustomQueryFunction : QueryFunction, IQueryColumnExpressionConvertible, IQueryColumnExpressionsCollector, ICloneable
Constructors
CustomQueryFunction()
Instantiates new intance of CustomQueryFunction.
Declaration
public CustomQueryFunction()
CustomQueryFunction(String, IQueryColumnExpressionConvertible[])
Instantiates new intance of CustomQueryFunction with function name and given column expressions collection.
Declaration
public CustomQueryFunction(string functionName, IQueryColumnExpressionConvertible[] expressions)
Parameters
Type | Name | Description |
---|---|---|
System.String | functionName | Name of the function. |
IQueryColumnExpressionConvertible[] | expressions | Column expressions. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | expressions |
ArgumentEmptyException | If array |
System.ArgumentNullException | If array |
CustomQueryFunction(String, QueryColumnExpression[])
Instantiates new intance of CustomQueryFunction with function name and given column expressions collection.
Declaration
public CustomQueryFunction(string functionName, QueryColumnExpression[] expressions)
Parameters
Type | Name | Description |
---|---|---|
System.String | functionName | Name of the function. |
QueryColumnExpression[] | expressions | Column expressions. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | expressions |
ArgumentEmptyException | If array |
System.ArgumentNullException | If array |
CustomQueryFunction(String, QueryColumnExpressionCollection)
Instantiates new intance of CustomQueryFunction with function name and given column expressions collection.
Declaration
public CustomQueryFunction(string functionName, QueryColumnExpressionCollection expressions)
Parameters
Type | Name | Description |
---|---|---|
System.String | functionName | Name of the function. |
QueryColumnExpressionCollection | expressions | Column expressions. |
CustomQueryFunction(CustomQueryFunction)
Instantiates new intance of CustomQueryFunction with given custom function.
Declaration
public CustomQueryFunction(CustomQueryFunction source)
Parameters
Type | Name | Description |
---|---|---|
CustomQueryFunction | source | Function CustomQueryFunction, clone of which will be created. |
Properties
Expressions
Function column expression.
Declaration
public QueryColumnExpressionCollection Expressions { get; }
Property Value
Type | Description |
---|---|
QueryColumnExpressionCollection |
FunctionName
Declaration
public string FunctionName { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
AddQueryColumnExpressions(QueryColumnExpressionCollection)
Declaration
protected override void AddQueryColumnExpressions(QueryColumnExpressionCollection collection)
Parameters
Type | Name | Description |
---|---|---|
QueryColumnExpressionCollection | collection |
Overrides
AddUsingParameters(QueryParameterCollection)
Adds given parameters to collection.
Declaration
public override void AddUsingParameters(QueryParameterCollection resultParameters)
Parameters
Type | Name | Description |
---|---|---|
QueryParameterCollection | resultParameters | Query parameters collection. |
Overrides
BuildSqlText(StringBuilder, DBEngine)
Forms sql query text with given System.Text.StringBuilder and DBEngine.
Declaration
public override void BuildSqlText(StringBuilder sb, DBEngine dbEngine)
Parameters
Type | Name | Description |
---|---|---|
System.Text.StringBuilder | sb | Instance of System.Text.StringBuilder, which forms sql text. |
DBEngine | dbEngine | Instance of db engine. |
Overrides
Clone()
Clones current instance of CustomQueryFunction.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | New cloned instance of CustomQueryFunction. |