# Swift Assist — Debug and SQL evidence Pass one `SQLExecutionEvidenceStore` to the trusted `UserContext` as its telemetry sink. Application diagnostics should use `safeSQLEvidence`, which exposes parameterized SQL and parameter count but never raw parameter values. ```swift import TeaQLCore public struct SafeSQLEvidence: Sendable, Equatable { public let operation: String public let parameterizedSQL: String public let parameterCount: Int public let elapsedMicros: UInt64 public let resultCount: Int? public let affectedRows: Int? public let resultSummary: String public let traceChain: [TraceNode] public let tracePath: [TraceNode] } public func safeSQLEvidence( from store: SQLExecutionEvidenceStore ) async -> [SafeSQLEvidence] { await store.snapshot().map { SafeSQLEvidence( operation: $0.operation.rawValue, parameterizedSQL: $0.parameterizedSQL, parameterCount: $0.parameters.count, elapsedMicros: $0.elapsedMicros, resultCount: $0.resultCount, affectedRows: $0.affectedRows, resultSummary: $0.resultSummary, traceChain: $0.traceChain, tracePath: $0.tracePath) } } ``` Use `enableAll()`, `enableSelect()`, `enableMutation()`, and `disable()` on the evidence store. Mode changes clear previous entries. Raw `SQLExecutionMetadata.parameters` remain trusted-boundary data. Every generated query still requires non-empty `comment(...)` and `purpose(...)`; every mutation requires `auditAs(...)`. Preserve not-found, checker, optimistic-conflict, and provider failures. Query and mutation logs and `TextDiagnosticSQLLogSink` are enabled by default. The sink is available as the trusted context's `diagnosticSQLLogSink`. Set `context.querySQLLogEnabled` and `context.mutationSQLLogEnabled` independently. Each metadata entry retains structured comment, purpose, audit reason, typed multi-level trace, parameterized SQL, copy-paste `debugSQL`, elapsed time, result count, and affected rows. Never attach rendered SQL to ordinary telemetry or responses. `traceChain` is the business request ancestry: root purpose, root comment, native Q operation and nested comment. `tracePath` is the physical provider/SQL route. Keep both value snapshots; native method names locate source calls, not filenames or line numbers. A non-SQL operation parent is not another SQL record. --- ## TeaQL seven-language assist contract Apply the verified Rust semantic ceiling while using only the exact SWIFT generated and runtime APIs. Discover APIs through the generated application AGENTS.md and progressive model-aware Assist. Do not inspect generated domain-library source. - Do not create plurals by appending `s` or `es`; use the centralized generated plural. - Human and non-human entities use different generated predicate vocabularies. Preserve forms such as “who are active” and “whose email is”; never infer them from English. - Configure filters, projection, paging, and other query options before `purpose(...)`. Comment may appear anywhere in the chain. Purpose enters the executable stage; execution requires both values, but comment does not have to immediately precede purpose. - Every execute/list/stream and every save accepts exactly one context argument: `UserContext`. Name that argument `context`, never `runtime`; data services and global policy are injected when the context is built. Reserve `runtime` for process-level runtime ownership, provider/pool setup, and module assembly. - Tenant, merchant, identity, permissions, request policy, purpose policy, hard limit, and continuous-page cursor policy come only from trusted context, never dynamic JSON or TFP. - If the required operation is absent after current entity/action and required field Assist, stop that path and report MISSING_ASSIST. Do not guess an API or search the generated library as a fallback. - Create each application-owned source file once. After its first compile attempt, repair only the smallest block identified by the exact compiler or test diagnostic. Preserve unrelated code; do not rewrite the complete file as an error-recovery loop. - Before a repair that would replace more than 25% of an existing application file, stop and report LARGE_REWRITE_REQUEST with the file, exact diagnostic, reason, and estimated scope. Initial creation and model-driven regeneration are not repairs. Capability: `debug`. - Capture purpose, comment, trace/correlation id, runtime-projected expanded masked SQL and its masking mode, duration, row count, provider and the native response. - Preserve the immutable row audit event and the customizable App Audit Sink as separate paths. Redact credentials, tokens, connection strings, and customer data. - Document only switches and hooks present in the selected runtime source. ## Standard OpenTelemetry module Use the optional standard module supplied by the selected TeaQL runtime. Match its version to the runtime dependency selected by the model and workspace; keep local source or internal Registry overrides during development. Do not upgrade to an unrelated public release just to enable telemetry. A runtime without this module reports `module_unavailable`; package installation alone does not enable export. On a supported backend, configure these trusted process variables before startup, never through a query, JSON or TFP payload: ```bash export TEAQL_TELEMETRY_ENABLED=true export TEAQL_TELEMETRY_SERVICE_NAME=payment-service export TEAQL_TELEMETRY_OTLP_ENDPOINT=http://localhost:4318 ``` Without enablement, startup reports `disabled` and all three activation variables; no SDK export resources are created. Enabled startup reports safe effective settings, full recording and masking. Invalid settings produce a fixed safe diagnostic, not a claim of successful export. Never print credentials or raw configuration values. The module automatically records supported Q, graph mutation and physical SQL operations as traces, logs and metrics. SQL is expanded with masked parameters; plaintext debugging never authorizes plaintext telemetry export. Full recording does not promise lossless delivery when bounded queues or exporters fail. Do not add per-method spans or replace the customer's global SDK providers. Keep schema reconciliation explicit. Run the generated ensure-schema and seed flow through the same configured runtime to observe startup settings and audited, idempotent seeding. Telemetry setup must not run ensure-schema implicitly. Flush and shut down the owned pipeline at application shutdown, not per query. Exporter failures do not change business results; durable business audit remains an independent path. ### Swift assembly Add the optional `TeaQLStandardTelemetry` product to the application's target dependencies, from the same package identity and version already supplying `TeaQLCore`. This works with the selected local or Registry package; do not add a second runtime source. Register once before creating TeaQLRuntime or UserContext: ```swift import TeaQLStandardTelemetry StandardTelemetryModule.install() ``` The disabled registration does not construct an SDK pipeline. Set the three variables before starting the process. Business methods need no SDK code.