Use auto-generated session settings from CockroachDB source code#23251
Open
rmloveland wants to merge 3 commits intomainfrom
Open
Use auto-generated session settings from CockroachDB source code#23251rmloveland wants to merge 3 commits intomainfrom
rmloveland wants to merge 3 commits intomainfrom
Conversation
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
rmloveland
force-pushed
the
20260430-DOC-12507-automated-session-settings
branch
from
9747974 to
ab3c1d9
Compare
Files changed:
|
Contributor
Author
|
@rafiss this is the docs update to pull in the autogenerated session settings you added in cockroachdb/cockroach#142228 ! |
rafiss
approved these changes
May 5, 2026
Contributor
rafiss
left a comment
rafiss
left a comment
There was a problem hiding this comment.
amazing! thanks for doing htis
taroface
reviewed
May 7, 2026
Contributor
taroface
left a comment
taroface
left a comment
There was a problem hiding this comment.
I think this automation is badly needed and overdue, so thank you for making it happen.
That said, I'm concerned that it completely erases the manual documentation of the settings, which in many cases were more descriptive and refined. Modest example: inject_retry_errors_enabled here versus in our docs. I'm not sure how to address this gap. What do you think about it?
Technical issue: The code formatting in the autogenerated table is not rendering correctly. I think we encountered this in the logging reference docs but don't recall how we fixed it.
| </div> | ||
|
|
||
| The following session variables are exposed only for backwards compatibility with earlier CockroachDB releases and have no impact on how CockroachDB runs: | ||
| **Read-only** indicates whether the variable can be changed in a session with [`SET`]({% link {{ page.version.version }}/set-vars.md %}). **Cluster Setting** identifies the [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) that supplies the default value, when applicable. |
Contributor
There was a problem hiding this comment.
Suggested change
| **Read-only** indicates whether the variable can be changed in a session with [`SET`]({% link {{ page.version.version }}/set-vars.md %}). **Cluster Setting** identifies the [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) that supplies the default value, when applicable. | |
| **Read-only** indicates whether the variable can be changed in a session with [`SET`]({% link {{ page.version.version }}/set-vars.md %}). **Cluster Setting** identifies the [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) that supplies the default value for the cluster, when applicable. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes DOC-12507