Commit | Line | Data |
---|---|---|
2facbdc3 | 1 | = babeltrace2-query(1) |
838dd456 | 2 | :manpagetype: command |
2facbdc3 | 3 | :revdate: 14 September 2019 |
838dd456 PP |
4 | |
5 | ||
2facbdc3 PP |
6 | == NAME |
7 | ||
8 | babeltrace2-query - Query an object from a Babeltrace 2 component class | |
838dd456 PP |
9 | |
10 | ||
2facbdc3 PP |
11 | == SYNOPSIS |
12 | ||
838dd456 | 13 | [verse] |
2facbdc3 PP |
14 | *babeltrace2* [<<gen-opts,'GENERAL OPTIONS'>>] *query* [opt:--params='PARAMS'] |
15 | 'COMP-CLS-TYPE'.'PLUGIN-NAME'.'COMP-CLS-NAME' 'OBJECT' | |
16 | ||
838dd456 | 17 | |
2facbdc3 | 18 | == DESCRIPTION |
838dd456 | 19 | |
838dd456 | 20 | The `query` command queries the object named 'OBJECT' from the component |
2facbdc3 PP |
21 | class named 'COMP-CLS-NAME' of the type 'COMP-CLS-TYPE' found in the |
22 | Babeltrace~2 plugin named 'PLUGIN-NAME' and prints the results. | |
838dd456 | 23 | |
2facbdc3 | 24 | include::common-see-babeltrace2-intro.txt[] |
838dd456 | 25 | |
2facbdc3 | 26 | The available values for 'COMP-CLS-TYPE' are: |
838dd456 PP |
27 | |
28 | `source`:: | |
29 | `src`:: | |
30 | Source component class. | |
31 | ||
32 | `filter`:: | |
33 | `flt`:: | |
34 | Filter component class. | |
35 | ||
36 | `sink`:: | |
37 | Sink component class. | |
38 | ||
39 | The exact object names and the parameters that a given component class | |
2facbdc3 PP |
40 | expects are described in its own documentation. man:babeltrace2-help(1) |
41 | can generally provide this information. | |
838dd456 | 42 | |
2facbdc3 PP |
43 | You can use the opt:--params option to pass parameters to the component |
44 | class's query operation. | |
838dd456 | 45 | |
2facbdc3 PP |
46 | The output of the `query` command can look like https://yaml.org/[YAML], |
47 | but it's not guaranteed to be YAML-compliant. | |
838dd456 | 48 | |
2facbdc3 | 49 | See <<examples,``EXAMPLES''>> for usage examples. |
838dd456 | 50 | |
838dd456 | 51 | |
2facbdc3 | 52 | == OPTIONS |
838dd456 | 53 | |
838dd456 PP |
54 | include::common-gen-options.txt[] |
55 | ||
56 | ||
2facbdc3 | 57 | === Query parameters |
838dd456 | 58 | |
2facbdc3 PP |
59 | opt:-p 'PARAMS':: |
60 | opt:--params='PARAMS':: | |
61 | Set the query parameters to 'PARAMS'. | |
62 | + | |
63 | -- | |
64 | include::common-cmd-params-format.txt[] | |
65 | -- | |
838dd456 | 66 | |
838dd456 PP |
67 | |
68 | include::common-cmd-info-options.txt[] | |
69 | ||
70 | ||
71 | [[examples]] | |
2facbdc3 PP |
72 | == EXAMPLES |
73 | ||
74 | .Query the available tracing sessions of a local LTTng relay daemon. | |
838dd456 PP |
75 | ==== |
76 | [role="term"] | |
77 | ---- | |
c1f82f3b | 78 | $ babeltrace2 query src.ctf.lttng-live sessions \ |
2facbdc3 | 79 | --params='url="net://localhost"' |
838dd456 PP |
80 | ---- |
81 | ==== | |
82 | ||
2facbdc3 | 83 | .Query the metadata info (includes the decoded plain text) of a CTF trace located on the local file system. |
838dd456 PP |
84 | ==== |
85 | [role="term"] | |
86 | ---- | |
c1f82f3b | 87 | $ babeltrace2 query src.ctf.fs metadata-info \ |
2facbdc3 | 88 | --params='path="/path/to/trace"' |
838dd456 PP |
89 | ---- |
90 | ==== | |
91 | ||
2facbdc3 | 92 | .Query the trace infos of a CTF trace located on the local file system. |
838dd456 PP |
93 | ==== |
94 | [role="term"] | |
95 | ---- | |
2facbdc3 | 96 | $ babeltrace2 query src.ctf.fs babeltrace.trace-infos \ |
9e534aae | 97 | --params='path="/path/to/trace"' |
838dd456 PP |
98 | ---- |
99 | ==== | |
100 | ||
101 | .Query some object from a sink component class without parameters. | |
102 | ==== | |
103 | [role="term"] | |
104 | ---- | |
c1f82f3b | 105 | $ babeltrace2 query sink.my-plugin.my-sink some-object |
838dd456 PP |
106 | ---- |
107 | ==== | |
108 | ||
109 | ||
110 | include::common-cli-env.txt[] | |
111 | ||
2facbdc3 | 112 | |
838dd456 PP |
113 | include::common-cli-files.txt[] |
114 | ||
2facbdc3 | 115 | |
838dd456 PP |
116 | include::common-cmd-footer.txt[] |
117 | ||
118 | ||
2facbdc3 PP |
119 | == SEE ALSO |
120 | ||
121 | man:babeltrace2-intro(7), | |
122 | man:babeltrace2(1) |