mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-14 09:59:48 -05:00
4aac4a4047
Update the ScriptingService to expose new scripting JSON-RPC APIs that use the SqlScriptPublishModel for script generation. The SqlScriptPublishModel is the model behind the SSMS scripting wizard. To enable scripting for CLI tools, we've ported SqlScriptPublishModel to .NET Core. The SqlScriptPublishModel wraps the SMO scripting APIs for .sql script generation. 1) Added three new requests to the ScriptingService: ScriptingRequest, ScriptingListObjectsRequest, ScriptingCancelRequest. 2) Generating scripts are long running operations, so the ScriptingRequest and ScriptingListObjectsRequest kick off a long running scripting task and return immediately. 3) Long running scripting task reports progress and completion, and can be cancelled by a ScriptingCancelRequest request. 4) Bumped the SMO nuget package to 140.17049.0. This new version contains a signed SSMS_Rel build of SMO with the SqlScriptPublishModel. 5) For testing, adding the Northwind database schema TODO (in later pull requests) 1) Integrate the new ScriptingService APIs with the ConnectionService 2) Integrate with the metadata support recently added
57 lines
1.8 KiB
C#
57 lines
1.8 KiB
C#
//
|
|
// 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.Threading;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.SqlTools.Utility;
|
|
|
|
namespace Microsoft.SqlTools.ServiceLayer.Scripting
|
|
{
|
|
/// <summary>
|
|
/// Base class for scripting operations. Because scripting operations can be very long
|
|
/// running, there my be multiple concurrent scripting operations. To distinguish events
|
|
/// between concurrent scripting operations, use the operation id.
|
|
/// </summary>
|
|
public abstract class ScriptingOperation : IDisposable
|
|
{
|
|
private CancellationTokenSource cancellation = new CancellationTokenSource();
|
|
|
|
protected ScriptingOperation()
|
|
{
|
|
this.OperationId = Guid.NewGuid().ToString();
|
|
}
|
|
|
|
protected CancellationToken CancellationToken { get { return this.cancellation.Token; } }
|
|
|
|
/// <summary>
|
|
/// Gets the unique id associated with this instance.
|
|
/// </summary>
|
|
public string OperationId { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Excecutes the scripting operation.
|
|
/// </summary>
|
|
public abstract void Execute();
|
|
|
|
/// <summary>
|
|
/// Cancels the scripting operation.
|
|
/// </summary>
|
|
public virtual void Cancel()
|
|
{
|
|
if (!this.cancellation.IsCancellationRequested)
|
|
{
|
|
Logger.Write(LogLevel.Verbose, string.Format("Cancel invoked for OperationId {0}", this.OperationId));
|
|
this.cancellation.Cancel();
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Disposes the scripting operation.
|
|
/// </summary>
|
|
public abstract void Dispose();
|
|
}
|
|
}
|