db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r1104454 - in /db/derby/docs/trunk/src: devguide/ ref/ tools/
Date Tue, 17 May 2011 18:37:18 GMT
Author: chaase3
Date: Tue May 17 18:37:18 2011
New Revision: 1104454

URL: http://svn.apache.org/viewvc?rev=1104454&view=rev
Log:
DERBY-5226  SQLJ system procedures should be documented in Reference Manual

Removed 5 topics from Tools Guide, created 4 topics for Reference Manual, fixed xrefs in Tools
Guide and Developer's Guide

Patches: DERBY-5226-2.diff

Added:
    db/derby/docs/trunk/src/ref/crefstorejardb.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefstorejarinstall.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefstorejarremove.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefstorejarreplace.dita   (with props)
Removed:
    db/derby/docs/trunk/src/tools/ctoolsstorejardb.dita
    db/derby/docs/trunk/src/tools/rtoolsjarload3284.dita
    db/derby/docs/trunk/src/tools/ttoolsjarload1002986.dita
    db/derby/docs/trunk/src/tools/ttoolsjarload1003059.dita
    db/derby/docs/trunk/src/tools/ttoolsjarload1003120.dita
Modified:
    db/derby/docs/trunk/src/devguide/rdevdeploy856948.dita
    db/derby/docs/trunk/src/ref/refderby.ditamap
    db/derby/docs/trunk/src/tools/ctoolspre23947.dita
    db/derby/docs/trunk/src/tools/derbytools.ditamap

Modified: db/derby/docs/trunk/src/devguide/rdevdeploy856948.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/rdevdeploy856948.dita?rev=1104454&r1=1104453&r2=1104454&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/rdevdeploy856948.dita (original)
+++ db/derby/docs/trunk/src/devguide/rdevdeploy856948.dita Tue May 17 18:37:18 2011
@@ -21,6 +21,7 @@ limitations under the License.
 <prolog>
 </prolog>
 <refbody>
-<section><p>See the <cite><ph conref="../conrefs.dita#pub/citutilities"></ph></cite>
for reference information about
-the utility and complete syntax.</p></section>
+<section><p>See the <ph conref="../conrefs.dita#pub/citref"></ph>
for reference
+information about the jar file system procedures and complete syntax.</p>
+</section>
 </refbody></reference>

Added: db/derby/docs/trunk/src/ref/crefstorejardb.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefstorejardb.dita?rev=1104454&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/crefstorejardb.dita (added)
+++ db/derby/docs/trunk/src/ref/crefstorejardb.dita Tue May 17 18:37:18 2011
@@ -0,0 +1,40 @@
+<?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 concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
+<concept xml:lang="en-us" id="ctoolsstorejardb">
+<title>System procedures for storing jar files in a database</title>
+<conbody>
+<p><codeph>SQLJ.INSTALL_JAR</codeph>, <codeph>SQLJ.REMOVE_JAR</codeph>,
and
+<codeph>SQLJ.REPLACE_JAR</codeph> are a set of procedures in the SQLJ schema
+that allow you to store jar files in a database.</p>
+<p>Your jar file has two names:</p>
+<ul>
+<li>A <i>physical name</i> (the name you gave it when you created it)</li>
+<li>A <i><ph conref="../conrefs.dita#prod/productshortname"></ph>
name</i> (the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> identifier you give
it
+when you load it into a particular schema). The
+<ph conref="../conrefs.dita#prod/productshortname"></ph> name, an
+<i><xref href="crefsqlj34834.dita#crefsqlj34834">SQL92Identifier</xref></i>,
can
+be delimited and must be unique within a schema.</li>
+</ul>
+<p>A single schema can store more than one jar file.</p>
+<p>For more information on when and how to use these procedures, see the section
+"Loading classes from a database" in the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
+</conbody>
+</concept>

Propchange: db/derby/docs/trunk/src/ref/crefstorejardb.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=1104454&r1=1104453&r2=1104454&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Tue May 17 18:37:18 2011
@@ -422,6 +422,14 @@ limitations under the License.
 </topicref>
 <topicref href="rrefupdatestatsproc.dita" navtitle="SYSCS_UTIL.SYSCS_UPDATE_STATISTICS
stored procedure">
 </topicref>
