Fill gaps in the Query devex documentation for Capella caused by the lack of an "official" command line client. Two options were considered:

1. Add cbq instructions wherever the devex docs for Server use the cbq shell
2. Add Couchbase Shell instructions, if possible, using the query command

Following MB-61482, we will be following option 1 cbq.

Gaps in the Query Developer Documentation for Capella

Read Data and Return Results › Set the Query Context for Server has instructions for cbq shell.
Read Data and Return Results › Set the Query Context for Capella has no command-line option.

Prepare Statements for Reuse › Supply Parameter Values for Server has instructions for cbq shell.
Prepare Statements for Reuse › Supply Parameter Values for Capella has no command-line option.
Note: CB Shell does not currently support named or positional parameters.

Use the Cost-Based Optimizer with Queries › Activate the Cost-Based Optimizer for Server has instructions for cbq shell.
Use the Cost-Based Optimizer with Queries › Activate the Cost-Based Optimizer for Capella has no command-line option.
Note: CB Shell does not currently support the use-cbo parameter.

SQL+⁠+ Support for Couchbase Transactions › Query Tools for Server has instructions for cbq shell.
SQL+⁠+ Support for Couchbase Transactions › Query Tools for Capella has no command-line option.
Note: CB Shell does not currently support transactions or transaction parameters.

Create Couchbase Transactions with SQL++ for Server has instructions for cbq shell.
Create Couchbase Transactions with SQL++ for Capella has no command-line option.
Note: CB Shell does not currently support transactions or transaction parameters.

Manage and Monitor Queries › Monitoring and Profiling for Server has instructions for cbq shell.
There is no equivalent page for Capella.
Note: CB Shell does not currently support the profile parameter.

Settings and Parameters › Request-Level Parameters for Server has instructions for cbq shell.
There is no equivalent page for Capella.
Note: CB Shell does not currently support request-level parameters.

To standardize on CB shell as the Query command-line tool for Capella ...

We would have to enhance CB shell so that it has feature parity with cbq:

• Enable multi-statement queries in CB shell, separated by semi-colons.
• Enable transactions and transaction parameters in CB shell.
• Enable named parameters and positional parameters in CB shell.
• Enable all request-level parameters in CB shell.

To make cbq available in Capella ...

We would have to do the following:

• Make cbq available in the Couchbase Server Tools download.
• Add cbq to the Connect section in the Capella UI, enabling users to do the following:
  • get a connection string;
  • specify a user and set access;
  • specify allowed IP addresses;
  • download the root certificate and tell users how to specify the client key and chain certificate;
  • generate a copy-and-paste command containing all this information.

Just as we do for cbsh, the SDKs, and the other command line tools.