Skip to content

Commit c0e0e5f

Browse files
Pallavi-Janardhansimon-dew
authored andcommitted
DOC-12541 Added a new file and modified the cli-intro file
1 parent 86e58c0 commit c0e0e5f

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed
Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
= cbqueryreportgen
2-
:description: pass:q[The 'cbqueryreportgen' tool returns the complete details of any Query service to generate reports.]
2+
:description: pass:q[The `cbqueryreportgen` tool returns the complete details of any Query service to generate reports.]
33
:page-status: Couchbase Server 8.0
44
:page-component: Query
55
ifndef::doctype-manpage[:doctitle: cbqueryreportgen]
66
:page-component-version: 8.0
77
:page-topic-type: reference
88

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

1212
== Syntax
1313

@@ -31,43 +31,42 @@ cbqueryreportgen [-<args>
3131

3232
== Description
3333

34-
The 'cbqueryreportgen' command connects to a Couchbase cluster and generates performance reports based on the Query service's AWR statistics.
34+
The `cbqueryreportgen` command connects to a Couchbase cluster and generates performance reports based on the Query Service's AWR statistics.
3535

3636
The tool allows users to specify a time range for the report, the type of report, and the output format.
3737
By default, the output of the command is a report in HTML format.
3838
You can save the generated report to a file or print it to the standard output.
3939

40-
The '--cluster' flag specifies the hostname of the Couchbase cluster. Example: 'couchbase://localhost'.
40+
The `--cluster` flag specifies the hostname of the Couchbase cluster. Example: `cbqueryreportgen couchbase://localhost`.
4141

42-
The '--username' flag specifies the username of the Couchbase cluster. Example: 'Administrator'.
42+
The `--username` flag specifies the username of the Couchbase cluster. Example: `cbqueryreportgen --username Administrator`.
4343

44-
The '--password' flag specifies the password of the Couchbase cluster. Example: 'password'.
44+
The `--password` flag specifies the password of the Couchbase cluster. Example: `cbqueryreportgen --password password`.
4545

46-
The '--keyspace' flag specifies the keyspace where the AWR stats are read from. Example: 'travel-sample._default.awr'.
46+
The `--keyspace` flag specifies the keyspace where the AWR stats are read from. Example: `cbqueryreportgen --keyspace travel-sample._default.awr`.
4747

48-
The '--time-period' flag specifies the time period for the report. 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'.
48+
The `--time-period` flag specifies the time period for the report. 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`.
4949

50-
The '--output' flag specifies the output file to write the report to. Example: 'report.html'.
50+
The `--output` flag specifies the output file to write the report to. Example: `cbqueryreportgen --output report.html`.
5151

5252
optional Flags:
5353

54-
The '--report-type' flag specifies the type of report to generate. Supported values are 'AWR' and 'ADHOC'. Default is 'AWR'(Automatic Workload Repository).
54+
The `--report-type` flag specifies the type of report to generate. Supported values are 'AWR' and 'ADHOC'. Default is 'AWR'(Automatic Workload Repository).
5555

56-
The '--output-file' flag specifies the file path where the report will be saved. If not provided, the report will be printed to stdout.
56+
The `--output-file` flag specifies the file path where the report will be saved. If not provided, the report will be printed to stdout.
5757

58-
The '--format' flag specifies the format of the report. 'HTML' is the default format.
58+
The `--format` flag specifies the format of the report. `HTML` is the default format.
5959

60-
The '-l, --limit' flag specifies the maximum number of results to include for every query. The default is '1000'.
60+
The `-l, --limit` flag specifies the maximum number of results to include for every query. The default is `1000`.
6161

62-
The '-v, --verbose' flag enables verbose logging for debugging purposes.
62+
The `-v, --verbose` flag enables verbose logging for debugging purposes.
6363

64-
The '-h, --help' flag prints the help information.
64+
The `-h, --help` flag prints the help information.
6565

66-
For more information on how the specific command works, run "cbqueryreportgen --help".
66+
For more information about how the specific command works, run `cbqueryreportgen --help`.
6767

6868
The `--version` flag prints to the console the version number of the Couchbase Server.
6969

7070
== See Also
71-
(Writer's NOTE: Should we include more information after this? If yes, will change the xref's to appropriate links else will remove this section.)
7271

73-
For more information on AWR, see xref:n1ql:n1ql-manage/query-awr.adoc[ AWR Query].
72+
For detailed information, see xref:n1ql:n1ql-manage/query-awr.adoc[Automatic Workload Repository].

modules/cli/pages/cli-intro.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ For the Server developer tools package, the {tools-ver} version of `cbimport`, `
127127

128128
You can download and use the latest version of the utilities (`cbimport`, `cbexport`, `cbbackupmgr`, and `cbq`) with earlier Couchbase Server versions.
129129

130-
The 'cbqueryreportgen' utility is supported only on Couchbase Server 8.0 and later.
130+
The `cbqueryreportgen` utility is supported only on Couchbase Server 8.0 or later.
131131

132132
For the Server admin tools package, do the following:
133133

0 commit comments

Comments
 (0)