Class ExportCSVParameter
The server task parameters for the exporting data to csv server task processs
This task exports data from either a ISQLWrapper data source, or from any entity (EntityDescriptor) in the system
Implements
Inherited Members
Namespace: LemonEdge.API.Tasks.Parameters
Assembly: API.dll
Syntax
[DataContract]
public class ExportCSVParameter : ServerTaskParameter, ICloneable, ICloneable<ExportCSVParameter>, INotifyPropertyChanged, IQueryExportParams
Fields
UNIQUE_TASK_ID
The unique id of the exporting data to csv server task
Declaration
public const string UNIQUE_TASK_ID = "6314045e-6b89-461c-863a-d772ea59c928"
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
An IEnumerable of ColumnDescriptor holding a list of all the columns to return.
If null then all columns will be included in the csv export, otherwise only the ones here will be included which can drastically reduce the query time, file size and improve performance
Declaration
public string Base64SerializedColumnsToReturn { 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 EntityTypeKey, or of a ISQLWrapperResult used to apply further filtering dynamically to the result set that should be exported to csv
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> |
EntityTypeKey
The UniqueKey of any entity in the system to export data from
Declaration
public string EntityTypeKey { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EntityTypeKey_Label
The name of any entity in the system to export data from
Declaration
public string EntityTypeKey_Label { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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 |
SQLWrapperID
The id of a ISQLWrapper that should be used to export data from into a csv file
Declaration
public Guid? SQLWrapperID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
SQLWrapperID_Label
The name of a ISQLWrapper that should be used to export data from into a csv file
Declaration
public string SQLWrapperID_Label { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
Clone()
Declaration
public ExportCSVParameter Clone()
Returns
Type | Description |
---|---|
ExportCSVParameter |
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type | Name | Description |
---|---|---|
SerializedParam | source |
Overrides
CopyFromSource(ExportCSVParameter)
Declaration
public void CopyFromSource(ExportCSVParameter source)
Parameters
Type | Name | Description |
---|---|---|
ExportCSVParameter | 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 |