|
1 | 1 | = 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.] |
5 | 3 | :page-status: Couchbase Server 8.0
|
| 4 | +:page-component: Query |
6 | 5 | ifndef::doctype-manpage[:doctitle: cbqueryreportgen]
|
| 6 | +:page-component-version: 8.0 |
7 | 7 | :page-topic-type: reference
|
8 | 8 |
|
9 |
| -== SYNOPSIS |
| 9 | +[abstract] |
| 10 | +{A query tool that returns the complete details of any Query Service to generate reports.} |
10 | 11 |
|
11 |
| -[verse] |
| 12 | +== Syntax |
12 | 13 | The basic syntax is:
|
13 | 14 |
|
14 | 15 | ----
|
15 | 16 | cbqueryreportgen [-<args>]
|
16 | 17 | ----
|
17 | 18 |
|
18 | 19 | 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'. |
21 | 22 | -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'. |
23 | 24 | -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'. |
25 | 26 |
|
26 | 27 |
|
27 | 28 | optional Flags:
|
28 | 29 |
|
29 | 30 | --report-type The type of report to generate. Supported values are 'AWR' and 'ADHOC'. Default is 'AWR'(Automatic Workload Repository).
|
30 | 31 | --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'. |
33 | 34 | -v, --verbose Enable verbose logging for debugging purposes.
|
34 | 35 | -h, --help Prints the help information.
|
35 | 36 |
|
36 | 37 | == Description
|
37 | 38 |
|
38 | 39 | cbqueryreportgen is a command-line tool that connects to a Couchbase cluster and generates performance reports based on the Query service's AWR statistics.
|
39 | 40 |
|
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. |
41 | 44 |
|
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". |
43 | 46 |
|
44 | 47 | ifeval::['{page-component-version}' == '8.0']
|
45 | 48 | This tool is only available in Couchbase Server 8.0 and later.
|
|
0 commit comments