Refactor existing RowVersion support

Author: mythz

src/ServiceStack.OrmLite.Sqlite/SqliteOrmLiteDialectProviderBase.cs

@@ -57,7 +57,7 @@ public override string ToPostCreateTableStatement(ModelDefinition modelDef)
                     modelDef.RowVersion.FieldName.SqlColumn(), 
                     modelDef.PrimaryKey.FieldName.SqlColumn());
 
-                var sql = "CREATE TRIGGER {0} AFTER UPDATE ON {1} FOR EACH ROW BEGIN {2} END;".Fmt(
+                var sql = "CREATE TRIGGER {0} BEFORE UPDATE ON {1} FOR EACH ROW BEGIN {2} END;".Fmt(
                     triggerName, modelDef.ModelName, triggerBody);
 
                 return sql;
@@ -244,6 +244,9 @@ public override string GetColumnDefinition(string fieldName, Type fieldType, boo
             var ret = base.GetColumnDefinition(fieldName, fieldType, isPrimaryKey, autoIncrement, isNullable, isRowVersion, fieldLength, scale, defaultValue, customFieldDefinition);
             if (isPrimaryKey)
                 return ret.Replace(" BIGINT ", " INTEGER ");
+            if (isRowVersion)
+                return ret + " DEFAULT 1";
+
             return ret;
         }
     }

src/ServiceStack.OrmLite/IOrmLiteDialectProvider.cs

@@ -78,7 +78,7 @@ string GetColumnDefinition(
 
         void PrepareParameterizedInsertStatement<T>(IDbCommand cmd, ICollection<string> insertFields = null);
 
-        void PrepareParameterizedUpdateStatement<T>(IDbCommand cmd, ICollection<string> updateFields = null);
+        bool PrepareParameterizedUpdateStatement<T>(IDbCommand cmd, ICollection<string> updateFields = null);
 
         void PrepareParameterizedDeleteStatement<T>(IDbCommand cmd, ICollection<string> deleteFields = null);
 

src/ServiceStack.OrmLite/ModelDefinition.cs

@@ -26,6 +26,8 @@ public ModelDefinition()
             this.CompositeIndexes = new List<CompositeIndexAttribute>();
         }
 
+        public const string RowVersionName = "RowVersion";
+
         public string Name { get; set; }
 
         public string Alias { get; set; }

src/ServiceStack.OrmLite/OrmLiteConfigExtensions.cs

@@ -105,7 +105,7 @@ internal static ModelDefinition GetModelDefinition(this Type modelType)
                 var isPrimaryKey = (!hasPkAttr && (propertyInfo.Name == OrmLiteConfig.IdField || (!hasIdField && isFirst)))
                     || propertyInfo.HasAttributeNamed(typeof(PrimaryKeyAttribute).Name);
 
-                var isRowVersion = propertyInfo.Name == "RowVersion"
+                var isRowVersion = propertyInfo.Name == ModelDefinition.RowVersionName
                     && propertyInfo.PropertyType == typeof(ulong);
 
                 var isNullableType = IsNullableType(propertyInfo.PropertyType);

src/ServiceStack.OrmLite/OrmLiteDialectProviderBase.cs

