Class ExecuteQueryRunnerParameter
The server task parameters for executing a query runner
This task executes the SQLWrapperID and for each result it executes each IQueryRunnerStep handler
Implements
Inherited Members
Namespace: LemonEdge.API.Tasks.Parameters
Assembly: API.dll
Syntax
[DataContract]
[ServerTaskParameters("Execute Query Runner", "fb74e5a0-eeab-4ae5-bcde-341e75f06534", Description = "Executes the query runner, and for each result executes each query runner step and stores the generated files(s).")]
public class ExecuteQueryRunnerParameter : ServerTaskParameter, ICloneable, ICloneable<ExecuteQueryRunnerParameter>, INotifyPropertyChanged, IQueryExportParams
Fields
UNIQUE_TASK_ID
The unique id of the query runner executer server task
Declaration
public const string UNIQUE_TASK_ID = "fb74e5a0-eeab-4ae5-bcde-341e75f06534"
Field Value
Type | Description |
---|---|
System.String |
Properties
AsOfDate
An as of date that this query should run as of, when producing the data to export to csv
Declaration
public DateTimeOffset? AsOfDate { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTimeOffset> |
Base64SerializedColumnsToReturn
Not used - only for IQueryExportParams compatability
Declaration
public string Base64SerializedColumnsToReturn { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Base64SerializedGlobalParameters
Holds the global parameters for the query runner
Declaration
public string Base64SerializedGlobalParameters { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Base64SerializedParameters
If executing a ISQLWrapper to retrieve data to write to a csv file, then this holds a Dictionary of string, string holding parameter names, and values for executing the specified custom query
Declaration
public string Base64SerializedParameters { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Base64SerializedQueryExecuter
A QueryableExecuter either of the type of the entity for
Declaration
public string Base64SerializedQueryExecuter { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CanvasID
The id of a canvas that this query should run within when producing the data to export to csv
Declaration
public Guid? CanvasID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
HasExcelHandler
Indicates the client handling this csv file will open it straight into excel and thus this csv file should have two header rows, one for the named data range, and the other a user friendly header
If this is false the csv will just have one header row which is the same as the excel named data range for importing the data back in, and so will lack the user friendly header
Declaration
public bool HasExcelHandler { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IncludeRowCount
Indicates the system should run the query once to get the total count, and another time to process the import providing a percentage progression
For improved performance the query will run without a row count but then the task can not provide feedback on the progress of the task
Declaration
public bool IncludeRowCount { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
QueryRunnerID
The id of a IQueryRunner that should be used to execute
Declaration
public Guid QueryRunnerID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
QueryRunnerID_Label
The name of a IQueryRunner that should be used to execute
Declaration
public string QueryRunnerID_Label { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RunAsTest
Indicates the query runner should be run as a test only reporting the step names generated and not executing the handlers
Declaration
public bool RunAsTest { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
Clone()
Declaration
public ExecuteQueryRunnerParameter Clone()
Returns
Type | Description |
---|---|
ExecuteQueryRunnerParameter |
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type | Name | Description |
---|---|---|
SerializedParam | source |
Overrides
CopyFromSource(ExecuteQueryRunnerParameter)
Declaration
public void CopyFromSource(ExecuteQueryRunnerParameter source)
Parameters
Type | Name | Description |
---|---|---|
ExecuteQueryRunnerParameter | source |
CreateNewParam()
Declaration
protected override SerializedParam CreateNewParam()
Returns
Type | Description |
---|---|
SerializedParam |
Overrides
GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)
Returns that this is a export data to csv task against the specified ISQLWrapper or entity
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type | Name | Description |
---|---|---|
IServerTask | task | The server task for processing the export data to csv task |
Returns
Type | Description |
---|---|
System.String | A string stating that this is a export data to csv task against the specified ISQLWrapper or entity |
Overrides
Events
PropertyChanged
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type | Description |
---|---|
System.ComponentModel.PropertyChangedEventHandler |