Moving Restore functionality to the mssql extension

extensions/mssql/package.json

@@ -142,6 +142,11 @@
         "category": "MSSQL",
         "title": "%title.attachDatabase%"
       },
+      {
+        "command": "mssql.restoreDatabase",
+        "category": "MSSQL",
+        "title": "%title.restoreDatabase%"
+      },
       {
         "command": "mssql.backupDatabase",
         "category": "MSSQL",
@@ -596,6 +601,10 @@
           "command": "mssql.attachDatabase",
           "when": "false"
         },
+        {
+          "command": "mssql.restoreDatabase",
+          "when": "false"
+        },
         {
           "command": "mssql.backupDatabase",
           "when": "false"
@@ -696,6 +705,11 @@
           "when": "connectionProvider == MSSQL && nodeType == Folder && objectType == Databases && !isCloud && config.workbench.enablePreviewFeatures",
           "group": "1_objectManagement@2"
         },
+        {
+          "command": "mssql.restoreDatabase",
+          "when": "connectionProvider == MSSQL && !isCloud && mssql:engineedition != 11 && nodeType && nodeType == Database && (productQualityType =~ /^(insider|dev)$/ || isDevelopment)",
+          "group": "1_objectManagement@3"
+        },
         {
           "command": "mssql.backupDatabase",
           "when": "connectionProvider == MSSQL && nodeType == Database && !isCloud && engineEdition != 11 && config.workbench.enablePreviewFeatures && (productQualityType =~ /^(insider|dev)$/ || isDevelopment)",

extensions/mssql/package.nls.json

@@ -199,5 +199,6 @@
 	"title.renameObject": "Rename (Preview)",
 	"title.detachDatabase": "Detach Database (Preview)",
 	"title.attachDatabase": "Attach Database (Preview)",
-	"title.backupDatabase": "Backup Database (Preview)"
+	"title.backupDatabase": "Backup Database (Preview)",
+	"title.restoreDatabase": "Restore (Preview)"
 }

extensions/mssql/src/objectManagement/commands.ts

@@ -26,6 +26,7 @@ import { ServerPropertiesDialog } from './ui/serverPropertiesDialog';
 import { DetachDatabaseDialog } from './ui/detachDatabaseDialog';
 import { DropDatabaseDialog } from './ui/dropDatabaseDialog';
 import { AttachDatabaseDialog } from './ui/attachDatabaseDialog';
