Interface QueryProvider

Hierarchy

DataProvider
- QueryProvider

Properties

Optional handle

handle: number

Readonly providerId

providerId: string

Methods

cancelQuery

cancelQuery(ownerUri: string): Thenable<QueryCancelResult>

- Defined in azdata/index.d.ts:867
Parameters
- ownerUri: string
Returns Thenable<QueryCancelResult>

commitEdit

commitEdit(ownerUri: string): Thenable<void>

- Defined in azdata/index.d.ts:887
Parameters
- ownerUri: string
Returns Thenable<void>

createRow

createRow(ownerUri: string): Thenable<EditCreateRowResult>

- Defined in azdata/index.d.ts:888
Parameters
- ownerUri: string
Returns Thenable<EditCreateRowResult>

deleteRow

deleteRow(ownerUri: string, rowId: number): Thenable<void>

- Defined in azdata/index.d.ts:889
Parameters
- ownerUri: string
- rowId: number
Returns Thenable<void>

disposeEdit

disposeEdit(ownerUri: string): Thenable<void>

- Defined in azdata/index.d.ts:890
Parameters
- ownerUri: string
Returns Thenable<void>

disposeQuery

disposeQuery(ownerUri: string): Thenable<void>

- Defined in azdata/index.d.ts:874
Parameters
- ownerUri: string
Returns Thenable<void>

getEditRows

getEditRows(rowData: EditSubsetParams): Thenable<EditSubsetResult>

- Defined in azdata/index.d.ts:895
Parameters
- rowData: EditSubsetParams
Returns Thenable<EditSubsetResult>

getQueryRows

getQueryRows(rowData: QueryExecuteSubsetParams): Thenable<QueryExecuteSubsetResult>

- Defined in azdata/index.d.ts:873
Parameters
- rowData: QueryExecuteSubsetParams
Returns Thenable<QueryExecuteSubsetResult>

initializeEdit

initializeEdit(ownerUri: string, schemaName: string, objectName: string, objectType: string, rowLimit: number, queryString: string): Thenable<void>

- Defined in azdata/index.d.ts:891
Parameters
- ownerUri: string
- schemaName: string
- objectName: string
- objectType: string
- rowLimit: number
- queryString: string
Returns Thenable<void>

parseSyntax

parseSyntax(ownerUri: string, query: string): Thenable<SyntaxParseResult>

- Defined in azdata/index.d.ts:872
Parameters
- ownerUri: string
- query: string
Returns Thenable<SyntaxParseResult>

registerOnBatchComplete

registerOnBatchComplete(handler: (batchInfo: QueryExecuteBatchNotificationParams) => any): void

- Defined in azdata/index.d.ts:881
Parameters
- handler: (batchInfo: QueryExecuteBatchNotificationParams) => any
  - - (batchInfo: QueryExecuteBatchNotificationParams): any
    - Parameters
      - batchInfo: QueryExecuteBatchNotificationParams
      Returns any
Returns void

registerOnBatchStart

registerOnBatchStart(handler: (batchInfo: QueryExecuteBatchNotificationParams) => any): void

- Defined in azdata/index.d.ts:880
Parameters
- handler: (batchInfo: QueryExecuteBatchNotificationParams) => any
  - - (batchInfo: QueryExecuteBatchNotificationParams): any
    - Parameters
      - batchInfo: QueryExecuteBatchNotificationParams
      Returns any
Returns void

registerOnEditSessionReady

registerOnEditSessionReady(handler: (ownerUri: string, success: boolean, message: string) => any): void

- Defined in azdata/index.d.ts:898
Parameters
- handler: (ownerUri: string, success: boolean, message: string) => any
  - - (ownerUri: string, success: boolean, message: string): any
    - Parameters
      - ownerUri: string
      - success: boolean
      - message: string
      Returns any
Returns void

registerOnMessage

registerOnMessage(handler: (message: QueryExecuteMessageParams) => any): void

