You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by fu...@apache.org on 2006/09/12 09:10:24 UTC
svn commit: r442496 - in /db/derby/docs/trunk/src/tools: derbytools.ditamap
rtoolsijcomref17529.dita rtoolsijcomref39198.dita
rtoolsijcomrefdescribe.dita rtoolsijcomrefshow.dita
Author: fuzzylogic
Date: Tue Sep 12 00:10:23 2006
New Revision: 442496
URL: http://svn.apache.org/viewvc?view=rev&rev=442496
Log:
DERBY-1659: Document describe and show tables functionality for ij
Added:
db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita (with props)
db/derby/docs/trunk/src/tools/rtoolsijcomrefshow.dita (with props)
Removed:
db/derby/docs/trunk/src/tools/rtoolsijcomref17529.dita
Modified:
db/derby/docs/trunk/src/tools/derbytools.ditamap
db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita
Modified: db/derby/docs/trunk/src/tools/derbytools.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/derbytools.ditamap?view=diff&rev=442496&r1=442495&r2=442496
==============================================================================
--- db/derby/docs/trunk/src/tools/derbytools.ditamap (original)
+++ db/derby/docs/trunk/src/tools/derbytools.ditamap Tue Sep 12 00:10:23 2006
@@ -95,6 +95,7 @@
<topicref href="rtoolsijcomref24423.dita" navtitle="Close"></topicref>
<topicref href="rtoolsijcomref31510.dita" navtitle="Commit"></topicref>
<topicref href="rtoolsijcomref22318.dita" navtitle="Connect"></topicref>
+<topicref href="rtoolsijcomrefdescribe.dita" navtitle="Describe"></topicref>
<topicref href="rtoolsijcomref20382.dita" navtitle="Disconnect"></topicref>
<topicref href="rtoolsijcomref39042.dita" navtitle="Driver"></topicref>
<topicref href="rtoolsijcomref18077.dita" navtitle="Elapsedtime"></topicref>
@@ -117,7 +118,7 @@
<topicref href="rtoolsijcomref12297.dita" navtitle="Rollback"></topicref>
<topicref href="rtoolsijcomref28886.dita" navtitle="Run"></topicref>
<topicref href="rtoolsijcomref39198.dita" navtitle="Set Connection"></topicref>
-<topicref href="rtoolsijcomref17529.dita" navtitle="Show Connections"></topicref>
+<topicref href="rtoolsijcomrefshow.dita" navtitle="Show"></topicref>
<topicref href="rtoolsijcomref17631.dita" navtitle="Wait For"></topicref>
<topicref href="rtoolsijcomref16653.dita" navtitle="Comment"></topicref>
<topicref href="rtoolsijcomref40155.dita" navtitle="Identifier"></topicref>
Modified: db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita?view=diff&rev=442496&r1=442495&r2=442496
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomref39198.dita Tue Sep 12 00:10:23 2006
@@ -28,7 +28,7 @@
</refsyn>
<section><title>Description</title>
<p>Allows you to specify which connection to make current when you have more
-than one connection open. Use the <xref href="rtoolsijcomref17529.dita#rtoolsijcomref17529">Show Connections</xref> command
+than one connection open. Use the <xref href="rtoolsijcomrefshow.dita#rtoolsijcomrefshow/rtoolsijcomref17529">Show Connections</xref> command
to display open connections.</p>
<p>If there is no such connection, an error results and the current connection
is unchanged.</p>
Added: db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita?view=auto&rev=442496
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita (added)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita Tue Sep 12 00:10:23 2006
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
+<reference xml:lang="en-us" id="rtoolsijcomrefdescribe">
+<title>Describe</title>
+<prolog><metadata>
+<keywords><indexterm>Describe</indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<refsyn>
+<title>Syntax</title>
+<codeblock><b>DESCRIBE <i>table-Name</i></b></codeblock>
+</refsyn>
+<section><title>Description</title>
+<p>Provides a decription of the specified table. 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 available schemas, use the <xref href="rtoolsijcomrefshow.dita#rtoolsijcomrefshow/showschemas">Show Schemas</xref> command.</p>
+</section>
+<example><title>Example</title>
+<codeblock>ij> <b>describe airlines;</b>
+COLUMN_NAME |TYPE_NAME|DEC&|NUM&|COLUM&|COLUMN_DEF|CHAR_OCTE&|IS_NULL&
+------------------------------------------------------------------------------
+AIRLINE |CHAR |NULL|NULL|2 |NULL |4 |NO
+AIRLINE_FULL |VARCHAR |NULL|NULL|24 |NULL |48 |YES
+BASIC_RATE |DOUBLE |NULL|2 |52 |NULL |NULL |YES
+DISTANCE_DISCOUNT |DOUBLE |NULL|2 |52 |NULL |NULL |YES
+BUSINESS_LEVEL_FACT&|DOUBLE |NULL|2 |52 |NULL |NULL |YES
+FIRSTCLASS_LEVEL_FA&|DOUBLE |NULL|2 |52 |NULL |NULL |YES
+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>
+</example>
+</refbody></reference>
Propchange: db/derby/docs/trunk/src/tools/rtoolsijcomrefdescribe.dita
------------------------------------------------------------------------------
svn:eol-style = native
Added: db/derby/docs/trunk/src/tools/rtoolsijcomrefshow.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijcomrefshow.dita?view=auto&rev=442496
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijcomrefshow.dita (added)
+++ db/derby/docs/trunk/src/tools/rtoolsijcomrefshow.dita Tue Sep 12 00:10:23 2006
@@ -0,0 +1,180 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
+<reference xml:lang="en-us" id="rtoolsijcomrefshow">
+<title>Show</title>
+<prolog><metadata>
+<keywords><indexterm>Show</indexterm><indexterm>Show Tables</indexterm>
+<indexterm>Show Connections</indexterm><indexterm>Multiple connections<indexterm>displaying</indexterm></indexterm>
+<indexterm>Show Schemas</indexterm><indexterm>Show Views</indexterm>
+<indexterm>Show Procedures</indexterm><indexterm>Show Synonyms</indexterm>
+<indexterm>Show Indexes in Schema</indexterm><indexterm>Show Indexes from Table</indexterm>
+</keywords></metadata></prolog>
+<refbody>
+<refsyn>
+<title>Syntax</title>
+<codeblock><b>SHOW
+{
+ CONNECTIONS |
+ INDEXES [ IN <i>schemaName</i> | FROM <i>table-Name</i> ] |
+ PROCEDURES [ IN <i>schemaName</i> ] |
+ SCHEMAS |
+ SYNONYMS [ IN <i>schemaName</i> ] |
+ TABLES [ IN <i>schemaName</i> ] |
+ VIEWS [ IN <i>schemaName</i> ] |
+
+}</b></codeblock>
+</refsyn>
+<section><title>Description</title>
+<p>The SHOW command can be used to display information about active connections and database objects.</p>
+<p id="rtoolsijcomref17529"><b>SHOW CONNECTIONS</b></p>
+<p>If there are no connections, the SHOW CONNECTIONS command returns "No connections available".</p>
+<p>Otherwise, the command displays a list of connection names and the URLs
+used to connect to them. The currently active connection, if there is one,
+is marked with an * after its name.</p>
+<p><b>Example</b></p>
+<codeblock>ij> <b>connect 'sample' as sample1;</b>
+ij> <b>connect 'newDB;create=true' as newDB;</b>
+ij(NEWDB)> <b>show connections;</b>
+SAMPLE1 - jdbc:derby:sample
+NEWDB* - jdbc:derby:newDB;create=true
+* = current connection
+ij(NEWDB)></codeblock>
+<p id="showindexes"><b>SHOW INDEXES</b></p>
+<p>SHOW INDEXES will display all the indexes in the database.</p>
+<p>If <codeph><b>IN <i>schemaName</i></b></codeph> is specified, then only the indexes in the specified schema are displayed.</p>
+<p>If <codeph><b>FROM <i>table-Name</i></b></codeph> is specified, then only the indexes on the specified table are displayed.</p>
+<p><b>Example</b></p>
+<codeblock>ij> <b>show indexes in app</b>;
+TABLE_NAME |COLUMN_NAME |NON_U&|TYPE|ASC&|CARDINA&|PAGES
+----------------------------------------------------------------------------
+AIRLINES |AIRLINE |false |3 |A |NULL |NULL
+COUNTRIES |COUNTRY_ISO_CODE |false |3 |A |NULL |NULL
+COUNTRIES |COUNTRY |false |3 |A |NULL |NULL
+CITIES |CITY_ID |false |3 |A |NULL |NULL
+FLIGHTS |FLIGHT_ID |false |3 |A |NULL |NULL
+FLIGHTS |SEGMENT_NUMBER |false |3 |A |NULL |NULL
+FLIGHTAVAILABILITY |FLIGHT_ID |false |3 |A |NULL |NULL
+FLIGHTAVAILABILITY |SEGMENT_NUMBER |false |3 |A |NULL |NULL
+FLIGHTAVAILABILITY |FLIGHT_DATE |false |3 |A |NULL |NULL
+MAPS |MAP_ID |false |3 |A |NULL |NULL
+MAPS |MAP_NAME |false |3 |A |NULL |NULL
+FLIGHTS |DEST_AIRPORT |true |3 |A |NULL |NULL
+FLIGHTS |ORIG_AIRPORT |true |3 |A |NULL |NULL
+CITIES |COUNTRY_ISO_CODE |true |3 |A |NULL |NULL
+FLIGHTAVAILABILITY |FLIGHT_ID |true |3 |A |NULL |NULL
+FLIGHTAVAILABILITY |SEGMENT_NUMBER |true |3 |A |NULL |NULL
+
+16 rows selected
+ij> <b>show indexes from flights</b>;
+TABLE_NAME |COLUMN_NAME |NON_U&|TYPE|ASC&|CARDINA&|PAGES
+----------------------------------------------------------------------------
+FLIGHTS |FLIGHT_ID |false |3 |A |NULL |NULL
+FLIGHTS |SEGMENT_NUMBER |false |3 |A |NULL |NULL
+FLIGHTS |DEST_AIRPORT |true |3 |A |NULL |NULL
+FLIGHTS |ORIG_AIRPORT |true |3 |A |NULL |NULL
+
+4 rows selected</codeblock>
+
+<p id="showprocedures"><b>SHOW PROCEDURES</b></p>
+<p>SHOW PROCEDURES will display all the procedures in the database that have been created
+with the CREATE PROCEDURE statement, as well as system procedures.</p>
+<p>If <codeph><b>IN <i>schemaName</i></b></codeph> is specified, only procedures in the specified schema are displayed.</p>
+<p><b>Example</b></p>
+<codeblock>ij> <b>show procedures in syscs_util;</b>
+PROCEDURE_SCHEM |PROCEDURE_NAME |REMARKS
+------------------------------------------------------------------------
+SYSCS_UTIL |SYSCS_BACKUP_DATABASE |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_BACKUP_DATABASE_AND_ENA&|org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_BACKUP_DATABASE_AND_ENA&|org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_BACKUP_DATABASE_NOWAIT |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_BULK_INSERT |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_CHECKPOINT_DATABASE |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_COMPRESS_TABLE |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_DISABLE_LOG_ARCHIVE_MODE|org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_EXPORT_QUERY |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_EXPORT_TABLE |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_FREEZE_DATABASE |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_IMPORT_DATA |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_IMPORT_TABLE |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_INPLACE_COMPRESS_TABLE |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_SET_DATABASE_PROPERTY |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_SET_RUNTIMESTATISTICS |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_SET_STATISTICS_TIMING |org.apache.derby.ca&
+SYSCS_UTIL |SYSCS_UNFREEZE_DATABASE |org.apache.derby.ca&
+
+18 rows selected</codeblock>
+
+<p id="showschemas"><b>SHOW SCHEMAS</b></p>
+<p>SHOW SCHEMAS will display all of the schemas in the current connection.</p>
+<p><b>Example</b></p>
+<codeblock>ij> <b>show schemas;</b>
+TABLE_SCHEM
+------------------------------
+APP
+NULLID
+SQLJ
+SYS
+SYSCAT
+SYSCS_DIAG
+SYSCS_UTIL
+SYSFUN
+SYSIBM
+SYSPROC
+SYSSTAT
+
+11 rows selected</codeblock>
+
+<p id="showsynonyms"><b>SHOW SYNONYMS</b></p>
+<p>SHOW SYNONYMS will display all the synonyms in the database that have been created
+with the CREATE SYNONYMS statement.</p>
+<p>If <codeph><b>IN <i>schemaName</i></b></codeph> is specified, only synonyms in the specified schema are displayed.</p>
+<p><b>Example</b></p>
+<codeblock>ij> <b>show synonyms;</b>
+TABLE_SCHEM |TABLE_NAME |REMARKS
+------------------------------------------------------------------------
+APP |MYAIRLINES |</codeblock>
+
+<p id="showtables"><b>SHOW TABLES</b></p>
+<p>SHOW TABLES will diplay all of the tables in the current schema.</p>
+<p>If <codeph><b>IN <i>schemaName</i></b></codeph> is specified, the tables in the given schema are displayed.</p>
+<p><b>Example</b></p>
+<codeblock>ij> <b>show tables;</b>
+TABLE_SCHEM |TABLE_NAME |REMARKS
+------------------------------------------------------------------------
+APP |AIRLINES |
+APP |CITIES |
+APP |COUNTRIES |
+APP |FLIGHTAVAILABILITY |
+APP |FLIGHTS |
+APP |FLIGHTS_HISTORY |
+APP |MAPS |
+
+7 rows selected</codeblock>
+<p id="showviews"><b>SHOW VIEWS</b></p>
+<p>SHOW VIEWS will display all of the views in the current schema.</p>
+<p>If <codeph><b>IN <i>schemaName</i></b></codeph> is specified, the tables in the given schema are displayed.</p>
+<p><b>Example</b></p>
+<codeblock>ij> <b>show views;</b>
+TABLE_SCHEM |TABLE_NAME |REMARKS
+------------------------------------------------------------------------
+APP |TOTALSEATS |
+
+1 row selected</codeblock>
+</section>
+</refbody></reference>
Propchange: db/derby/docs/trunk/src/tools/rtoolsijcomrefshow.dita
------------------------------------------------------------------------------
svn:eol-style = native