Persistence Model: Replace some hard coded strings in DTOs

src/Umbraco.Core/Persistence/Constants-DatabaseSchema.cs

@@ -9,8 +9,20 @@ public static class DatabaseSchema
         // TODO: Why aren't all table names with the same prefix?
         public const string TableNamePrefix = "umbraco";
 
+        public static class Columns
+        {
+            // Defines constants for common field names used throughout the database, to ensure
+            // casing is aligned wherever used.
+            public const string PrimaryKeyNameId = "id";
+            public const string PrimaryKeyNamePk = "pk";
+            public const string PrimaryKeyNameKey = "key";
+            public const string NodeIdName = "nodeId";
+            public const string UniqueIdName = "uniqueId";
+        }
+
         public static class Tables
         {
+
             public const string Lock = TableNamePrefix + "Lock";
             public const string Log = TableNamePrefix + "Log";
 

src/Umbraco.Infrastructure/Persistence/Dtos/AccessDto.cs

@@ -6,13 +6,14 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("id", AutoIncrement = false)]
+[PrimaryKey(PrimaryKeyColumnName, AutoIncrement = false)]
 [ExplicitColumns]
 internal sealed class AccessDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.Access;
+    public const string PrimaryKeyColumnName = Constants.DatabaseSchema.Columns.PrimaryKeyNameId;
 
-    [Column("id")]
+    [Column(PrimaryKeyColumnName)]
     [PrimaryKeyColumn(Name = "PK_umbracoAccess", AutoIncrement = false)]
     public Guid Id { get; set; }
 
@@ -38,6 +39,6 @@ internal sealed class AccessDto
     public DateTime UpdateDate { get; set; }
 
     [ResultColumn]
-    [Reference(ReferenceType.Many, ReferenceMemberName = "AccessId")]
+    [Reference(ReferenceType.Many, ReferenceMemberName = AccessRuleDto.AccessIdColumnName)]
     public List<AccessRuleDto> Rules { get; set; } = new();
 }

src/Umbraco.Infrastructure/Persistence/Dtos/AccessRuleDto.cs

@@ -6,24 +6,31 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("id", AutoIncrement = false)]
+[PrimaryKey(PrimaryKeyColumnName, AutoIncrement = false)]
 [ExplicitColumns]
 internal sealed class AccessRuleDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.AccessRule;
-    [Column("id")]
+    public const string PrimaryKeyColumnName = Constants.DatabaseSchema.Columns.PrimaryKeyNameId;
+
+    internal const string AccessIdColumnName = "accessId";
+
+    private const string RuleValueColumnName = "ruleValue";
+    private const string RuleTypeColumnName = "ruleType";
+
+    [Column(PrimaryKeyColumnName)]
     [PrimaryKeyColumn(Name = "PK_umbracoAccessRule", AutoIncrement = false)]
     public Guid Id { get; set; }
 
-    [Column("accessId")]
+    [Column(AccessIdColumnName)]
     [ForeignKey(typeof(AccessDto), Name = "FK_umbracoAccessRule_umbracoAccess_id")]
     public Guid AccessId { get; set; }
 
-    [Column("ruleValue")]
-    [Index(IndexTypes.UniqueNonClustered, ForColumns = "ruleValue,ruleType,accessId", Name = "IX_umbracoAccessRule")]
+    [Column(RuleValueColumnName)]
+    [Index(IndexTypes.UniqueNonClustered, ForColumns = $"{RuleValueColumnName},{RuleTypeColumnName},{AccessIdColumnName}", Name = "IX_umbracoAccessRule")]
     public string? RuleValue { get; set; }
 
-    [Column("ruleType")]
+    [Column(RuleTypeColumnName)]
     public string? RuleType { get; set; }
 
     [Column("createDate")]

src/Umbraco.Infrastructure/Persistence/Dtos/AuditEntryDto.cs

@@ -6,13 +6,14 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("id")]
+[PrimaryKey(PrimaryKeyColumnName)]
 [ExplicitColumns]
 internal sealed class AuditEntryDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.AuditEntry;
+    public const string PrimaryKeyColumnName = Constants.DatabaseSchema.Columns.PrimaryKeyNameId;
 
-    [Column("id")]
+    [Column(PrimaryKeyColumnName)]
     [PrimaryKeyColumn]
     public int Id { get; set; }
 

src/Umbraco.Infrastructure/Persistence/Dtos/CacheInstructionDto.cs

@@ -5,13 +5,14 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("id")]
+[PrimaryKey(PrimaryKeyColumnName)]
 [ExplicitColumns]
 public class CacheInstructionDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.CacheInstruction;
