mirror of
https://github.com/ckaczor/azuredatastudio.git
synced 2026-01-23 17:23:02 -05:00
Add queryInfo to query events (#19777)
* Add queryInfo to query events * docs
This commit is contained in:
18
src/sql/azdata.d.ts
vendored
18
src/sql/azdata.d.ts
vendored
@@ -4992,14 +4992,18 @@ declare module 'azdata' {
|
||||
| 'executionPlan'
|
||||
| 'visualize';
|
||||
|
||||
/**
|
||||
* args for each event type
|
||||
* queryStart: undefined
|
||||
* queryStop: undefined
|
||||
* executionPlan: string
|
||||
* visualize: ResultSetSummary
|
||||
*/
|
||||
export interface QueryEventListener {
|
||||
/**
|
||||
* A callback that is called whenever a query event occurs
|
||||
* @param type The type of query event
|
||||
* @param document The document this event was sent by
|
||||
* @param args The extra information for the event, if any
|
||||
* The args sent depend on the type of event :
|
||||
* queryStart: undefined
|
||||
* queryStop: undefined
|
||||
* executionPlan: string (the plan itself)
|
||||
* visualize: ResultSetSummary (the result set to be visualized)
|
||||
*/
|
||||
onQueryEvent(type: QueryEventType, document: QueryDocument, args: ResultSetSummary | string | undefined): void;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user