Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace queryeditor

Namespace for interacting with query editor

Index

Interfaces

Type aliases

Functions

Type aliases

QueryEventType

QueryEventType: "queryStart" | "queryUpdate" | "queryStop" | "executionPlan" | "visualize"

Functions

connect

  • connect(fileUri: string, connectionId: string): Thenable<void>

  • Make connection for the query editor

    Parameters

    • fileUri: string

      file URI for the query editor

    • connectionId: string

      connection ID

    Returns Thenable<void>

getQueryDocument

  • Get a QueryDocument object for a file URI

    Parameters

    • fileUri: string

    Returns Thenable<QueryDocument>

registerQueryEventListener

  • Register a query event listener

    Parameters

    Returns vscode.Disposable

runQuery

  • runQuery(fileUri: string, options?: Map<string, string>, runCurrentQuery?: boolean): void

  • Run query if it is a query editor and it is already opened.

    Parameters

    • fileUri: string

      file URI for the query editor

    • Optional options: Map<string, string>

      options

    • Optional runCurrentQuery: boolean

      true: run current query only, false: run all the queries in the file, default is true.

    Returns void

Generated using TypeDoc