Skip to content

Example: SQL catalog

A sql/index.md page indexes every SQL statement and stored procedure call doc gen found in a repository, grouped by operation type. It is the entry point to the per-statement sql/SQL-NNN.md pages, and reviewers use it to confirm that the statement inventory is complete and readable at a glance.

What reviewers should check

  • The Description column is a short intent summary of roughly 4-12 words. Raw or truncated SQL pasted into that column — column lists, aliases, WHERE fragments — is the headline defect for this page.
  • Every description starts with an operation verb (Insert, Retrieve, Update, Delete, Fetch next) and names the entity in business terms, not table or column names lifted from the statement.
  • Descriptions agree with the one-line summary on the matching sql/SQL-NNN.md document; where that summary already reads as intent it should simply be reused rather than reworded.
  • Only the operation sections that actually have statements are present. Empty Create, Read, Update, Delete, or Sequence sections must be omitted, not left in place with a placeholder row.
  • The Sequence table uses the Sequence column in place of Type, and holds only identity or NEXTVAL retrieval statements.
  • Every SQL ID is a working link to a file that exists in the same sql/ folder, and the Type column reads exactly Inline or Stored Proc.
  • The Related documentation list uses the canonical page names and links every standard page except this one, and ## Sources is the final section.

Example

The document below is a complete, correct sql/index.md.

View rendered example — the same document as a real page, so you can compare rendering as well as source.

---
title: SAIF.Framework.Validation SQL catalog
summary: Index of all SQL statements used by this library, grouped by operation type.
status: draft
owner: Claims Systems Team
last_reviewed: 2026-08-14
library: SAIF.Framework.Validation
reference_type: package
---

# SAIF.Framework.Validation SQL catalog

This page indexes all SQL statements and stored procedure calls in this library, grouped by CRUD type.

## Create operations

| SQL ID | Description | Type | Tables | Business object |
| --- | --- | --- | --- | --- |
| [SQL-001](SQL-001.md) | Insert a validation failure record for a claim | Inline | ValidationFailureAudit | `ValidationAuditRepository` |
| [SQL-002](SQL-002.md) | Insert the header row for a rule set run | Inline | RuleSetExecution | `RuleSetExecutionRepository` |

## Read operations

| SQL ID | Description | Type | Tables | Business object |
| --- | --- | --- | --- | --- |
| [SQL-004](SQL-004.md) | Retrieve active rule definitions for a jurisdiction | Inline | ValidationRuleDefinition, Jurisdiction | `RuleDefinitionRepository` |
| [SQL-007](SQL-007.md) | Retrieve pending premium audits for a processing window | Stored Proc | PremiumAuditQueue, Policy, AuditStatus | `PendingAuditRepository` |

## Update operations

| SQL ID | Description | Type | Tables | Business object |
| --- | --- | --- | --- | --- |
| [SQL-009](SQL-009.md) | Update the validation status of a claim | Inline | ClaimValidationStatus | `ClaimValidationStatusRepository` |

## Delete operations

| SQL ID | Description | Type | Tables | Business object |
| --- | --- | --- | --- | --- |
| [SQL-011](SQL-011.md) | Delete cached rule definitions past their retention | Inline | RuleDefinitionCache | `RuleCacheRepository` |

## Sequence operations

| SQL ID | Description | Sequence | Tables | Business object |
| --- | --- | --- | --- | --- |
| [SQL-012](SQL-012.md) | Fetch next generated identity for an audit row | `SCOPE_IDENTITY()` | ValidationFailureAudit | `ValidationAuditRepository` |

## Related documentation
- [Index](../index.md)
- [Overview](../overview.md)
- [Architecture](../architecture.md)
- [Dependencies](../dependencies.md)
- [Operations and processes](../operations-processes.md)
- [Business rules](../business-rules.md)
- [Database tables](../database-tables.md)
- [API reference](../api/index.md)

## Sources
- src/SAIF.Framework.Validation/Data/ValidationAuditRepository.vb
- src/SAIF.Framework.Validation/Data/RuleSetExecutionRepository.vb
- src/SAIF.Framework.Validation/Data/RuleDefinitionRepository.vb
- src/SAIF.Framework.Validation/Data/ClaimValidationStatusRepository.vb
- src/SAIF.Framework.Validation/Data/RuleCacheRepository.vb
- src/SAIF.Framework.Validation/Data/PendingAuditRepository.vb