+    public const string PrimaryKeyColumnName = Constants.DatabaseSchema.Columns.PrimaryKeyNameId;
 
-    [Column("id")]
+    [Column(PrimaryKeyColumnName)]
     [NullSetting(NullSetting = NullSettings.NotNull)]
     [PrimaryKeyColumn(AutoIncrement = true, Name = "PK_umbracoCacheInstruction")]
     public int Id { get; set; }

src/Umbraco.Infrastructure/Persistence/Dtos/ConsentDto.cs

@@ -6,13 +6,14 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("id")]
+[PrimaryKey(PrimaryKeyColumnName)]
 [ExplicitColumns]
 public class ConsentDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.Consent;
+    public const string PrimaryKeyColumnName = Constants.DatabaseSchema.Columns.PrimaryKeyNameId;
 
-    [Column("id")]
+    [Column(PrimaryKeyColumnName)]
     [PrimaryKeyColumn]
     public int Id { get; set; }
 

src/Umbraco.Infrastructure/Persistence/Dtos/ContentDto.cs

@@ -5,29 +5,33 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("nodeId", AutoIncrement = false)]
+[PrimaryKey(PrimaryKeyColumnName, AutoIncrement = false)]
 [ExplicitColumns]
 public class ContentDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.Content;
+    public const string PrimaryKeyColumnName = Constants.DatabaseSchema.Columns.NodeIdName;
+    public const string ContentTypeIdColumnName = "contentTypeId";
 
-    [Column("nodeId")]
+    internal const string ReferenceMemberName = "NodeId"; // should be ContentVersionDto.NodeIdColumnName, but for database compatibility we keep it like this
+
+    [Column(PrimaryKeyColumnName)]
     [PrimaryKeyColumn(AutoIncrement = false)]
     [ForeignKey(typeof(NodeDto))]
     public int NodeId { get; set; }
 
-    [Column("contentTypeId")]
-    [ForeignKey(typeof(ContentTypeDto), Column = "nodeId")]
+    [Column(ContentTypeIdColumnName)]
+    [ForeignKey(typeof(ContentTypeDto), Column = ContentTypeDto.NodeIdColumnName)]
     public int ContentTypeId { get; set; }
 
     [ResultColumn]
-    [Reference(ReferenceType.OneToOne, ColumnName = "nodeId")]
+    [Reference(ReferenceType.OneToOne, ColumnName = PrimaryKeyColumnName)]
     public NodeDto NodeDto { get; set; } = null!;
 
     // although a content has many content versions,
     // they can only be loaded one by one (as several content),
     // so this here is a OneToOne reference
     [ResultColumn]
-    [Reference(ReferenceType.OneToOne, ReferenceMemberName = "nodeId")]
+    [Reference(ReferenceType.OneToOne, ReferenceMemberName = ReferenceMemberName)]
     public ContentVersionDto ContentVersionDto { get; set; } = null!;
 }

src/Umbraco.Infrastructure/Persistence/Dtos/ContentNuDto.cs

@@ -6,19 +6,24 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("nodeId", AutoIncrement = false)]
+[PrimaryKey(PrimaryKeyColumnName, AutoIncrement = false)]
 [ExplicitColumns]
 public class ContentNuDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.NodeData;
+    public const string PrimaryKeyColumnName = Constants.DatabaseSchema.Columns.NodeIdName;
 
-    [Column("nodeId")]
-    [PrimaryKeyColumn(AutoIncrement = false, Name = "PK_cmsContentNu", OnColumns = "nodeId, published")]
-    [ForeignKey(typeof(ContentDto), Column = "nodeId", OnDelete = Rule.Cascade)]
+    private const string PublishedColumnName = "published";
+    private const string RvColumnName = "rv";
+    private const string DataRawColumnName = "dataRaw";
+
+    [Column(PrimaryKeyColumnName)]
+    [PrimaryKeyColumn(AutoIncrement = false, Name = "PK_cmsContentNu", OnColumns = $"{PrimaryKeyColumnName}, {PublishedColumnName}")]
+    [ForeignKey(typeof(ContentDto), Column = PrimaryKeyColumnName, OnDelete = Rule.Cascade)]
     public int NodeId { get; set; }
 
-    [Column("published")]
-    [Index(IndexTypes.NonClustered, Name = "IX_" + TableName + "_published", ForColumns = "published,nodeId,rv", IncludeColumns = "dataRaw")]
+    [Column(PublishedColumnName)]
+    [Index(IndexTypes.NonClustered, Name = "IX_" + TableName + "_" + PublishedColumnName, ForColumns = $"{PublishedColumnName},{PrimaryKeyColumnName},{RvColumnName}", IncludeColumns = DataRawColumnName)]
     public bool Published { get; set; }
 
     /// <summary>