- Defined in azdata/index.d.ts:884
Parameters
- handler: (message: QueryExecuteMessageParams) => any
  - - (message: QueryExecuteMessageParams): any
    - Parameters
      - message: QueryExecuteMessageParams
      Returns any
Returns void

registerOnQueryComplete

registerOnQueryComplete(handler: (result: QueryExecuteCompleteNotificationResult) => any): void

- Defined in azdata/index.d.ts:879
Parameters
- handler: (result: QueryExecuteCompleteNotificationResult) => any
  - - (result: QueryExecuteCompleteNotificationResult): any
    - Parameters
      - result: QueryExecuteCompleteNotificationResult
      Returns any
Returns void

registerOnResultSetAvailable

registerOnResultSetAvailable(handler: (resultSetInfo: QueryExecuteResultSetNotificationParams) => any): void

- Defined in azdata/index.d.ts:882
Parameters
- handler: (resultSetInfo: QueryExecuteResultSetNotificationParams) => any
  - - (resultSetInfo: QueryExecuteResultSetNotificationParams): any
    - Parameters
      - resultSetInfo: QueryExecuteResultSetNotificationParams
      Returns any
Returns void

registerOnResultSetUpdated

registerOnResultSetUpdated(handler: (resultSetInfo: QueryExecuteResultSetNotificationParams) => any): void

- Defined in azdata/index.d.ts:883
Parameters
- handler: (resultSetInfo: QueryExecuteResultSetNotificationParams) => any
  - - (resultSetInfo: QueryExecuteResultSetNotificationParams): any
    - Parameters
      - resultSetInfo: QueryExecuteResultSetNotificationParams
      Returns any
Returns void

revertCell

revertCell(ownerUri: string, rowId: number, columnId: number): Thenable<EditRevertCellResult>

- Defined in azdata/index.d.ts:892
Parameters
- ownerUri: string
- rowId: number
- columnId: number
Returns Thenable<EditRevertCellResult>

revertRow

revertRow(ownerUri: string, rowId: number): Thenable<void>

- Defined in azdata/index.d.ts:893
Parameters
- ownerUri: string
- rowId: number
Returns Thenable<void>

runQuery

runQuery(ownerUri: string, selection: ISelectionData, runOptions?: ExecutionPlanOptions): Thenable<void>

- Defined in azdata/index.d.ts:868
Parameters
- ownerUri: string
- selection: ISelectionData
- Optional runOptions: ExecutionPlanOptions
Returns Thenable<void>

runQueryAndReturn

runQueryAndReturn(ownerUri: string, queryString: string): Thenable<SimpleExecuteResult>

- Defined in azdata/index.d.ts:871
Parameters
- ownerUri: string
- queryString: string
Returns Thenable<SimpleExecuteResult>

runQueryStatement

runQueryStatement(ownerUri: string, line: number, column: number): Thenable<void>

- Defined in azdata/index.d.ts:869
Parameters
- ownerUri: string
- line: number
- column: number
Returns Thenable<void>

runQueryString

runQueryString(ownerUri: string, queryString: string): Thenable<void>

- Defined in azdata/index.d.ts:870
Parameters
- ownerUri: string
- queryString: string
Returns Thenable<void>

saveResults

saveResults(requestParams: SaveResultsRequestParams): Thenable<SaveResultRequestResult>

- Defined in azdata/index.d.ts:875
Parameters
- requestParams: SaveResultsRequestParams
Returns Thenable<SaveResultRequestResult>

setQueryExecutionOptions

setQueryExecutionOptions(ownerUri: string, options: QueryExecutionOptions): Thenable<void>

- Defined in azdata/index.d.ts:876
Parameters
- ownerUri: string
- options: QueryExecutionOptions
Returns Thenable<void>

updateCell

updateCell(ownerUri: string, rowId: number, columnId: number, newValue: string): Thenable<EditUpdateCellResult>

- Defined in azdata/index.d.ts:894
Parameters
- ownerUri: string
- rowId: number
- columnId: number
- newValue: string
Returns Thenable<EditUpdateCellResult>

Generated using TypeDoc