ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-03-28 07:40:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fleshing out the SqlProjects service bindings (#21984)

Browse Source 
* starts of sqlprojectsservice

* copy to mssql

* adding all the boilerplate

* updating service call structures

* Fixing up test mocks

* Adding comments to all the bindings

* blank space

* swapping for Promise; adding vscode-mssql type bindings

* patching
This commit is contained in:
Benjin Dubishar
2023-02-22 22:58:30 -08:00
committed by GitHub
parent 872095ed84
commit 0354775107
7 changed files with 1070 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

258
extensions/mssql/src/contracts.ts
View File

@@ -602,29 +602,275 @@ export namespace SavePublishProfileRequest {
// ------------------------------- </ DacFx > ------------------------------------
// ------------------------------- < Sql Projects > ------------------------------------
//#region SqlProjects
export namespace NewSqlProjectRequest {
export const type = new RequestType<NewSqlProjectParams, azdata.ResultStatus, void, void>('sqlProjects/newProject');
//#region Functions
//#region Project-level functions
export namespace CreateSqlProjectRequest {
export const type = new RequestType<CreateSqlProjectParams, azdata.ResultStatus, void, void>('sqlProjects/newProject'); // TODO: switch to "createProject" with next Tools Service update
}
export namespace OpenSqlProjectRequest {
export const type = new RequestType<SqlProjectParams, azdata.ResultStatus, void, void>('sqlProjects/openProject');
}
export namespace CloseSqlProjectRequest {
export const type = new RequestType<SqlProjectParams, azdata.ResultStatus, void, void>('sqlProjects/closeProject');
}
export namespace GetCrossPlatformCompatiblityRequest {
export const type = new RequestType<SqlProjectParams, mssql.GetCrossPlatformCompatiblityResult, void, void>('sqlProjects/getCrossPlatformCompatibility');
}
export namespace UpdateProjectForCrossPlatformRequest {
export const type = new RequestType<SqlProjectParams, azdata.ResultStatus, void, void>('sqlProjects/updateProjectForCrossPlatform');
}
//#endregion
//#region File/folder functions
//#region SQL object script functions
export namespace AddSqlObjectScriptRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlProjects/addSqlObjectScript');
}
export namespace DeleteSqlObjectScriptRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlProjects/deleteSqlObjectScript');
}
export namespace ExcludeSqlObjectScriptRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlProjects/excludeSqlObjectScript');
}
export namespace MoveSqlObjectScriptRequest {
export const type = new RequestType<MoveItemParams, azdata.ResultStatus, void, void>('sqlProjects/moveSqlObjectScript');
}
//#endregion
//#region Folder functions
export namespace AddFolderRequest {
export const type = new RequestType<FolderParams, azdata.ResultStatus, void, void>('sqlProjects/addFolder');
}
export namespace DeleteFolderRequest {
export const type = new RequestType<FolderParams, azdata.ResultStatus, void, void>('sqlProjects/deleteFolder');
}
//#endregion
//#region Pre/Post-deployment script functions
export namespace AddPostDeploymentScriptRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlProjects/addPostDeploymentScript');
}
export namespace AddPreDeploymentScriptRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlProjects/addPreDeploymentScript');
}
export namespace DeletePostDeploymentScriptRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlProjects/deletePostDeploymentScript');
}
export namespace DeletePreDeploymentScriptRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlProjects/deletePreDeploymentScript');
}
export namespace ExcludePostDeploymentScriptRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlProjects/excludePostDeploymentScript');
}
export namespace ExcludePreDeploymentScriptRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlProjects/excludePreDeploymentScript');
}
export namespace MovePostDeploymentScriptRequest {
export const type = new RequestType<MoveItemParams, azdata.ResultStatus, void, void>('sqlProjects/movePostDeploymentScript');
}
export namespace MovePreDeploymentScriptRequest {
export const type = new RequestType<MoveItemParams, azdata.ResultStatus, void, void>('sqlProjects/movePreDeploymentScript');
}
//#endregion
//#endregion
//#region SQLCMD variable functions
export namespace AddSqlCmdVariableRequest {
export const type = new RequestType<AddSqlCmdVariableParams, azdata.ResultStatus, void, void>('sqlProjects/addSqlCmdVariable');
}
export namespace DeleteSqlCmdVariableRequest {
export const type = new RequestType<DeleteSqlCmdVariableParams, azdata.ResultStatus, void, void>('sqlProjects/deleteSqlCmdVariable');
}
export namespace UpdateSqlCmdVariableRequest {
export const type = new RequestType<AddSqlCmdVariableParams, azdata.ResultStatus, void, void>('sqlProjects/updateSqlCmdVariable');
}
//#endregion
//#region Database reference functions
export namespace AddDacpacReferenceRequest {
/**
*
*/
export const type = new RequestType<AddDacpacReferenceParams, azdata.ResultStatus, void, void>('sqlprojects/addDacpacReference');
}
export namespace AddSqlProjectReferenceRequest {
export const type = new RequestType<AddSqlProjectReferenceParams, azdata.ResultStatus, void, void>('sqlprojects/addSqlProjectReference');
}
export namespace AddSystemDatabaseReferenceRequest {
export const type = new RequestType<AddSystemDatabaseReferenceParams, azdata.ResultStatus, void, void>('sqlprojects/addSystemDatabaseReference');
}
export namespace DeleteDatabaseReferenceRequest {
export const type = new RequestType<SqlProjectScriptParams, azdata.ResultStatus, void, void>('sqlprojects/deleteDatabaseReference');
}
//#endregion
//#endregion
//#region Parameters
export interface SqlProjectParams {
/**
* Absolute path of the project, including .sqlproj
*/
projectUri: string;
}
export interface NewSqlProjectParams extends SqlProjectParams {
sqlProjectType: mssql.ProjectType,
databaseSchemaProvider: string,
buildSdkVersion?: string
export interface SqlProjectScriptParams extends SqlProjectParams {
/**
* Path of the script, including .sql, relative to the .sqlproj
*/
path: string;
}
export interface AddDacpacReferenceParams extends AddUserDatabaseReferenceParams {
/**
* Path to the .dacpac file
*/
dacpacPath: string;
}
export interface AddDatabaseReferenceParams extends SqlProjectParams {
/**
* Whether to suppress missing dependencies
*/
suppressMissingDependencies: boolean;
/**
* Literal name used to reference another database in the same server, if not using SQLCMD variables
*/
databaseLiteral?: string;
}
export interface AddSqlProjectReferenceParams extends AddUserDatabaseReferenceParams {
/**
* Path to the referenced .sqlproj file
*/
projectPath: string;
/**
* GUID for the referenced SQL project
*/
projectGuid: string;
}
export interface AddSystemDatabaseReferenceParams extends AddDatabaseReferenceParams {
/**
* Type of system database
*/
systemDatabase: mssql.SystemDatabase;
}
export interface AddUserDatabaseReferenceParams extends AddDatabaseReferenceParams {
/**
* SQLCMD variable name for specifying the other database this reference is to, if different from that of the current project
*/
databaseVariable?: string;
/**
* SQLCMD variable name for specifying the other server this reference is to, if different from that of the current project.
* If this is set, DatabaseVariable must also be set.
*/
serverVariable?: string;
}
export interface DeleteDatabaseReferenceParams extends SqlProjectParams {
/**
* Name of the reference to be deleted. Name of the System DB, path of the sqlproj, or path of the dacpac
*/
name: string;
}
export interface FolderParams extends SqlProjectParams {
/**
* Path of the folder, typically relative to the .sqlproj file
*/
path: string;
}
export interface CreateSqlProjectParams extends SqlProjectParams {
/**
* Type of SQL Project: SDK-style or Legacy
*/
sqlProjectType: mssql.ProjectType;
/**
* Database schema provider for the project, in the format
* "Microsoft.Data.Tools.Schema.Sql.SqlXYZDatabaseSchemaProvider".
* Case sensitive.
*/
databaseSchemaProvider?: string;
/**
* Version of the Microsoft.Build.Sql SDK for the project, if overriding the default
*/
buildSdkVersion?: string;
}
export interface AddSqlCmdVariableParams extends SqlProjectParams {
/**
* Name of the SQLCMD variable
*/
name: string;
/**
* Default value of the SQLCMD variable
*/
defaultValue: string;
/**
* Value of the SQLCMD variable, with or without the $()
*/
value: string;
}
export interface DeleteSqlCmdVariableParams extends SqlProjectParams {
/**
* Name of the SQLCMD variable to be deleted
*/
name?: string;
}
export interface MoveItemParams extends SqlProjectScriptParams {
/**
* Destination path of the file or folder, relative to the .sqlproj
*/
destinationPath: string;
}
//#endregion
//#endregion
// ------------------------------- </ Sql Projects > -----------------------------------
// ------------------------------- <CMS> ----------------------------------------