adding metadata to object explorer node info (#320)

* adding metadata to oe node info
microsoft · Apr 19, 2017 · 8c0885d · 8c0885d
1 parent 96d46b5
commit 8c0885d
Show file tree

Hide file tree

Showing 16 changed files with 121 additions and 81 deletions.
diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.cs b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.cs
@@ -2053,11 +2053,11 @@ public static string SchemaHierarchy_TableTypeIndexes
             }
         }
 
-        public static string SchemaHierarchy_ServerInstance
+        public static string SchemaHierarchy_Server
         {
             get
             {
-                return Keys.GetString(Keys.SchemaHierarchy_ServerInstance);
+                return Keys.GetString(Keys.SchemaHierarchy_Server);
             }
         }
 
@@ -3036,7 +3036,7 @@ public class Keys
             public const string SchemaHierarchy_TableTypeIndexes = "SchemaHierarchy_TableTypeIndexes";
 
 
-            public const string SchemaHierarchy_ServerInstance = "SchemaHierarchy_ServerInstance";
+            public const string SchemaHierarchy_Server = "SchemaHierarchy_Server";
 
 
             public const string SchemaHierarchy_SelectiveXmlIndexes = "SchemaHierarchy_SelectiveXmlIndexes";

diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.resx b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.resx
@@ -1199,8 +1199,8 @@
     <value>Table Type Indexes</value>
     <comment></comment>
   </data>
-  <data name="SchemaHierarchy_ServerInstance" xml:space="preserve">
-    <value>ServerInstance</value>
+  <data name="SchemaHierarchy_Server" xml:space="preserve">
+    <value>Server</value>
     <comment></comment>
   </data>
   <data name="SchemaHierarchy_SelectiveXmlIndexes" xml:space="preserve">

diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.strings b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.strings
@@ -597,7 +597,7 @@ SchemaHierarchy_ColumnStoreIndexes = Column Store Indexes
 
 SchemaHierarchy_TableTypeIndexes = Table Type Indexes
 
-SchemaHierarchy_ServerInstance = ServerInstance
+SchemaHierarchy_Server = Server
 
 SchemaHierarchy_SelectiveXmlIndexes = Selective XML Indexes
 

diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.xlf b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.xlf
@@ -1351,11 +1351,6 @@
         <target state="new">Table Type Indexes</target>
         <note></note>
       </trans-unit>
-      <trans-unit id="SchemaHierarchy_ServerInstance">
-        <source>ServerInstance</source>
-        <target state="new">ServerInstance</target>
-        <note></note>
-      </trans-unit>
       <trans-unit id="SchemaHierarchy_SelectiveXmlIndexes">
         <source>Selective XML Indexes</source>
         <target state="new">Selective XML Indexes</target>
@@ -1416,6 +1411,11 @@
         <target state="new">Column Encryption Keys</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="SchemaHierarchy_Server">
+        <source>Server</source>
+        <target state="new">Server</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/Contracts/NodeInfo.cs b/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/Contracts/NodeInfo.cs
@@ -3,6 +3,8 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using Microsoft.SqlTools.ServiceLayer.Metadata.Contracts;
+
 namespace Microsoft.SqlTools.ServiceLayer.ObjectExplorer.Contracts
 {
     /// <summary>
@@ -36,5 +38,10 @@ public class NodeInfo
         /// is it expandable?
         /// </summary>
         public bool IsLeaf { get; set; }
+
+        /// <summary>
+        /// Object Metadata for smo objects to be used for scripting
+        /// </summary>
+        public ObjectMetadata Metadata { get; set; }
     }
 }
