update infra docs

This commit is contained in:
Aaron Po
2026-08-04 06:18:54 -04:00
parent 19dfad5ab5
commit f9acdc8ada
11 changed files with 21 additions and 151 deletions

View File

@@ -6,15 +6,12 @@ namespace Infrastructure.Sql;
/// Base class for ADO.NET-based repositories, providing shared connection creation and
/// entity-mapping infrastructure for derived repository implementations.
/// </summary>
/// <typeparam name="T">The entity type managed by the repository.</typeparam>
/// <param name="connectionFactory">The factory used to create database connections.</param>
public abstract class Repository<T>(ISqlConnectionFactory connectionFactory)
where T : class
{
/// <summary>
/// Creates and opens a new database connection using the configured <see cref="ISqlConnectionFactory" />.
/// </summary>
/// <returns>An open <see cref="DbConnection" /> ready for use.</returns>
/// <exception cref="DbException">Thrown when the connection cannot be opened.</exception>
protected async Task<DbConnection> CreateConnection()
{
@@ -26,7 +23,5 @@ public abstract class Repository<T>(ISqlConnectionFactory connectionFactory)
/// <summary>
/// Maps the current row of a data reader to an instance of <typeparamref name="T" />.
/// </summary>
/// <param name="reader">The data reader positioned on the row to map.</param>
/// <returns>The mapped entity instance.</returns>
protected abstract T MapToEntity(DbDataReader reader);
}