dleslie 01/05/16 11:31:05
Modified: java/src/org/apache/xalan/lib/sql package.html
Log:
Editing pass.
Revision Changes Path
1.8 +14 -22 xml-xalan/java/src/org/apache/xalan/lib/sql/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/package.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- package.html 2001/05/13 22:56:25 1.7
+++ package.html 2001/05/16 18:31:00 1.8
@@ -2,29 +2,21 @@
<title>Xalan SQL Extension</title>
<body>
<p>Provides extension functions for connecting to a JDBC data source,
executing a query,
- and working incrementally through "streamable" result set.<p>
- <p>
- The SQL Extension operates in on of two modes, streaming or cached. In
streaming modes, there is only
- one row object that is allocated and its contents are updated as the row
element set is traversed. In
- this mode, the element set can only be traversed forward since there is
only one row node object, no
- history is ever kept. Streaming mode is advantages when SQL Queries are
large and memory is an issue
- since the number of record returned do not affect them memory footprint.
It does however come with
- the restriction that the result set can only be traversed once. In cached
mode, as the result set
- is traversed, history of the previous rows are recorded, hence the result
set can then be traversed
- forward or backward and as many times as necessary. In this mode, there
is a downside that memory
- is consumed as the result set is traversed.
+ and working incrementally through a "streamable" result set.<p>
+ <p>The SQL Extension operates in one of two modes: streaming or
cached.</p>
+ <p>In streaming mode, a single row object is allocated. The contents of
this object are updated as the row
+ element set is traversed. Accordingly, the result set can only be
traversed once moving forward. Consider using streaming mode
+ when the result set is large and memory is an issue. The number of
records returned does not affect the memory footprint.</p>
+ <p>In cached mode, the result set can be traversed forward or backward as
many times as desired. The downside: memory is
+ consumed as the result set is traversed.</p>
- The default mode is cached mode and may be changed using the set with the
two methods enableCacheNodes
- and disableCahcedNodes.
- </p>
+ <p>Currently, the default is cached mode. To set the mode, use the
enableCacheNodes() or disableCahcedNodes() method.</p>
<p>
+ <hr>
+ <em>**Experimental**</em> This package is experimental. Streaming mode is
not fully implemented and may not return the entire
+ result set. If you do use streaming mode, be careful not to attempt to
traverse the result set in any manner other than a
+ single traversal from start to finish.
<HR>
- <em>
- **Experimental** This package has been marked as experimental since the
streaming mode
- is not fully implemented and is not the default mode. Disabling node
caching (streaming mode) may
- not return the full result set.
- <HR>
- </em>
</p>
<p>XConnection provides three extension functions that you can use in
your stylesheet.</p>
@@ -39,8 +31,8 @@
begin "transforming" the row-set before the entire result set has
been returned.<br/><br/></li>
<li>pquery(), addParameter(), addParameterFromElement(),
clearParameters() -- Use the XConnection pquery() method in
conjunction with these other methods to set up and execute
parameterized queries.<br/><br/></li>
- <li>enableCacheNodes(), disableCacheNodes() -- Use these XConnection
methods to manage the caching of the streamable
- nodes returned by queries.<br/><br/></li>
+ <li>enableCacheNodes(), disableCacheNodes() -- Use these XConnection
methods to cache the result set or use a single row
+ element to stream through the result set.<br/><br/></li>
<li>close() -- Use the XConnection object close() method to terminate
the connection.</li>
</ol>
<p>The query() or pquery() extension function returns a Document node
that contains (as needed) an array of column-header elements,
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
