cockroachdb/cockroach

stmtbundle: add recent schema changes and descriptor JSON

Closed

#170,491 opened on May 18, 2026

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Go (4,124 forks)batch import
A-sql-debug-bundleC-enhancementE-starterT-sql-queriesgood first issue

Repository metrics

Stars
 (32,150 stars)
PR merge metrics
 (Avg merge 5d 4h) (26 merged PRs in 30d)

Description

When investigating optimizer bugs, In order to rule out schema changes and other interactions with descriptor state, we should consider adding two things to statement diagnostics bundles:

  1. a list of all known schema changes for each schema object used by the statement
  2. the pretty-printed descriptor JSON for the descriptor of each schema object used by the statement

Jira issue: CRDB-64033

Contributor guide

Research direction
Focus on the stmtbundle package in the CockroachDB source, likely under pkg/sql/... The issue asks to add schema changes and descriptor JSON to statement diagnostics bundles. Review existing bundle structure and the descriptor API. Check comments in the issue for any clarifications. No linked PRs or assignees.
Tech stack
gosql
Domain
backenddatabase
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Go programmingCockroachDB internalsSQL schema concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30