File: rhdb-explain.xml

package info (click to toggle)
rhdb-explain 2.0-1
  • links: PTS
  • area: contrib
  • in suites: sarge
  • size: 1,348 kB
  • ctags: 2,029
  • sloc: java: 13,411; xml: 209; makefile: 42; sh: 22
file content (85 lines) | stat: -rw-r--r-- 2,841 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

  <!ENTITY dhfirstname "<firstname>Peter</firstname>">
  <!ENTITY dhsurname   "<surname>Eisentraut</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>March 7, 2004</date>">
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>peter_e@gmx.net</email>">
  <!ENTITY dhusername  "Peter Eisentraut">
  <!ENTITY dhucpackage "<refentrytitle>RHDB-EXPLAIN</refentrytitle>">
  <!ENTITY dhpackage   "rhdb-explain">

  <!ENTITY debian      "<application>Debian</application>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>

    <author>
      &dhfirstname;
      &dhsurname;
    </author>

    <copyright>
      <year>2004</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>

  <refmeta>
    &dhucpackage;
    &dhsection;
  </refmeta>

  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>A tool for visualizing the output of the <application>PostgreSQL</application> <command>EXPLAIN</command> command</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      program <command>&dhpackage;</command>.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.</para>

    <para><command>&dhpackage;</command> is Visual Explain, an interactive tool for
      visualizing the output of the <application>PostgreSQL</application>
      <command>EXPLAIN</command> and <command>EXPLAIN ANALYZE</command>
      commands.  <command>EXPLAIN</command> and
      <command>EXPLAIN ANALYZE</command> show the users the query plan
      that a <application>PostgreSQL</application> backend produces for a
      given optimizable query.  The default form of this plan is a
      plain-text tree, which, while easy to read for simple queries,
      becomes progressilvely more difficult to interpret as query complexity
      increases.  By visualizing the text output of
      <command>EXPLAIN</command>/<command>EXPLAIN ANALYZE</command> in an
      appropriate manner, the difficulty of interpreting query plans
      drops significantly.</para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).</para>

  </refsect1>
</refentry>