Skip to content

Commit

Permalink
567564: Single query report
Browse files Browse the repository at this point in the history 
Help updates

Task-Url: https://bugs.eclipse.org/bugs/show_bug.cgi?id=567564

Change-Id: Ibda8ac5f61d0f3b2f8e41c35583e5aaaea77c947
  • Loading branch information
@ajohnson1
ajohnson1 committed Oct 4, 2020
1 parent c33b21b commit e2bad31
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 114 deletions.
62 changes: 35 additions & 27 deletions plugins/org.eclipse.mat.ui.help/reference/inspections/query_report.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@
http://www.eclipse.org/legal/epl-v10.html
</copyrholder>
</copyright>
<metadata>
<prodinfo>
<prodname>Eclipse Memory Analyzer</prodname>
<vrmlist><vrm version="1" release="11" modification="0"/></vrmlist>
<platform>Windows</platform>
<platform>Linux</platform>
</prodinfo>
</metadata>
</prolog>

<refbody>
Expand Down Expand Up @@ -55,35 +63,35 @@
<title>Result</title>
<p>An HTML report holding the result of the query.</p>
</section>
<example platform="windows">
<p>Simple example of a histogram for Windows</p>
<example platform="Windows">
<title>Simple example of a histogram for Windows</title>
<p>
<codeph>
<cmdname>./mat/ParseHeapDump.bat</cmdname>
<varname>myheapdump.hprof</varname>
<filepath><cmdname>.\mat\ParseHeapDump.bat</cmdname></filepath>
<filepath>myheapdump.hprof</filepath>
<option>-command=</option><cmdname>histogram</cmdname>
<parmname>org.eclipse.mat.api:query</parmname>
</codeph>
</p>
</example>
<example platform="linux">
<p>Simple example of a histogram for Linux</p>
<example platform="Linux">
<title>Simple example of a histogram for Linux</title>
<p>
<codeph>
<cmdname>./mat/ParseHeapDump.sh</cmdname>
<filepath><cmdname>./mat/ParseHeapDump.sh</cmdname></filepath>
<varname>myheapdump.hprof</varname>
<option>-command=</option><cmdname>histogram</cmdname>
<parmname>org.eclipse.mat.api:query</parmname>
</codeph>
</p>
</example>
<example platform="windows">
<p>Simple OQL example for Windows</p>
<example platform="Windows">
<title>Simple OQL example for Windows</title>
<p>
<codeph>
<cmdname>./mat/ParseHeapDump.bat</cmdname>
<varname>myheapdump.hprof</varname>
"<option>-command=</option><cmdname>oql</cmdname> <varname>\\\"SELECT * FROM java.lang.String s\\\"</varname>"
<filepath><cmdname>.\mat\ParseHeapDump.bat</cmdname></filepath>
<filepath>myheapdump.hprof</filepath>
<synph><delim>"</delim></synph><option>-command=</option><cmdname>oql</cmdname> <varname>\\\"SELECT * FROM java.lang.String s\\\"</varname><synph><delim>"</delim></synph>
<parmname>org.eclipse.mat.api:query</parmname>
</codeph>
<note>The OQL query <cmdname>oql</cmdname> has the actual OQL statement surrounded by
Expand All @@ -94,13 +102,13 @@
treats it as a single item.</note>
</p>
</example>
<example platform="linux">
<p>Simple OQL example for Linux</p>
<example platform="Linux">
<title>Simple OQL example for Linux</title>
<p>
<codeph>
<cmdname>./mat/ParseHeapDump.sh</cmdname>
<varname>myheapdump.hprof</varname>
"<option>-command=</option><cmdname>oql</cmdname> <varname>\"SELECT * FROM java.lang.String s\"</varname>"
<filepath><cmdname>./mat/ParseHeapDump.sh</cmdname></filepath>
<filepath>myheapdump.hprof</filepath>
<synph><delim>"</delim></synph><option>-command=</option><cmdname>oql</cmdname> <varname>\"SELECT * FROM java.lang.String s\"</varname><synph><delim>"</delim></synph>
<parmname>org.eclipse.mat.api:query</parmname>
</codeph>
<note>The OQL query <cmdname>oql</cmdname> has the actual OQL statement surrounded by
Expand All @@ -111,13 +119,13 @@
treats it as a single item.</note>
</p>
</example>
<example platform="windows">
<p>Another OQL example for Windows</p>
<example platform="Windows">
<title>Another OQL example for Windows</title>
<p>
<codeph>
<cmdname>./mat/ParseHeapDump.bat</cmdname>
<varname>myheapdump.hprof</varname>
"<option>-command=</option><cmdname>oql</cmdname> <varname>\\\"SELECT s AS Object, toString(s) AS \\\\\\\"String value\\\\\\\" FROM \\\\\\\"java.lang.String.*\\\\\\\" s WHERE toString(s) LIKE \\\\\\\".*\\..*\\\\\\\" AND s.hash ^^^&gt; 0\\\"</varname>
<filepath><cmdname>.\mat\ParseHeapDump.bat</cmdname></filepath>
<filepath>myheapdump.hprof</filepath>
<synph><delim>"</delim></synph><option>-command=</option><cmdname>oql</cmdname> <varname>\\\"SELECT s AS Object, toString(s) AS \\\\\\\"String value\\\\\\\" FROM \\\\\\\"java.lang.String.*\\\\\\\" s WHERE toString(s) LIKE \\\\\\\".*\\..*\\\\\\\" AND s.hash ^^^&gt; 0\\\"</varname><synph><delim>"</delim></synph>
<parmname>org.eclipse.mat.api:query</parmname>
</codeph>
<msgblock>
Expand Down Expand Up @@ -174,13 +182,13 @@ Subtask: Checking class java.lang.String
</note>
</p>
</example>
<example platform="linux">
<p>Another OQL example for Linux</p>
<example platform="Linux">
<title>Another OQL example for Linux</title>
<p>
<codeph>
<cmdname>./mat/ParseHeapDump.sh</cmdname>
<varname>myheapdump.hprof</varname>
"<option>-command=</option><cmdname>oql</cmdname> <varname>\"select s as \\\"a b\\\" from \\\"java.lang.String.*\\\" WHERE toString(s) LIKE \\\".*\\\..*\\\" AND s.hash &gt; 0\"</varname>
<filepath><cmdname>./mat/ParseHeapDump.sh</cmdname></filepath>
<filepath>myheapdump.hprof</filepath>
<synph><delim>"</delim></synph><option>-command=</option><cmdname>oql</cmdname> <varname>\"select s as \\\"a b\\\" from \\\"java.lang.String.*\\\" WHERE toString(s) LIKE \\\".*\\\..*\\\" AND s.hash &gt; 0\"</varname><synph><delim>"</delim></synph>
<parmname>org.eclipse.mat.api:query</parmname>
</codeph>
<msgblock>
Expand Down
78 changes: 39 additions & 39 deletions plugins/org.eclipse.mat.ui.help/reference/inspections/query_report.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@
<meta name="DC.Title" content="Query Report"/>
<meta name="abstract" content="Run a single query to produce a HTML report in batch mode."/>
<meta name="description" content="Run a single query to produce a HTML report in batch mode."/>
<meta name="prodname" content="Eclipse Memory Analyzer"/>
<meta name="version" content="1"/>
<meta name="release" content="11"/>
<meta name="modification" content="0"/>
<meta name="platform" content="Windows"/>
<meta name="platform" content="Linux"/>
<meta name="copyright" content="Copyright (c) 2020 IBM Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html " type="primary"/>
<meta name="DC.Rights.Owner" content="Copyright (c) 2020 IBM Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html " type="primary"/>
<meta name="DC.Format" content="XHTML"/>
Expand Down Expand Up @@ -41,23 +47,23 @@ <h1 class="title topictitle1">Query Report</h1>
<div class="section"><h2 class="title sectiontitle">Arguments</h2>

