Raggruppata documentazione DBCONTEXT

Author: AngeloDotNet

src/NET6CustomLibrary/Docs/DBContext/README-DbContext-Generics.md

@@ -0,0 +1,104 @@
+# Entity Framework Core DbContext generics methods configuration
+
+
+## Example entity
+
+In this example, the entity is a data model that implements the *IEntity* interface and has a primary key of type *int*.
+
+```csharp
+namespace MyNet6Project;
+
+public class MyEntity : IEntity<int>
+{
+    public int Id { get; set; }
+    public string Name { get; set; }
+    public string Description { get; set; }
+}
+```
+
+
+## Example interface
+
+In this example, the interface is a service that implements the *IMyService* interface.
+
+```csharp
+namespace MyNet6Project;
+
+public interface IMyService
+{
+    Task<List<MyEntity>> GetListItemAsync();
+    Task<MyEntity> GetItemAsync(int id);
+    Task CreateItemAsync(MyEntity item);
+    Task UpdateItemAsync(MyEntity item);
+    Task DeleteItemAsync(MyEntity item);
+}
+```
+
+
+## Example class
+
+In this example, the class is a service that implements the *IMyService* interface.
+
+```csharp
+namespace MyNet6Project;
+
+public class MyService : IMyService
+{
+    private readonly IUnitOfWork<MyEntity, int> unitOfWork;
+
+    public MyService(IUnitOfWork<MyEntity, int> unitOfWork)
+    {
+        this.unitOfWork = unitOfWork;
+    }
+
+    public async Task<List<MyEntity>> GetListItemAsync()
+    {
+        var listItem = await unitOfWork.ReadOnly.GetAllAsync();
+        return listItem;
+    }
+
+    public async Task<MyEntity> GetItemAsync(int id)
+    {
+        var item = await unitOfWork.ReadOnly.GetByIdAsync(id);
+        return item;
+    }
+
+    public async Task CreateItemAsync(MyEntity item)
+    {
+        await unitOfWork.Command.CreateAsync(item);
+    }
+
+    public async Task UpdateItemAsync(MyEntity item)
+    {
+        await unitOfWork.Command.UpdateAsync(item);
+    }
+
+    public async Task DeleteItemAsync(MyEntity item)
+    {
+        await unitOfWork.Command.DeleteAsync(item);
+    }
+}
+```
+
+
+## Registering services at Startup
+
+```csharp
+public Startup(IConfiguration configuration)
+{
+  Configuration = configuration;
+}
+
+public IConfiguration Configuration { get; }
+	
+public void ConfigureServices(IServiceCollection services)
+{
+  //OMISSIS
+
+  services.AddDbContextGenericsMethods<MyDbContext>();
+  
+  //OMISSIS
+}
+```
+
+<b>Note:</b> You need to replace the <b>MyDbContext</b> value with the actual implementation of your DbContext

src/NET6CustomLibrary/Docs/DBContext/README-DbContextPool-MySQL.md

@@ -0,0 +1,41 @@
+# Entity Framework Core DbContext Pool configuration for MySQL database
+
+
+## Configuration to add to the appsettings.json file
+
+```json
+"ConnectionStrings": {
+  "Default": "Server=[SERVER];Database=[DATABASE];Uid=[USERNAME];Pwd=[PASSWORD];Port=3306"
+},
+```
+
+<b>Note:</b> The default port for Mysql / MariaDB is 3306, but it can be changed as needed according to your needs.
+
+
+## Registering services at Startup
+
+```csharp
+public Startup(IConfiguration configuration)
+{
+  Configuration = configuration;
+}
+
+public IConfiguration Configuration { get; }
+	
+public void ConfigureServices(IServiceCollection services)
+{
+  //OMISSIS
+
+  var connectionString = Configuration.GetSection("ConnectionStrings").GetValue<string>("Default");
+
+  //OMISSIS
+
+  services.AddDbContextUseMySql<MyDbContext>(connectionString, 3);
+}
+```
+
+<b>Note:</b>The value <b>3</b> indicates the number of attempts (retryOnFailure), in order to avoid transient errors.
+
+If you don't want to activate connection resiliency, set the value to <b>zero</b>.
+
+Finally you need to replace the <b>MyDbContext</b> value with the actual implementation of your DbContext

