Expose the SQLite VFS setting

Author: arontsang

src/Microsoft.Data.Sqlite.Core/SqliteConnectionInternal.cs

@@ -93,7 +93,10 @@ public SqliteConnectionInternal(SqliteConnectionStringBuilder connectionOptions,
                 }
             }
 
-            var rc = sqlite3_open_v2(filename, out _db, flags, vfs: null);
+            var vfs = !string.IsNullOrWhiteSpace(connectionOptions.Vfs)
+                ? connectionOptions.Vfs
+                : null;
+            var rc = sqlite3_open_v2(filename, out _db, flags, vfs: vfs);
             SqliteException.ThrowExceptionForRC(rc, _db);
 
             if (connectionOptions.Password.Length != 0)

src/Microsoft.Data.Sqlite.Core/SqliteConnectionStringBuilder.cs

@@ -31,6 +31,7 @@ public class SqliteConnectionStringBuilder : DbConnectionStringBuilder
         private const string DefaultTimeoutKeyword = "Default Timeout";
         private const string CommandTimeoutKeyword = "Command Timeout";
         private const string PoolingKeyword = "Pooling";
+        private const string VfsKeyword = "Vfs";
 
         private enum Keywords
         {
@@ -41,7 +42,8 @@ private enum Keywords
             ForeignKeys,
             RecursiveTriggers,
             DefaultTimeout,
-            Pooling
+            Pooling,
+            Vfs,
         }
 
         private static readonly IReadOnlyList<string> _validKeywords;
@@ -55,10 +57,11 @@ private enum Keywords
         private bool _recursiveTriggers;
         private int _defaultTimeout = 30;
         private bool _pooling = true;
+        private string? _vfs = string.Empty;
 
         static SqliteConnectionStringBuilder()
         {
-            var validKeywords = new string[8];
+            var validKeywords = new string[9];
             validKeywords[(int)Keywords.DataSource] = DataSourceKeyword;
             validKeywords[(int)Keywords.Mode] = ModeKeyword;
             validKeywords[(int)Keywords.Cache] = CacheKeyword;
@@ -67,9 +70,10 @@ static SqliteConnectionStringBuilder()
             validKeywords[(int)Keywords.RecursiveTriggers] = RecursiveTriggersKeyword;
             validKeywords[(int)Keywords.DefaultTimeout] = DefaultTimeoutKeyword;
             validKeywords[(int)Keywords.Pooling] = PoolingKeyword;
+            validKeywords[(int)Keywords.Vfs] = VfsKeyword;
             _validKeywords = validKeywords;
 
-            _keywords = new Dictionary<string, Keywords>(11, StringComparer.OrdinalIgnoreCase)
+            _keywords = new Dictionary<string, Keywords>(12, StringComparer.OrdinalIgnoreCase)
             {
                 [DataSourceKeyword] = Keywords.DataSource,
                 [ModeKeyword] = Keywords.Mode,
@@ -79,6 +83,7 @@ static SqliteConnectionStringBuilder()
                 [RecursiveTriggersKeyword] = Keywords.RecursiveTriggers,
                 [DefaultTimeoutKeyword] = Keywords.DefaultTimeout,
                 [PoolingKeyword] = Keywords.Pooling,
+                [VfsKeyword] = Keywords.Vfs,
 
                 // aliases
                 [FilenameKeyword] = Keywords.DataSource,
@@ -217,6 +222,17 @@ public bool Pooling
             set => base[PoolingKeyword] = _pooling = value;
         }
 
+        /// <summary>
+        ///     Gets or sets the SQLite VFS used by the connection.
+        /// </summary>
+        /// <value>The SQLite VFS used by the connection.</value>
+        /// <seealso href="https://www.sqlite.org/vfs.html">SQLite VFS</seealso>
+        public string? Vfs
+        {
+            get => _vfs;
+            set => base[VfsKeyword] = _vfs = value;
+        }
+
         /// <summary>
         ///     Gets or sets the value associated with the specified key.
         /// </summary>
@@ -269,6 +285,9 @@ public override object? this[string keyword]
                     case Keywords.Pooling:
                         Pooling = Convert.ToBoolean(value, CultureInfo.InvariantCulture);
                         return;
+                    case Keywords.Vfs:
+                        Vfs = Convert.ToString(value, CultureInfo.InvariantCulture);;
+                        return;
 
                     default:
                         Debug.Fail("Unexpected keyword: " + keyword);
@@ -458,6 +477,9 @@ private void Reset(Keywords index)
                 case Keywords.Pooling:
                     _pooling = true;
                     return;
+                case Keywords.Vfs:
+                    _vfs = string.Empty;
+                    return;
 
                 default:
                     Debug.Fail("Unexpected keyword: " + index);

test/Microsoft.Data.Sqlite.Tests/SqliteConnectionStringBuilderTest.cs

@@ -148,7 +148,7 @@ public void Keys_works()
         var keys = (ICollection<string>)new SqliteConnectionStringBuilder().Keys;
 
         Assert.True(keys.IsReadOnly);
-        Assert.Equal(8, keys.Count);
+        Assert.Equal(9, keys.Count);
         Assert.Contains("Data Source", keys);
         Assert.Contains("Mode", keys);
         Assert.Contains("Cache", keys);
@@ -157,6 +157,7 @@ public void Keys_works()
         Assert.Contains("Recursive Triggers", keys);
         Assert.Contains("Default Timeout", keys);
         Assert.Contains("Pooling", keys);
+        Assert.Contains("Vfs", keys);
     }
 
     [Fact]
@@ -165,7 +166,7 @@ public void Values_works()
         var values = (ICollection<object>)new SqliteConnectionStringBuilder().Values;
 
         Assert.True(values.IsReadOnly);
-        Assert.Equal(8, values.Count);
+        Assert.Equal(9, values.Count);
     }
 
     [Fact]