Skip to content

Commit 8de7118

Browse files
Pallavi-Janardhansimon-dew
authored andcommitted
DOC-12541 Added a new file and modified the cli-intro file
1 parent 00b1ce0 commit 8de7118

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

modules/cli/pages/cbqueryreportgen.adoc

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,48 @@
11
= cbqueryreportgen
2-
:page-component: Query
3-
4-
:description: A query tool that returns the complete details of any Query service to generate reports.
2+
:description: pass:q[A query tool that returns the complete details of any Query service to generate reports.]
53
:page-status: Couchbase Server 8.0
4+
:page-component: Query
65
ifndef::doctype-manpage[:doctitle: cbqueryreportgen]
6+
:page-component-version: 8.0
77
:page-topic-type: reference
88

9-
== SYNOPSIS
9+
[abstract]
10+
{A query tool that returns the complete details of any Query Service to generate reports.}
1011

11-
[verse]
12+
== Syntax
1213
The basic syntax is:
1314

1415
----
1516
cbqueryreportgen [-<args>]
1617
----
1718

1819
Required Flags:
19-
-c, --cluster The hostname of the Couchbase cluster. Example: couchbase://localhost
20-
-u, --username The username of the Couchbase cluster. Example: Administrator.
20+
-c, --cluster The hostname of the Couchbase cluster. Example: 'couchbase://localhost'.
21+
-u, --username The username of the Couchbase cluster. Example: 'Administrator'.
2122
-p, --password The password of the Couchbase cluster.
22-
-k, --keyspace The keyspace where the awr stats are read from. Example: travel-sample._default.awr.
23+
-k, --keyspace The keyspace where the awr stats are read from. Example: 'travel-sample._default.awr'.
2324
-t1, --time-period The required format is 'start-time, end-time' in the format 'YYYY-MM-DDTHH:MM:SS'. Example: '2025-10-01T00:00:00,2025-10-02T00:00:00'.
24-
-o, --output The output file to write the report to. Example: report.html.
25+
-o, --output The output file to write the report to. Example: 'report.html'.
2526

2627

2728
optional Flags:
2829

2930
--report-type The type of report to generate. Supported values are 'AWR' and 'ADHOC'. Default is 'AWR'(Automatic Workload Repository).
3031
--output-file The file path where the report will be saved. If not provided, the report will be printed to stdout.
31-
--format The format of the report. Default format is 'HTML'.
32-
-l, --limit The maximum number of results to include for every query. Default is 1000.
32+
--format The format of the report. 'HTML' is the default format.
33+
-l, --limit The maximum number of results to include for every query. The default is '1000'.
3334
-v, --verbose Enable verbose logging for debugging purposes.
3435
-h, --help Prints the help information.
3536

3637
== Description
3738

3839
cbqueryreportgen is a command-line tool that connects to a Couchbase cluster and generates performance reports based on the Query service's AWR statistics.
3940

40-
The tool allows users to specify a time range for the report, the type of report, and the output format. By default, the output of the command is a report in HTML format. You can save the generated report to a file or print it to the standard output.
41+
The tool allows users to specify a time range for the report, the type of report, and the output format.
42+
By default, the output of the command is a report in HTML format.
43+
You can save the generated report to a file or print it to the standard output.
4144

42-
For more information on how specific commands work, you can run "cbqueryreportgen --help".
45+
For more information on how specific commands work, run "cbqueryreportgen --help".
4346

4447
ifeval::['{page-component-version}' == '8.0']
4548
This tool is only available in Couchbase Server 8.0 and later.

0 commit comments

Comments
 (0)