Add scripting API implemented by the SqlScriptPublishModel

docs/samples/jsonrpc/netcore/executequery/project.json

@@ -4,19 +4,19 @@
   "buildOptions": {
     "debugType": "portable",
     "emitEntryPoint": true    
-  },  
+  },
   "dependencies": {
     "Microsoft.SqlTools.ServiceLayer": {
       "target": "project"
     },
     "Newtonsoft.Json": "9.0.1",
     "System.Data.Common": "4.1.0",
     "System.Data.SqlClient": "4.4.0-sqltools-24613-04",
-    "Microsoft.SqlServer.Smo": "14.0.17028",
+    "Microsoft.SqlServer.Smo": "140.17049.0",
     "System.Security.SecureString": "4.0.0",
     "System.Collections.Specialized": "4.0.1",
     "System.ComponentModel.TypeConverter": "4.1.0",
-    "System.Diagnostics.Contracts": "4.0.1",    
+    "System.Diagnostics.Contracts": "4.0.1",
     "System.Diagnostics.TraceSource": "4.0.0",
     "NETStandard.Library": "1.6.0",
     "Microsoft.NETCore.Runtime.CoreCLR": "1.0.2",

docs/samples/smo/netcore/ModifySetting/project.json

@@ -5,7 +5,7 @@
     "emitEntryPoint": true
   },
   "dependencies": {
-    "Microsoft.SqlServer.Smo": "14.0.17028"
+    "Microsoft.SqlServer.Smo": "140.17049.0"
   },
   "frameworks": {
     "netcoreapp1.0": {

src/Microsoft.SqlTools.ServiceLayer/Scripting/Contracts/ScriptingCancelEvent.cs

@@ -0,0 +1,22 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using Microsoft.SqlTools.Hosting.Protocol.Contracts;
+
+namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
+{
+    /// <summary>
+    /// Parameters sent when a scripting operation has been canceled.
+    /// </summary>
+    public class ScriptingCancelParameters : ScriptingEventParams { }
+
+    /// <summary>
+    /// Event sent to indicate that a scripting operation has been canceled.
+    /// </summary>
+    public class ScriptingCancelEvent
+    {
+        public static readonly EventType<ScriptingCancelParameters> Type = EventType<ScriptingCancelParameters>.Create("scripting/scriptCancel");
+    }
+}

src/Microsoft.SqlTools.ServiceLayer/Scripting/Contracts/ScriptingCancelRequest.cs

@@ -0,0 +1,34 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using Microsoft.SqlTools.Hosting.Protocol.Contracts;
+
+namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
+{
+    /// <summary>
+    /// Parameters to cancel a scripting request.
+    /// </summary>
+    public class ScriptingCancelParams
+    {
+        /// <summary>
+        /// Gets or sets the operation id of the scripting operation to cancel.
+        /// </summary>
+        public string OperationId { get; set; }
+    }
+
+    /// <summary>
+    /// Parameters returned from a scripting request.
+    /// </summary>
+    public class ScriptingCancelResult { }
+
+    /// <summary>
+    /// Defines the scripting cancel request type.
+    /// </summary>
+    public class ScriptingCancelRequest
+    {
+        public static readonly RequestType<ScriptingCancelParams, ScriptingCancelResult> Type = 
+            RequestType<ScriptingCancelParams, ScriptingCancelResult>.Create("scripting/scriptCancel");
+    }
+}

src/Microsoft.SqlTools.ServiceLayer/Scripting/Contracts/ScriptingCompleteEvent.cs

@@ -0,0 +1,24 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+    using Microsoft.SqlTools.Hosting.Protocol.Contracts;
+
+namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
+{
+    /// <summary>
+    /// Parameters sent to when a scripting operation has completed.
+    /// </summary>
+    public class ScriptingCompleteParameters : ScriptingEventParams {}
+
+
+    /// <summary>
+    /// Event sent to indicate a scripting operation has completed.
+    /// </summary>
+    public class ScriptingCompleteEvent
+    {
+        public static readonly EventType<ScriptingCompleteParameters> Type = 
+            EventType<ScriptingCompleteParameters>.Create("scripting/scriptComplete");
+    }
+}

src/Microsoft.SqlTools.ServiceLayer/Scripting/Contracts/ScriptingErrorEvent.cs

@@ -0,0 +1,34 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using Microsoft.SqlTools.Hosting.Protocol.Contracts;
+
+namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
+{
+    /// <summary>
+    /// Parameters sent when a scripting operation has encountered an error.
+    /// </summary>
+    public class ScriptingErrorParams : ScriptingEventParams
+    {
+        /// <summary>
+        /// Gets or sets error message.
+        /// </summary>
+        public string Message { get; set; }
+
+        /// <summary>
+        /// Gets or sets error details.
+        /// </summary>
+        public string Details { get; set; }
+    }
+
+    /// <summary>
+    /// Event sent to indicate a scripting operation has encountered an error.
+    /// </summary>
+    public class ScriptingErrorEvent
+    {
+        public static readonly EventType<ScriptingErrorParams> Type = 
+            EventType<ScriptingErrorParams>.Create("scripting/scriptError");
+    }
+}

src/Microsoft.SqlTools.ServiceLayer/Scripting/Contracts/ScriptingEventParams.cs

@@ -0,0 +1,18 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
+{
+    /// <summary>
+    /// Base class for all scripting event parameters.
+    /// </summary>
+    public abstract class ScriptingEventParams
+    {
+        /// <summary>
+        /// Gets or sets the operation id of the scripting operation this event is associated with.
+        /// </summary>
+        public string OperationId { get; set; }
+    }
+}

src/Microsoft.SqlTools.ServiceLayer/Scripting/Contracts/ScriptingListObjectsEvent.cs

@@ -0,0 +1,34 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System.Collections.Generic;
+using Microsoft.SqlTools.Hosting.Protocol.Contracts;
+
+namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
+{
+    /// <summary>
+    /// Parameters sent when a list objects operation has completed.
+    /// </summary>
+    public class ScriptingListObjectsCompleteParameters : ScriptingEventParams
+    {
+        /// <summary>
+        /// Gets or sets the list of database objects returned from the list objects operation.
+        /// </summary>
+        public List<ScriptingObject> DatabaseObjects { get; set; }
+
+        /// <summary>
+        /// Gets or sets the count of database object returned from the list objects operation.
+        /// </summary>
+        public int Count { get; set; }
+    }
+
+    /// <summary>
+    /// Event sent to indicate a list objects operation has completed.
+    /// </summary>
+    public class ScriptingListObjectsCompleteEvent
+    {
+        public static readonly EventType<ScriptingListObjectsCompleteParameters> Type = EventType<ScriptingListObjectsCompleteParameters>.Create("scripting/listObjectsComplete");
+    }
+}

src/Microsoft.SqlTools.ServiceLayer/Scripting/Contracts/ScriptingListObjectsRequest.cs

@@ -0,0 +1,35 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System.Collections.Generic;
+using Microsoft.SqlTools.Hosting.Protocol.Contracts;
+
+namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
+{
+    /// <summary>
+    /// Parameters for a list objects request.
+    /// </summary>
+    public class ScriptingListObjectsParams
+    {
+        public string ConnectionString { get; set; }
+    }
+
+    /// <summary>
+    /// Parameters returned from a list objects request.
+    /// </summary>
+    public class ScriptingListObjectsResult
+    {
+        public string OperationId { get; set; }
+    }
+
+    /// <summary>
+    /// Defines the scripting list objects request type.
+    /// </summary>
+    public class ScriptingListObjectsRequest
+    {
+        public static readonly RequestType<ScriptingListObjectsParams, ScriptingListObjectsResult> Type = 
+            RequestType<ScriptingListObjectsParams, ScriptingListObjectsResult>.Create("scripting/listObjects");
+    }
+}

src/Microsoft.SqlTools.ServiceLayer/Scripting/Contracts/ScriptingObject.cs

@@ -0,0 +1,93 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System;
+using System.Collections.Generic;
+
+namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
+{
+    /// <summary>
+    /// Class to represent a database object that can be scripted.
+    /// </summary>
+    public sealed class ScriptingObject : IEquatable<ScriptingObject>
+    {
+        /// <summary>
+        /// Gets or sets the database object type.  
+        /// </summary>
+        /// <remarks>
+        /// This underlying values are determined by the SqlScriptPublishModel.GetDatabaseObjectTypes() and
+        /// can change depending on the version of SMO used by the tools service.  Values can be: 
+        ///     Table,
+        ///     View,
+        ///     StoredProcedure,
+        ///     UserDefinedFunction,
+        ///     UserDefinedDataType,
+        ///     User,
+        ///     Default,
+        ///     Rule,
+        ///     DatabaseRole,
+        ///     ApplicationRole,
+        ///     SqlAssembly,
+        ///     DdlTrigger,
+        ///     Synonym,
+        ///     XmlSchemaCollection,
+        ///     Schema,
+        ///     PlanGuide,
+        ///     UserDefinedType,
+        ///     UserDefinedAggregate,
+        ///     FullTextCatalog,
+        ///     UserDefinedTableType
+        /// </remarks>
+        public string Type { get; set; }
+
+        /// <summary>
+        /// Gets or sets the schema of the database object.
+        /// </summary>
+        public string Schema { get; set; }
+
+        /// <summary>
+        /// Gets or sets the database object name.
+        /// </summary>
+        public string Name { get; set; }
+
+        public override string ToString()
+        {
+            string objectName = string.IsNullOrEmpty(this.Schema)
+                ? this.Name
+                : this.Schema + "." + this.Name;
+
+            return objectName;
+        }
+
+        public override int GetHashCode()
+        {
+            return
+                StringComparer.OrdinalIgnoreCase.GetHashCode(this.Type ?? string.Empty) ^
+                StringComparer.OrdinalIgnoreCase.GetHashCode(this.Schema ?? string.Empty) ^
+                StringComparer.OrdinalIgnoreCase.GetHashCode(this.Name ?? string.Empty);
+        }
+
+        public override bool Equals(object obj)
+        {
+            return 
+                obj != null &&
+                this.GetType() == obj.GetType() && 
+                this.Equals((ScriptingObject)obj);
+        }
+
+        public bool Equals(ScriptingObject other)
+        {
+            if (other == null)
+            {
+                return false;
+            }
+
+            return
+                string.Equals(this.Type, other.Type, StringComparison.OrdinalIgnoreCase) &&
+                string.Equals(this.Schema, other.Schema, StringComparison.OrdinalIgnoreCase) &&
+                string.Equals(this.Name, other.Name, StringComparison.OrdinalIgnoreCase);
+        }
+    }
+}