The ExecuteSQLInformation type is used hold information to execute and return TSQL data that can be passed between the UX and APIs.
Below are the properties and their purpose.
- string CommandName
- Default Value: Empty string.
- Intended Value: The name of the TSQL stored procedure to execute.
- int CommandTimeout
- Default Value: 100.
- Intended Value: The number of seconds to wait for execution to complete before it will timeout.
- Guid SessionGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the users current session.
- Guid UserGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the user calling the TSQL.
- Guid CurrentInstanceGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the instance the user is currently on.
- Guid TargetInstanceGUID
- Default Value: Empty Guid.
- Intended Value: The guid of an instance the TSQL may apply changes to. If a second instance guid is needed to perform an action that isn’t CurrentInstanceGUID then use this property.
- bool ReturnsDataset
- Default Value: false.
- Intended Value: Determines if the TSQL will return the results as XML in the Result property.
- bool ReturnsUserMessage
- Default Value: false.
- Intended Value: Determines if the TSQL will use a parameter called @UserMessage and assign a value to it, this value will be returned in the UserMessage property.
- bool ReturnsResult
- Default Value: false.
- Intended Value: Determines if the TSQL will use a parameter called @Result and assign a value to it, this value will be returned in the Result property.
- string Filter
- Default Value: Empty string.
- Intended Value: The value that will be set to the @Filter parameter in the TSQL.
- string Hierarchy
- Default Value: Empty string.
- Intended Value: The value that will be set to the @Hierarchy parameter in the TSQL.
- string StartDate
- Default Value: Empty string.
- Intended Value: The value that will be set to the @StartDate parameter in the TSQL.
- string EndDate
- Default Value: Empty string.
- Intended Value: The value that will be set to the @EndDate parameter in the TSQL.
- int PageSize
- Default Value: 0.
- Intended Value: The value that will be set to the @PageSize parameter in the TSQL, the PageNumber property must also be set to use this.
- int PageNumber
- Default Value: 0.
- Intended Value: The value that will be set to the @PageNumber parameter in the TSQL, the PageSize property must also be set to use this.
- string InputString
- Default Value: Empty string.
- Intended Value: The value that will be set to the @InputString parameter in the TSQL.
- string Result
- Default Value: Empty string.
- Intended Value: Contains the result of the TSQL only when the ReturnsDataset or ReturnsResult properties are true.
- string UserMessage
- Default Value: Empty string.
- Intended Value: Contains the value of the TSQL parameter @UserMessage only when the ReturnsUserMessage property is true.
- string ErrorMessage
- Default Value: Empty string.
- Intended Value: A message with information regarding what failed in the API or TSQL when attempting to execute TSQL so it can be properly handled in the UX.
- bool NewSQLVersion
- Default Value: true.
- Intended Value: Determines if the new standard TSQL parameter list will be used or if the old parameter list should be used instead.
- New parameter list requires @CurrentInstanceGUID, @TargetInstanceGUID.
- Old parameter list requires @InstanceGUID.
