From 064d9f258c8c005a6ed5c1e0abe09d282bcd76b1 Mon Sep 17 00:00:00 2001 From: ebembi-crdb <169454390+ebembi-crdb@users.noreply.github.com> Date: Fri, 15 May 2026 15:09:05 +0530 Subject: [PATCH] ref-docs: append draft for sql: add grammar for SHOW INSPECT ERRORS command --- src/current/v26.1/show-inspect-errors.md | 82 ++++++++++++++++++++++++ 1 file changed, 82 insertions(+) diff --git a/src/current/v26.1/show-inspect-errors.md b/src/current/v26.1/show-inspect-errors.md index ba239239c3f..b92696144e9 100644 --- a/src/current/v26.1/show-inspect-errors.md +++ b/src/current/v26.1/show-inspect-errors.md @@ -116,3 +116,85 @@ SHOW INSPECT ERRORS FOR TABLE movr.public.users WITH DETAILS; - [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) - [Jobs page in DB Console]({% link {{ page.version.version }}/ui-jobs-page.md %}) - [Authorization]({% link {{ page.version.version }}/security-reference/authorization.md %}#supported-privileges) + + + +```yaml +--- +title: SHOW INSPECT ERRORS +summary: Display errors from data consistency validation jobs in CockroachDB. +toc: true +docs_area: reference.sql +--- +``` + +The `SHOW INSPECT ERRORS` statement displays errors from data consistency validation jobs. This statement is currently unimplemented and will be fully functional in a future release. + +## Required privileges + +The user must have the `INSPECT` [system privilege]({% link {{ page.version.version }}/security-reference/authorization.md %}#supported-privileges). + +## Synopsis + +{% include_cached copy-clipboard.html %} +~~~ sql +SHOW INSPECT ERRORS [FOR TABLE table_name] [FOR JOB job_id] [WITH DETAILS] +~~~ + +## Parameters + +Parameter | Description +----------|------------ +`table_name` | Show errors only for the specified table +`job_id` | Show errors only for the specified data consistency validation job ID +`WITH DETAILS` | Include additional detailed information about each error + +## Examples + +Show all data consistency validation errors: + +{% include_cached copy-clipboard.html %} +~~~ sql +SHOW INSPECT ERRORS; +~~~ + +Show errors for a specific table: + +{% include_cached copy-clipboard.html %} +~~~ sql +SHOW INSPECT ERRORS FOR TABLE users; +~~~ + +Show errors for a specific validation job: + +{% include_cached copy-clipboard.html %} +~~~ sql +SHOW INSPECT ERRORS FOR JOB 123456789; +~~~ + +Show detailed error information: + +{% include_cached copy-clipboard.html %} +~~~ sql +SHOW INSPECT ERRORS WITH DETAILS; +~~~ + +Combine options to filter errors for a specific table and job with details: + +{% include_cached copy-clipboard.html %} +~~~ sql +SHOW INSPECT ERRORS FOR TABLE orders FOR JOB 987654321 WITH DETAILS; +~~~ + +{{site.data.alerts.callout_info}} +This statement is currently unimplemented. The grammar has been added in preparation for future data consistency validation functionality. +{{site.data.alerts.end}} + +## See also + +- [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) +- [System privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#supported-privileges) + +[NEEDS REVIEW: The exact output format and available columns are not specified since the statement is unimplemented. The system.inspect_errors table structure should be documented once the implementation is complete.] + +