IQueryExecutionContext Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The context of the current query execution.
public interface IQueryExecutionContexttype IQueryExecutionContext = interfacePublic Interface IQueryExecutionContextProperties
| CancellationToken |
Gets the cancellation token to cancel the query. |
| EntityRuntime |
Gets the current query runtime. |
| Exception |
Gets the error exception if the execution failed in the middle. |
| JoinableTaskFactory |
Gets the JoinableTaskFactory should be used to manage tasks depended for this execution. |
| QueryExecutionErrors |
Gets the list of errors encountered in query execution. |
| RemoteContext |
Gets the context of the execution, if it has a remote origin. It is null, if it is executed inside a stand-alone VS session. |
| SourceDataVersions |
Gets the version set of data sources which produces the query result. Query data provider should retrieve data newer than the version is set here. |
| TraceSource |
Gets the project query trace source. |
| UpdatedDataVersions |
Gets the version set of the data sources after being modified by the query action. |
Methods
| JoinDependentTasks() |
Join the JoinableTaskCollection of this query execution. |
| ReportError(Exception) |
Report an exception happened during the execution, which will fail this query execution. |
| ReportError(QueryExecutionErrorBase) |
Report an error happened during the execution. This will not fail the query execution. |
| ReportInputDataVersion(String, Int64) |
Reports the execution of the query depending on a specific version of a data source. When it conflicts with the existing set, it will put the SourceDataVersions to a mixed version. |
| ReportUpdatedDataVersion(String, Int64) |
Reports the updated data source version after it is being modified. The execution context will retain the newest version number. |
Extension Methods
| ConvertLocalPathToSharedUri(IQueryExecutionContext, String) |
Convert a server side local path to a vsls form shared Uri path. Note: this function only works when the query is coming from a remote LiveShare connection. |
| ConvertSharedPathToLocalPathIfNecessary(IQueryExecutionContext, String) |
Converts a potential vsls:// uri path to the server side local path. |