Interface IQueryExportParams
An interface for common parameter properties for parameters that run queries, such as ExportCSVParameter
Namespace: LemonEdge.API.Tasks.Parameters
Assembly: API.dll
Syntax
public interface IQueryExportParams
Properties
AsOfDate
An as of date that this query should run as of, when producing the data to export to csv
Declaration
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
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
string Base64SerializedParameters { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Base64SerializedQueryExecuter
A QueryableExecuter either of the type of the entity for
Declaration
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
Guid? CanvasID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
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
bool IncludeRowCount { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |