Add some GQB docs.
authordpage <dpage@a7884b65-44f6-0310-8a51-81a127f17b15>
Thu, 21 Aug 2008 09:07:04 +0000 (09:07 +0000)
committerdpage <dpage@a7884b65-44f6-0310-8a51-81a127f17b15>
Thu, 21 Aug 2008 09:07:04 +0000 (09:07 +0000)
git-svn-id: svn://svn.pgadmin.org/trunk/pgadmin3@7411 a7884b65-44f6-0310-8a51-81a127f17b15

docs/en_US/gqb.html [new file with mode: 0644]
docs/en_US/images/gqb.png [new file with mode: 0644]
docs/en_US/images/query.png
docs/en_US/pgadmin3.hhc
docs/en_US/pgadmin3.hhp
docs/en_US/query.html

diff --git a/docs/en_US/gqb.html b/docs/en_US/gqb.html
new file mode 100644 (file)
index 0000000..1781f81
--- /dev/null
@@ -0,0 +1,60 @@
+<html>\r
+\r
+<head>\r
+<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">\r
+<link rel="STYLESHEET" type="text/css" href="pgadmin3.css">\r
+<title>Graphical Query builder</title>\r
+</head>\r
+\r
+<body>\r
+\r
+<h3>Graphical Query Builder</h3>\r
+\r
+<center><img src="images/gqb.png"></center>\r
+\r
+<p>The Graphical Query Builder (GQB) is part of the <a href="query.html">Query\r
+Tool</a> which allows you to build simple SQL queries visually.</p>\r
+\r
+<p>There are three main parts of the GQB. The relation browser on the left\r
+hand side allows you to select catalogs, classes and views to include in \r
+your queries. Along the bottom are a set of tabs which allow you to specify\r
+selection criteria, output format and sorting. The third section is the \r
+canvas on which you draw the relationships between the relations in your\r
+tables. You can adjust the relative size of each section by dragging the\r
+join (or sash) between the panes.</p>\r
+\r
+<p>To add relations to the query, either double click them in the relation\r
+browser, or drag them from the browser onto the canvas. You can arrange relations\r
+on the canvas by selecting the relation name with the mouse and moving the relation\r
+to the desired position.</p>\r
+\r
+<p>To create joins between relations, drag a column from one relation onto \r
+another. A line will be drawn between them to indicate the join. Right-clicking\r
+the join will present a popup menu from where you can select the join operator\r
+or delete it.</p>\r
+\r
+<p>To select the columns that will appear in the query results, check the desired\r
+columns within the relation on the canvas. Each column selected will be added to\r
+the list on the Columns tab on which you can adjust the ordering, and specify\r
+column aliases.</p>\r
+\r
+<p>To specify selection criteria, add rows to the grid on the Criteria tab. The\r
+restricted value can be set to a column name, or a constant value. The Operator \r
+column allows you to select a simple operator to be used to compare the restricted \r
+value with the value specified in the Value column. The Connector specifies how\r
+the criteria will be joined to the next (if any).</p>\r
+\r
+<p>The query results may be ordered on the Ordering tab. Select the columns\r
+required on the left, and use the buttons in the middle to add them to the\r
+ordering list on the right. You can also remove columns in the same way. \r
+For each column added to the ordering list you can specify the sorting\r
+direction. You can also adjust the priority of each ordering column by\r
+selecting it, and moving it up or down the list using the buttons on the \r
+right.</p>\r
+\r
+<p>When you have designed your query, you can use the Execute, Execute to File,\r
+or Explain options on the toobar (and Query menu) to generate and execute the \r
+query.</p>\r
+\r
+</body>\r
+</html>\r
diff --git a/docs/en_US/images/gqb.png b/docs/en_US/images/gqb.png
new file mode 100644 (file)
index 0000000..6c6fe7f
Binary files /dev/null and b/docs/en_US/images/gqb.png differ
index c2599345b49332544426a3574cef50e53af649f3..b083c9a241610e918cd3896b2bb57f8d53b54aab 100644 (file)
Binary files a/docs/en_US/images/query.png and b/docs/en_US/images/query.png differ
index 78448dd5ea5f63b055d25553848177ad25d28fc2..fa8176624d67c48a2742dbb32f62b6f859523aaa 100644 (file)
                                        <param name="Name" value="Export data">
                                        <param name="Local" value="export.html">
                                        </OBJECT>
+                               <LI> <OBJECT type="text/sitemap">
+                                       <param name="Name" value="Graphical query builder">
+                                       <param name="Local" value="gqb.html">
+                                       </OBJECT>
                                <LI> <OBJECT type="text/sitemap">
                                        <param name="Name" value="Query tool macros">
                                        <param name="Local" value="macros.html">
index 976e4115f060ad159e33857ea50b717f334d53c1..06af939bd52c90ad60874f0be6b2a5940e9e3647 100644 (file)
@@ -25,6 +25,7 @@ export.html
 extend.html
 grantwiz.html
 gridopts.html
+gqb.html
 guruhints.html
 index.html
 kerberos.html
index cc16afb9201a9bae46193da85b91f665ed6e94d6..8d79eeadb143ff85ec9f5ecb17f02635b0077ff6 100644 (file)
 
 <center><img src="images/query.png"></center>
 
-<p>The Query Tool enables you to execute arbitrary SQL commands. All
-rules that are mentioned in the PostgreSQL User's guide apply.
-</p>
-<p>The upper part of the Query Tool contains the edit entry window,
+<p>The Query Tool enables you to execute arbitrary SQL commands.</p>
+
+<p>The upper part of the Query Tool contains the SQL Editor 
 where you type your commands. You may read the query from a file, or
 write it out to a file. When writing a file, the encoding of the file
 is determined by the file suffix: if it is *.sql, a 8 byte local
@@ -38,6 +37,10 @@ it can in <i>psql</i>. You can optionally enable the Tab key to activate
 the autocomplete feature as well - the can be done on the
 <a href="options-tab3.html">options dialog</a>.</p>
 
+<p>If you prefer to build your queries graphically, you can use the 
+<a href="gqb.html">Graphical Query Builder</a> to generate the SQL
+for you.</p>
+
 <p>To execute the query, you select Execute from the Query menu, or
 you press the execute toolbar button, or you press the F5 function
 key. If you didn't select a word, the complete contents of the window