doco with rollback

Author: SimonCropp

pages/mdsource/with-rollback.source.md

@@ -0,0 +1,20 @@
+# With Rollback
+
+Multiple actions a targeted to the same database and changes are rolled back instead of being committed.
+
+Characteristics:
+
+ * Better performance that the standard API.
+ * If a test fails, it is not possible to look at the current database state.
+
+If a test has failed, to debug the database state, temporarily switch back to the standard API.
+
+
+## Usage
+
+snippet: WithRollback
+
+
+## EntityFramework Usage
+
+snippet: EfWithRollback

pages/with-rollback.md

@@ -0,0 +1,53 @@
+<!--
+GENERATED FILE - DO NOT EDIT
+This file was generated by [MarkdownSnippets](https://github.com/SimonCropp/MarkdownSnippets).
+Source File: /pages/mdsource/with-rollback.source.md
+To change this file edit the source file and then run MarkdownSnippets.
+-->
+# With Rollback
+
+Multiple actions a targeted to the same database and changes are rolled back instead of being committed.
+
+Characteristics:
+
+ * Better performance that the standard API.
+ * If a test fails, it is not possible to look at the current database state.
+
+If a test has failed, to debug the database state, temporarily switch back to the standard API.
+
+
+## Usage
+
+<!-- snippet: WithRollback -->
+```cs
+var sqlInstance = new SqlInstance(
+    name: "theInstanceName",
+    buildTemplate: TestDbBuilder.CreateTable
+);
+
+using (var sqlDatabase = await sqlInstance.BuildWithRollback())
+{
+    var sqlConnection = sqlDatabase.Connection;
+    //Use the SqlConnection
+}
+```
+<sup>[snippet source](/src/LocalDb.Tests/Snippets/WithRollback.cs#L8-L19)</sup>
+<!-- endsnippet -->
+
+
+## EntityFramework Usage
+
+<!-- snippet: EfWithRollback -->
+```cs
+var sqlInstance = new SqlInstance<TheDbContext>(
+    constructInstance: builder => new TheDbContext(builder.Options));
+
+using (var sqlDatabase = await sqlInstance.BuildWithRollback())
+{
+    var sqlConnection = sqlDatabase.Connection;
+    var dbContext = sqlDatabase.Context;
+    //Use the SqlConnection or TheDbContext
+}
+```
+<sup>[snippet source](/src/EfLocalDb.Tests/Snippets/WithRollback.cs#L8-L18)</sup>
+<!-- endsnippet -->

readme.md

@@ -16,6 +16,7 @@ Provides a wrapper around [SqlLocalDB](https://docs.microsoft.com/en-us/sql/data
  * [Raw SqlConnection Usage](/pages/raw-usage.md)
  * [EntityFramework Usage](/pages/ef-usage.md)
  * [EntityFramework Migrations](/pages/efmigrations.md)
+ * [With Rollback Usage](/pages/with-rollback.md)
  * [Directory and name resolution](/pages/directory-and-name-resolution.md)
  * [Sql Management Studio](/pages/sql-management-studio.md)
  * [Logging](/pages/logging.md)

readme.source.md

@@ -10,6 +10,7 @@ Provides a wrapper around [SqlLocalDB](https://docs.microsoft.com/en-us/sql/data
  * [Raw SqlConnection Usage](/pages/raw-usage.md)
  * [EntityFramework Usage](/pages/ef-usage.md)
  * [EntityFramework Migrations](/pages/efmigrations.md)
+ * [With Rollback Usage](/pages/with-rollback.md)
  * [Directory and name resolution](/pages/directory-and-name-resolution.md)
  * [Sql Management Studio](/pages/sql-management-studio.md)
  * [Logging](/pages/logging.md)

src/EfLocalDb.Tests/Snippets/WithRollback.cs

@@ -0,0 +1,20 @@
+using System.Threading.Tasks;
+using EfLocalDb;
+
+class WithRollback
+{
+    async Task Usage()
+    {
+        #region EfWithRollback
+        var sqlInstance = new SqlInstance<TheDbContext>(
+            constructInstance: builder => new TheDbContext(builder.Options));
+
+        using (var sqlDatabase = await sqlInstance.BuildWithRollback())
+        {
+            var sqlConnection = sqlDatabase.Connection;
+            var dbContext = sqlDatabase.Context;
+            //Use the SqlConnection or TheDbContext
+        }
+        #endregion
+    }
+}

src/LocalDb.Tests/Snippets/WithRollback.cs

@@ -0,0 +1,21 @@
+using System.Threading.Tasks;
+using LocalDb;
+
+class WithRollback
+{
+    async Task Usage()
+    {
+        #region WithRollback
+        var sqlInstance = new SqlInstance(
+            name: "theInstanceName",
+            buildTemplate: TestDbBuilder.CreateTable
+        );
+
+        using (var sqlDatabase = await sqlInstance.BuildWithRollback())
+        {
+            var sqlConnection = sqlDatabase.Connection;
+            //Use the SqlConnection
+        }
+        #endregion
+    }
+}