Merge pull request #74 from DataObjects-NET/disposable-querycommand

Disposable QueryCommand

Author: alex-kulakov

ChangeLog/6.0.3_Z_Final.txt

@@ -1,5 +1,6 @@
 [main] Provider for MS SQL Server was branched out into a separate project
 [main] Events for changes cancelling ported from 5.0.x
+[main] QueryCommand now implements IDisposable interface
 [main] TupleDescriptor no longer implements IList<T>
 [main] TupleDescriptor.GetCommonPartLength(TupleDescriptor) method was removed
 [main] TupleDescriptor.IsValueType(int) method was removed

Extensions/Xtensive.Orm.BulkOperations/Internals/BulkDeleteOperation.cs

@@ -1,4 +1,8 @@
-using System;
+// Copyright (C) 2019-2020 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
+
+using System;
 using System.Linq;
 using Xtensive.Orm.Linq;
 using Xtensive.Orm.Providers;
@@ -15,16 +19,15 @@ internal class BulkDeleteOperation<T> : QueryOperation<T>
 
     protected override int ExecuteInternal()
     {
-      base.ExecuteInternal();
+      _ = base.ExecuteInternal();
       QueryTranslationResult request = GetRequest(query);
       Bindings = request.ParameterBindings.ToList();
       if (PrimaryIndexes.Length > 1)
         throw new NotImplementedException("Inheritance is not implemented");
       SqlDelete delete = SqlDml.Delete(SqlDml.TableRef(PrimaryIndexes[0].Table));
       Join(delete, (SqlSelect) request.Query);
-      QueryCommand command = ToCommand(delete);
-      int result = command.ExecuteNonQuery();
-      return result;
+      using var command = ToCommand(delete);
+      return command.ExecuteNonQuery();
     }
 
     protected override SqlTableRef GetStatementTable(SqlStatement statement)

Extensions/Xtensive.Orm.BulkOperations/Internals/BulkUpdateOperation.cs

@@ -1,4 +1,8 @@
-using System;
+// Copyright (C) 2007-2020 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Linq.Expressions;
@@ -22,7 +26,7 @@ internal class BulkUpdateOperation<T> : QueryOperation<T>
 
     protected override int ExecuteInternal()
     {
-      base.ExecuteInternal();
+      _ = base.ExecuteInternal();
       QueryTranslationResult request = GetRequest(query);
       Bindings = request.ParameterBindings.ToList();
       if (PrimaryIndexes.Length > 1)
@@ -31,7 +35,7 @@ protected override int ExecuteInternal()
       setOperation.Statement = SetStatement.Create(update);
       Join(update, (SqlSelect) request.Query);
       setOperation.AddValues();
-      QueryCommand command = ToCommand(update);
+      using var command = ToCommand(update);
       return command.ExecuteNonQuery();
     }
 

Extensions/Xtensive.Orm.BulkOperations/Internals/InsertOperation.cs

@@ -1,4 +1,8 @@
-using System;
+// Copyright (C) 2019-2020 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Linq.Expressions;
@@ -25,7 +29,7 @@ protected override int ExecuteInternal()
       SqlInsert insert = SqlDml.Insert(SqlDml.TableRef(PrimaryIndexes[0].Table));
       setOperation.Statement = SetStatement.Create(insert);
       setOperation.AddValues();
-      QueryCommand command = ToCommand(insert);
+      using var command = ToCommand(insert);
       return command.ExecuteNonQuery();
     }
 

Extensions/Xtensive.Orm.BulkOperations/Internals/Operation.cs

@@ -1,4 +1,8 @@
-using System;
+// Copyright (C) 2019-2020 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
+
+using System;
 using System.Collections.Generic;
 using System.Data.Common;
 using System.Linq;

Orm/Xtensive.Orm.Tests/Issues/IssueJira0571_MySqlKeyGenerationProblem.cs

@@ -1,6 +1,6 @@
-// Copyright (C) 2014 Xtensive LLC.
-// All rights reserved.
-// For conditions of distribution and use, see license.
+// Copyright (C) 2015-2020 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
 // Created by: Alexey Kulakov
 // Created:    2015.02.03
 
@@ -138,7 +138,8 @@ private void CheckSchemaGenerators(Schema schema, string generatorName, Session
       var query = GetQuery(generatorTable);
       var queryBuilder = GetQueryBuilder(session);
       var queryCompilationResult = queryBuilder.CompileQuery(query);
-      var command = queryBuilder.CreateCommand(queryBuilder.CreateRequest(queryCompilationResult, Enumerable.Empty<Services.QueryParameterBinding>()));
+      var queryRequest = queryBuilder.CreateRequest(queryCompilationResult, Enumerable.Empty<Services.QueryParameterBinding>())
+      using var command = queryBuilder.CreateCommand(queryRequest);
       var rowCount = command.ExecuteScalar();
       Assert.AreEqual(expectedValue, rowCount);
     }

Orm/Xtensive.Orm.Tests/Storage/QueryBuilderTest.cs