@@ -32,10 +37,10 @@ public class ContentNuDto
     [NullSetting(NullSetting = NullSettings.Null)]
     public string? Data { get; set; }
 
-    [Column("rv")]
+    [Column(RvColumnName)]
     public long Rv { get; set; }
 
-    [Column("dataRaw")]
+    [Column(DataRawColumnName)]
     [NullSetting(NullSetting = NullSettings.Null)]
     public byte[]? RawData { get; set; }
 }

src/Umbraco.Infrastructure/Persistence/Dtos/ContentScheduleDto.cs

@@ -5,13 +5,14 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("id", AutoIncrement = false)]
+[PrimaryKey(PrimaryKeyColumnName, AutoIncrement = false)]
 [ExplicitColumns]
 internal sealed class ContentScheduleDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.ContentSchedule;
+    public const string PrimaryKeyColumnName = Constants.DatabaseSchema.Columns.PrimaryKeyNameId;
 
-    [Column("id")]
+    [Column(PrimaryKeyColumnName)]
     [PrimaryKeyColumn(AutoIncrement = false)]
     public Guid Id { get; set; }
 

src/Umbraco.Infrastructure/Persistence/Dtos/ContentType2ContentTypeDto.cs

@@ -9,13 +9,15 @@ namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 internal sealed class ContentType2ContentTypeDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.ContentTypeTree;
+    public const string PrimaryKeyColumnName = "parentContentTypeId";
+    public const string ChildIdColumnName = "childContentTypeId";
 
-    [Column("parentContentTypeId")]
-    [PrimaryKeyColumn(AutoIncrement = false, Clustered = true, Name = "PK_cmsContentType2ContentType", OnColumns = "parentContentTypeId, childContentTypeId")]
+    [Column(PrimaryKeyColumnName)]
+    [PrimaryKeyColumn(AutoIncrement = false, Clustered = true, Name = "PK_cmsContentType2ContentType", OnColumns = $"{PrimaryKeyColumnName}, {ChildIdColumnName}")]
     [ForeignKey(typeof(NodeDto), Name = "FK_cmsContentType2ContentType_umbracoNode_parent")]
     public int ParentId { get; set; }
 
-    [Column("childContentTypeId")]
+    [Column(ChildIdColumnName)]
     [ForeignKey(typeof(NodeDto), Name = "FK_cmsContentType2ContentType_umbracoNode_child")]
     public int ChildId { get; set; }
 }

src/Umbraco.Infrastructure/Persistence/Dtos/ContentTypeAllowedContentTypeDto.cs

@@ -5,22 +5,28 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("Id", AutoIncrement = false)]
+[PrimaryKey(PrimaryKeyColumnName, AutoIncrement = false)]
 [ExplicitColumns]
 internal sealed class ContentTypeAllowedContentTypeDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.ContentChildType;
 
-    [Column("Id")]
-    [ForeignKey(typeof(ContentTypeDto), Name = "FK_cmsContentTypeAllowedContentType_cmsContentType", Column = "nodeId")]
-    [PrimaryKeyColumn(AutoIncrement = false, Clustered = true, Name = "PK_cmsContentTypeAllowedContentType", OnColumns = "Id, AllowedId")]
+    // To avoid any risk of casing bugs caused by inconsistencies between upgraded and new installs, we keep the casing "Id" here even though in other tables the usual casing is lower-case ("id").
+    public const string PrimaryKeyColumnName = "Id";
+    public const string NodeIdColumnName = Constants.DatabaseSchema.Columns.NodeIdName;
+    public const string SortOrderColumnName = "SortOrder";
+    public const string AllowedIdColumnName = "AllowedId";
+
+    [Column(PrimaryKeyColumnName)]
+    [ForeignKey(typeof(ContentTypeDto), Name = "FK_cmsContentTypeAllowedContentType_cmsContentType", Column = NodeIdColumnName)]
+    [PrimaryKeyColumn(AutoIncrement = false, Clustered = true, Name = "PK_cmsContentTypeAllowedContentType", OnColumns = $"{PrimaryKeyColumnName}, {AllowedIdColumnName}")]
     public int Id { get; set; }
 
-    [Column("AllowedId")]
-    [ForeignKey(typeof(ContentTypeDto), Name = "FK_cmsContentTypeAllowedContentType_cmsContentType1", Column = "nodeId")]
+    [Column(AllowedIdColumnName)]
+    [ForeignKey(typeof(ContentTypeDto), Name = "FK_cmsContentTypeAllowedContentType_cmsContentType1", Column = NodeIdColumnName)]
     public int AllowedId { get; set; }
 
