mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-14 01:25:40 -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
94 lines
2.9 KiB
C#
94 lines
2.9 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.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);
|
|
}
|
|
}
|
|
}
|