src/NET6CustomLibrary/Docs/DBContext/README-DbContextPool-Postgres.md

@@ -0,0 +1,41 @@
+# Entity Framework Core DbContext Pool configuration for Postgres database
+
+
+## Configuration to add to the appsettings.json file
+
+```json
+"ConnectionStrings": {
+  "Default": "Host=[SERVER];Port=5432;Database=[DATABASE];Username=[USERNAME];Password=[PASSWORD]"
+},
+```
+
+<b>Note:</b> The default port for Postgres is 5432, but it can be changed as needed according to your needs.
+
+
+## Registering services at Startup
+
+```csharp
+public Startup(IConfiguration configuration)
+{
+  Configuration = configuration;
+}
+
+public IConfiguration Configuration { get; }
+	
+public void ConfigureServices(IServiceCollection services)
+{
+  //OMISSIS
+
+  var connectionString = Configuration.GetSection("ConnectionStrings").GetValue<string>("Default");
+
+  //OMISSIS
+
+  services.AddDbContextUsePostgres<MyDbContext>(connectionString, 3);
+}
+```
+
+<b>Note:</b>The value <b>3</b> indicates the number of attempts (retryOnFailure), in order to avoid transient errors.
+
+If you don't want to activate connection resiliency, set the value to <b>zero</b>.
+
+Finally you need to replace the <b>MyDbContext</b> value with the actual implementation of your DbContext

src/NET6CustomLibrary/Docs/DBContext/README-DbContextPool-SQLServer.md

@@ -0,0 +1,41 @@
+# Entity Framework Core DbContext Pool configuration for SQL Server database
+
+
+## Configuration to add to the appsettings.json file
+
+```json
+"ConnectionStrings": {
+  "Default": "Data Source=[SERVER];Initial Catalog=[DATABASE];User ID=[USERNAME];Password=[PASSWORD]"
+},
+```
+
+<b>Note:</b> The default port for SQL Server is 1433, but it can be changed as needed according to your needs.
+
+
+## Registering services at Startup
+
+```csharp
+public Startup(IConfiguration configuration)
+{
+  Configuration = configuration;
+}
+
+public IConfiguration Configuration { get; }
+	
+public void ConfigureServices(IServiceCollection services)
+{
+  //OMISSIS
+
+  var connectionString = Configuration.GetSection("ConnectionStrings").GetValue<string>("Default");
+
+  //OMISSIS
+
+  services.AddDbContextUseSQLServer<MyDbContext>(connectionString, 3);
+}
+```
+
+<b>Note:</b>The value <b>3</b> indicates the number of attempts (retryOnFailure), in order to avoid transient errors.
+
+If you don't want to activate connection resiliency, set the value to <b>zero</b>.
+
+Finally you need to replace the <b>MyDbContext</b> value with the actual implementation of your DbContext

src/NET6CustomLibrary/Docs/DBContext/README-DbContextPool-SQLite.md

@@ -0,0 +1,35 @@
+# Entity Framework Core DbContext Pool configuration for SQLite database
+
+
+## Configuration to add to the appsettings.json file
+
+```json
+"ConnectionStrings": {
+    "Default": "Data Source=Data/MyDatabase.db"
+},
+```
+
+
+## Registering services at Startup
+
+```csharp
+public Startup(IConfiguration configuration)
+{
+  Configuration = configuration;
+}
+
+public IConfiguration Configuration { get; }
+	
+public void ConfigureServices(IServiceCollection services)
+{
+  //OMISSIS
+
+  var connectionString = Configuration.GetSection("ConnectionStrings").GetValue<string>("Default");
+
+  //OMISSIS
+
+  services.AddDbContextUseSQLite<MyDbContext>(connectionString);
+}
+```
+
+<b>Note:</b> You need to replace the <b>MyDbContext</b> value with the actual implementation of your DbContext