-    [Column("SortOrder")]
+    [Column(SortOrderColumnName)]
     [Constraint(Name = "df_cmsContentTypeAllowedContentType_sortOrder", Default = "0")]
     public int SortOrder { get; set; }
 

src/Umbraco.Infrastructure/Persistence/Dtos/ContentTypeDto.cs

@@ -5,21 +5,26 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("pk")]
+[PrimaryKey(PrimaryKeyColumnName)]
 [ExplicitColumns]
 internal class ContentTypeDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.ContentType;
+    public const string PrimaryKeyColumnName = Constants.DatabaseSchema.Columns.PrimaryKeyNamePk;
+    public const string NodeIdColumnName = Constants.DatabaseSchema.Columns.NodeIdName;
+
+    internal const string ReferenceColumnName = "NodeId"; // should be ContentTypeDto.NodeIdColumnName, but for database compatibility we keep it like this
+
     private string? _alias;
 
     // Public constants to bind properties between DTOs
     public const string VariationsColumnName = "variations";
 
-    [Column("pk")]
+    [Column(PrimaryKeyColumnName)]
     [PrimaryKeyColumn(IdentitySeed = 700)]
     public int PrimaryKey { get; set; }
 
-    [Column("nodeId")]
+    [Column(NodeIdColumnName)]
     [ForeignKey(typeof(NodeDto))]
     [Index(IndexTypes.UniqueNonClustered, Name = "IX_cmsContentType")]
     public int NodeId { get; set; }
@@ -59,6 +64,6 @@ internal class ContentTypeDto
     public byte Variations { get; set; }
 
     [ResultColumn]
-    [Reference(ReferenceType.OneToOne, ColumnName = "NodeId")]
+    [Reference(ReferenceType.OneToOne, ColumnName = ReferenceColumnName)]
     public NodeDto NodeDto { get; set; } = null!;
 }

src/Umbraco.Infrastructure/Persistence/Dtos/ContentTypeTemplateDto.cs

@@ -5,20 +5,22 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("contentTypeNodeId", AutoIncrement = false)]
+[PrimaryKey(PrimaryKeyName, AutoIncrement = false)]
 [ExplicitColumns]
 internal sealed class ContentTypeTemplateDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.DocumentType;
+    public const string PrimaryKeyName = "contentTypeNodeId";
+    public const string TemplateNodeIdName = "templateNodeId";
 
-    [Column("contentTypeNodeId")]
-    [PrimaryKeyColumn(AutoIncrement = false, Name = "PK_cmsDocumentType", OnColumns = "contentTypeNodeId, templateNodeId")]
-    [ForeignKey(typeof(ContentTypeDto), Column = "nodeId")]
+    [Column(PrimaryKeyName)]
+    [PrimaryKeyColumn(AutoIncrement = false, Name = "PK_cmsDocumentType", OnColumns = $"{PrimaryKeyName}, {TemplateNodeIdName}")]
+    [ForeignKey(typeof(ContentTypeDto), Column = ContentTypeDto.NodeIdColumnName)]
     [ForeignKey(typeof(NodeDto))]
     public int ContentTypeNodeId { get; set; }
 
-    [Column("templateNodeId")]
-    [ForeignKey(typeof(TemplateDto), Column = "nodeId")]
+    [Column(TemplateNodeIdName)]
+    [ForeignKey(typeof(TemplateDto), Column = TemplateDto.NodeIdColumnName)]
     public int TemplateNodeId { get; set; }
 
     [Column("IsDefault")]

src/Umbraco.Infrastructure/Persistence/Dtos/ContentVersionCleanupPolicyDto.cs

@@ -5,15 +5,16 @@
 namespace Umbraco.Cms.Infrastructure.Persistence.Dtos;
 
 [TableName(TableName)]
-[PrimaryKey("contentTypeId", AutoIncrement = false)]
+[PrimaryKey(PrimaryKeyName, AutoIncrement = false)]
 [ExplicitColumns]
 internal sealed class ContentVersionCleanupPolicyDto
 {
     public const string TableName = Constants.DatabaseSchema.Tables.ContentVersionCleanupPolicy;
+    public const string PrimaryKeyName = "contentTypeId";
 
-    [Column("contentTypeId")]
+    [Column(PrimaryKeyName)]
     [PrimaryKeyColumn(AutoIncrement = false, Name = "PK_umbracoContentVersionCleanupPolicy")]
-    [ForeignKey(typeof(ContentTypeDto), Column = "nodeId")]
+    [ForeignKey(typeof(ContentTypeDto), Column = ContentTypeDto.NodeIdColumnName)]
     public int ContentTypeId { get; set; }
 
     [Column("preventCleanup")]