Migrations: Ensure umbracoPropertyData column casing (#21015)

* Add migration to fix umbracoPropertyData column casing.

* Improve migration with column existence check and logging

- Add ILogger to log when column is renamed
- Check if column exists with incorrect casing before renaming
- Use fluent Rename API instead of raw SQL
- Add XML remarks documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Clarify what old and new column name really is

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: kjac <kja@umbraco.dk>
This commit is contained in:
Andy Butland
2025-12-01 18:47:31 +01:00
committed by GitHub
parent 1c922f34f5
commit 34aabb8413
2 changed files with 60 additions and 0 deletions

View File

@@ -141,6 +141,9 @@ public class UmbracoPlan : MigrationPlan
To<V_17_0_0.EnsureDefaultMediaFolderHasDefaultCollection>("{8B2C830A-4FFB-4433-8337-8649B0BF52C8}"); To<V_17_0_0.EnsureDefaultMediaFolderHasDefaultCollection>("{8B2C830A-4FFB-4433-8337-8649B0BF52C8}");
To<V_17_0_0.InvalidateBackofficeUserAccess>("{1C38D589-26BB-4A46-9ABE-E4A0DF548A87}"); To<V_17_0_0.InvalidateBackofficeUserAccess>("{1C38D589-26BB-4A46-9ABE-E4A0DF548A87}");
// To 17.1.0
To<V_17_1_0.EnsureUmbracoPropertyDataColumnCasing>("{BE5CA411-E12D-4455-A59E-F12A669E5363}");
// To 18.0.0 // To 18.0.0
// TODO (V18): Enable on 18 branch // TODO (V18): Enable on 18 branch
//// To<V_18_0_0.MigrateSingleBlockList>("{74332C49-B279-4945-8943-F8F00B1F5949}"); //// To<V_18_0_0.MigrateSingleBlockList>("{74332C49-B279-4945-8943-F8F00B1F5949}");

View File

@@ -0,0 +1,57 @@
using Microsoft.Extensions.Logging;
using NPoco;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Models.Membership;
using Umbraco.Cms.Infrastructure.Persistence;
using static Umbraco.Cms.Core.Constants;
using ColumnInfo = Umbraco.Cms.Infrastructure.Persistence.SqlSyntax.ColumnInfo;
namespace Umbraco.Cms.Infrastructure.Migrations.Upgrade.V_17_1_0;
/// <summary>
/// Ensures the propertyTypeId column in umbracoPropertyData has correct camel case naming.
/// </summary>
/// <remarks>
/// SQL Server is case sensitive for columns used in a SQL Bulk insert statement(which is used in publishing
/// operations on umbracoPropertyData).
/// Earlier versions of Umbraco used all lower case for the propertyTypeId column name (propertytypeid), whereas newer versions
/// use camel case (propertyTypeId).
/// </remarks>
public class EnsureUmbracoPropertyDataColumnCasing : AsyncMigrationBase
{
private readonly ILogger<EnsureUmbracoPropertyDataColumnCasing> _logger;
/// <summary>
/// Initializes a new instance of the <see cref="EnsureUmbracoPropertyDataColumnCasing"/> class.
/// </summary>
public EnsureUmbracoPropertyDataColumnCasing(IMigrationContext context, ILogger<EnsureUmbracoPropertyDataColumnCasing> logger)
: base(context) => _logger = logger;
/// <inheritdoc/>
protected override Task MigrateAsync()
{
// We only need to do this for SQL Server.
if (DatabaseType == DatabaseType.SQLite)
{
return Task.CompletedTask;
}
const string oldColumnName = "propertytypeid";
const string newColumnName = "propertyTypeId";
ColumnInfo[] columns = [.. SqlSyntax.GetColumnsInSchema(Context.Database)];
ColumnInfo? targetColumn = columns
.FirstOrDefault(x => x.TableName == DatabaseSchema.Tables.PropertyData && string.Equals(x.ColumnName, oldColumnName, StringComparison.InvariantCulture));
if (targetColumn is not null)
{
// The column exists with incorrect casing, we need to rename it.
Rename.Column(oldColumnName)
.OnTable(DatabaseSchema.Tables.PropertyData)
.To(newColumnName)
.Do();
_logger.LogInformation("Renamed column {OldColumnName} to {NewColumnName} on table {TableName}", oldColumnName, newColumnName, DatabaseSchema.Tables.PropertyData);
}
return Task.CompletedTask;
}
}