Files
azuredatastudio/extensions/mssql/src/mssql.proposed.d.ts
Charles Gagnon 336f3af6a4 Add mssql.proposed.d.ts (#23394)
* Add mssql.proposed.d.ts

* Add proposed ref
2023-06-15 16:29:20 -07:00

34 lines
1.7 KiB
TypeScript

/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
declare module 'mssql' {
import * as azdata from 'azdata';
/**
* Covers defining what the mssql extension exports to other extensions.
*
* This file should only contain definitions which rely on PROPOSED azdata typings
* (from azdata.proposed.d.ts). Anything which relies on STABLE typings (from azdata.d.ts)
* should go in mssql.d.ts.
*
* This is to make it easier for extensions that don't need these features to only import the ones
* that depend on stable features so they don't have to copy over the proposed typings themselves.
*
* IMPORTANT: THIS IS NOT A HARD DEFINITION unlike vscode; therefore no enums or classes should be defined here
* (const enums get evaluated when typescript -> javascript so those are fine)
*/
export interface IExtension {
readonly sqlAssessment: ISqlAssessmentService;
}
export interface ISqlAssessmentService {
assessmentInvoke(ownerUri: string, targetType: azdata.sqlAssessment.SqlAssessmentTargetType): Promise<azdata.SqlAssessmentResult>;
getAssessmentItems(ownerUri: string, targetType: azdata.sqlAssessment.SqlAssessmentTargetType): Promise<azdata.SqlAssessmentResult>;
generateAssessmentScript(items: azdata.SqlAssessmentResultItem[], targetServerName: string, targetDatabaseName: string, taskExecutionMode: azdata.TaskExecutionMode): Promise<azdata.ResultStatus>;
}
}