<table cellpadding="4" cellspacing="0" summary="" border="1" class="simpletable"><tr class="sthead">
<th valign="bottom" align="left" id="d5950e43" class="stentry">Argument</th>
<th valign="bottom" align="left" id="d5950e61" class="stentry">Argument</th>

<th valign="bottom" align="left" id="d5950e46" class="stentry">Description</th>
<th valign="bottom" align="left" id="d5950e64" class="stentry">Description</th>

</tr>
<tr class="strow">
<td valign="top" headers="d5950e43" class="stentry">-command</td>
<td valign="top" headers="d5950e61" class="stentry">-command</td>

<td valign="top" headers="d5950e46" class="stentry">The command line version of the query to be run. This
<td valign="top" headers="d5950e64" class="stentry">The command line version of the query to be run. This
is like the text typed into the <a class="xref" href="../selectingqueries.html">'Search Queries' query browser</a> command line.
</td>

</tr>
<tr class="strow">
<td valign="top" headers="d5950e43" class="stentry">other report options</td>
<td valign="top" headers="d5950e61" class="stentry">other report options</td>

<td valign="top" headers="d5950e46" class="stentry">See <a class="xref" href="../../tasks/batch.html#task_batch__report_options">batch mode control of report options</a></td>
<td valign="top" headers="d5950e64" class="stentry">See <a class="xref" href="../../tasks/batch.html#task_batch__report_options">batch mode control of report options</a></td>

