docs(auditlog): generalize two stale XML-doc comments

- AddColumnIfMissing is now shared by ExecutionId and ParentExecutionId;
  drop the ExecutionId-specific tag.
- AuditLogRepository.GetExecutionTreeAsync doc no longer hardcodes the
  MAXRECURSION literal; reference the ExecutionChainMaxDepth const instead.
This commit is contained in:
Joseph Doherty
2026-05-21 20:14:31 -04:00
parent 933f0484ba
commit 9ec83d5070
2 changed files with 6 additions and 4 deletions

View File

@@ -147,8 +147,9 @@ public class SqliteAuditWriter : IAuditWriter, ISiteAuditQueue, IAsyncDisposable
} }
/// <summary> /// <summary>
/// Audit Log #23 (ExecutionId): adds a column to <c>AuditLog</c> only when /// Audit Log #23: additively adds a column to <c>AuditLog</c> only when
/// it is not already present. SQLite lacks <c>ADD COLUMN IF NOT EXISTS</c>, /// it is not already present (used for <c>ExecutionId</c> and
/// <c>ParentExecutionId</c>). SQLite lacks <c>ADD COLUMN IF NOT EXISTS</c>,
/// so the schema is probed via <c>PRAGMA table_info</c> first. Idempotent — /// so the schema is probed via <c>PRAGMA table_info</c> first. Idempotent —
/// safe to run on every <see cref="InitializeSchema"/>. Mirrors /// safe to run on every <see cref="InitializeSchema"/>. Mirrors
/// <c>StoreAndForwardStorage.AddColumnIfMissingAsync</c>; kept synchronous /// <c>StoreAndForwardStorage.AddColumnIfMissingAsync</c>; kept synchronous

View File

@@ -581,8 +581,9 @@ VALUES
/// and joining <c>edge.ParentExecutionId = chain.ExecutionId</c> to /// and joining <c>edge.ParentExecutionId = chain.ExecutionId</c> to
/// enumerate every descendant. Recursing over edges rather than raw rows /// enumerate every descendant. Recursing over edges rather than raw rows
/// keeps the recursion one path wide per execution. It is bounded by /// keeps the recursion one path wide per execution. It is bounded by
/// <c>OPTION (MAXRECURSION 32)</c> — corrupt cyclic data raises a /// <c>OPTION (MAXRECURSION ...)</c> at <see cref="ExecutionChainMaxDepth"/>
/// <see cref="SqlException"/> (msg 530) rather than spinning. /// — corrupt cyclic data raises a <see cref="SqlException"/> (msg 530)
/// rather than spinning.
/// </para> /// </para>
/// <para> /// <para>
/// The chain's full execution-id set is every edge's <c>ExecutionId</c> /// The chain's full execution-id set is every edge's <c>ExecutionId</c>