This package offers a flexible and generic database abstraction supporting multiple providers, including SQL Server, PostgreSQL, MySQL, and Oracle. It facilitates asynchronous execution of SQL commands, stored procedures, and parameterized queries with methods like ExecuteReaderAsync and ExecuteNonQueryAsync. Designed for extensibility and integration with dependency injection, it is ideal for applications using the repository pattern. The package simplifies multi-database integration, providing customizable database connections for efficient data handling in .NET applications.
License
—
Deps
1
Install Size
—
Vulns
✓ 0
Published
Mar 4, 2026
$ dotnet add package DataAccessProvider.CoreThe Data Access Provider Framework offers a flexible, pluggable way to interact with various data sources such as SQL databases (MSSQL, PostgreSQL, MySQL), file-based sources (JSON), and non-relational databases (MongoDB). By standardizing the approach to data access with source parameters (SourceParams), the framework allows developers to seamlessly switch between different data sources with minimal code changes.
async/await for efficient, non-blocking database operations.MSSQLSourceParams)PostgresSourceParams)MySQLSourceParams)OracleSourceParams)MongoDBParams)JsonFileSourceParams)StaticCodeParams)You can also extend the provider to support any custom data source by registering new data source implementations.
The DataAccessProvider is designed to provide a simple, consistent interface for interacting with multiple database types, such as MSSQL, MySQL, PostgreSQL, MongoDB, and more. By leveraging this provider, you can easily switch between databases by passing the appropriate data source parameters, without needing to modify your core application logic.
Microsoft.Data.SqlClientNpgsqlMySql.DataMongoDB.DriverTo get started, clone the repository and reference it in your project. You'll also need to install the required NuGet packages for your data sources.
git clone https://github.com/your-repo/dataaccessprovider.gitThe DataAccessProvider is available as a NuGet package from GitHub. You can add it as a dependency to your project directly from the GitHub NuGet package repository.
RegisterDataSource<TParams, TSource>(): This method allows the external consumer to register new custom data source types.BaseDataSourceParams and IDataSource implementations.Startup.cs.IDataSourceProvider to execute queries on the custom data source. // Add connection strings for each database type
services.AddDataAccessProvider(configuration)To store your connection strings in the appsettings.json file, use the following structure:
appsettings.json:{
"ConnectionStrings": {
"MSSQLSource": "Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;",
"PostgresSource": "Host=localhost;Port=5432;Database=mydb;Username=myuser;Password=mypassword",
"MySQLSource": "Server=myServerAddress;Database=myDataBase;User=myUsername;Password=myPassword;",
"OracleSource": "Data Source=MyOracleDB;User Id=myUsername;Password=myPassword;"
}
}IDataSourceProviderThe IDataSourceProvider in this framework automatically determines which data source to use based on the provided SourceParams. This makes it flexible to switch between different data sources like MSSQL, PostgreSQL, or even JSON files, without changing your core logic.
Additionally, when using generic types, the provider can infer the type and return results mapped to a specified class, making it easy to handle type-safe responses.
// Resolve the IDataSourceProvider from the service provider
var dataSourceProvider = serviceProvider.GetService<IDataSourceProvider>();
// Example 1: Execute a query using MSSQLSourceParams
var mssqParams1 = new MSSQLSourceParams
{
Query = "SELECT TOP 1 * FROM [dbo].[Diary]"
};
var result1 = await dataSourceProvider.ExecuteReaderAsync(mssqParams1);
// Example 2: Execute a query with a typed return (e.g., Diary class)
var mssqParams2 = new MSSQLSourceParams<Diary>
{
Query = "SELECT TOP 1 * FROM [dbo].[Diary]"
};
var result2 = await dataSourceProvider.ExecuteReaderAsync(mssqParams2);
// Example 3: Execute a query using StaticCodeParams (for static content)
var codeParams = new StaticCodeParams
{
Content = "Hello World"
};
var result3 = await dataSourceProvider.ExecuteReaderAsync(codeParams);
// Example 4: Execute a query using JsonFileSourceParams
var jsonFileParams = new JsonFileSourceParams
{
Content = @"{Name: 'Michael Jackson'}"
};
var result4 = await dataSourceProvider.ExecuteNonQueryAsync(jsonFileParams);1: [{"Id":1,"Title":"First Entry","Date":"2022-01-01T00:00:00"}]
2: [{"Id":1,"Title":"First Entry","Date":"2022-01-01T00:00:00"}]
3: "Hello World"
4: {"Name": "Michael Jackson"}The DataAccessProvider allows you to register your own custom data sources at runtime using the RegisterDataSource<TParams, TSource>() method. This enables you to extend the framework by adding support for new data source types, without modifying the existing factory.
public void RegisterDataSource<TParams, TSource>()
where TParams : BaseDataSourceParams
where TSource : IDataSource;SourceParams ClassDefine a custom SourceParams class that extends BaseDataSourceParams and contains any additional properties you need.
public class XmlFileSourceParams : BaseDataSourceParams
{
/// <summary>
/// Path to the XML file to be read.
/// </summary>
public string FilePath { get; set; }
/// <summary>
/// The root element in the XML file where the data begins.
/// </summary>
public string RootElement { get; set; }
/// <summary>
/// An optional XPath query to select specific nodes from the XML document.
/// </summary>
public string? XPathQuery { get; set; }
/// <summary>
/// Specifies whether to ignore namespaces in the XML document.
/// </summary>
public bool IgnoreNamespaces { get; set; } = true;
/// <summary>
/// Additional attributes or settings related to XML parsing.
/// </summary>
public Dictionary<string, string>? AdditionalAttributes { get; set; }
}IDataSourceCreate a custom data source by implementing the IDataSource interface and providing the necessary logic to interact with the custom data source.
Now that the CustomSourceParams and CustomDataSource are defined, you can register them with the DataSourceFactory by calling RegisterDataSource<TParams, TSource>() from the DataSourceFactory service.
var dataSourceFactory = serviceProvider.GetService<IDataSourceFactory>();
// Register the custom data source
dataSourceFactory.RegisterDataSource<XmlFileSourceParams, XmlFileSource>();Once the custom data source is registered, you can use it just like any other data source by passing CustomSourceParams to the IDataSourceProvider.
var xmlFileParams = new XmlFileSourceParams
{
FilePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "TestFiles", "data.xml"),
RootElement = "Employees",
XPathQuery = "//Employee[Age > 30]", // Optional XPath to filter nodes
IgnoreNamespaces = true,
AdditionalAttributes = new Dictionary<string, string>
{
{ "attribute1", "value1" },
{ "attribute2", "value2" }
}
};
// Use IDataSourceProvider to execute the query
var result = await dataSourceProvider.ExecuteReaderAsync(xmlFileParams);
Console.WriteLine($"\nXML Data Source Result: {JsonSerializer.Serialize(result.Value)}");DbParameter Extension MethodThe library includes an extension method for adding database parameters to a list in a type-safe and generic manner. This method supports multiple database types, including SQL Server and PostgreSQL.
Here is how you can use the AddParameter extension method to add parameters to a List<DbParameter>:
public class Example
{
public void AddParameters()
{
// For SQL Server
var parameters = new List<SqlParameter>();
parameters.AddParameter("@Id", DbType.Int32, 1);
parameters.AddParameter("@Id", DbType.Int32, 2);
// For PostgreSQL
var parameters = new List<NpgsqlParameter>();
parameters.AddParameter("@Name", DbType.String, "John Doe");
// Use parameters with your database command
}
}Contributions are welcome! If you'd like to add support for additional databases or improve the library, feel free to open a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.