Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace objectexplorer

Namespace for interacting with Object Explorer

Index

Interfaces

Functions

Functions

findNodes

  • findNodes(connectionId: string, type: string, schema: string, name: string, database: string, parentObjectNames: string[]): Thenable<ObjectExplorerNode[]>

  • Find Object Explorer nodes that match the given information

    Parameters

    • connectionId: string

      The id of the connection that the node exists on

    • type: string

      The type of the object to retrieve

    • schema: string

      The schema of the object, if applicable

    • name: string

      The name of the object

    • database: string

      The database the object exists under, if applicable

    • parentObjectNames: string[]

      A list of names of parent objects in the tree, ordered from highest to lowest level (for example when searching for a table's column, provide the name of its parent table for this argument)

    Returns Thenable<ObjectExplorerNode[]>

getActiveConnectionNodes

  • Get all active Object Explorer connection nodes

    Returns Thenable<ObjectExplorerNode[]>

    The Object Explorer nodes for each saved connection

getNode

  • Get an Object Explorer node corresponding to the given connection and path. If no path is given, it returns the top-level node for the given connection. If there is no node at the given path, it returns undefined.

    Parameters

    • connectionId: string

      The id of the connection that the node exists on

    • Optional nodePath: string

      The path of the node to get

    Returns Thenable<ObjectExplorerNode>

    The node corresponding to the given connection and path, or undefined if no such node exists.

getSessionConnectionProfile

  • Get connectionProfile from sessionId

    Parameters

    • sessionId: string

      The id of the session that the node exists on

    Returns Thenable<IConnectionProfile>

    The IConnectionProfile for the session

Generated using TypeDoc