Class SQLWrapperExecuter
Used for executing a sql wrapper and enumerating the results with the generic ISQLWrapperResult
Each ISQLWrapperResult can be interogated using the SQLWrapperInterpretor
Inheritance
Inherited Members
Namespace: LemonEdge.API.Entities.Helpers
Assembly: API.dll
Syntax
public class SQLWrapperExecuter : BaseSQLWrapperExecuter<SQLWrapperExecuter, ISQLWrapperResult>Constructors
SQLWrapperExecuter(SQLWrapperInterpretor, IEntityRetriever, IReadOnlyCache)
Creates a new SQLWrapperExecuter for the specified sql wrapper
Declaration
public SQLWrapperExecuter(SQLWrapperInterpretor interpretor, IEntityRetriever retriever, IReadOnlyCache cache)Parameters
| Type | Name | Description |
|---|---|---|
| SQLWrapperInterpretor | interpretor | The SQL Wrapper interprator which holds the SQL Wrapper to execute, and also methods to analyse the results |
| IEntityRetriever | retriever | A context to execute the sql wrapper with |
| IReadOnlyCache | cache | A local cache |
SQLWrapperExecuter(ISQLWrapper, IEntityRetriever, IReadOnlyCache)
Creates a new SQLWrapperExecuter for the specified sql wrapper
Declaration
public SQLWrapperExecuter(ISQLWrapper sqlWrapper, IEntityRetriever retriever, IReadOnlyCache cache)Parameters
| Type | Name | Description |
|---|---|---|
| ISQLWrapper | sqlWrapper | The sql wrapper to execute |
| IEntityRetriever | retriever | A context to execute the sql wrapper with |
| IReadOnlyCache | cache | A local cache |
SQLWrapperExecuter(Guid, IEntityRetriever, IReadOnlyCache)
Creates a new SQLWrapperExecuter for the specified sql wrapper
Declaration
public SQLWrapperExecuter(Guid sqlWrapperID, IEntityRetriever retriever, IReadOnlyCache cache)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | sqlWrapperID | The unique global id of the sql wrapper to execute - must match exactly |
| IEntityRetriever | retriever | A context to execute the sql wrapper with |
| IReadOnlyCache | cache | A local cache |
SQLWrapperExecuter(String, IEntityRetriever, IReadOnlyCache)
Creates a new SQLWrapperExecuter for the specified sql wrapper
Declaration
public SQLWrapperExecuter(string sqlWrapperName, IEntityRetriever retriever, IReadOnlyCache cache)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | sqlWrapperName | The name of the sql wrapper to execute - must match exactly |
| IEntityRetriever | retriever | A context to execute the sql wrapper with |
| IReadOnlyCache | cache | A local cache |
Methods
Execute()
Executes the sql wrapper with the specified parameters and filters. Returns the results as an enumeration of ISQLWrapperResult which can be used to retrieve all the values for the record
Declaration
public override Task<IEnumerable<ISQLWrapperResult>> Execute()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<ISQLWrapperResult>> | The results of exeucting the sql wrapper as an enumeration of ISQLWrapperResult which can be used to retrieve all the values for the record |
Overrides
ExecuteCount()
Executes the sql wrapper with the specified parameters and filters. Returns the total count of the results
Declaration
public override Task<int> ExecuteCount()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> | The count of the results of exeucting the sql wrapper |
Overrides
GetResultValue(ISQLWrapperResult, String)
Returns the result held for the specified columnName
Declaration
public object GetResultValue(ISQLWrapperResult resultWrapper, string columnName)Parameters
| Type | Name | Description |
|---|---|---|
| ISQLWrapperResult | resultWrapper | The record holding a row of values from executing the results of this sql wrapper |
| System.String | columnName | The name of the column to return the value of which comes from the value of the Name for the column you want returned |
Returns
| Type | Description |
|---|---|
| System.Object |
GetResultValue<T>(ISQLWrapperResult, String)
Returns the result held for the specified columnName
Declaration
public T GetResultValue<T>(ISQLWrapperResult resultWrapper, string columnName)Parameters
| Type | Name | Description |
|---|---|---|
| ISQLWrapperResult | resultWrapper | The record holding a row of values from executing the results of this sql wrapper |
| System.String | columnName | The name of the column to return the value of which comes from the value of the Name for the column you want returned |
Returns
| Type | Description |
|---|---|
| T |
Type Parameters
| Name | Description |
|---|---|
| T | The type the value returned should be of |
GetWrapperInterpretor()
Returns a sql wrapper interprator gorfor the sql wrapper to be executed
This can be used to retrieve the values of each ISQLWrapperResult in the executed results enumeration
Declaration
public Task<SQLWrapperInterpretor> GetWrapperInterpretor()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SQLWrapperInterpretor> | A sql wrapper interprator gorfor the sql wrapper to be executed |