Extensions

SQLite supports loading extensions at run time. Extensions include things like additional SQL functions, collations, virtual tables, and more.

.NET Core includes additional logic for locating native libraries in additional places like referenced NuGet packages. Unfortunately, SQLite can't leverage this logic; it calls the platform API directly to load libraries. Because of this, you may need to modify the PATH, LD_LIBRARY_PATH, or DYLD_LIBRARY_PATH environment variables before loading SQLite extensions. There's a sample on GitHub that demonstrates finding binaries for the current runtime inside a referenced NuGet package.

To load an extension, call the LoadExtension method. Microsoft.Data.Sqlite will ensure that the extension remains loaded even if the connection is closed and reopened.

// Load the SpatiaLite extension
connection.LoadExtension("mod_spatialite");

var command = connection.CreateCommand();
command.CommandText =
@"
    SELECT spatialite_version()
";
var version = (string)command.ExecuteScalar();

Console.WriteLine($"Using SpatiaLite {version}");

Note

The LoadExtension method was added in version 3.0.

See also