ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-13 17:23:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

Address remaining comments for Object Management Database Handler (#2081)

Browse Source
This commit is contained in:
Cory Rivera
2023-06-01 11:02:59 -07:00
committed by GitHub
parent b45026967e
commit 0a5a7b4cc5
4 changed files with 167 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

217
src/Microsoft.SqlTools.ServiceLayer/ObjectManagement/ObjectTypes/Database/DatabaseHandler.cs
View File

@@ -6,8 +6,6 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Data; using System.Data;
using System.Diagnostics;
using System.Globalization;
using System.Linq; using System.Linq;
using System.Threading.Tasks; using System.Threading.Tasks;
using Microsoft.SqlServer.Management.Common; using Microsoft.SqlServer.Management.Common;
@@ -18,6 +16,7 @@ using static Microsoft.SqlTools.ServiceLayer.Admin.AzureSqlDbHelper;
using Microsoft.SqlTools.ServiceLayer.Connection; using Microsoft.SqlTools.ServiceLayer.Connection;
using Microsoft.SqlTools.ServiceLayer.Management; using Microsoft.SqlTools.ServiceLayer.Management;
using Microsoft.SqlTools.ServiceLayer.ObjectManagement.Contracts; using Microsoft.SqlTools.ServiceLayer.ObjectManagement.Contracts;
using Microsoft.SqlTools.ServiceLayer.Utility;
namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
{ {
@@ -30,17 +29,15 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
private const int minimumVersionForRecoveryModel = 8; private const int minimumVersionForRecoveryModel = 8;
private const string serverNotExistsError = "Server was not created for data container"; private const string serverNotExistsError = "Server was not created for data container";
private readonly Dictionary<CompatibilityLevel, string> displayCompatLevels = new Dictionary<CompatibilityLevel, string>(); private static readonly Dictionary<CompatibilityLevel, string> displayCompatLevels = new Dictionary<CompatibilityLevel, string>();
private readonly Dictionary<ContainmentType, string> displayContainmentTypes = new Dictionary<ContainmentType, string>(); private static readonly Dictionary<ContainmentType, string> displayContainmentTypes = new Dictionary<ContainmentType, string>();
private readonly Dictionary<RecoveryModel, string> displayRecoveryModels = new Dictionary<RecoveryModel, string>(); private static readonly Dictionary<RecoveryModel, string> displayRecoveryModels = new Dictionary<RecoveryModel, string>();
private readonly Dictionary<string, CompatibilityLevel> compatLevelEnums = new Dictionary<string, CompatibilityLevel>(); private static readonly Dictionary<string, CompatibilityLevel> compatLevelEnums = new Dictionary<string, CompatibilityLevel>();
private readonly Dictionary<string, ContainmentType> containmentTypeEnums = new Dictionary<string, ContainmentType>(); private static readonly Dictionary<string, ContainmentType> containmentTypeEnums = new Dictionary<string, ContainmentType>();
private readonly Dictionary<string, RecoveryModel> recoveryModelEnums = new Dictionary<string, RecoveryModel>(); private static readonly Dictionary<string, RecoveryModel> recoveryModelEnums = new Dictionary<string, RecoveryModel>();
private readonly HashSet<char> illegalFilenameCharacters = new HashSet<char>(new char[] { '\\', '/', ':', '*', '?', '"', '<', '>', '|' }); static DatabaseHandler()
public DatabaseHandler(ConnectionService connectionService) : base(connectionService)
{ {
displayCompatLevels.Add(CompatibilityLevel.Version70, SR.compatibilityLevel_sphinx); displayCompatLevels.Add(CompatibilityLevel.Version70, SR.compatibilityLevel_sphinx);
displayCompatLevels.Add(CompatibilityLevel.Version80, SR.compatibilityLevel_shiloh); displayCompatLevels.Add(CompatibilityLevel.Version80, SR.compatibilityLevel_shiloh);
@@ -60,19 +57,24 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
displayRecoveryModels.Add(RecoveryModel.BulkLogged, SR.general_recoveryModel_bulkLogged); displayRecoveryModels.Add(RecoveryModel.BulkLogged, SR.general_recoveryModel_bulkLogged);
displayRecoveryModels.Add(RecoveryModel.Simple, SR.general_recoveryModel_simple); displayRecoveryModels.Add(RecoveryModel.Simple, SR.general_recoveryModel_simple);
// Set up maps from displayName to enum type so we can retrieve the equivalent enum types later. // Set up maps from displayName to enum type so we can retrieve the equivalent enum types later when getting a Save/Script request.
// We can't use a simple Enum.Parse for that since the displayNames get localized. // We can't use a simple Enum.Parse for that since the displayNames get localized.
foreach (CompatibilityLevel key in displayCompatLevels.Keys) foreach (CompatibilityLevel key in displayCompatLevels.Keys)
{ {
compatLevelEnums.Add(displayCompatLevels[key], key); compatLevelEnums.Add(displayCompatLevels[key], key);
} }
foreach (ContainmentType key in displayContainmentTypes.Keys)
{
containmentTypeEnums.Add(displayContainmentTypes[key], key);
}
foreach (RecoveryModel key in displayRecoveryModels.Keys)
{
recoveryModelEnums.Add(displayRecoveryModels[key], key);
}
}
containmentTypeEnums.Add(displayContainmentTypes[ContainmentType.None], ContainmentType.None); public DatabaseHandler(ConnectionService connectionService) : base(connectionService)
containmentTypeEnums.Add(displayContainmentTypes[ContainmentType.Partial], ContainmentType.Partial); {
recoveryModelEnums.Add(displayRecoveryModels[RecoveryModel.Full], RecoveryModel.Full);
recoveryModelEnums.Add(displayRecoveryModels[RecoveryModel.BulkLogged], RecoveryModel.BulkLogged);
recoveryModelEnums.Add(displayRecoveryModels[RecoveryModel.Simple], RecoveryModel.Simple);
} }
public override bool CanHandleType(SqlObjectType objectType) public override bool CanHandleType(SqlObjectType objectType)
@@ -140,12 +142,12 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
databaseViewInfo.CompatibilityLevels = GetCompatibilityLevels(dataContainer.SqlServerVersion, prototype); databaseViewInfo.CompatibilityLevels = GetCompatibilityLevels(dataContainer.SqlServerVersion, prototype);
} }
// These aren't visible when the target DB is on Azure so only populate if it's not an Azure DB // These aren't included when the target DB is on Azure so only populate if it's not an Azure DB
databaseViewInfo.RecoveryModels = GetRecoveryModels(dataContainer.Server, prototype); databaseViewInfo.RecoveryModels = GetRecoveryModels(dataContainer.Server, prototype);
databaseViewInfo.ContainmentTypes = GetContainmentTypes(dataContainer.Server, prototype); databaseViewInfo.ContainmentTypes = GetContainmentTypes(dataContainer.Server, prototype);
} }
// Skip adding logins for the Owner field if running against an Azure SQL DB // Skip adding logins if running against an Azure SQL DB
if (dataContainer.Server.ServerType != DatabaseEngineType.SqlAzureDatabase) if (dataContainer.Server.ServerType != DatabaseEngineType.SqlAzureDatabase)
{ {
var logins = new List<string>(); var logins = new List<string>();
@@ -232,16 +234,22 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
// Update database file names now that we have a database name // Update database file names now that we have a database name
if (!prototype.HideFileSettings) if (!prototype.HideFileSettings)
{ {
var sanitizedName = SanitizeFileName(prototype.Name); var sanitizedName = DatabaseUtils.SanitizeDatabaseFileName(prototype.Name);
var dataFile = prototype.Files[0]; var dataFile = prototype.Files[0];
Debug.Assert(dataFile.DatabaseFileType == FileType.Data, "Expected first database file to be a data file for new database prototype."); if (dataFile.DatabaseFileType != FileType.Data)
{
throw new InvalidOperationException("Database prototype's first file was not a Data file.");
}
dataFile.Name = sanitizedName; dataFile.Name = sanitizedName;
if (prototype.NumberOfLogFiles > 0) if (prototype.NumberOfLogFiles > 0)
{ {
var logFile = prototype.Files[1]; var logFile = prototype.Files[1];
Debug.Assert(dataFile.DatabaseFileType == FileType.Log, "Expected first database file to be a log file for new database prototype"); if (logFile.DatabaseFileType != FileType.Log)
{
throw new InvalidOperationException("Database prototype's second file was not a Log file.");
}
logFile.Name = $"{sanitizedName}_log"; logFile.Name = $"{sanitizedName}_log";
} }
} }
@@ -298,48 +306,21 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
} }
/// <summary> /// <summary>
/// Removes invalid characters from a filename string, replacing each invalid character with an underscore. /// Get supported database collations for this server.
/// </summary> /// </summary>
private string SanitizeFileName(string fileName) /// <returns>A string array containing the display names of the collations. The first element will be "<default>" if this is either a new database or a Sphinx server.
{
char[] nameChars = fileName.ToCharArray();
for (int i = 0; i < nameChars.Length; i++)
{
if (illegalFilenameCharacters.Contains(nameChars[i]))
{
nameChars[i] = '_';
}
}
return new string(nameChars);
}
private bool IsManagedInstance(Server server)
{
return server?.Information?.DatabaseEngineEdition == DatabaseEngineEdition.SqlManagedInstance;
}
private bool IsArcEnabledManagedInstance(Server server)
{
return server?.Information?.DatabaseEngineEdition == DatabaseEngineEdition.SqlAzureArcManagedInstance;
}
private bool IsAnyManagedInstance(Server server)
{
return (IsManagedInstance(server) || IsArcEnabledManagedInstance(server));
}
private string[] GetCollations(Server server, DatabasePrototype prototype, bool isNewObject) private string[] GetCollations(Server server, DatabasePrototype prototype, bool isNewObject)
{ {
var collationItems = new List<string>(); var collationItems = new List<string>();
bool isSphinxServer = (server.VersionMajor < minimumVersionForWritableCollation); bool isSphinxServer = (server.VersionMajor < minimumVersionForWritableCollation);
// if we're creating a new database or this is a Sphinx Server, add "<default>" to the dropdown // if we're creating a new database or this is a Sphinx Server, add "<default>" to the list
if (isNewObject || isSphinxServer) if (isNewObject || isSphinxServer)
{ {
collationItems.Add(SR.general_default); collationItems.Add(SR.general_default);
} }
// if the server is shiloh or later, add specific collations to the dropdown // if the server is shiloh or later, add specific collations to the list
if (!isSphinxServer) if (!isSphinxServer)
{ {
DataTable serverCollationsTable = server.EnumCollations(); DataTable serverCollationsTable = server.EnumCollations();
@@ -355,11 +336,7 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
if (prototype.Exists) if (prototype.Exists)
{ {
System.Diagnostics.Debug.Assert(((prototype.Collation != null) && (prototype.Collation.Length != 0)), // Put the prototype's current collation at the front of the list
"prototype.Collation is null");
System.Diagnostics.Debug.Assert(collationItems.Contains(prototype.Collation),
"prototype.Collation is not in the collation list");
int index = collationItems.FindIndex(collation => collation.Equals(prototype.Collation, StringComparison.InvariantCultureIgnoreCase)); int index = collationItems.FindIndex(collation => collation.Equals(prototype.Collation, StringComparison.InvariantCultureIgnoreCase));
if (index > 0) if (index > 0)
{ {
@@ -370,14 +347,22 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
return collationItems.ToArray(); return collationItems.ToArray();
} }
/// <summary>
/// Gets the prototype's current collation.
/// </summary>
private string[] GetCollationsWithPrototypeCollation(DatabasePrototype prototype) private string[] GetCollationsWithPrototypeCollation(DatabasePrototype prototype)
{ {
return new string[] { prototype.Collation }; return new string[] { prototype.Collation };
} }
/// <summary>
/// Get supported database containment types for this server.
/// </summary>
/// <returns>A string array containing the display names of the containment types. This array is empty if containment types are not supported for this server.</returns>
private string[] GetContainmentTypes(Server server, DatabasePrototype prototype) private string[] GetContainmentTypes(Server server, DatabasePrototype prototype)
{ {
if (!(SqlMgmtUtils.IsSql11OrLater(server.ServerVersion)) || IsAnyManagedInstance(server)) // Containment types are only supported for Denali and later, and only if the server is not a managed instance
if (!(SqlMgmtUtils.IsSql11OrLater(server.ServerVersion)) || server.IsAnyManagedInstance())
{ {
return Array.Empty<string>(); return Array.Empty<string>();
} }
@@ -394,6 +379,7 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
containmentTypes.Add(displayContainmentTypes[ContainmentType.None]); containmentTypes.Add(displayContainmentTypes[ContainmentType.None]);
containmentTypes.Add(displayContainmentTypes[ContainmentType.Partial]); containmentTypes.Add(displayContainmentTypes[ContainmentType.Partial]);
// Put the prototype's current containment type at the front of the list
var swapIndex = 0; var swapIndex = 0;
switch (dbContainmentType) switch (dbContainmentType)
{ {
@@ -403,7 +389,6 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
swapIndex = 1; swapIndex = 1;
break; break;
default: default:
Debug.Fail(string.Format(CultureInfo.InvariantCulture, "Unexpected containment type '{0}'", dbContainmentType));
break; break;
} }
if (swapIndex > 0) if (swapIndex > 0)
@@ -416,22 +401,23 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
return containmentTypes.ToArray(); return containmentTypes.ToArray();
} }
/// <summary>
/// Get supported database recovery models for this server.
/// </summary>
/// <returns>A string array containing the display names of the recovery models. This array is empty if recovery models are not supported for this server.</returns>
private string[] GetRecoveryModels(Server server, DatabasePrototype prototype) private string[] GetRecoveryModels(Server server, DatabasePrototype prototype)
{ {
// if the server is shiloh or later, but not Managed Instance, enable the dropdown // Recovery models are only supported if the server is shiloh or later and is not a Managed Instance
var recoveryModelEnabled = (minimumVersionForRecoveryModel <= server.VersionMajor) && !IsAnyManagedInstance(server); var recoveryModelEnabled = (minimumVersionForRecoveryModel <= server.VersionMajor) && !server.IsAnyManagedInstance();
if (server.GetDisabledProperties().Contains("RecoveryModel") || !recoveryModelEnabled) if (server.GetDisabledProperties().Contains("RecoveryModel") || !recoveryModelEnabled)
{ {
return Array.Empty<string>(); return Array.Empty<string>();
} }
var recoveryModels = new List<string>(); var recoveryModels = new List<string>();
// Note: we still discriminate on IsAnyManagedInstance(server) because GetDisabledProperties() if (!server.IsAnyManagedInstance())
// was not updated to handle SQL Managed Instance.
if (!IsAnyManagedInstance(server))
{ {
// add recovery model options to the dropdown
recoveryModels.Add(displayRecoveryModels[RecoveryModel.Full]); recoveryModels.Add(displayRecoveryModels[RecoveryModel.Full]);
recoveryModels.Add(displayRecoveryModels[RecoveryModel.BulkLogged]); recoveryModels.Add(displayRecoveryModels[RecoveryModel.BulkLogged]);
recoveryModels.Add(displayRecoveryModels[RecoveryModel.Simple]); recoveryModels.Add(displayRecoveryModels[RecoveryModel.Simple]);
@@ -450,6 +436,7 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
} }
} }
// Put the prototype's current recovery model at the front of the list
if (recoveryModelEnabled) if (recoveryModelEnabled)
{ {
var swapIndex = 0; var swapIndex = 0;
@@ -464,7 +451,6 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
break; break;
default: default:
Debug.Assert(RecoveryModel.Full == prototype.RecoveryModel, string.Format(CultureInfo.InvariantCulture, "Unknown recovery model '{0}'", prototype.RecoveryModel));
break; break;
} }
if (swapIndex > 0) if (swapIndex > 0)
@@ -477,24 +463,32 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
return recoveryModels.ToArray(); return recoveryModels.ToArray();
} }
/// <summary>
/// Get supported database compatibility levels for this Azure server.
/// </summary>
/// <returns>A string array containing the display names of the compatibility levels. This array is empty if the database has a compatibility level we don't recognize.</returns>
private string[] GetCompatibilityLevelsAzure(DatabasePrototype prototype) private string[] GetCompatibilityLevelsAzure(DatabasePrototype prototype)
{ {
// For Azure we loop through all of the possible compatibility levels. We do this because there's only one compat level active on a // For Azure we loop through all of the possible compatibility levels. We do this because there's only one compat level active on a
// version at a time, but that can change at any point so in order to reduce maintenance required when that happens we'll just find // version at a time, but that can change at any point so in order to reduce maintenance required when that happens we'll just find
// the one that matches the current set level and display that // the one that matches the current set level and display that
foreach (var level in this.displayCompatLevels.Keys) foreach (var level in displayCompatLevels.Keys)
{ {
if (level == prototype.DatabaseCompatibilityLevel) if (level == prototype.DatabaseCompatibilityLevel)
{ {
// Azure can't change the compat level so we only populate the current version // Azure can't change the compat level so we only include the current version
return new string[] { this.displayCompatLevels[level] }; return new string[] { displayCompatLevels[level] };
} }
} }
Debug.Fail(string.Format(CultureInfo.InvariantCulture, "Unknown compatibility level '{0}'", prototype.DatabaseCompatibilityLevel)); // If we couldn't find the prototype's current compatibility level, then treat compatibillity levels as unsupported for this server
return Array.Empty<string>(); return Array.Empty<string>();
} }
/// <summary>
/// Get supported database compatibility levels for this server.
/// </summary>
/// <returns>A string array containing the display names of the compatibility levels. This array is empty if this is either a Sphinx server or if the database has a compatibility level we don't recognize.</returns>
private string[] GetCompatibilityLevels(int sqlServerVersion, DatabasePrototype prototype) private string[] GetCompatibilityLevels(int sqlServerVersion, DatabasePrototype prototype)
{ {
// Unlikely that we are hitting such an old SQL Server, but leaving to preserve // Unlikely that we are hitting such an old SQL Server, but leaving to preserve
@@ -509,49 +503,49 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
switch (sqlServerVersion) switch (sqlServerVersion)
{ {
case 8: // Shiloh case 8: // Shiloh
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version70]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version70]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version80]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version80]);
break; break;
case 9: // Yukon case 9: // Yukon
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version70]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version70]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version80]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version80]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version90]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version90]);
break; break;
case 10: // Katmai case 10: // Katmai
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version80]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version80]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version90]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version90]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version100]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version100]);
break; break;
case 11: // Denali case 11: // Denali
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version90]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version90]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version100]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version100]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version110]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version110]);
break; break;
case 12: // SQL2014 case 12: // SQL2014
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version100]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version100]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version110]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version110]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version120]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version120]);
break; break;
case 13: // SQL2016 case 13: // SQL2016
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version100]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version100]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version110]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version110]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version120]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version120]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version130]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version130]);
break; break;
case 14: // SQL2017 case 14: // SQL2017
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version100]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version100]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version110]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version110]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version120]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version120]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version130]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version130]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version140]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version140]);
break; break;
case 15: // SQL2019 case 15: // SQL2019
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version100]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version100]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version110]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version110]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version120]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version120]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version130]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version130]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version140]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version140]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version150]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version150]);
break; break;
/* SQL_VBUMP_REVIEW */ /* SQL_VBUMP_REVIEW */
default: default:
@@ -559,21 +553,21 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
// do not know about. We play conservative and only add the compat level we know // do not know about. We play conservative and only add the compat level we know
// about so far. // about so far.
// At vBump, add a new case and move the 'default' label there. // At vBump, add a new case and move the 'default' label there.
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version100]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version100]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version110]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version110]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version120]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version120]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version130]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version130]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version140]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version140]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version150]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version150]);
compatibilityLevels.Add(this.displayCompatLevels[CompatibilityLevel.Version160]); compatibilityLevels.Add(displayCompatLevels[CompatibilityLevel.Version160]);
break; break;
} }
// set the compatability level for this combo box based on the prototype // set the first compatability level for this list based on the prototype
for (var i = 0; i < compatibilityLevels.Count; i++) for (var i = 0; i < compatibilityLevels.Count; i++)
{ {
var level = compatibilityLevels[i]; var level = compatibilityLevels[i];
var prototypeLevel = this.displayCompatLevels[prototype.DatabaseCompatibilityLevel]; var prototypeLevel = displayCompatLevels[prototype.DatabaseCompatibilityLevel];
if (level == prototypeLevel) if (level == prototypeLevel)
{ {
if (i > 0) if (i > 0)
@@ -585,8 +579,7 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectManagement
} }
} }
// previous loop did not find the prototype compatibility level in this server's compatability options // previous loop did not find the prototype compatibility level in this server's compatability options, so treat compatibility levels as unsupported for this server
// disable the compatability level option
return Array.Empty<string>(); return Array.Empty<string>();
} }
} }

