Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expose SQLite VFS option in connection string #34864

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Expose SQLite VFS option in connection string #34864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/Microsoft.Data.Sqlite.Core/SqliteConnectionInternal.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
28 changes: 25 additions & 3 deletions src/Microsoft.Data.Sqlite.Core/SqliteConnectionStringBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -41,7 +42,8 @@ private enum Keywords
ForeignKeys,
RecursiveTriggers,
DefaultTimeout,
Pooling
Pooling,
Vfs,
}

private static readonly IReadOnlyList<string> _validKeywords;
Expand All @@ -55,10 +57,11 @@ private enum Keywords
private bool _recursiveTriggers;
private int _defaultTimeout = 30;
private bool _pooling = true;
private string? _vfs = string.Empty;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the default value should be null. Any reason for 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;
Expand All @@ -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,
Expand All @@ -79,6 +83,7 @@ static SqliteConnectionStringBuilder()
[RecursiveTriggersKeyword] = Keywords.RecursiveTriggers,
[DefaultTimeoutKeyword] = Keywords.DefaultTimeout,
[PoolingKeyword] = Keywords.Pooling,
[VfsKeyword] = Keywords.Vfs,

// aliases
[FilenameKeyword] = Keywords.DataSource,
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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);;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Two semicolons at the end.

return;

default:
Debug.Fail("Unexpected keyword: " + keyword);
Expand Down Expand Up @@ -458,6 +477,9 @@ private void Reset(Keywords index)
case Keywords.Pooling:
_pooling = true;
return;
case Keywords.Vfs:
_vfs = string.Empty;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above. null?

return;

default:
Debug.Fail("Unexpected keyword: " + index);
Expand Down
5 changes: 3 additions & 2 deletions test/Microsoft.Data.Sqlite.Tests/SqliteConnectionStringBuilderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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]
Expand All @@ -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]
Expand Down