End-User Documentation

SqlValidationResult and AssemblyValidationResult

SqlValidationResult and AssemblyValidationResult

These result objects are designed for assertions, readable failures, and reporting.

SqlValidationResult

  • IsValid
  • Errors
  • Warnings
  • ErrorSummary
  • Source
  • StatementType

ErrorSummary returns "No issues found." when validation produced neither errors nor warnings.

AssemblyValidationResult

  • Results
  • AllValid
  • TotalErrors
  • TotalWarnings
  • QueriesValidated
  • InsertsValidated
  • UpdatesValidated
  • DeletesValidated
  • Summary

Summary groups issues by source member so CI logs are easy to scan.

Example

var query = new SqlQuery("SELECT FROM customers");
SqlValidationResult singleResult = new(query.Errors, query.Warnings, "Orders.GetAll", query.StatementType);

var assemblyResult = QueryLens.ValidateAssembly(typeof(OrderQueries).Assembly);
Assert.NotNull(assemblyResult.Summary);

Related