@@ -1,6 +1,6 @@
-// Copyright (C) 2012 Xtensive LLC.
-// All rights reserved.
-// For conditions of distribution and use, see license.
+// Copyright (C) 2012-2020 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
 // Created by: Denis Krjuchkov
 // Created:    2012.02.27
 
@@ -68,8 +68,10 @@ public void ModifyQueryTest()
         var command = builder.CreateCommand(request);
         Assert.That(command, Is.Not.Null);
 
-        var result = Convert.ToInt32(command.ExecuteScalar());
-        Assert.That(result, Is.EqualTo(1));
+        using (command) {
+          var result = Convert.ToInt32(command.ExecuteScalar());
+          Assert.That(result, Is.EqualTo(1));
+        }
 
         tx.Complete();
       }
@@ -83,20 +85,22 @@ public void ComposeQuery()
         var builder = session.Services.Get<QueryBuilder>();
         Assert.That(builder, Is.Not.Null);
 
-        var binding = builder.CreateParameterBinding(typeof (int), () => 43);
+        var binding = builder.CreateParameterBinding(typeof(int), () => 43);
         var select = SqlDml.Select(binding.ParameterReference);
 
         var compiled = builder.CompileQuery(select);
         Assert.That(compiled, Is.Not.Null);
 
-        var request = builder.CreateRequest(compiled, new[] {binding});
+        var request = builder.CreateRequest(compiled, new[] { binding });
         Assert.That(request, Is.Not.Null);
 
         var command = builder.CreateCommand(request);
         Assert.That(command, Is.Not.Null);
 
-        var result = Convert.ToInt32(command.ExecuteScalar());
-        Assert.That(result, Is.EqualTo(43));
+        using (command) {
+          var result = Convert.ToInt32(command.ExecuteScalar());
+          Assert.That(result, Is.EqualTo(43));
+        }
 
         tx.Complete();
       }

Orm/Xtensive.Orm.Tests/Upgrade/SchemaSharing/QueryBuilder/Model.cs

@@ -1,4 +1,4 @@
-// Copyright (C) 2017 Xtensive LLC.
+// Copyright (C) 2017 Xtensive LLC.
 // All rights reserved.
 // For conditions of distribution and use, see license.
 // Created by: Alexey Kulakov
@@ -316,8 +316,7 @@ private object ExecuteScalar(Services.QueryBuilder queryBuilder, ISqlCompileUnit
     {
       var commandtext = queryBuilder.CompileQuery(query);
       var request = queryBuilder.CreateRequest(commandtext, Enumerable.Empty<Services.QueryParameterBinding>());
-      var command = queryBuilder.CreateCommand(request);
-
+      using var command = queryBuilder.CreateCommand(request);
       return command.ExecuteScalar();
     }
 

Orm/Xtensive.Orm/Orm/Services/QueryBuilding/QueryCommand.cs

@@ -1,10 +1,12 @@
-// Copyright (C) 2012 Xtensive LLC.
-// All rights reserved.
-// For conditions of distribution and use, see license.
+// Copyright (C) 2012-2020 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
 // Created by: Denis Krjuchkov
 // Created:    2012.02.27
 
+using System;
 using System.Data.Common;
+using System.Runtime.CompilerServices;
 using Xtensive.Orm.Providers;
 
 namespace Xtensive.Orm.Services
@@ -14,16 +16,24 @@ namespace Xtensive.Orm.Services
   /// Unlike <see cref="DbCommand"/> this type is aware of <see cref="Session.Events"/>
   /// and does all nessesary logging of executed SQL.
   /// </summary>
-  public sealed class QueryCommand
+  public sealed class QueryCommand : IDisposable
   {
     private readonly StorageDriver driver;
     private readonly Session session;
     private readonly DbCommand realCommand;
 
+    private bool disposed;
+
     /// <summary>
     /// Gets SQL query to execute.
     /// </summary>
-    public string CommandText { get { return realCommand.CommandText; } }
+    public string CommandText
+    {
+      get {
+        EnsureNotDisposed();
+        return realCommand.CommandText;
+      }
+    }
 
     /// <summary>
     /// Executes query and returns <see cref="DbDataReader"/>
@@ -41,6 +51,7 @@ public DbDataReader ExecuteReader()
     /// <returns>Number of affected rows.</returns>
     public int ExecuteNonQuery()
     {
+      EnsureNotDisposed();
       return driver.ExecuteNonQuery(session, realCommand);
     }
 
@@ -50,9 +61,28 @@ public int ExecuteNonQuery()
     /// <returns>Scalar result of query.</returns>
     public object ExecuteScalar()
     {
+      EnsureNotDisposed();
       return driver.ExecuteScalar(session, realCommand);
     }
 
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    private void EnsureNotDisposed()
+    {
+      if (disposed) {
+        throw new ObjectDisposedException(null);
+      }
+    }
+
+    /// <inheritdoc/>
+    public void Dispose()
+    {
+      if (disposed) {
+        return;
+      }
+      disposed = true;
+      realCommand?.Dispose();
+    }
+
     // Constructors
 
     internal QueryCommand(StorageDriver driver, Session session, DbCommand realCommand)