+<topicref collection-type="family" href="crefstorejardb.dita" navtitle="System procedures
for storing jar files in a database">
+<topicref href="rrefstorejarinstall.dita" navtitle="SQLJ.INSTALL_JAR system procedure">
+</topicref>
+<topicref href="rrefstorejarremove.dita" navtitle="SQLJ.REMOVE_JAR system procedure">
+</topicref>
+<topicref href="rrefstorejarreplace.dita" navtitle="SQLJ.REPLACE_JAR system procedure">
+</topicref>
+</topicref>
 </topicref>
 <topicref href="rrefsyscsdiagtables.dita" navtitle="SYSCS_DIAG diagnostic tables and functions">
 </topicref>

Added: db/derby/docs/trunk/src/ref/rrefstorejarinstall.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefstorejarinstall.dita?rev=1104454&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefstorejarinstall.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefstorejarinstall.dita Tue May 17 18:37:18 2011
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rrefstorejarinstall" xml:lang="en-us">
+<title>SQLJ.INSTALL_JAR system procedure</title>
+<shortdesc> 
+The SQLJ.INSTALL_JAR system procedure stores a jar file in a database.
+</shortdesc>
+<prolog><metadata><keywords>
+<indexterm>SQLJ.INSTALL_JAR system procedure</indexterm>
+<indexterm>system procedures<indexterm>SQLJ.INSTALL_JAR</indexterm></indexterm>
+<indexterm>jar files<indexterm>storing in databases</indexterm></indexterm>
+</keywords></metadata></prolog>
+<refbody>
+<section><title>Syntax</title>
+<codeblock>SQLJ.INSTALL_JAR(IN JAR_FILE_PATH VARCHAR(32672), 
+                 IN QUALIFIED_JAR_NAME VARCHAR(32672),
+                 IN DEPLOY INTEGER)</codeblock>
+<dl>
+<dlentry><dt>JAR_FILE_PATH</dt>
+<dd>The path and physical name of the jar file to add. For example:
+<codeblock>d:/todays_build/tours.jar</codeblock>
+</dd>
+</dlentry>
+<dlentry><dt>QUALIFIED_JAR_NAME</dt>
+<dd>The <ph conref="../conrefs.dita#prod/productshortname"></ph> name of
the
+jar file, qualified by the schema name. Two examples:
+<codeblock>MYSCHEMA.Sample1</codeblock>
+<codeblock> -- a delimited identifier
+MYSCHEMA."Sample2"</codeblock>
+</dd>
+</dlentry>
+<dlentry><dt>DEPLOY</dt>
+<dd>If set to 1, indicates the existence of an SQLJ deployment descriptor file.
+<ph conref="../conrefs.dita#prod/productshortname"></ph> ignores this
+argument, so it is normally set to 0.</dd>
+</dlentry>
+</dl>
+</section>
+<section><title>SQL examples</title>
+<codeblock><b>-- SQL statement</b>
+CALL SQLJ.INSTALL_JAR('tours.jar', 'APP.Sample1', 0)
+
+<b>-- SQL statement
+-- using a quoted identifier for the 
+-- <ph conref="../conrefs.dita#prod/productshortname"></ph> jar name</b>
+CALL SQLJ.INSTALL_JAR('tours.jar', 'APP."Sample2"', 0)</codeblock>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefstorejarinstall.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefstorejarremove.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefstorejarremove.dita?rev=1104454&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefstorejarremove.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefstorejarremove.dita Tue May 17 18:37:18 2011
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rrefstorejarremove" xml:lang="en-us">
+<title>SQLJ.REMOVE_JAR system procedure</title>
+<shortdesc> 
+The SQLJ.REMOVE_JAR system procedure removes a jar file from a database.
+</shortdesc>
+<prolog><metadata><keywords>
+<indexterm>SQLJ.REMOVE_JAR system procedure</indexterm>
+<indexterm>system procedures<indexterm>SQLJ.REMOVE_JAR</indexterm></indexterm>
+<indexterm>jar files<indexterm>removing from databases</indexterm></indexterm>
+</keywords></metadata></prolog>
+<refbody>
+<section><title>Syntax</title>
+<codeblock>SQLJ.REMOVE_JAR(IN QUALIFIED_JAR_NAME VARCHAR(32672),
+                IN UNDEPLOY INTEGER)</codeblock>
+<dl>
+<dlentry><dt>QUALIFIED_JAR_NAME</dt>
+<dd>The <ph conref="../conrefs.dita#prod/productshortname"></ph> name of
the
+jar file, qualified by the schema name. Two examples:
+<codeblock>MYSCHEMA.Sample1</codeblock>
+<codeblock> -- a delimited identifier.
+MYSCHEMA."Sample2"</codeblock>
+</dd>
+</dlentry>
+<dlentry><dt>UNDEPLOY</dt>
+<dd>If set to 1, indicates the existence of an SQLJ deployment descriptor file.
+<ph conref="../conrefs.dita#prod/productshortname"></ph> ignores this
+argument, so it is normally set to 0.</dd>
+</dlentry>
+</dl>
+</section>
+<section><title>SQL example</title>
+<codeblock><b>-- SQL statement</b>
+CALL SQLJ.REMOVE_JAR('APP.Sample1', 0)</codeblock>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefstorejarremove.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefstorejarreplace.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefstorejarreplace.dita?rev=1104454&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefstorejarreplace.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefstorejarreplace.dita Tue May 17 18:37:18 2011
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rrefstorejarreplace" xml:lang="en-us">
+<title>SQLJ.REPLACE_JAR system procedure</title>
+<shortdesc> 
+The SQLJ.REPLACE_JAR system procedure replaces a jar file in a database.
+</shortdesc>
+<prolog><metadata><keywords>
+<indexterm>SQLJ.REPLACE_JAR system procedure</indexterm>
+<indexterm>system procedures<indexterm>SQLJ.REPLACE_JAR</indexterm></indexterm>
+<indexterm>jar files<indexterm>replacing in databases</indexterm></indexterm>
+</keywords></metadata></prolog>
+<refbody>
+<section><title>Syntax</title>
+<codeblock>SQLJ.REPLACE_JAR(IN JAR_FILE_PATH VARCHAR(32762), 
+                 IN QUALIFIED_JAR_NAME VARCHAR(32762))</codeblock>
+<dl>
+<dlentry><dt>JAR_FILE_PATH</dt>
+<dd>The path and physical name of the jar file to use as a replacement. For
+example:
+<codeblock>d:/todays_build/tours.jar</codeblock></dd>
+</dlentry>
+<dlentry><dt>QUALIFIED_JAR_NAME</dt>
+<dd>The <ph conref="../conrefs.dita#prod/productshortname"></ph> name of
the
+jar file, qualified by the schema name. Two examples:
+<codeblock>MYSCHEMA.Sample1</codeblock>
+<codeblock> -- a delimited identifier.
+MYSCHEMA."Sample2"</codeblock>
+</dd>
+</dlentry>
+</dl>
+</section>
+<section><title>SQL example</title>
+<codeblock><b>-- SQL statement</b>
+CALL sqlj.replace_jar('c:\myjarfiles\newtours.jar', 'APP.Sample1')</codeblock>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefstorejarreplace.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: db/derby/docs/trunk/src/tools/ctoolspre23947.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolspre23947.dita?rev=1104454&r1=1104453&r2=1104454&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolspre23947.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolspre23947.dita Tue May 17 18:37:18 2011
@@ -33,8 +33,6 @@ for <codeph>ij</codeph> properties.</p><
 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="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>Reference