</tr>
</table>
Expand All @@ -70,26 +76,24 @@ <h1 class="title topictitle1">Query Report</h1>

</div>

<div class="example">
<p class="p">Simple example of a histogram for Windows</p>

<div class="example"><h2 class="title sectiontitle">Simple example of a histogram for Windows</h2>

<p class="p">
<samp class="ph codeph">
<span class="keyword cmdname">./mat/ParseHeapDump.bat</span>
<var class="keyword varname">myheapdump.hprof</var>
<span class="ph filepath"><span class="keyword cmdname">.\mat\ParseHeapDump.bat</span></span>
<span class="ph filepath">myheapdump.hprof</span>
<span class="keyword option">-command=</span><span class="keyword cmdname">histogram</span>
<span class="keyword parmname">org.eclipse.mat.api:query</span>
</samp>
</p>

</div>

<div class="example">
<p class="p">Simple example of a histogram for Linux</p>

<div class="example"><h2 class="title sectiontitle">Simple example of a histogram for Linux</h2>

<p class="p">
<samp class="ph codeph">
<span class="keyword cmdname">./mat/ParseHeapDump.sh</span>
<span class="ph filepath"><span class="keyword cmdname">./mat/ParseHeapDump.sh</span></span>
<var class="keyword varname">myheapdump.hprof</var>
<span class="keyword option">-command=</span><span class="keyword cmdname">histogram</span>
<span class="keyword parmname">org.eclipse.mat.api:query</span>
Expand All @@ -98,14 +102,13 @@ <h1 class="title topictitle1">Query Report</h1>

</div>

<div class="example">
<p class="p">Simple OQL example for Windows</p>

<div class="example"><h2 class="title sectiontitle">Simple OQL example for Windows</h2>

<div class="p">
<samp class="ph codeph">
<span class="keyword cmdname">./mat/ParseHeapDump.bat</span>
<var class="keyword varname">myheapdump.hprof</var>
"<span class="keyword option">-command=</span><span class="keyword cmdname">oql</span> <var class="keyword varname">\\\"SELECT * FROM java.lang.String s\\\"</var>"
<span class="ph filepath"><span class="keyword cmdname">.\mat\ParseHeapDump.bat</span></span>
<span class="ph filepath">myheapdump.hprof</span>
<span class="ph synph"><span class="ph delim">"</span></span><span class="keyword option">-command=</span><span class="keyword cmdname">oql</span> <var class="keyword varname">\\\"SELECT * FROM java.lang.String s\\\"</var><span class="ph synph"><span class="ph delim">"</span></span>
<span class="keyword parmname">org.eclipse.mat.api:query</span>
</samp>
<div class="note note"><span class="notetitle">Note:</span> The OQL query <span class="keyword cmdname">oql</span> has the actual OQL statement surrounded by
Expand All @@ -119,14 +122,13 @@ <h1 class="title topictitle1">Query Report</h1>

</div>

<div class="example">
<p class="p">Simple OQL example for Linux</p>

<div class="example"><h2 class="title sectiontitle">Simple OQL example for Linux</h2>