@@ -454,7 +454,7 @@ public virtual string ToSelectStatement(Type tableType, string sqlFilter, params
                 return sqlFilter.SqlFmt(filterParams);
 
             var modelDef = tableType.GetModelDefinition();
-            var sql = new StringBuilder("SELECT " + tableType.GetColumnNames() + " FROM " + GetQuotedTableName(modelDef));
+            var sql = new StringBuilder("SELECT " + GetColumnNames(modelDef) + " FROM " + GetQuotedTableName(modelDef));
 
             if (!string.IsNullOrEmpty(sqlFilter))
             {
@@ -471,6 +471,20 @@ public virtual string ToSelectStatement(Type tableType, string sqlFilter, params
             return sql.ToString();
         }
 
+        public virtual string GetColumnNames(ModelDefinition modelDef)
+        {
+            var sqlColumns = new StringBuilder();
+            foreach (var field in modelDef.FieldDefinitions)
+            {
+                if (sqlColumns.Length > 0)
+                    sqlColumns.Append(", ");
+
+                sqlColumns.Append(GetQuotedColumnName(field.FieldName));
+            }
+
+            return sqlColumns.ToString();
+        }
+
         /// Fmt
         public virtual string ToInsertRowStatement(IDbCommand command, object objWithProperties, ICollection<string> insertFields = null)
         {
@@ -483,10 +497,12 @@ public virtual string ToInsertRowStatement(IDbCommand command, object objWithPro
 
             foreach (var fieldDef in modelDef.FieldDefinitions)
             {
-                if (fieldDef.IsComputed) continue;
-                if (fieldDef.AutoIncrement) continue;
+                if (fieldDef.AutoIncrement || fieldDef.IsComputed || fieldDef.IsRowVersion)
+                    continue;
+
                 //insertFields contains Property "Name" of fields to insert ( that's how expressions work )
-                if (insertFields.Count > 0 && !insertFields.Contains(fieldDef.Name)) continue;
+                if (insertFields.Count > 0 && !insertFields.Contains(fieldDef.Name)) 
+                    continue;
 
                 if (sbColumnNames.Length > 0) sbColumnNames.Append(",");
                 if (sbColumnValues.Length > 0) sbColumnValues.Append(",");
@@ -520,10 +536,12 @@ public virtual void PrepareParameterizedInsertStatement<T>(IDbCommand cmd, IColl
 
             foreach (var fieldDef in modelDef.FieldDefinitionsArray)
             {
-                if (fieldDef.AutoIncrement || fieldDef.IsComputed) continue;
+                if (fieldDef.AutoIncrement || fieldDef.IsComputed || fieldDef.IsRowVersion) 
+                    continue;
 
                 //insertFields contains Property "Name" of fields to insert ( that's how expressions work )
-                if (insertFields != null && !insertFields.Contains(fieldDef.Name)) continue;
+                if (insertFields != null && !insertFields.Contains(fieldDef.Name)) 
+                    continue;
 
                 if (sbColumnNames.Length > 0)
                     sbColumnNames.Append(",");
@@ -548,63 +566,82 @@ public virtual void PrepareParameterizedInsertStatement<T>(IDbCommand cmd, IColl
                                             GetQuotedTableName(modelDef), sbColumnNames, sbColumnValues);
         }
 
-        public virtual void PrepareParameterizedUpdateStatement<T>(IDbCommand cmd, ICollection<string> updateFields = null)
+        public virtual bool PrepareParameterizedUpdateStatement<T>(IDbCommand cmd, ICollection<string> updateFields = null)
         {
             var sqlFilter = new StringBuilder();
             var sql = new StringBuilder();
             var modelDef = typeof(T).GetModelDefinition();
+            var hadRowVesion = false;
+            var updateAllFields = updateFields == null || updateFields.Count == 0;
 
             cmd.Parameters.Clear();
             cmd.CommandTimeout = OrmLiteConfig.CommandTimeout;
 
             foreach (var fieldDef in modelDef.FieldDefinitions)
             {
-                if (fieldDef.IsComputed) continue;
+                if (fieldDef.IsComputed) 
+                    continue;
+
                 try
                 {
-                    if (fieldDef.IsPrimaryKey && (updateFields == null || updateFields.Count == 0))
+                    if ((fieldDef.IsPrimaryKey || fieldDef.IsRowVersion) && updateAllFields)
                     {
-                        if (sqlFilter.Length > 0) sqlFilter.Append(" AND ");
+                        if (sqlFilter.Length > 0) 
+                            sqlFilter.Append(" AND ");
 
-                        sqlFilter
-                            .Append(GetQuotedColumnName(fieldDef.FieldName))
-                            .Append("=")
-                            .Append(this.GetParam(SanitizeFieldNameForParamName(fieldDef.FieldName)));
+                        AppendFieldCondition(sqlFilter, fieldDef, cmd);
 
-                        AddParameter(cmd, fieldDef);
+                        if (fieldDef.IsRowVersion)
+                            hadRowVesion = true;
 
                         continue;
                     }
 
-                    if ((updateFields != null && updateFields.Count > 0) && !updateFields.Contains(fieldDef.Name))
+                    if (!updateAllFields && !updateFields.Contains(fieldDef.Name))
                         continue;
 
                     if (sql.Length > 0)
                         sql.Append(", ");
 
-                    sql.Append(GetQuotedColumnName(fieldDef.FieldName))
-                       .Append("=")
-                       .Append(this.GetParam(SanitizeFieldNameForParamName(fieldDef.FieldName)));
-
-                    AddParameter(cmd, fieldDef);
+                    AppendFieldCondition(sql, fieldDef, cmd);
                 }
                 catch (Exception ex)
                 {
                     Log.Error("ERROR in PrepareParameterizedUpdateStatement(): " + ex.Message, ex);
                 }
             }
 
-            if (sql.Length < 1)
-                return;
+            if (sql.Length > 0)
+            {
+                cmd.CommandText = string.Format("UPDATE {0} SET {1} {2}",
+                    GetQuotedTableName(modelDef), sql, (sqlFilter.Length > 0 ? "WHERE " + sqlFilter : ""));
+            }
+
+            return hadRowVesion;
+        }
+
+        public virtual void AppendFieldCondition(StringBuilder sqlFilter, FieldDefinition fieldDef, IDbCommand cmd)
+        {
+            sqlFilter
+                .Append(GetQuotedColumnName(fieldDef.FieldName))
+                .Append("=")
+                .Append(this.GetParam(SanitizeFieldNameForParamName(fieldDef.FieldName)));
+
+            AddParameter(cmd, fieldDef);
+        }
 
-            cmd.CommandText = string.Format("UPDATE {0} SET {1} {2}",
-                GetQuotedTableName(modelDef), sql, (sqlFilter.Length > 0 ? "WHERE " + sqlFilter : ""));
+        public virtual void AppendFieldConditionFmt(StringBuilder sqlFilter, FieldDefinition fieldDef, object objWithProperties)
+        {
+            sqlFilter.AppendFormat("{0}={1}", 
+                GetQuotedColumnName(fieldDef.FieldName),
+                fieldDef.GetQuotedValue(objWithProperties));
         }
 
         public virtual void PrepareParameterizedDeleteStatement<T>(IDbCommand cmd, ICollection<string> deleteFields = null)
         {
             var sqlFilter = new StringBuilder();
             var modelDef = typeof(T).GetModelDefinition();
+            var hasSpecificFilter = deleteFields != null && deleteFields.Count > 0;
 
             cmd.Parameters.Clear();
             cmd.CommandTimeout = OrmLiteConfig.CommandTimeout;
@@ -613,20 +650,15 @@ public virtual void PrepareParameterizedDeleteStatement<T>(IDbCommand cmd, IColl
             {
                 if (fieldDef.IsComputed) continue;
 
-                if ((deleteFields != null && deleteFields.Count > 0) && !deleteFields.Contains(fieldDef.Name))
+                if (hasSpecificFilter && !deleteFields.Contains(fieldDef.Name))
                     continue;
 
                 try
                 {
                     if (sqlFilter.Length > 0)
                         sqlFilter.Append(" AND ");
 
-                    sqlFilter
-                        .Append(GetQuotedColumnName(fieldDef.FieldName))
-                        .Append("=")
-                        .Append(this.GetParam(SanitizeFieldNameForParamName(fieldDef.FieldName)));
-
-                    AddParameter(cmd, fieldDef);
+                    AppendFieldCondition(sqlFilter, fieldDef, cmd);
                 }
                 catch (Exception ex)
                 {
@@ -757,33 +789,32 @@ protected virtual object GetAnonValue<T>(FieldDefinition fieldDef, object obj)
 
         public virtual string ToUpdateRowStatement(object objWithProperties, ICollection<string> updateFields = null)
         {
-            if (updateFields == null)
-                updateFields = new List<string>();
-
             var sqlFilter = new StringBuilder();
             var sql = new StringBuilder();
             var modelDef = objWithProperties.GetType().GetModelDefinition();
+            var updateAllFields = updateFields == null || updateFields.Count == 0;
 
             foreach (var fieldDef in modelDef.FieldDefinitions)
             {
                 if (fieldDef.IsComputed) continue;
 
                 try
                 {
-                    if (fieldDef.IsPrimaryKey && updateFields.Count == 0)
+                    if (fieldDef.IsPrimaryKey && updateAllFields)
                     {
-                        if (sqlFilter.Length > 0) sqlFilter.Append(" AND ");
+                        if (sqlFilter.Length > 0) 
+                            sqlFilter.Append(" AND ");
 
-                        sqlFilter.AppendFormat("{0}={1}", GetQuotedColumnName(fieldDef.FieldName), fieldDef.GetQuotedValue(objWithProperties));
+                        AppendFieldConditionFmt(sqlFilter, fieldDef, objWithProperties);
 
                         continue;
                     }
 
-                    if (updateFields.Count > 0 && !updateFields.Contains(fieldDef.Name) || fieldDef.AutoIncrement) continue;
+                    if (!updateAllFields && !updateFields.Contains(fieldDef.Name) || fieldDef.AutoIncrement) continue;
                     if (sql.Length > 0)
                         sql.Append(", ");
 
-                    sql.AppendFormat("{0}={1}", GetQuotedColumnName(fieldDef.FieldName), fieldDef.GetQuotedValue(objWithProperties));
+                    AppendFieldConditionFmt(sql, fieldDef, objWithProperties);
                 }
                 catch (Exception ex)
                 {
@@ -811,9 +842,10 @@ public virtual string ToDeleteRowStatement(object objWithProperties)
                 {
                     if (fieldDef.IsPrimaryKey)
                     {
-                        if (sqlFilter.Length > 0) sqlFilter.Append(" AND ");
+                        if (sqlFilter.Length > 0) 
+                            sqlFilter.Append(" AND ");
 
-                        sqlFilter.AppendFormat("{0} = {1}", GetQuotedColumnName(fieldDef.FieldName), fieldDef.GetQuotedValue(objWithProperties));
+                        AppendFieldConditionFmt(sqlFilter, fieldDef, objWithProperties);
                     }
                 }
                 catch (Exception ex)
@@ -838,7 +870,8 @@ public virtual string ToDeleteStatement(Type tableType, string sqlFilter, params
                 && sqlFilter.Length > deleteStatement.Length
                 && sqlFilter.Substring(0, deleteStatement.Length).ToUpper().Equals(deleteStatement);
 
-            if (isFullDeleteStatement) return sqlFilter.SqlFmt(filterParams);
+            if (isFullDeleteStatement) 
+                return sqlFilter.SqlFmt(filterParams);
 
             var modelDef = tableType.GetModelDefinition();
             sql.AppendFormat("DELETE FROM {0}", GetQuotedTableName(modelDef));
@@ -860,8 +893,6 @@ public virtual string ToCreateTableStatement(Type tableType)
             var modelDef = tableType.GetModelDefinition();
             foreach (var fieldDef in modelDef.FieldDefinitions)
             {
-                if (sbColumns.Length != 0) sbColumns.Append(", \n  ");
-
                 var columnDefinition = GetColumnDefinition(
                     fieldDef.FieldName,
                     fieldDef.ColumnType,
@@ -874,6 +905,12 @@ public virtual string ToCreateTableStatement(Type tableType)
                     fieldDef.DefaultValue,
                     fieldDef.CustomFieldDefinition);
 
+                if (columnDefinition == null)
+                    continue;
+
+                if (sbColumns.Length != 0) 
+                    sbColumns.Append(", \n  ");
+
                 sbColumns.Append(columnDefinition);
 
                 if (fieldDef.ForeignKey == null) continue;
@@ -1005,11 +1042,6 @@ protected virtual string ToCreateIndexStatement(bool isUnique, string indexName,
                                  (isCombined) ? fieldName : GetQuotedColumnName(fieldName));
         }
 
-        public virtual string GetColumnNames(ModelDefinition modelDef)
-        {
-            return modelDef.GetColumnNames();
-        }
-
         public virtual List<string> ToCreateSequenceStatements(Type tableType)
         {
             return new List<string>();

src/ServiceStack.OrmLite/OrmLiteUtilExtensions.cs

@@ -100,22 +100,12 @@ public static IList ConvertToList(this IDataReader dataReader, Type type)
 
         internal static string GetColumnNames(this Type tableType)
         {
-            var modelDefinition = tableType.GetModelDefinition();
-            return GetColumnNames(modelDefinition);
+            return GetColumnNames(tableType.GetModelDefinition());
         }
 
         public static string GetColumnNames(this ModelDefinition modelDef)
         {
-            var sqlColumns = new StringBuilder();
-            foreach (var field in modelDef.FieldDefinitions)
-            {
-                if (sqlColumns.Length > 0)
-                    sqlColumns.Append(", ");
-
-                sqlColumns.Append(OrmLiteConfig.DialectProvider.GetQuotedColumnName(field.FieldName));
-            }
-
-            return sqlColumns.ToString();
+            return OrmLiteConfig.DialectProvider.GetColumnNames(modelDef);
         }
 
         internal static string GetIdsInSql(this IEnumerable idValues)

src/ServiceStack.OrmLite/OrmLiteWriteExtensions.cs

@@ -383,13 +383,18 @@ internal static int Update<T>(this IDbCommand dbCmd, T obj)
             if (OrmLiteConfig.UpdateFilter != null)
                 OrmLiteConfig.UpdateFilter(dbCmd, obj);
 
-            OrmLiteConfig.DialectProvider.PrepareParameterizedUpdateStatement<T>(dbCmd);
+            var hadRowVersion = OrmLiteConfig.DialectProvider.PrepareParameterizedUpdateStatement<T>(dbCmd);
             if (string.IsNullOrEmpty(dbCmd.CommandText))
                 return 0;
 
             OrmLiteConfig.DialectProvider.SetParameterValues<T>(dbCmd, obj);
 
-            return dbCmd.ExecNonQuery();
+            var rowsUpdated = dbCmd.ExecNonQuery();
+
+            if (hadRowVersion && rowsUpdated == 0)
+                throw new RowModifiedException();
+
+            return rowsUpdated;
         }
 
         internal static int Update<T>(this IDbCommand dbCmd, params T[] objs)

src/ServiceStack.OrmLite/RowModifiedException.cs

@@ -0,0 +1,22 @@
+using System;
+
+namespace ServiceStack.OrmLite
+{
+    /// <summary>
+    /// Thrown when an update to a table with optimistic concurrency column(s) fails.
+    /// </summary>
+    public class RowModifiedException : Exception
+    {
+        public RowModifiedException()
+        {
+        }
+        public RowModifiedException(string message)
+            : base(message)
+        {
+        }
+        public RowModifiedException(string message, Exception innerException)
+            : base(message, innerException)
+        {
+        }
+    }
+}