Support custom order of columns when creating table (#665)

Much nicer, thx 👍

Author: pedoc

src/ServiceStack.OrmLite.MySql/MySqlDialectProviderBase.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Data;
 using System.Data.Common;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using ServiceStack.OrmLite.MySql.Converters;

src/ServiceStack.OrmLite/FieldDefinition.cs

@@ -62,6 +62,8 @@ public class FieldDefinition
         public string CheckConstraint { get; set; }
 
         public bool IsUniqueConstraint { get; set; }
+
+        public int Order { get; set; }
 
         public ForeignKeyConstraint ForeignKey { get; set; }
 

src/ServiceStack.OrmLite/OrmLiteConfigExtensions.cs

@@ -42,7 +42,7 @@ internal static void ClearCache()
         }
 
         internal static ModelDefinition GetModelDefinition(this Type modelType)
-        {
+        {                            
             if (typeModelDefinitionMap.TryGetValue(modelType, out var modelDef))
                 return modelDef;
 
@@ -98,6 +98,7 @@ string JoinSql(List<string> statements)
             var hasIdField = CheckForIdField(objProperties);
 
             var i = 0;
+            var propertyInfoIdx = 0;
             foreach (var propertyInfo in objProperties)
             {
                 if (propertyInfo.GetIndexParameters().Length > 0)
@@ -111,7 +112,7 @@ string JoinSql(List<string> statements)
                 var decimalAttribute = propertyInfo.FirstAttribute<DecimalLengthAttribute>();
                 var belongToAttribute = propertyInfo.FirstAttribute<BelongToAttribute>();
                 var referenceAttr = propertyInfo.FirstAttribute<ReferenceAttribute>();
-                
+
                 var isRowVersion = propertyInfo.Name == ModelDefinition.RowVersionName
                     && (propertyInfo.PropertyType == typeof(ulong) || propertyInfo.PropertyType == typeof(byte[]));
 
@@ -124,7 +125,7 @@ string JoinSql(List<string> statements)
                 var propertyType = isNullableType
                     ? Nullable.GetUnderlyingType(propertyInfo.PropertyType)
                     : propertyInfo.PropertyType;
-                
+
 
                 Type treatAsType = null;
 
@@ -149,13 +150,13 @@ string JoinSql(List<string> statements)
                    || isAutoId;
 
                 var isAutoIncrement = isPrimaryKey && propertyInfo.HasAttributeCached<AutoIncrementAttribute>();
-                
+
                 if (isAutoIncrement && propertyInfo.PropertyType == typeof(Guid))
                     throw new NotSupportedException($"[AutoIncrement] is only valid for integer properties for {modelType.Name}.{propertyInfo.Name} Guid property use [AutoId] instead");
-                
+
                 if (isAutoId && (propertyInfo.PropertyType == typeof(int) || propertyInfo.PropertyType == typeof(long)))
                     throw new NotSupportedException($"[AutoId] is only valid for Guid properties for {modelType.Name}.{propertyInfo.Name} integer property use [AutoIncrement] instead");
-                
+
                 var aliasAttr = propertyInfo.FirstAttribute<AliasAttribute>();
 
                 var indexAttr = propertyInfo.FirstAttribute<IndexAttribute>();
@@ -171,6 +172,9 @@ string JoinSql(List<string> statements)
                 var customFieldAttr = propertyInfo.FirstAttribute<CustomFieldAttribute>();
                 var chkConstraintAttr = propertyInfo.FirstAttribute<CheckConstraintAttribute>();
 
+                var order = propertyInfoIdx++;
+                if (customFieldAttr != null) order = customFieldAttr.Order;
+
                 var fieldDefinition = new FieldDefinition
                 {
                     Name = propertyInfo.Name,
@@ -187,7 +191,7 @@ string JoinSql(List<string> statements)
                     IsUniqueIndex = isUnique,
                     IsClustered = indexAttr?.Clustered == true,
                     IsNonClustered = indexAttr?.NonClustered == true,
-                    IndexName = indexAttr?.Name, 
+                    IndexName = indexAttr?.Name,
                     IsRowVersion = isRowVersion,
                     IgnoreOnInsert = propertyInfo.HasAttributeCached<IgnoreOnInsertAttribute>(),
                     IgnoreOnUpdate = propertyInfo.HasAttributeCached<IgnoreOnUpdateAttribute>(),
@@ -213,6 +217,7 @@ string JoinSql(List<string> statements)
                     BelongToModelName = belongToAttribute?.BelongToTableType.GetModelDefinition().ModelName,
                     CustomFieldDefinition = customFieldAttr?.Sql,
                     IsRefType = propertyType.IsRefType(),
+                    Order = order
                 };
 
                 if (isIgnored)

src/ServiceStack.OrmLite/OrmLiteDialectProviderBase.cs

@@ -1297,9 +1297,9 @@ public virtual string ResolveFragment(string sql)
 
         public virtual string GetAutoIdDefaultValue(FieldDefinition fieldDef) => null;
 
-        public Func<ModelDefinition, List<FieldDefinition>> CreateTableFieldsStrategy { get; set; } = GetFieldDefinitions;
+        public Func<ModelDefinition, IEnumerable<FieldDefinition>> CreateTableFieldsStrategy { get; set; } = GetFieldDefinitions;
 
-        public static List<FieldDefinition> GetFieldDefinitions(ModelDefinition modelDef) => modelDef.FieldDefinitions;
+        public static IEnumerable<FieldDefinition> GetFieldDefinitions(ModelDefinition modelDef) => modelDef.FieldDefinitions.OrderBy(fd=>fd.Order);
 
         public abstract string ToCreateSchemaStatement(string schemaName);
 

tests/ServiceStack.OrmLite.MySql.Tests/OrmLiteCreateTableTests.cs

@@ -160,5 +160,83 @@ public void Does_DoesColumnExist()
             exists = db.ColumnExists<Signal>(x => x.Code);
             Assert.That(exists);
         }
+
+        [Test]
+        public void Can_create_table_with_custom_field_order()
+        {
+            using (var db = OpenDbConnection())
+            {
+                var modelDefinition = typeof(ModelWithCustomFiledOrder).GetModelMetadata();
+                db.DropAndCreateTable<ModelWithCustomFiledOrder>();
+                var defs=db.SqlList<(string field,string type,string @null,string key,string @default,string extra)>("desc " + modelDefinition.Name);
+                Assert.AreEqual(nameof(ModelWithCustomFiledOrder.Filed1),defs[0].field);
+                Assert.AreEqual(nameof(ModelWithCustomFiledOrder.Filed3),defs[1].field);
+                Assert.AreEqual(nameof(ModelWithCustomFiledOrder.Filed2), defs[2].field);
+                Assert.AreEqual(nameof(ModelWithCustomFiledOrder.Id),defs[3].field);
+            }
+        }
+
+        [Test]
+        public void Can_create_table_without_custom_field_order()
+        {
+            using (var db = OpenDbConnection())
+            {
+                var modelDefinition = typeof(ModelWithoutCustomFiledOrder).GetModelMetadata();
+                db.DropAndCreateTable<ModelWithoutCustomFiledOrder>();
+                var defs = db.SqlList<(string field, string type, string @null, string key, string @default, string extra)>("desc " + modelDefinition.Name);
+                Assert.AreEqual(nameof(ModelWithoutCustomFiledOrder.Id), defs[0].field);
+                Assert.AreEqual(nameof(ModelWithoutCustomFiledOrder.Filed1), defs[1].field);
+                Assert.AreEqual(nameof(ModelWithoutCustomFiledOrder.Filed2), defs[2].field);
+                Assert.AreEqual(nameof(ModelWithoutCustomFiledOrder.Filed3), defs[3].field);
+            }
+        }
+
+        [Test]
+        public void model_definition_without_custom_order()
+        {
+            var modelDefinition = typeof(ModelWithoutCustomFiledOrder).GetModelMetadata();
+            Assert.AreEqual(4, modelDefinition.FieldDefinitions.Count);
+            Assert.AreEqual(0, modelDefinition.FieldDefinitions.Find(fd => fd.Name == nameof(ModelWithoutCustomFiledOrder.Id)).Order);
+            Assert.AreEqual(1, modelDefinition.FieldDefinitions.Find(fd => fd.Name == nameof(ModelWithoutCustomFiledOrder.Filed1)).Order);
+            Assert.AreEqual(2, modelDefinition.FieldDefinitions.Find(fd => fd.Name == nameof(ModelWithoutCustomFiledOrder.Filed2)).Order);
+            Assert.AreEqual(3, modelDefinition.FieldDefinitions.Find(fd => fd.Name == nameof(ModelWithoutCustomFiledOrder.Filed3)).Order);
+        }
+
+        [Test]
+        public void model_definition_with_custom_order()
+        {
+            var modelDefinition = typeof(ModelWithCustomFiledOrder).GetModelMetadata();
+            Assert.AreEqual(4, modelDefinition.FieldDefinitions.Count);
+            Assert.AreEqual(100, modelDefinition.FieldDefinitions.Find(fd => fd.Name == nameof(ModelWithoutCustomFiledOrder.Id)).Order);
+            Assert.AreEqual(5, modelDefinition.FieldDefinitions.Find(fd => fd.Name == nameof(ModelWithoutCustomFiledOrder.Filed1)).Order);
+            Assert.AreEqual(13, modelDefinition.FieldDefinitions.Find(fd => fd.Name == nameof(ModelWithoutCustomFiledOrder.Filed2)).Order);
+            Assert.AreEqual(8, modelDefinition.FieldDefinitions.Find(fd => fd.Name == nameof(ModelWithoutCustomFiledOrder.Filed3)).Order);
+        }
+
+        public class ModelWithoutCustomFiledOrder
+        {
+            [PrimaryKey]
+            [AutoIncrement]
+            public int Id { get; set; }
+
+            public int Filed1 { get; set; }
+            public string Filed2 { get; set; }
+            public float Filed3 { get; set; }
+        }
+
+        public class ModelWithCustomFiledOrder
+        {
+            [PrimaryKey]
+            [AutoIncrement]
+            [CustomField(Order = 100)]
+            public int Id { get; set; }
+
+            [CustomField(Order = 5)]
+            public int Filed1 { get; set; }
+            [CustomField(Order = 13)]
+            public string Filed2 { get; set; }
+            [CustomField(Order = 8)]
+            public float Filed3 { get; set; }
+        }
     }
 }