19
src/Microsoft.SqlTools.ServiceLayer/Utility/DatabaseUtils.cs
View File

@@ -19,7 +19,7 @@ using System.Security;
namespace Microsoft.SqlTools.ServiceLayer.Utility namespace Microsoft.SqlTools.ServiceLayer.Utility
{ {
public class DatabaseUtils public static class DatabaseUtils
{ {
/// <summary> /// <summary>
/// Check if the database is a system database /// Check if the database is a system database
@@ -328,5 +328,22 @@ namespace Microsoft.SqlTools.ServiceLayer.Utility
return new string[0]; return new string[0];
} }
} }
/// <summary>
/// Removes invalid characters from a filename string, replacing each invalid character with an underscore.
/// </summary>
public static string SanitizeDatabaseFileName(string fileName)
{
char[] nameChars = fileName.ToCharArray();
for (int i = 0; i < nameChars.Length; i++)
{
if (illegalFilenameCharacters.Contains(nameChars[i]))
{
nameChars[i] = '_';
}
}
return new string(nameChars);
}
private static readonly HashSet<char> illegalFilenameCharacters = new HashSet<char>(new char[] { '\\', '/', ':', '*', '?', '"', '<', '>', '|' });
} }
} }

28
src/Microsoft.SqlTools.ServiceLayer/Utility/ServerUtils.cs Normal file
View File

