Aggiornata documentazione

Author: AngeloDotNet

src/CustomLibrary.EFCore/Docs/DBContext-GenericMethods.md

@@ -0,0 +1,63 @@
+# DBContext generic methods
+
+## Example entity
+```csharp
+public class MyEntity : IEntity<int>
+{
+    public int Id { get; set; }
+    public string Name { get; set; }
+    public string Description { get; set; }
+}
+```
+
+## Example interface
+```csharp
+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
+```csharp
+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);
+    }
+}
+```

src/CustomLibrary.EFCore/Docs/DBContextPoolRegistrationDifferentDatabases.md

@@ -0,0 +1,54 @@
+# DBContext Pool registration for different databases
+
+## Registering services at Startup
+```csharp
+public void ConfigureServices(IServiceCollection services)
+{
+  //numbers of retries to connect to the database
+  int retryOnFailure = 3; // or zero if you don't want to retry
+
+  //default assembly migrations (in this case the migrations will be created in the DbContext assembly)
+  string migrationsAssembly = string.Empty;
+
+  //or you can customize the assembly for migrations using the syntax
+  string migrationsAssembly = "MyAssembly.Migrations.MySQLDatabase";
+
+  services.AddDbContextServicesGenerics<MyDbContext>();
+
+  //if you use MySQL database
+  services.AddDbContextForMySql(connectionString, retryOnFailure, migrationsAssembly);
+
+  //if you use PostgreSQL database
+  services.AddDbContextForPostgres(connectionString, retryOnFailure, migrationsAssembly);
+
+  //if you use SQLServer database
+  services.AddDbContextForSQLServer(connectionString, retryOnFailure, migrationsAssembly);
+
+  //if you use SQLite database but in this case the retryOnFailure is not necessary as SQLite is not subject to transient errors
+  services.AddDbContextForSQLite(connectionString, migrationsAssembly);
+}
+```
+
+## Connection strings of the databases
+```json
+// for database MySQL / MariaDB
+"ConnectionStrings": {
+  "Default": "Server=[SERVER];Database=[DATABASE];Uid=[USERNAME];Pwd=[PASSWORD];Port=3306"
+}
+
+//for database PostgreSQL
+"ConnectionStrings": {
+  "Default": "Host=[SERVER];Port=5432;Database=[DATABASE];Username=[USERNAME];Password=[PASSWORD]"
+}
+
+//for database SQLServer
+"ConnectionStrings": {
+  "Default": "Data Source=[SERVER];Initial Catalog=[DATABASE];User ID=[USERNAME];Password=[PASSWORD]"
+//or "Default": "Data Source=[SERVER];Initial Catalog=[DATABASE];User ID=[USERNAME];Password=[PASSWORD];Encrypt=False"
+}
+
+//for database SQLite
+"ConnectionStrings": {
+    "Default": "Data Source=Data/MyDatabase.db"
+}
+```

src/CustomLibrary.EFCore/Docs/DBContextRegistrationDatabases.md

@@ -0,0 +1,25 @@
+# DBContext registration for databases SQL server
+
+## Registering services at Startup
+```csharp
+public void ConfigureServices(IServiceCollection services)
+{
+  //default assembly migrations (in this case the migrations will be created in the DbContext assembly)
+  string migrationsAssembly = string.Empty;
+
+  //or you can customize the assembly for migrations using the syntax
+  string migrationsAssembly = "MyAssembly.Migrations.MySQLDatabase";
+
+  services.AddDbContextServicesGenerics<MyDbContext>();
+  services.AddDbContextNoPoolSQLServer(connectionString, migrationsAssembly);
+}
+```
+
+## Connection strings of the databases
+```json
+//for database SQLServer
+"ConnectionStrings": {
+  "Default": "Data Source=[SERVER];Initial Catalog=[DATABASE];User ID=[USERNAME];Password=[PASSWORD]"
+  //or "Default": "Data Source=[SERVER];Initial Catalog=[DATABASE];User ID=[USERNAME];Password=[PASSWORD];Encrypt=False"
+}
+```