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 ch...@apache.org on 2009/05/28 15:22:41 UTC
svn commit: r779597 - in /db/derby/docs/branches/10.5/src: ref/ tools/
Author: chaase3
Date: Thu May 28 13:22:40 2009
New Revision: 779597
URL: http://svn.apache.org/viewvc?rev=779597&view=rev
Log:
DERBY-3737: Document the new SignatureChecker lint tool in the Tools Guide
Merged DERBY-3737.diff to 10.5 docs branch from trunk revision 779589.
Added:
db/derby/docs/branches/10.5/src/tools/ctoolssigcheck.dita
- copied unchanged from r779589, db/derby/docs/trunk/src/tools/ctoolssigcheck.dita
db/derby/docs/branches/10.5/src/tools/ctoolsusingsigcheck.dita
- copied unchanged from r779589, db/derby/docs/trunk/src/tools/ctoolsusingsigcheck.dita
Modified:
db/derby/docs/branches/10.5/src/ref/rrefsqljargmatching.dita
db/derby/docs/branches/10.5/src/tools/ctoolsijtools30948.dita
db/derby/docs/branches/10.5/src/tools/ctoolsijtools37363.dita
db/derby/docs/branches/10.5/src/tools/ctoolspre11181.dita
db/derby/docs/branches/10.5/src/tools/ctoolspre23947.dita
db/derby/docs/branches/10.5/src/tools/derbytools.ditamap
Modified: db/derby/docs/branches/10.5/src/ref/rrefsqljargmatching.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/ref/rrefsqljargmatching.dita?rev=779597&r1=779596&r2=779597&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/ref/rrefsqljargmatching.dita (original)
+++ db/derby/docs/branches/10.5/src/ref/rrefsqljargmatching.dita Thu May 28 13:22:40 2009
@@ -88,7 +88,10 @@
then the last <i>n</i> arguments of the Java method must be of type
<i>java.sql.ResultSet[]</i>.</li>
</ul>
-
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides a tool,
+<codeph>SignatureChecker</codeph>, which can identify any SQL functions or
+procedures in a database that do not follow these argument matching rules. See
+the <ph conref="../conrefs.dita#pub/citutilities"></ph> for details.</p>
</section>
<section>
Modified: db/derby/docs/branches/10.5/src/tools/ctoolsijtools30948.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/tools/ctoolsijtools30948.dita?rev=779597&r1=779596&r2=779597&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/tools/ctoolsijtools30948.dita (original)
+++ db/derby/docs/branches/10.5/src/tools/ctoolsijtools30948.dita Thu May 28 13:22:40 2009
@@ -29,7 +29,8 @@
<p>Included with the product are some standalone Java tools and utilities
that make it easier to use and develop applications for <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
<p>These tools and utilities include: <ul>
-<li><codeph>ij</codeph> <p><codeph>ij</codeph> is <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
+<li><i><ph><indexterm>ij<indexterm>description</indexterm></indexterm></ph>ij</i>
+<p><codeph>ij</codeph> is <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
interactive JDBC scripting tool. It is a simple utility for running scripts
against a <ph conref="../conrefs.dita#prod/productshortname"></ph> database.
You can also use it interactively to run ad hoc queries. <codeph>ij</codeph> provides
@@ -39,19 +40,22 @@
allow you to import data directly from files into tables and to export data
from tables into files. Server-side utilities can be in a client/server environment
but require that all files referenced be on the Server machine.</p></li>
-<li><i>Database class loading utilities</i> <p>These utilities allow you
-to store application logic in a database.</p></li>
+<li><i>The jar file utilities</i> <p>These utilities allow you
+to store jar files in a database.</p></li>
<li><i><ph><indexterm>sysinfo<indexterm>description</indexterm></indexterm></ph>sysinfo</i>
<p><codeph>sysinfo</codeph> provides information about your version of <ph
conref="../conrefs.dita#prod/productshortname"></ph> and your environment.</p></li>
<li><i><ph><indexterm>dblook<indexterm>description</indexterm></indexterm></ph>dblook</i>
<p><codeph>dblook</codeph> is <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
-Data Definition Language (DDL) Generation Utility, also called a schema dump
-tool. It is a simple utility for the dumping the DDL of a user-specified database
-to either a console or to a file. The generated DDL can then be used for such
+Data Definition Language (DDL) Generation Utility, more informally called a schema dump
+tool. It is a simple utility that dumps the DDL of a user-specified database
+to either a console or a file. The generated DDL can then be used for such
things as recreating all or parts of a database, viewing a subset of a database's
objects (for example, those which pertain to specific tables and schemas),
or documenting a database's schema.</p></li>
-</ul></p>
+<li><i><ph><indexterm>SignatureChecker<indexterm>description</indexterm></indexterm></ph>SignatureChecker</i>
+<p>The <codeph>SignatureChecker</codeph> tool identifies any SQL functions
+and procedures in a database that do not follow the SQL Standard argument
+matching rules.</p></li></ul></p>
</conbody>
</concept>
Modified: db/derby/docs/branches/10.5/src/tools/ctoolsijtools37363.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/tools/ctoolsijtools37363.dita?rev=779597&r1=779596&r2=779597&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/tools/ctoolsijtools37363.dita (original)
+++ db/derby/docs/branches/10.5/src/tools/ctoolsijtools37363.dita Thu May 28 13:22:40 2009
@@ -21,11 +21,12 @@
<title>Environment setup and the Derby tools</title>
<prolog></prolog>
<conbody>
-<p><codeph>ij</codeph>, <codeph>sysinfo</codeph>, and <codeph>dblook</codeph> are
+<p><codeph>ij</codeph>, <codeph>sysinfo</codeph>, <codeph>dblook</codeph>,
+and <codeph>SignatureChecker</codeph> are
tools that can be used in an embedded or a client/server environment. The
-import and export utilities and database class loading utilities are database-side
-utilities, which means that they run in the same JVM as <ph conref="../conrefs.dita#prod/productshortname"></ph> (e.g.
-on the Server). This means when used in a client/server environment all files
-imported, exported, or loaded must be local to the Server machine.</p>
+import and export utilities and jar file utilities are database-side
+utilities, which means that they run in the same JVM as <ph conref="../conrefs.dita#prod/productshortname"></ph> (that is,
+on the server). This means when used in a client/server environment all files
+imported, exported, or loaded must be local to the server machine.</p>
</conbody>
</concept>
Modified: db/derby/docs/branches/10.5/src/tools/ctoolspre11181.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/tools/ctoolspre11181.dita?rev=779597&r1=779596&r2=779597&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/tools/ctoolspre11181.dita (original)
+++ db/derby/docs/branches/10.5/src/tools/ctoolspre11181.dita Thu May 28 13:22:40 2009
@@ -26,8 +26,9 @@
<ul>
<li>ij</li>
<li>the import and export utilities</li>
-<li>the database class loading utilities</li>
+<li>the jar file utilities</li>
<li>sysinfo</li>
<li>dblook</li>
+<li>SignatureChecker</li>
</ul></p>
</conbody></concept>
Modified: db/derby/docs/branches/10.5/src/tools/ctoolspre23947.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/tools/ctoolspre23947.dita?rev=779597&r1=779596&r2=779597&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/tools/ctoolspre23947.dita (original)
+++ db/derby/docs/branches/10.5/src/tools/ctoolspre23947.dita Thu May 28 13:22:40 2009
@@ -26,25 +26,24 @@
of the tools and utilities, and <ph conref="../conrefs.dita#prod/productshortname"></ph> and
JDBC basics for new or infrequent users.</p></li>
<li><xref href="ctoolsij34525.dita#ctoolsij34525"></xref> <p>How to get
-started with ij, a JDBC and SQL scripting tool.</p></li>
+started with <codeph>ij</codeph>, a JDBC and SQL scripting tool.</p></li>
<li><xref href="rtoolsijpropref29864.dita#rtoolsijpropref29864"></xref> <p>Reference
-for ij properties.</p></li>
+for <codeph>ij</codeph> properties.</p></li>
<li><xref href="rtoolsijcomref25570.dita#rtoolsijcomref25570"></xref> <p>Reference
-for ij commands and errors.</p></li>
+for <codeph>ij</codeph> commands and errors.</p></li>
<li><xref href="ctoolsimport16245.dita#ctoolsimport16245"></xref> <p>Reference
and how-to instructions for using bulk import and export.</p></li>
-<li><xref href="rtoolsijcomref25570.dita#rtoolsijcomref25570"></xref> <p>Syntax
+<li><xref href="ctoolsstorejardb.dita#ctoolsstorejardb"></xref> <p>Syntax
for executing the built-in procedures for storing jar files in the database.</p></li>
<li><xref href="rtoolssysinfo41288.dita#rtoolssysinfo41288"></xref> <p>Reference
information on the utility that provides information about your <ph conref="../conrefs.dita#prod/productshortname"></ph> environment.</p></li>
-<li><xref href="ctoolsdblook.dita#ctoolsdblook"></xref> <p>dblook is <ph
-conref="../conrefs.dita#prod/productshortname"></ph>'s Data Definition Language
-(DDL) Generation Utility, which is more informally called a schema dump tool.
-It is a simple utility that dumps the DDL of a user-specified database to
-either a console or to a file. The generated DDL can then be used to recreate
-all or parts of a database, view a subset of a database's objects (for example,
-those which pertain to specific tables or schemas), or document a database's
-schema.</p></li>
+<li><xref href="ctoolsdblook.dita#ctoolsdblook"></xref> <p>Reference
+information for a utility that dumps the DDL of a user-specified database to
+either a console or a file.</p></li>
+<li><xref href="ctoolssigcheck.dita#ctoolssigcheck"></xref> <p>Reference
+information for a tool that identifies any SQL functions
+and procedures in a database that do not follow the SQL Standard argument
+matching rules.</p></li>
</ul></p>
</conbody>
</concept>
Modified: db/derby/docs/branches/10.5/src/tools/derbytools.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/tools/derbytools.ditamap?rev=779597&r1=779596&r2=779597&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/tools/derbytools.ditamap (original)
+++ db/derby/docs/branches/10.5/src/tools/derbytools.ditamap Thu May 28 13:22:40 2009
@@ -344,5 +344,8 @@
</topicref>
<topicref href="rtoolsdblookexamples.dita" navtitle="dblook examples"></topicref>
</topicref>
+<topicref collection-type="family" href="ctoolssigcheck.dita" navtitle="SignatureChecker">
+<topicref href="ctoolsusingsigcheck.dita" navtitle="Using SignatureChecker"></topicref>
+</topicref>
<topicref href="rtoolstrademderby.dita" navtitle="Trademarks"></topicref>
</map>