You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{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.
11
11
12
12
== Syntax
13
13
@@ -31,43 +31,42 @@ cbqueryreportgen [-<args>
31
31
32
32
== Description
33
33
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.
35
35
36
36
The tool allows users to specify a time range for the report, the type of report, and the output format.
37
37
By default, the output of the command is a report in HTML format.
38
38
You can save the generated report to a file or print it to the standard output.
39
39
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`.
41
41
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`.
43
43
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`.
45
45
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`.
47
47
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`.
49
49
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`.
51
51
52
52
optional Flags:
53
53
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).
55
55
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.
57
57
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.
59
59
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`.
61
61
62
-
The '-v, --verbose' flag enables verbose logging for debugging purposes.
62
+
The `-v, --verbose` flag enables verbose logging for debugging purposes.
63
63
64
-
The '-h, --help' flag prints the help information.
64
+
The `-h, --help` flag prints the help information.
65
65
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`.
67
67
68
68
The `--version` flag prints to the console the version number of the Couchbase Server.
69
69
70
70
== 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.)
72
71
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].
Copy file name to clipboardExpand all lines: modules/cli/pages/cli-intro.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -127,7 +127,7 @@ For the Server developer tools package, the {tools-ver} version of `cbimport`, `
127
127
128
128
You can download and use the latest version of the utilities (`cbimport`, `cbexport`, `cbbackupmgr`, and `cbq`) with earlier Couchbase Server versions.
129
129
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.
131
131
132
132
For the Server admin tools package, do the following:
0 commit comments