Rename GetTopicIDByUniqueKey to GetTopicID

JeremyCaney · JeremyCaney · commit 10a9c0c99fd6 · 2020-12-21T14:52:18.000-08:00
Now that we've deleted the legacy (and flakey!) `GetTopicID` function in preference for the new(er) `GetTopicIDByUniqueKey` function, we can rename the `GetTopicIDByUniqueKey` to the unqualified name `GetTopicID`. This is a more intuitive name now that there's no longer a `GetTopicID` function (ff58a71). As part of this, updated the reference in `SqlTopicRepository`, the `GetTopics` stored procedure, as well as the `OnTopic.Data.Sql.Database` documentation (`README.md`).
diff --git a/OnTopic.Data.Sql.Database/Functions/GetTopicID.sql b/OnTopic.Data.Sql.Database/Functions/GetTopicID.sql
@@ -1,12 +1,12 @@
 ﻿--------------------------------------------------------------------------------------------------------------------------------
--- GET TOPIC ID BY UNIQUE KEY
+-- GET TOPIC ID
 --------------------------------------------------------------------------------------------------------------------------------
 -- Given a fully-qualified unique key, finds the TopicID associated with that key. Unlike [GetTopicID], this is guaranteed to
 -- return an exclusive instance.
 --------------------------------------------------------------------------------------------------------------------------------
 
 CREATE
-FUNCTION	[dbo].[GetTopicIDByUniqueKey]
+FUNCTION	[dbo].[GetTopicID]
 (
 	@UniqueKey		NVARCHAR(2500)
 )
diff --git a/OnTopic.Data.Sql.Database/OnTopic.Data.Sql.Database.sqlproj b/OnTopic.Data.Sql.Database/OnTopic.Data.Sql.Database.sqlproj
@@ -83,9 +83,9 @@
     <Build Include="Utilities\Stored Procedures\DeleteOrphanedLastModifiedAttributes.sql" />
     <Build Include="Utilities\Stored Procedures\DeleteConsecutiveAttributes.sql" />
     <Build Include="Utilities\Stored Procedures\ConsolidateVersions.sql" />
-    <Build Include="Functions\GetTopicIDByUniqueKey.sql" />
     <Build Include="Functions\GetExtendedAttribute.sql" />
     <Build Include="Functions\GetUniqueKey.sql" />
+    <Build Include="Functions\GetTopicID.sql" />
     <Build Include="Utilities\Views\UniqueKeyIndex.sql" />
     <Build Include="Utilities\Views\LeftRightRange.sql" />
     <Build Include="Utilities\Tables\AdjacencyList.sql" />
diff --git a/OnTopic.Data.Sql.Database/README.md b/OnTopic.Data.Sql.Database/README.md
@@ -36,8 +36,7 @@ The following is a summary of the most relevant stored procedures.
 - **[`UpdateRelationships`](Stored%20Procedures/UpdateRelationships.sql)**: Associates a relationship with a topic based on a `@TopicId`, `TopicList` array of `@Target_TopicIds`, and a `@RelationshipKey` (which can be any string label).
 
 ## Functions
-- **[`GetTopicID`](Functions/GetTopicID.sql)**: Retrieves a topic's `TopicId` based on a corresponding `@TopicKey`.
-- **[`GetTopicIDByUniqueKey`](Functions/GetTopicIDByUniqueKey.sql)**: Retrieves a topic's `TopicId` based on a corresponding `@UniqueKey` (e.g., `Root:Configuration`).
+- **[`GetTopicID`](Functions/GetTopicID.sql)**: Retrieves a topic's `TopicId` based on a corresponding `@UniqueKey` (e.g., `Root:Configuration`).
 - **[`GetUniqueKey`](Functions/GetUniqueKey.sql)**: Retrieves a topic's `UniqueKey` based on a corresponding `@TopicID`.
 - **[`GetParentID`](Functions/GetParentID.sql)**: Retrieves a topic's parent's `TopicID` based the child's `@TopicID`.
 - **[`GetAttributes`](functions/GetAttributes.sql)**: Given a `@TopicID`, provides the latest version of each attribute value from both `Attributes` and `ExtendedAttributes`, excluding key attributes (i.e., `Key`, `ContentType`, and `ParentID`).
diff --git a/OnTopic.Data.Sql.Database/Stored Procedures/GetTopics.sql b/OnTopic.Data.Sql.Database/Stored Procedures/GetTopics.sql
@@ -16,12 +16,12 @@ AS
 --------------------------------------------------------------------------------------------------------------------------------
 IF @UniqueKey IS NOT NULL
   BEGIN
-    SET	@TopicID		= dbo.GetTopicIDByUniqueKey(@UniqueKey)
+    SET	@TopicID		= dbo.GetTopicID(@UniqueKey)
   END
 
 IF @TopicID < 0
   BEGIN
-    SET	@TopicID		= dbo.GetTopicIDByUniqueKey('Root')
+    SET	@TopicID		= dbo.GetTopicID('Root')
   END
 
 --------------------------------------------------------------------------------------------------------------------------------
diff --git a/OnTopic.Data.Sql/SqlTopicRepository.cs b/OnTopic.Data.Sql/SqlTopicRepository.cs
@@ -77,7 +77,7 @@ public override Topic Load(string? uniqueKey = null, bool isRecursive = true) {
       | Establish database connection
       \-----------------------------------------------------------------------------------------------------------------------*/
       using var connection      = new SqlConnection(_connectionString);
-      using var command         = new SqlCommand("GetTopicIDByUniqueKey", connection);
+      using var command         = new SqlCommand("GetTopicID", connection);
 
       var topicId               = -1;
 

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,12 @@`
`1`	`1`	`--------------------------------------------------------------------------------------------------------------------------------`
`2`		`--- GET TOPIC ID BY UNIQUE KEY`
	`2`	`+-- GET TOPIC ID`
`3`	`3`	`--------------------------------------------------------------------------------------------------------------------------------`
`4`	`4`	`-- Given a fully-qualified unique key, finds the TopicID associated with that key. Unlike [GetTopicID], this is guaranteed to`
`5`	`5`	`-- return an exclusive instance.`
`6`	`6`	`--------------------------------------------------------------------------------------------------------------------------------`
`7`	`7`
`8`	`8`	`CREATE`
`9`		`-FUNCTION [dbo].[GetTopicIDByUniqueKey]`
	`9`	`+FUNCTION [dbo].[GetTopicID]`
`10`	`10`	`(`
`11`	`11`	`@UniqueKey NVARCHAR(2500)`
`12`	`12`	`)`