Add details on connecting to a virtual cluster using native cockroach sql options
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- sql
- Domain
- cli, documentation
Research direction
Open the work-with-virtual-clusters documentation page and review its existing PostgreSQL URL connection instructions. Add the documented cockroach sql --database cluster:/ option, then verify that the example clearly explains when it can be used alongside the URL approach.
Written by the indexing model from the issue text.
Description
Regarding this page: https://www.cockroachlabs.com/docs/stable/work-with-virtual-clusters
It describes how to connect to a virtual cluster by using a long-winded postgresql URL (postgresql://..... While this is fine, there's also the option to use the cockroach sql client like this:
cockroach sql --database cluster:<cluster name>/<database>
Sometimes, passing the cluster name in like this is easier than construction a long postgresql URL.
Could we add the use of cockroach sql --database to this page?
Jira issue: DOC-16297
- Dominant language
- HTML
- Stars
- 212
- Forks
- 479
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
rescript-lang/rescript#8761 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
ccch1mneyyy/dsh-TUI#1452 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100