<div class="p">
<samp class="ph codeph">
<span class="keyword cmdname">./mat/ParseHeapDump.sh</span>
<var class="keyword varname">myheapdump.hprof</var>
"<span class="keyword option">-command=</span><span class="keyword cmdname">oql</span> <var class="keyword varname">\"SELECT * FROM java.lang.String s\"</var>"
<span class="ph filepath"><span class="keyword cmdname">./mat/ParseHeapDump.sh</span></span>
<span class="ph filepath">myheapdump.hprof</span>
<span class="ph synph"><span class="ph delim">"</span></span><span class="keyword option">-command=</span><span class="keyword cmdname">oql</span> <var class="keyword varname">\"SELECT * FROM java.lang.String s\"</var><span class="ph synph"><span class="ph delim">"</span></span>
<span class="keyword parmname">org.eclipse.mat.api:query</span>
</samp>
<div class="note note"><span class="notetitle">Note:</span> The OQL query <span class="keyword cmdname">oql</span> has the actual OQL statement surrounded by
Expand All @@ -140,14 +142,13 @@ <h1 class="title topictitle1">Query Report</h1>

</div>

<div class="example">
<p class="p">Another OQL example for Windows</p>

<div class="example"><h2 class="title sectiontitle">Another OQL example for Windows</h2>

<div class="p">
<samp class="ph codeph">
<span class="keyword cmdname">./mat/ParseHeapDump.bat</span>
<var class="keyword varname">myheapdump.hprof</var>
"<span class="keyword option">-command=</span><span class="keyword cmdname">oql</span> <var class="keyword varname">\\\"SELECT s AS Object, toString(s) AS \\\\\\\"String value\\\\\\\" FROM \\\\\\\"java.lang.String.*\\\\\\\" s WHERE toString(s) LIKE \\\\\\\".*\\..*\\\\\\\" AND s.hash ^^^&gt; 0\\\"</var>
<span class="ph filepath"><span class="keyword cmdname">.\mat\ParseHeapDump.bat</span></span>
<span class="ph filepath">myheapdump.hprof</span>
<span class="ph synph"><span class="ph delim">"</span></span><span class="keyword option">-command=</span><span class="keyword cmdname">oql</span> <var class="keyword varname">\\\"SELECT s AS Object, toString(s) AS \\\\\\\"String value\\\\\\\" FROM \\\\\\\"java.lang.String.*\\\\\\\" s WHERE toString(s) LIKE \\\\\\\".*\\..*\\\\\\\" AND s.hash ^^^&gt; 0\\\"</var><span class="ph synph"><span class="ph delim">"</span></span>
<span class="keyword parmname">org.eclipse.mat.api:query</span>
</samp>
<pre class="pre msgblock">
Expand Down Expand Up @@ -208,14 +209,13 @@ <h1 class="title topictitle1">Query Report</h1>

</div>

<div class="example">
<p class="p">Another OQL example for Linux</p>

<div class="example"><h2 class="title sectiontitle">Another OQL example for Linux</h2>

<div class="p">
<samp class="ph codeph">
<span class="keyword cmdname">./mat/ParseHeapDump.sh</span>
<var class="keyword varname">myheapdump.hprof</var>
"<span class="keyword option">-command=</span><span class="keyword cmdname">oql</span> <var class="keyword varname">\"select s as \\\"a b\\\" from \\\"java.lang.String.*\\\" WHERE toString(s) LIKE \\\".*\\\..*\\\" AND s.hash &gt; 0\"</var>
<span class="ph filepath"><span class="keyword cmdname">./mat/ParseHeapDump.sh</span></span>
<span class="ph filepath">myheapdump.hprof</span>
<span class="ph synph"><span class="ph delim">"</span></span><span class="keyword option">-command=</span><span class="keyword cmdname">oql</span> <var class="keyword varname">\"select s as \\\"a b\\\" from \\\"java.lang.String.*\\\" WHERE toString(s) LIKE \\\".*\\\..*\\\" AND s.hash &gt; 0\"</var><span class="ph synph"><span class="ph delim">"</span></span>
<span class="keyword parmname">org.eclipse.mat.api:query</span>
</samp>
<pre class="pre msgblock">
Expand Down
Loading

0 comments on commit e2bad31

Please sign in to comment.