@@ -0,0 +1,28 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using Microsoft.SqlServer.Management.Common;
using Microsoft.SqlServer.Management.Smo;
namespace Microsoft.SqlTools.ServiceLayer.Utility
{
public static class ServerUtils
{
public static bool IsManagedInstance(this Server server)
{
return server.Information?.DatabaseEngineEdition == DatabaseEngineEdition.SqlManagedInstance;
}
public static bool IsArcEnabledManagedInstance(this Server server)
{
return server.Information?.DatabaseEngineEdition == DatabaseEngineEdition.SqlAzureArcManagedInstance;
}
public static bool IsAnyManagedInstance(this Server server)
{
return (IsManagedInstance(server) || IsArcEnabledManagedInstance(server));
}
}
}

32
test/Microsoft.SqlTools.ServiceLayer.IntegrationTests/ObjectManagement/DatabaseHandlerTests.cs
View File

@@ -56,19 +56,19 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.ObjectManagement
// create and update // create and update
var parametersForCreation = ObjectManagementTestUtils.GetInitializeViewRequestParams(connectionResult.ConnectionInfo.OwnerUri, "master", true, SqlObjectType.Database, "", ""); var parametersForCreation = ObjectManagementTestUtils.GetInitializeViewRequestParams(connectionResult.ConnectionInfo.OwnerUri, "master", true, SqlObjectType.Database, "", "");
await ObjectManagementTestUtils.SaveObject(parametersForCreation, testDatabase); await ObjectManagementTestUtils.SaveObject(parametersForCreation, testDatabase);
Assert.True(databaseExists(testDatabase.Name!, server), $"Expected database '{testDatabase.Name}' was not created succesfully"); Assert.That(DatabaseExists(testDatabase.Name!, server), $"Expected database '{testDatabase.Name}' was not created succesfully");
var parametersForUpdate = ObjectManagementTestUtils.GetInitializeViewRequestParams(connectionResult.ConnectionInfo.OwnerUri, "master", false, SqlObjectType.Database, "", objUrn); var parametersForUpdate = ObjectManagementTestUtils.GetInitializeViewRequestParams(connectionResult.ConnectionInfo.OwnerUri, "master", false, SqlObjectType.Database, "", objUrn);
await ObjectManagementTestUtils.SaveObject(parametersForUpdate, testDatabase); await ObjectManagementTestUtils.SaveObject(parametersForUpdate, testDatabase);
// cleanup // cleanup
await ObjectManagementTestUtils.DropObject(connectionResult.ConnectionInfo.OwnerUri, objUrn, throwIfNotExist: true); await ObjectManagementTestUtils.DropObject(connectionResult.ConnectionInfo.OwnerUri, objUrn, throwIfNotExist: true);
Assert.False(databaseExists(testDatabase.Name!, server), $"Database '{testDatabase.Name}' was not dropped succesfully"); Assert.That(DatabaseExists(testDatabase.Name!, server), Is.False, $"Database '{testDatabase.Name}' was not dropped succesfully");
} }
finally finally
{ {
// Cleanup using SMO if Drop didn't work // Cleanup using SMO if Drop didn't work
dropDatabase(server, testDatabase.Name!); DropDatabase(server, testDatabase.Name!);
} }
} }
} }
@@ -92,13 +92,13 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.ObjectManagement
{ {
var parametersForCreation = ObjectManagementTestUtils.GetInitializeViewRequestParams(connectionResult.ConnectionInfo.OwnerUri, "master", true, SqlObjectType.Database, "", ""); var parametersForCreation = ObjectManagementTestUtils.GetInitializeViewRequestParams(connectionResult.ConnectionInfo.OwnerUri, "master", true, SqlObjectType.Database, "", "");
var script = await ObjectManagementTestUtils.ScriptObject(parametersForCreation, testDatabase); var script = await ObjectManagementTestUtils.ScriptObject(parametersForCreation, testDatabase);
Assert.True(!databaseExists(testDatabase.Name!, server), $"Database should not have been created for scripting operation"); Assert.That(DatabaseExists(testDatabase.Name!, server), Is.False, $"Database should not have been created for scripting operation");
Assert.True(script.ToLowerInvariant().Contains($"create database [{testDatabase.Name!.ToLowerInvariant()}]")); Assert.That(script.ToLowerInvariant(), Does.Contain($"create database [{testDatabase.Name!.ToLowerInvariant()}]"));
} }
finally finally
{ {
// Cleanup database on the off-chance that scripting somehow created the database // Cleanup database on the off-chance that scripting somehow created the database
dropDatabase(server, testDatabase.Name!); DropDatabase(server, testDatabase.Name!);
} }
} }
} }
@@ -119,8 +119,8 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.ObjectManagement
} }
catch (FailedOperationException ex) catch (FailedOperationException ex)
{ {
Assert.NotNull(ex.InnerException, "Expected inner exception was null."); Assert.That(ex.InnerException, Is.Not.Null, "Expected inner exception was null.");
Assert.True(ex.InnerException is MissingObjectException, $"Received unexpected inner exception type: {ex.InnerException!.GetType()}"); Assert.That(ex.InnerException, Is.InstanceOf<MissingObjectException>(), $"Received unexpected inner exception type: {ex.InnerException!.GetType()}");
} }
} }
@@ -143,26 +143,26 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.ObjectManagement
{ {
var parametersForCreation = ObjectManagementTestUtils.GetInitializeViewRequestParams(connectionResult.ConnectionInfo.OwnerUri, "master", true, SqlObjectType.Database, "", ""); var parametersForCreation = ObjectManagementTestUtils.GetInitializeViewRequestParams(connectionResult.ConnectionInfo.OwnerUri, "master", true, SqlObjectType.Database, "", "");
await ObjectManagementTestUtils.SaveObject(parametersForCreation, testDatabase); await ObjectManagementTestUtils.SaveObject(parametersForCreation, testDatabase);
Assert.True(databaseExists(testDatabase.Name!, server), $"Expected database '{testDatabase.Name}' was not created succesfully"); Assert.That(DatabaseExists(testDatabase.Name!, server), $"Expected database '{testDatabase.Name}' was not created succesfully");
await ObjectManagementTestUtils.SaveObject(parametersForCreation, testDatabase); await ObjectManagementTestUtils.SaveObject(parametersForCreation, testDatabase);
Assert.Fail("Did not throw an exception when trying to create database with same name."); Assert.Fail("Did not throw an exception when trying to create database with same name.");
} }
catch (FailedOperationException ex) catch (FailedOperationException ex)
{ {
Assert.NotNull(ex.InnerException, "Expected inner exception was null."); Assert.That(ex.InnerException, Is.Not.Null, "Expected inner exception was null.");
Assert.True(ex.InnerException is ExecutionFailureException, $"Received unexpected inner exception type: {ex.InnerException!.GetType()}"); Assert.That(ex.InnerException, Is.InstanceOf<ExecutionFailureException>(), $"Received unexpected inner exception type: {ex.InnerException!.GetType()}");
Assert.NotNull(ex.InnerException.InnerException, "Expected inner-inner exception was null."); Assert.That(ex.InnerException.InnerException, Is.Not.Null, "Expected inner-inner exception was null.");
Assert.True(ex.InnerException.InnerException is SqlException, $"Received unexpected inner-inner exception type: {ex.InnerException.InnerException!.GetType()}"); Assert.That(ex.InnerException.InnerException, Is.InstanceOf<SqlException>(), $"Received unexpected inner-inner exception type: {ex.InnerException.InnerException!.GetType()}");
} }
finally finally
{ {
dropDatabase(server, testDatabase.Name!); DropDatabase(server, testDatabase.Name!);
} }
} }
} }
private bool databaseExists(string dbName, Server server) private bool DatabaseExists(string dbName, Server server)
{ {
server.Databases.Refresh(); server.Databases.Refresh();
bool dbFound = false; bool dbFound = false;
@@ -177,7 +177,7 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.ObjectManagement
return dbFound; return dbFound;
} }
private void dropDatabase(Server server, string databaseName) private void DropDatabase(Server server, string databaseName)
{ {
server.Databases.Refresh(); server.Databases.Refresh();
foreach (Database db in server.Databases) foreach (Database db in server.Databases)