SafeConnection 1.0.5

About

SafeConnection is a robust library designed to facilitate secure and efficient database connections. It provides a comprehensive set of features including:

• Secure Connections: Ensures all database connections are secure and encrypted. Additionally, it closes the passed connection explicitly.
• Caching: Implements in-memory caching to reduce database load and improve performance.
• Logging: Integrated logging capabilities to track database operations and errors.
• Compatibility: Supports multiple .NET versions including .NET Standard 3.1 and .NET 6.0.
• Ease of Use: Simple and intuitive API for quick integration into your projects.

This library is ideal for applications that require reliable and secure database interactions with minimal overhead.

Usage Instructions

To use SafeConnection, simply install the package via NuGet and add the following code to your project:

1. Install the Package: Add the SafeConnection package to your project using NuGet:

    dotnet add package SafeConnection
   

2. Inject the Service: Inject the SafeConnection service into your application as Singleton:

    builder.Services.AddSingleton<SafeConnection>(_ => new SafeConnection(
    	appName: builder.Environment.ApplicationName, // It will be used in the logs.
    	environment: builder.Environment.EnvironmentName, // It will be used in the logs.
    	sqlConnectionString: builder.Configuration.GetConnectionString("Your_Sql_log_connectionString"), // Where the logs will be stored.
    	sqlTable: "App_Logs", // The table where the logs will be stored.
    	cacheExpirationMinutes: builder.Configuration.GetValue<int>("CacheExpirationInMinutes") // The expiration time of the cache in minutes.
    ));
   

3. Use the Service: Use the SafeConnection service in your application to interact with the database:

    public class YourService
    {
    	private readonly SafeConnection _safeConnection;
   
    	// Inject SafeConnection service
    	public YourService(SafeConnection safeConnection)
    	{
    		_safeConnection = safeConnection;
    	}
   
    	// Use SafeConnection to execute SQL queries
    	public async Task<IEnumerable<YourModel>> GetYourData()
    	{
    		return await _safeConnection.QueryAsync<YourModel>("SELECT field1, field2 FROM YourTable", "YourCacheKey");
    	}
    }
   

4. The SQL table structure:

    CREATE TABLE App_Logs (
    	Id int IDENTITY(1,1) NOT NULL,
    	[DateTime] datetime NOT NULL,
    	App varchar(20) COLLATE SQL_Latin1_General_CP1_CI_AS NOT NULL,
    	Env varchar(20) COLLATE SQL_Latin1_General_CP1_CI_AS NOT NULL,
    	Query varchar(500) COLLATE SQL_Latin1_General_CP1_CI_AS NOT NULL,
    	Cached bit NOT NULL,
    	Duration real NOT NULL,
    	[Rows] int NOT NULL,
    	Columns int NOT NULL,
    	Kb int NULL,
    	CONSTRAINT App_Logs_PK PRIMARY KEY (Id)
    );
   

5. Enjoy!