diff --git a/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/Nodes/NodeTypes.cs b/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/Nodes/NodeTypes.cs
@@ -13,18 +13,17 @@ public enum NodeTypes
     {
         None,
         SqlServersRoot,
-        DatabaseInstance,
-        DacInstance,
-        ServerInstance,
-        ScalarValuedFunctionInstance,
-        TableValuedFunctionInstance,
-        AggregateFunctionInstance,
+        Database,
+        Server,
+        ScalarValuedFunction,
+        TableValuedFunction,
+        AggregateFunction,
         FileGroupInstance,
-        StoredProcedureInstance,
-        UserDefinedTableTypeInstance,
-        ViewInstance,
-        TableInstance,
-        HistoryTableInstance,
+        StoredProcedure,
+        UserDefinedTableType,
+        View,
+        Table,
+        HistoryTable,
         Databases,
         ExternalResources,
         ServerLevelSecurity,
@@ -130,10 +129,10 @@ public enum NodeTypes
         SecurityPolicies,
         DatabaseScopedCredentials,
         ExternalTables,
-        ExternalResourceInstance,
+        ExternalResource,
         ExternalDataSources,
         ExternalFileFormats,
-        ExternalTableInstance,
+        ExternalTable,
         AlwaysEncryptedKeys,
         ColumnMasterKeys,
         ColumnEncryptionKeys

diff --git a/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/Nodes/TreeNode.cs b/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/Nodes/TreeNode.cs
@@ -8,7 +8,7 @@
 using System.Collections.ObjectModel;
 using System.Diagnostics;
 using System.Globalization;
-using System.Linq;
+using Microsoft.SqlTools.ServiceLayer.Metadata.Contracts;
 using Microsoft.SqlTools.ServiceLayer.ObjectExplorer.Contracts;
 using Microsoft.SqlTools.ServiceLayer.ObjectExplorer.SmoModel;
 using Microsoft.SqlTools.Utility;
@@ -52,6 +52,12 @@ public TreeNode(string value)
         /// </summary>
         public string NodeValue { get; set; }
 
+
+        /// <summary>
+        /// Object metadata for smo objects
+        /// </summary>
+        public ObjectMetadata ObjectMetadata { get; set; }
+
         /// <summary>
         /// The type of the node - for example Server, Database, Folder, Table
         /// </summary>
@@ -170,7 +176,8 @@ public NodeInfo ToNodeInfo()
                 IsLeaf = this.IsAlwaysLeaf,
                 Label = this.Label,
                 NodePath = this.GetNodePath(),
-                NodeType = this.NodeType
+                NodeType = this.NodeType,
+                Metadata = this.ObjectMetadata
             };
         }
 

diff --git a/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/SmoModel/ServerNode.cs b/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/SmoModel/ServerNode.cs
@@ -49,8 +49,8 @@ public ServerNode(ConnectionCompleteParams connInfo, IMultiServiceProvider servi
 
             NodeValue = connectionSummary.ServerName;
             IsAlwaysLeaf = false;
-            NodeType = NodeTypes.ServerInstance.ToString();
-            NodeTypeId = NodeTypes.ServerInstance;
+            NodeType = NodeTypes.Server.ToString();
+            NodeTypeId = NodeTypes.Server;
             Label = GetConnectionLabel();
         }
 

diff --git a/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/SmoModel/SmoTreeNode.cs b/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/SmoModel/SmoTreeNode.cs
@@ -56,6 +56,18 @@ public virtual void CacheInfoFromModel(NamedSmoObject smoObject)
         {
             SmoObject = smoObject;
             NodeValue = smoObject.Name;
+            ScriptSchemaObjectBase schemaBasecObject = smoObject as ScriptSchemaObjectBase;
+            ObjectMetadata = new Metadata.Contracts.ObjectMetadata();
+            if (schemaBasecObject != null)
+            {
+                ObjectMetadata.MetadataTypeName = schemaBasecObject.Urn?.Type;
+                ObjectMetadata.Name = schemaBasecObject.Name;
+                ObjectMetadata.Schema = schemaBasecObject.Schema;
+                if (!string.IsNullOrEmpty(ObjectMetadata.Schema))
+                {
+                    NodeValue = $"{ObjectMetadata.Schema}.{smoObject.Name}";
+                }
+            }
         }
 
         public virtual NamedSmoObject GetParentSmoObject()

