mirror of
https://github.com/ckaczor/azuredatastudio.git
synced 2026-01-30 17:23:29 -05:00
Consolidate connection namespace (#8844)
This commit is contained in:
56
src/sql/azdata.d.ts
vendored
56
src/sql/azdata.d.ts
vendored
@@ -146,6 +146,33 @@ declare module 'azdata' {
|
||||
*/
|
||||
connectionId: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* List the databases that can be accessed from the given connection
|
||||
* @param connectionId The ID of the connection
|
||||
* @returns An list of names of databases
|
||||
*/
|
||||
export function listDatabases(connectionId: string): Thenable<string[]>;
|
||||
|
||||
/**
|
||||
* Get a URI corresponding to the given connection so that it can be used with data
|
||||
* providers and other APIs that require a connection API.
|
||||
* Note: If the given connection corresponds to multiple URIs this may return any of them
|
||||
* @param connectionId The ID of the connection
|
||||
*/
|
||||
export function getUriForConnection(connectionId: string): Thenable<string>;
|
||||
|
||||
/**
|
||||
* Opens the connection dialog, calls the callback with the result. If connection was successful
|
||||
* returns the connection otherwise returns undefined
|
||||
*/
|
||||
export function openConnectionDialog(providers?: string[], initialConnectionProfile?: IConnectionProfile, connectionCompletionOptions?: IConnectionCompletionOptions): Thenable<connection.Connection>;
|
||||
|
||||
/**
|
||||
* Opens the connection and add it to object explorer and opens the dashboard and returns the ConnectionResult
|
||||
* @param connectionProfile connection profile
|
||||
*/
|
||||
export function connect(connectionProfile: IConnectionProfile, saveConnection?: boolean, showDashboard?: boolean): Thenable<ConnectionResult>;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -4161,35 +4188,6 @@ declare module 'azdata' {
|
||||
errorCode: number;
|
||||
}
|
||||
|
||||
export namespace connection {
|
||||
/**
|
||||
* List the databases that can be accessed from the given connection
|
||||
* @param connectionId The ID of the connection
|
||||
* @returns An list of names of databases
|
||||
*/
|
||||
export function listDatabases(connectionId: string): Thenable<string[]>;
|
||||
|
||||
/**
|
||||
* Get a URI corresponding to the given connection so that it can be used with data
|
||||
* providers and other APIs that require a connection API.
|
||||
* Note: If the given connection corresponds to multiple URIs this may return any of them
|
||||
* @param connectionId The ID of the connection
|
||||
*/
|
||||
export function getUriForConnection(connectionId: string): Thenable<string>;
|
||||
|
||||
/**
|
||||
* Opens the connection dialog, calls the callback with the result. If connection was successful
|
||||
* returns the connection otherwise returns undefined
|
||||
*/
|
||||
export function openConnectionDialog(providers?: string[], initialConnectionProfile?: IConnectionProfile, connectionCompletionOptions?: IConnectionCompletionOptions): Thenable<connection.Connection>;
|
||||
|
||||
/**
|
||||
* Opens the connection and add it to object explorer and opens the dashboard and returns the ConnectionResult
|
||||
* @param connectionProfile connection profile
|
||||
*/
|
||||
export function connect(connectionProfile: IConnectionProfile, saveConnection?: boolean, showDashboard?: boolean): Thenable<ConnectionResult>;
|
||||
}
|
||||
|
||||
export namespace nb {
|
||||
/**
|
||||
* All notebook documents currently known to the system.
|
||||
|
||||
Reference in New Issue
Block a user