4 :revdate: 5 October 2017
9 babeltrace-query - Query object from a component class
15 *babeltrace query* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path]
16 [opt:--omit-system-plugin-path]
17 [opt:--plugin-path='PATH'[:__PATH__]...]
18 [opt:--params='PARAMS'] 'TYPE.PLUGIN.COMPCLS' 'OBJECT'
23 The `query` command queries the object named 'OBJECT' from the component
24 class 'COMPCLS' of the type 'TYPE' found in the Babeltrace plugin
25 'PLUGIN' and prints the results.
27 See man:babeltrace-intro(7) to learn more about the Babeltrace
28 project and its core concepts.
30 The available values for 'TYPE' are:
34 Source component class.
38 Filter component class.
43 The exact object names and the parameters that a given component class
44 expects are described in its documentation. man:babeltrace-help(1) can
45 generally provide this information.
47 You can use the opt:--params='PARAMS' option to pass parameters to the
48 component class's query function. See <<params-fmt,Parameters format>>
49 for the exact format of 'PARAMS'.
51 The output of the `query` command looks like YAML, although it is not
52 guaranteed that it is YAML-compliant.
54 See <<examples,EXAMPLES>> for usage examples.
57 include::common-cmd-params-format.txt[]
59 include::common-cmd-plugin-path.txt[]
64 include::common-gen-options.txt[]
69 opt:-p 'PARAMS', opt:--params='PARAMS'::
70 Set the query parameters to 'PARAMS'. See <<params-fmt,Parameters
71 format>> for the exact format of 'PARAMS'.
74 include::common-plugin-path-options.txt[]
76 include::common-cmd-info-options.txt[]
82 .Query the available sessions of the LTTng live source component class.
86 $ babeltrace query src.ctf.lttng-live sessions \
87 --params='url="net://RHOST/host/TGTHOST"'
91 .Query the metadata info (includes the decoded text) of a CTF trace located on the local file system.
95 $ babeltrace query src.ctf.fs metadata-info \
96 --params='path="/path/to/trace"'
100 .Query the trace info of CTF traces located on the local file system.
104 $ babeltrace query src.ctf.fs trace-info \
105 --params='path="/path/to/trace"'
109 .Query some object from a sink component class without parameters.
113 $ babeltrace query sink.my-plugin.my-sink some-object
118 include::common-cli-env.txt[]
120 include::common-cli-files.txt[]
122 include::common-cmd-footer.txt[]
128 man:babeltrace-intro(7)