diff --git a/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/SmoModel/TreeNodeDefinition.xml b/src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/SmoModel/TreeNodeDefinition.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <ServerExplorerTree>
-  <Node Name="ServerInstance" LocLabel="SR.SchemaHierarchy_ServerInstance" Image="Server">
+  <Node Name="Server" LocLabel="SR.SchemaHierarchy_ServerInstance" Image="Server">
     <Child Name="Databases"/>
     <Child Name="ServerLevelSecurity"/>
     <Child Name="ServerLevelServerObjects"/>
@@ -49,7 +49,7 @@
   <Node Name="ServerLevelServerTriggers" LocLabel="SR.SchemaHierarchy_ServerTriggers" BaseClass="ModelBased" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlServerDdlTrigger"/>
   <Node Name="ServerLevelErrorMessages" LocLabel="SR.SchemaHierarchy_ErrorMessages" BaseClass="ModelBased" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlErrorMessage"/>
 
-  <Node Name="DatabaseInstance" LocLabel="string.Empty" Image="Database" BaseClass="ModelBased" IsAsyncLoad="" Strategy="CreateModel">
+  <Node Name="Database" LocLabel="string.Empty" Image="Database" BaseClass="ModelBased" IsAsyncLoad="" Strategy="CreateModel">
     <Child Name="Tables"/>
     <Child Name="Views"/>
     <Child Name="Synonyms"/>
@@ -142,7 +142,7 @@
     </Filters>
   </Node>
 
-  <Node Name="TableInstance" LocLabel="string.Empty" BaseClass="ModelBased" IsAsyncLoad="" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlTable" TreeNode="HistoryTableInstanceTreeNode">
+  <Node Name="Table" LocLabel="string.Empty" BaseClass="ModelBased" IsAsyncLoad="" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlTable" TreeNode="HistoryTableInstanceTreeNode">
     <!-- TODO Add special history table handling to only return related history table instead of all! Under Table, we directly show any related history tables.-->
     <Filters>
       <Filter Property="TemporalType" Type="Enum" ValidFor="Sql2016|SqlvNext|AzureV12">
@@ -158,14 +158,14 @@
   </Node>
 
   <!-- TODO This should use display item not ChildQuerierTypes -->
-  <Node Name="HistoryTableInstance" LocLabel="string.Empty" BaseClass="ModelBased" IsAsyncLoad="" Strategy="PopulateDetails" ChildQuerierTypes="SqlTable" ValidFor="Sql2016|SqlvNext|AzureV12">
+  <Node Name="HistoryTable" LocLabel="string.Empty" BaseClass="ModelBased" IsAsyncLoad="" Strategy="PopulateDetails" ChildQuerierTypes="SqlTable" ValidFor="Sql2016|SqlvNext|AzureV12">
     <Child Name="Columns"/>
     <Child Name="Indexes"/>
     <Child Name="Statistics"/>
   </Node>
 
   <!-- TODO This should use display item not ChildQuerierTypes -->
-  <Node Name="ExternalTableInstance" LocLabel="string.Empty" BaseClass="ModelBased" IsAsyncLoad="" Strategy="PopulateDetails" ChildQuerierTypes="SqlTable" ValidFor="Sql2016|SqlvNext|AzureV12">
+  <Node Name="ExternalTable" LocLabel="string.Empty" BaseClass="ModelBased" IsAsyncLoad="" Strategy="PopulateDetails" ChildQuerierTypes="SqlTable" ValidFor="Sql2016|SqlvNext|AzureV12">
     <Child Name="Columns"/>
     <Child Name="Statistics"/>
   </Node>
@@ -192,7 +192,7 @@
 
   <Node Name="SystemViews" LocLabel="SR.SchemaHierarchy_SystemViews" BaseClass="ModelBased" IsMsShippedOwned="true" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlView" TreeNode="ViewInstanceTreeNode"/>
 
-  <Node Name="ViewInstance" LocLabel="string.Empty" BaseClass="ModelBased" IsAsyncLoad="" Strategy="PopulateDetails">
+  <Node Name="View" LocLabel="string.Empty" BaseClass="ModelBased" IsAsyncLoad="" Strategy="PopulateDetails">
     <Child Name="Columns"/>
     <Child Name="Triggers"/>
     <Child Name="Indexes"/>
