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.Hosting/Utility/Extensions.cs

@@ -56,4 +56,26 @@ public static bool HasTrue(this bool? obj)
             return obj.HasValue && obj.Value;
         }
     }
+
+    public static class ExceptionExtensions
+    {
+        /// <summary>
+        /// Returns true if the passed exception or any inner exception is an OperationCanceledException instance.
+        /// </summary>
+        public static bool IsOperationCanceledException(this Exception e)
+        {
+            Exception current = e;
+            while (current != null)
+            {
+                if (current is OperationCanceledException)
+                {
+                    return true;
+                }
+
+                current = current.InnerException;
+            }
+
+            return false;
+        }
+    }
 }

src/Microsoft.SqlTools.ServiceLayer/Localization/sr.cs

@@ -2157,6 +2157,30 @@ public static string SchemaHierarchy_ColumnEncryptionKeys
             }
         }
 
+        public static string ScriptingParams_ConnectionString_Property_Invalid
+        {
+            get
+            {
+                return Keys.GetString(Keys.ScriptingParams_ConnectionString_Property_Invalid);
+            }
+        }
+
+        public static string ScriptingParams_FilePath_Property_Invalid
+        {
+            get
+            {
+                return Keys.GetString(Keys.ScriptingParams_FilePath_Property_Invalid);
+            }
+        }
+
+        public static string ScriptingListObjectsCompleteParams_ConnectionString_Property_Invalid
+        {
+            get
+            {
+                return Keys.GetString(Keys.ScriptingListObjectsCompleteParams_ConnectionString_Property_Invalid);
+            }
+        }
+
         public static string ConnectionServiceListDbErrorNotConnected(string uri)
         {
             return Keys.GetString(Keys.ConnectionServiceListDbErrorNotConnected, uri);
@@ -3075,6 +3099,15 @@ public class Keys
             public const string SchemaHierarchy_ColumnEncryptionKeys = "SchemaHierarchy_ColumnEncryptionKeys";
 
 
+            public const string ScriptingParams_ConnectionString_Property_Invalid = "ScriptingParams_ConnectionString_Property_Invalid";
+
+
+            public const string ScriptingParams_FilePath_Property_Invalid = "ScriptingParams_FilePath_Property_Invalid";
+
+
+            public const string ScriptingListObjectsCompleteParams_ConnectionString_Property_Invalid = "ScriptingListObjectsCompleteParams_ConnectionString_Property_Invalid";
+
+
             private Keys()
             { }
 

src/Microsoft.SqlTools.ServiceLayer/Localization/sr.resx

@@ -1251,4 +1251,16 @@
     <value>Column Encryption Keys</value>
     <comment></comment>
   </data>
+  <data name="ScriptingParams_ConnectionString_Property_Invalid" xml:space="preserve">
+    <value>Error parsing ScriptingParams.ConnectionString property.</value>
+    <comment></comment>
+  </data>
+  <data name="ScriptingParams_FilePath_Property_Invalid" xml:space="preserve">
+    <value>Invalid directory specified by the ScriptingParams.FilePath property.</value>
+    <comment></comment>
+  </data>
+  <data name="ScriptingListObjectsCompleteParams_ConnectionString_Property_Invalid" xml:space="preserve">
+    <value>Error parsing ScriptingListObjectsCompleteParams.ConnectionString property.</value>
+    <comment></comment>
+  </data>
 </root>

src/Microsoft.SqlTools.ServiceLayer/Localization/sr.strings

@@ -623,3 +623,11 @@ SchemaHierarchy_ColumnMasterKeys = Column Master Keys
 
 SchemaHierarchy_ColumnEncryptionKeys = Column Encryption Keys
 
+############################################################################
+# Scripting Service
+
+ScriptingParams_ConnectionString_Property_Invalid = Error parsing ScriptingParams.ConnectionString property.
+
+ScriptingParams_FilePath_Property_Invalid = Invalid directory specified by the ScriptingParams.FilePath property.
+
+ScriptingListObjectsCompleteParams_ConnectionString_Property_Invalid = Error parsing ScriptingListObjectsCompleteParams.ConnectionString property.

src/Microsoft.SqlTools.ServiceLayer/Localization/sr.xlf

@@ -1416,6 +1416,21 @@
         <target state="new">Server</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="ScriptingParams_ConnectionString_Property_Invalid">
+        <source>Error parsing ScriptingParams.ConnectionString property.</source>
+        <target state="new">Error parsing ScriptingParams.ConnectionString property.</target>
+        <note></note>
+      </trans-unit>
+      <trans-unit id="ScriptingParams_FilePath_Property_Invalid">
+        <source>Invalid directory specified by the ScriptingParams.FilePath property.</source>
+        <target state="new">Invalid directory specified by the ScriptingParams.FilePath property.</target>
+        <note></note>
+      </trans-unit>
+      <trans-unit id="ScriptingListObjectsCompleteParams_ConnectionString_Property_Invalid">
+        <source>Error parsing ScriptingListObjectsCompleteParams.ConnectionString property.</source>
+        <target state="new">Error parsing ScriptingListObjectsCompleteParams.ConnectionString property.</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

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

@@ -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.SqlTools.Hosting.Protocol.Contracts;
+
+namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
+{
+    /// <summary>
+    /// Parameters to cancel a scripting request.
+    /// </summary>
+    public class ScriptingCancelParams : ScriptingEventParams { }
+
+    /// <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,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 to when a scripting operation has completed.
+    /// </summary>
+    public class ScriptingCompleteParams : ScriptingEventParams
+    {
+        public string ErrorDetails { get; set; }
+
+        public string ErrorMessage { get; set; }
+
+        public bool HasError { get; set; }
+
+        public bool Canceled { get; set; }
+
+        public bool Success { get; set; }
+    }
+
+    /// <summary>
+    /// Event sent to indicate a scripting operation has completed.
+    /// </summary>
+    public class ScriptingCompleteEvent
+    {
+        public static readonly EventType<ScriptingCompleteParams> Type = 
+            EventType<ScriptingCompleteParams>.Create("scripting/scriptComplete");
+    }
+}

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,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 sent when a list objects operation has completed.
+    /// </summary>
+    public class ScriptingListObjectsCompleteParams : ScriptingCompleteParams
+    {
+        /// <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<ScriptingListObjectsCompleteParams> Type = 
+            EventType<ScriptingListObjectsCompleteParams>.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");
+    }
+}