BufferResultSets Travis test and Docs

Author: caleblloyd

.ci/config/config.buffer.json

@@ -0,0 +1,11 @@
+{
+    "Data": {
+      "ConnectionString": "server=127.0.0.1;user id=mysqltest;password='test;key=\"val';port=3306;database=mysqltest;ssl mode=none;Use Affected Rows=true;BufferResultSets=true",
+      "PasswordlessUser": "no_password",
+      "SecondaryDatabase": "testdb2",
+      "SupportsCachedProcedures": true,
+      "SupportsJson": true,
+      "MySqlBulkLoaderLocalCsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.CSV",
+      "MySqlBulkLoaderLocalTsvFile": "%TESTDATA%/LoadData_UTF8_BOM_Unix.TSV"
+    }
+}

.travis.yml

@@ -22,6 +22,7 @@ script:
 - echo 'Executing tests with No Compression, SSL' && ./.ci/use-config.sh config.ssl.json 172.17.0.1 3307 && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
 - echo 'Executing tests with Compression, SSL' && ./.ci/use-config.sh config.compression+ssl.json 172.17.0.1 3307 && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
 - echo 'Executing tests with Unix Domain Socket, No Compression, No SSL' && ./.ci/use-config.sh config.uds.json && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
+- echo 'Executing tests with Buffering, No Compression, No SSL' && ./.ci/use-config.sh config.buffer.json 172.17.0.1 3307 && time dotnet test tests/SideBySide/SideBySide.csproj -c Release -f netcoreapp1.1.1
 
 after_script:
 - chmod +x .ci/build-docs.sh && ./.ci/build-docs.sh

docs/content/connection-options.md

@@ -127,10 +127,16 @@ These are the other options that MySqlConnector supports.  They are set to sensi
     <th style="width: 70%">Descriotion</th>
   </thead>
   <tr>
-    <td>AllowUserVariables</td>
-    <td>true</td>
+    <td>AllowUserVariables, Allow User Variables</td>
+    <td>false</td>
     <td>Setting this to true indicates that the provider expects user variables in the SQL.</td>
   </tr>
+  <tr>
+    <td>BufferResultSets, Buffer Result Sets</td>
+    <td>false</td>
+    <td>Setting this to true immediately buffers all result sets to memory upon calling ExecuteReader/ExecuteReaderAsync.  This will allow the connection
+      to execute another statement while still holding the original postion of the reader.  Do not use when result sets are bigger than available memory.</td>
+  </tr>
   <tr>
     <td>Compress, Use Compression, UseCompression</td>
     <td>false</td>

tests/SideBySide/Attributes.cs

@@ -69,12 +69,14 @@ public BulkLoaderLocalTsvFileFactAttribute()
 
 	public class UnbufferedResultSetsFactAttribute : FactAttribute
 	{
+#if !BASELINE
 		public UnbufferedResultSetsFactAttribute()
 		{
 			var csb = AppConfig.CreateConnectionStringBuilder();
 			if(csb.BufferResultSets == true)
 				Skip = "Do not run when BufferResultSets are used";
 		}
+#endif
 	}
 
 	public class TcpConnectionFactAttribute : FactAttribute

tests/SideBySide/QueryTests.cs

@@ -152,7 +152,9 @@ public async Task MultipleReaders()
 		public async Task MultipleBufferedReaders()
 		{
 			var csb = AppConfig.CreateConnectionStringBuilder();
+#if !BASELINE
 			csb.BufferResultSets = true;
+#endif
 
 			using (var connection = new MySqlConnection(csb.ConnectionString))
 			{