Modified: db/derby/docs/trunk/src/tools/derbytools.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/derbytools.ditamap?rev=1104454&r1=1104453&r2=1104454&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/derbytools.ditamap (original)
+++ db/derby/docs/trunk/src/tools/derbytools.ditamap Tue May 17 18:37:18 2011
@@ -325,15 +325,6 @@ limitations under the License.
 <topicref href="rtoolsimportcodeset.dita" navtitle="CODESET values for import and export
procedures">
 </topicref>
 </topicref>
-<topicref collection-type="family" href="ctoolsstorejardb.dita" navtitle="Storing jar
files in a database ">
-<topicref href="ttoolsjarload1002986.dita" navtitle="Adding a Jar File"></topicref>
-<topicref href="ttoolsjarload1003059.dita" navtitle="Removing a jar file">
-</topicref>
-<topicref href="ttoolsjarload1003120.dita" navtitle="Replacing a jar file">
-</topicref>
-<topicref href="rtoolsjarload3284.dita" navtitle="Installing a jar example">
-</topicref>
-</topicref>
 <topicref collection-type="family" href="rtoolssysinfo41288.dita" navtitle="sysinfo">
 <topicref href="rtoolssysinfo1002629.dita" navtitle="sysinfo example"></topicref>
 <topicref href="ctoolssysinfo1002931.dita" navtitle="Using sysinfo to check the classpath">



Mime
View raw message