@@ -233,7 +233,7 @@
   <Node Name="UserDefinedTypes" LocLabel="SR.SchemaHierarchy_UserDefinedTypes" BaseClass="ModelBased" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlUserDefinedType" ValidFor="Sql2005|Sql2008|Sql2012|Sql2014|Sql2016|SqlvNext|AzureV12"/>
   <Node Name="XmlSchemaCollections" LocLabel="SR.SchemaHierarchy_XMLSchemaCollections" BaseClass="ModelBased" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlXmlSchemaCollection" ValidFor="Sql2005|Sql2008|Sql2012|Sql2014|Sql2016|SqlvNext|AzureV12"/>
 
-  <Node Name="UserDefinedTableTypeInstance" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
+  <Node Name="UserDefinedTableType" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
     <Child Name="UserDefinedTableTypeColumns"/>
     <Child Name="UserDefinedTableTypeKeys"/>
     <Child Name="UserDefinedTableTypeConstraints"/>
@@ -267,7 +267,7 @@
     <Child Name="SystemStoredProcedures"/>
   </Node>
   <Node Name="SystemStoredProcedures" LocLabel="SR.SchemaHierarchy_SystemStoredProcedures" BaseClass="ModelBased" IsMsShippedOwned="true" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlProcedure" TreeNode="StoredProcedureInstanceTreeNode"/>
-  <Node Name="StoredProcedureInstance" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
+  <Node Name="StoredProcedure" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
     <Child Name="StoredProcedureParameters"/>
   </Node>
   <Node Name="StoredProcedureParameters" LocLabel="SR.SchemaHierarchy_Parameters"  BaseClass="ModelBased" Strategy="StoredProcedureParameters" ChildQuerierTypes="SqlSubroutineParameter" DisableSort=""/>
@@ -279,7 +279,7 @@
       </Filter>
     </Filters>
   </Node>
-  <Node Name="TableValuedFunctionInstance" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
+  <Node Name="TableValuedFunction" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
     <Child Name="TableValuedFunctionParameters"/>
   </Node>
   <Node Name="TableValuedFunctionParameters" LocLabel="SR.SchemaHierarchy_Parameters"  BaseClass="ModelBased" Strategy="FunctionParameters" ChildQuerierTypes="SqlSubroutineParameter" DisableSort=""/>
@@ -291,13 +291,13 @@
       </Filter>
     </Filters>
   </Node>
-  <Node Name="ScalarValuedFunctionInstance" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
+  <Node Name="ScalarValuedFunction" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
     <Child Name="ScalarValuedFunctionParameters"/>
   </Node>
   <Node Name="ScalarValuedFunctionParameters" LocLabel="SR.SchemaHierarchy_Parameters"  BaseClass="ModelBased" Strategy="FunctionParameters" ChildQuerierTypes="SqlSubroutineParameter" DisableSort=""/>
 
   <Node Name="AggregateFunctions" LocLabel="SR.SchemaHierarchy_AggregateFunctions" BaseClass="ModelBased" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlUserDefinedAggregate" TreeNode="AggregateFunctionInstanceTreeNode" ValidFor="Sql2005|Sql2008|Sql2012|Sql2014|Sql2016|SqlvNext|AzureV12"/>
-  <Node Name="AggregateFunctionInstance" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
+  <Node Name="AggregateFunction" LocLabel="string.Empty" BaseClass="ModelBased" ChildQuerierTypes="" IsAsyncLoad="" Strategy="PopulateDetails">
     <Child Name="AggregateFunctionParameters"/>
   </Node>
   <Node Name="AggregateFunctionParameters" LocLabel="SR.SchemaHierarchy_Parameters"  BaseClass="ModelBased" Strategy="PopulateParentDetails" ChildQuerierTypes="SqlSubroutineParameter" DisableSort=""/>