+import { RestoreDatabaseDialog } from './ui/restoreDatabaseDialog';
 import { BackupDatabaseDialog } from './ui/backupDatabaseDialog';
 
 export function registerObjectManagementCommands(appContext: AppContext) {
@@ -73,6 +74,9 @@ export function registerObjectManagementCommands(appContext: AppContext) {
 	appContext.extensionContext.subscriptions.push(vscode.commands.registerCommand('mssql.dropDatabase', async (context: azdata.ObjectExplorerContext) => {
 		await handleDropDatabase(context, service);
 	}));
+	appContext.extensionContext.subscriptions.push(vscode.commands.registerCommand('mssql.restoreDatabase', async (context: azdata.ObjectExplorerContext) => {
+		await handleRestoreDatabase(context, service);
+	}));
 }
 
 function getObjectManagementService(appContext: AppContext, useTestService: boolean): IObjectManagementService {
@@ -455,6 +459,40 @@ async function handleDropDatabase(context: azdata.ObjectExplorerContext, service
 	}
 }
 
+async function handleRestoreDatabase(context: azdata.ObjectExplorerContext, service: IObjectManagementService): Promise<void> {
+	const connectionUri = await getConnectionUri(context);
+	if (!connectionUri) {
+		return;
+	}
+	try {
+		const parentUrn = await getParentUrn(context);
+		const options: ObjectManagementDialogOptions = {
+			connectionUri: connectionUri,
+			isNewObject: true,
+			database: context.connectionProfile!.databaseName!,
+			objectType: ObjectManagement.NodeType.Database,
+			objectName: '',
+			parentUrn: parentUrn,
+			objectExplorerContext: context
+		};
+		const dialog = new RestoreDatabaseDialog(service, options);
+		const startTime = Date.now();
+		await dialog.open();
+		TelemetryReporter.sendTelemetryEvent(TelemetryActions.OpenRestoreDatabaseDialog, {
+			objectType: ObjectManagement.NodeType.Database
+		}, {
+			elapsedTimeMs: Date.now() - startTime
+		});
+	}
+	catch (err) {
+		TelemetryReporter.createErrorEvent2(ObjectManagementViewName, TelemetryActions.OpenRestoreDatabaseDialog, err).withAdditionalProperties({
+			objectType: context.nodeInfo!.nodeType
+		}).send();
+		console.error(err);
+		await vscode.window.showErrorMessage(objectManagementLoc.OpenRestoreDatabaseDialogError(getErrorMessage(err)));
+	}
+}
+
 function getDialog(service: IObjectManagementService, dialogOptions: ObjectManagementDialogOptions): ObjectManagementDialogBase<ObjectManagement.SqlObject, ObjectManagement.ObjectViewInfo<ObjectManagement.SqlObject>> {
 	const verticalTabsDialogWidth = '750px';
 	switch (dialogOptions.objectType) {

extensions/mssql/src/objectManagement/constants.ts

@@ -46,6 +46,11 @@ export const QueryStorePropertiesDocUrl = 'https://learn.microsoft.com/sql/relat
 export const DatabaseFilesPropertiesDocUrl = 'https://learn.microsoft.com/sql/relational-databases/databases/database-properties-files-page';
 export const DatabaseFileGroupsPropertiesDocUrl = 'https://learn.microsoft.com/sql/relational-databases/databases/database-properties-filegroups-page';
 
+// Restore database help links
+export const RestoreDatabaseGeneralTabDocUrl = 'https://learn.microsoft.com/sql/relational-databases/backup-restore/restore-database-general-page'
+export const RestoreDatabaseFilesTabDocUrl = 'https://learn.microsoft.com/sql/relational-databases/backup-restore/restore-database-files-page'
+export const RestoreDatabaseOptionsTabDocUrl = 'https://learn.microsoft.com/sql/relational-databases/backup-restore/restore-database-options-page'
+
 export const enum TelemetryActions {
 	CreateObject = 'CreateObject',
 	DropObject = 'DropObject',
@@ -58,7 +63,9 @@ export const enum TelemetryActions {
 	OpenBackupDatabaseDialog = 'OpenBackupDatabaseDialog',
 	OpenDropDatabaseDialog = 'OpenDropDatabaseDialog',
 	AttachDatabase = 'AttachDatabase',
-	DetachDatabase = 'DetachDatabase'
+	DetachDatabase = 'DetachDatabase',
+	OpenRestoreDatabaseDialog = 'OpenRestoreDatabaseDialog',
+	RestoreDatabase = 'RestoreDatabase'
 }
 
 export const ObjectManagementViewName = 'ObjectManagement';

extensions/mssql/src/objectManagement/interfaces.ts

@@ -2,6 +2,8 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
+
+import * as azdata from 'azdata';
 import { ObjectManagement } from 'mssql';
 
 /**
@@ -459,6 +461,7 @@ export interface Database extends ObjectManagement.SqlObject {
 	files?: DatabaseFile[];
 	filegroups?: FileGroup[];
 	queryStoreOptions?: QueryStoreOptions;
+	restorePlanResponse?: azdata.RestorePlanResponse;
 	backupEncryptors?: BackupEncryptor[];
 }
 
@@ -489,6 +492,7 @@ export interface DatabaseViewInfo extends ObjectManagement.ObjectViewInfo<Databa
 	sizeBasedCleanupModeOptions?: string[];
 	staleThresholdOptions?: string[];
 	serverFilestreamAccessLevel?: FileStreamEffectiveLevel;
+	restoreDatabaseInfo?: RestoreDatabaseInfo;
 }
 
 export interface QueryStoreOptions {
@@ -505,6 +509,17 @@ export interface QueryStoreOptions {
 	currentStorageSizeInMB: number;
 }
 
+export interface RestoreDatabaseInfo {
+	sourceDatabaseNames: string[];
+	targetDatabaseNames: string[];
+	recoveryStateOptions: CategoryValue[];
+}
+
+export interface CategoryValue {
+	displayName: string;
+	name: string;
+}
+
 export interface QueryStoreCapturePolicyOptions {
 	executionCount: number;
 	staleThreshold: string;

extensions/mssql/src/objectManagement/localizedConstants.ts

@@ -148,6 +148,20 @@ export function BackupDatabaseOperationDisplayName(objectName: string): string {
 	}, "Backup database '{0}'", objectName);
 }
 
+export function OpenRestoreDatabaseDialogError(error: string): string {
+	return localize({
+		key: 'objectManagement.openRestoreDatabaseDialogError',
+		comment: ['{0}: error message.']
+	}, "An error occurred while opening the restore database dialog. {0}", error);
+}
+
+export function RestoreDatabaseOperationDisplayName(objectName: string): string {
+	return localize({
+		key: 'objectManagement.restoreDatabaseOperationName',
+		comment: ['{0}: object name.']
+	}, "Restore database '{0}'", objectName);
+}
+
 export function OpenObjectPropertiesDialogError(objectType: string, objectName: string, error: string): string {
 	return localize({
 		key: 'objectManagement.openObjectPropertiesDialogError',
@@ -221,6 +235,7 @@ export const EditionText = localize('objectManagement.editionLabel', "Edition");
 export const MaxSizeText = localize('objectManagement.maxSizeLabel', "Max Size");
 export const AzurePricingLinkText = localize('objectManagement.azurePricingLink', "Azure SQL Database pricing calculator");
 export const DetachDatabaseDialogTitle = (dbName: string) => localize('objectManagement.detachDatabaseDialogTitle', "Detach Database - {0} (Preview)", dbName);
+export const RestoreDatabaseDialogTitle = (dbName: string) => localize('objectManagement.restoreDatabaseDialogTitle', "Restore Database - {0} (Preview)", dbName);
 export const DetachDropConnections = localize('objectManagement.detachDropConnections', "Drop connnections");
 export const DetachUpdateStatistics = localize('objectManagement.detachUpdateStatistics', "Update statistics");
 export const DatabaseFilesLabel = localize('objectManagement.databaseFiles', "Database Files");
@@ -314,6 +329,52 @@ export const SQLAuthenticationTypeDisplayText = localize('objectManagement.login
 export const AADAuthenticationTypeDisplayText = localize('objectManagement.login.aadAuthenticationType', "Microsoft Entra ID Authentication");
 export const OldPasswordCannotBeEmptyError = localize('objectManagement.login.oldPasswordCannotBeEmptyError', "Old password cannot be empty.");
 
+//Restore Database
+export const RestoreFromText = localize('objectManagement.restoreDatabase.restoreFromText', "Restore from");
+export const BackupFilePathText = localize('objectManagement.restoreDatabase.backupFilePathText', "Backup file path");
+export const DatabaseText = localize('objectManagement.restoreDatabase.databaseText', "Database");
+export const TargetDatabaseText = localize('objectManagement.restoreDatabase.targetDatabaseText', "Target database");
+export const RestoreToText = localize('objectManagement.restoreDatabase.restoreToText', "Restore to");
+export const SourceSectionText = localize('objectManagement.restoreDatabase.SourceSectionText', "Source");
+export const DestinationSectionText = localize('objectManagement.restoreDatabase.DestinationSectionText', "Destination");
+export const RestorePlanSectionText = localize('objectManagement.restoreDatabase.RestorePlanSectionText', "Restore plan");
+export const RestoreFromBackupFileOptionText = localize('objectManagement.restoreDatabase.restoreFromBackupFileOptionText', "Backup file");
+export const RestoreFromDatabaseOptionText = localize('objectManagement.restoreDatabase.restoreFromDatabaseOptionText', "Database");
+export const BackupFolderPathTitle = localize('objectManagement.restoreDatabase.backupFolderPathTitle', "Please enter one or more file paths separated by commas");
+export const RestoreDatabaseFilesAsText = localize('objectManagement.restoreDatabase.restoreDatabaseFilesAsText', "Restore database files as");
+export const RestoreDatabaseFileDetailsText = localize('objectManagement.restoreDatabase.restoreDatabaseFileDetailsText', "Restore database file Details");
+export const RestoreOptionsText = localize('objectManagement.restoreDatabase.restoreOptionsText', "Restore Options");
+export const RestoreTailLogBackupText = localize('objectManagement.restoreDatabase.restoreTailLogBackupOptionsText', "Tail-log backup");
+export const RestoreServerConnectionsOptionsText = localize('objectManagement.restoreDatabase.restoreServerConnectionsOptionsText', "Server connections");
+export const RelocateAllFilesText = localize('objectManagement.restoreDatabase.relocateAllFilesText', "Relocate All Files");
+export const DataFileFolderText = localize('objectManagement.restoreDatabase.dataFileFolderText', "Data File Folder");
+export const LogFileFolderText = localize('objectManagement.restoreDatabase.logFileFolderText', "Log File Folder");
+export const OverwriteTheExistingDatabaseText = localize('objectManagement.restoreDatabase.overwriteTheExistingDatabaseText', "Overwrite the existing database (WITH REPLACE)");
+export const PreserveReplicationSettingsText = localize('objectManagement.restoreDatabase.preserveReplicationSettingsText', "Preserve the replication settings (WITH KEEP_REPLICATION)");
+export const RestrictAccessToRestoredDBText = localize('objectManagement.restoreDatabase.restrictAccessToRestoredDBText', "Restrict access to the restored database (WITH RESTRICTED_USER)");
+export const RecoveryStateText = localize('objectManagement.restoreDatabase.recoveryStateText', "Recovery State");
+export const StandbyFileText = localize('objectManagement.restoreDatabase.standbyFileText', "Standby file");
+export const TakeTailLogBackupBeforeRestoreText = localize('objectManagement.restoreDatabase.takeTailLogBackupBeforeRestoreText', "Take tail-log backup before restore");
+export const LeaveSourceDBText = localize('objectManagement.restoreDatabase.leaveSourceDBText', "Leave source database in the restoring state (WITH NORECOVERY)");
+export const TailLogBackupFileText = localize('objectManagement.restoreDatabase.tailLogBackupFileText', "Tail Log Backup File");
+export const CloseExistingConnectionText = localize('objectManagement.restoreDatabase.closeExistingConnectionText', "Close existing connections to destination database");
+export const RestoreText = localize('objectManagement.restoreDatabase.restorePlan.restoreText', "Restore");
+export const ComponentText = localize('objectManagement.restoreDatabase.restorePlan.componentText', "Component");
+export const TypeText = localize('objectManagement.restoreDatabase.restorePlan.typeText', "Type");
+export const ServerText = localize('objectManagement.restoreDatabase.restorePlan.serverText', "Server");
+export const PositionText = localize('objectManagement.restoreDatabase.restorePlan.positionText', "Position");
+export const FirstLSNText = localize('objectManagement.restoreDatabase.restorePlan.firstLSNText', "First LSN");
+export const LastLSNText = localize('objectManagement.restoreDatabase.restorePlan.lastLSNText', "Last LSN");
+export const CheckpointLSNText = localize('objectManagement.restoreDatabase.restorePlan.checkpointLSNText', "Checkpoint LSN");
+export const FullLSNText = localize('objectManagement.restoreDatabase.restorePlan.FullLSNText', "Full LSN");
+export const StartDateText = localize('objectManagement.restoreDatabase.restorePlan.startDateText', "Start Date");
+export const FinishDateText = localize('objectManagement.restoreDatabase.restorePlan.FinishDateText', "Finish Date");
+export const UserNameText = localize('objectManagement.restoreDatabase.restorePlan.userNameText', "User Name");
+export const ExpirationText = localize('objectManagement.restoreDatabase.restorePlan.expirationText', "Expiration");
+export const LogicalFileNameText = localize('objectManagement.restoreDatabase.restorePlan.logicalFileNameText', "Logical File Name");
+export const OriginalFileNameText = localize('objectManagement.restoreDatabase.restorePlan.originalFileNameText', "Original File Name");
+export const RestoreAsText = localize('objectManagement.restoreDatabase.restorePlan.restoreAsText', "Restore As");
+
 // User
 export const UserTypeText = localize('objectManagement.user.type', "Type");
 export const UserType_LoginMapped = localize('objectManagement.user.loginMapped', "Mapped to a server login");

extensions/mssql/src/objectManagement/objectManagementService.ts

@@ -7,7 +7,6 @@ import { ApplicationRoleViewInfo, AuthenticationType, DatabaseRoleViewInfo, Data
 import * as Utils from '../utils';
 import * as constants from '../constants';
 import * as contracts from '../contracts';
-
 import { BaseService, ISqlOpsFeature, SqlOpsDataClient } from 'dataprotocol-client';
 import { ObjectManagement, IObjectManagementService, DatabaseFileData, BackupInfo } from 'mssql';
 import { ClientCapabilities } from 'vscode-languageclient';