svn commit: r536228 - /db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita

[bp...@apache.org]

Author: bpendleton
Date: Tue May  8 08:43:55 2007
New Revision: 536228

URL: http://svn.apache.org/viewvc?view=rev&rev=536228
Log:
DERBY-2019: IJ describe command does not handle quotes very well

IJ's describe command already accepted a string for the table name,
but there were several problems with the handling of the table name
in single quotes:
1) The table name was unnecessarily forced to upper case.
2) The command only worked properly if you gave both schema and table name.
3) It had a rather bizarre behavior with an empty string

This patch updates the docuentation for the describe command to
explain its behavior more clearly, and to add additional examples.

Modified:
    db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita

Modified: db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita?view=diff&rev=536228&r1=536227&r2=536228
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita Tue May  8 08:43:55 2007
@@ -28,8 +28,9 @@
 </refsyn>
 <section><title>Description</title>
 <p>Provides a decription of the specified table or view. For a list of tables in the current schema, use the <xref href="rtoolsijcomrefshow.dita#rtoolsijcomrefshow/showtables">Show Tables</xref> command. For a list of views in the current schema, use the <xref href="rtoolsijcomrefshow.dita#rtoolsijcomrefshow/showviews">Show Views</xref> command. For a list of available schemas, use the <xref href="rtoolsijcomrefshow.dita#rtoolsijcomrefshow/showschemas">Show Schemas</xref> command.</p>
+<p>If the table or view is in a particular schema, qualify it with the schema name. If the table or view name is case-sensitive, enclose it in single quotes. You can display all the columns from all the tables and views in a single schema in a single display by using the wildcard character '*'. See the examples below.</p>
 </section>
-<example><title>Example</title>
+<example><title>Examples</title>
 <codeblock>ij&gt; <b>describe airlines;</b>
 COLUMN_NAME         |TYPE_NAME|DEC&amp;|NUM&amp;|COLUM&amp;|COLUMN_DEF|CHAR_OCTE&amp;|IS_NULL&amp;
 ------------------------------------------------------------------------------
@@ -42,5 +43,18 @@
 ECONOMY_SEATS       |INTEGER  |0   |10  |10    |NULL      |NULL      |YES
 BUSINESS_SEATS      |INTEGER  |0   |10  |10    |NULL      |NULL      |YES
 FIRSTCLASS_SEATS    |INTEGER  |0   |10  |10    |NULL      |NULL      |YES</codeblock>
+<codeblock>
+    -- describe a table in another schema:
+    <b>describe user2.flights;</b>
+    -- describe a table whose name is in mixed-case:
+    <b>describe 'EmployeeTable';</b>
+    -- describe a table in a different schema, with a case-sensitive name:
+    <b>describe 'MyUser.Orders';</b>
+    -- describe all the columns from all the tables and views in APP schema:
+    <b>describe 'APP.*';</b>
+    -- describe all the columns in the current schema:
+    <b>describe '*';</b>
+</codeblock>
+
 </example>
 </refbody></reference>