You are viewing a plain text version of this content. The canonical link for it is here.
Posted to rivet-dev@tcl.apache.org by da...@apache.org on 2002/10/02 21:15:01 UTC
cvs commit: tcl-rivet/doc/packages/dio dio.html
davidw 2002/10/02 12:15:00
Modified: . ChangeLog
doc rivet.xml
doc/html directives.html help.html index.html internals.html
upgrading.html
doc/packages/dio dio.html
Added: doc/html installation.html
Log:
* doc/rivet.xml: Added 'Introduction' section.
Revision Changes Path
1.69 +4 -0 tcl-rivet/ChangeLog
Index: ChangeLog
===================================================================
RCS file: /home/cvs/tcl-rivet/ChangeLog,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -r1.68 -r1.69
--- ChangeLog 29 Sep 2002 23:09:05 -0000 1.68
+++ ChangeLog 2 Oct 2002 19:14:59 -0000 1.69
@@ -1,3 +1,7 @@
+2002-10-02 David N. Welton <da...@dedasys.com>
+
+ * doc/rivet.xml: Added 'Introduction' section.
+
2002-09-29 David N. Welton <da...@dedasys.com>
* doc/rivet.xml: Reworked several elements to better utilize
1.9 +37 -10 tcl-rivet/doc/rivet.xml
Index: rivet.xml
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/rivet.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- rivet.xml 29 Sep 2002 23:09:05 -0000 1.8
+++ rivet.xml 2 Oct 2002 19:15:00 -0000 1.9
@@ -13,28 +13,55 @@
<author>
<firstname>David</firstname>
<surname>Welton</surname>
+ <affiliation>
+ <address>
+ <email>davidw@apache.org</email>
+ </address>
+ </affiliation>
</author>
<author>
<firstname>Damon</firstname>
<surname>Courtney</surname>
+ <affiliation>
+ <address>
+ <email>damonc@apache.org</email>
+ </address>
+ </affiliation>
</author>
</articleinfo>
- <!--
+
<section>
- <title>Introduction</title>
+ <title>Introduction to Apache Rivet</title>
+ <para>
+ Apache Rivet is a system for creating dynamic web content via a
+ programming language integrated with Apache Web Server. It is
+ designed to be fast, powerful and extensible, consume few system
+ resources, be easy to learn, and to provide the user with a
+ platform that can also be used for other programming tasks
+ outside the web (GUI's, system administration tasks, text
+ processing, database manipulation, XML, and so on). In order to
+ meet these goals, we have chosen the Tcl programming language to
+ combine with the Apache Web Server.
+ </para>
+ <para>
+ In this manual, we aim to help get you started, and then
+ writing productive code as quickly as possible, as well as
+ giving you ideas on how to best take advantage of Rivet's
+ architecture to create different styles of web site.
+ </para>
- <para>
- Hi - thanks for having a look at Apache Rivet - we hope you like
- it! If you have any questions, feel free to ask on the mailing
- lists, if you haven't found the answers here. If you think that
- the answer should be here, don't hesitate to tell us that,
- either.
+ <para>
+ This documentation is a work in progress, and, like everything
+ else about Apache Rivet, it is Free Software. If you see
+ something that needs improving, and have ideas or suggestions,
+ don't hesitate to let us know. If you want to contribute
+ directly, better yet!
</para>
</section>
- -->
- <section>
+
+ <section id="installation">
<title>Apache Rivet Installation</title>
<procedure>
1.2 +2 -2 tcl-rivet/doc/html/directives.html
Index: directives.html
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/directives.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- directives.html 29 Sep 2002 23:09:05 -0000 1.1
+++ directives.html 2 Oct 2002 19:15:00 -0000 1.2
@@ -1,5 +1,5 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Rivet Apache Directives</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"><link rel="home" href="index.html" title="Apache Rivet"><link rel="up" href="index.html" title="Apache Rivet"><link rel="previous" href="index.html" title="Apache Rivet"><link rel="next" href="commands.html" title="Rivet Tcl Commands and Variables"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Rivet Apache Directives</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a>�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="commands.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="directives"></a>Rivet Apache Directives</h2></div></div><p style="width:90%">
+<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Rivet Apache Directives</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"><link rel="home" href="index.html" title="Apache Rivet"><link rel="up" href="index.html" title="Apache Rivet"><link rel="previous" href="installation.html" title="Apache Rivet Installation"><link rel="next" href="commands.html" title="Rivet Tcl Commands and Variables"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Rivet Apache Directives</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="installation.html">Prev</a>�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="commands.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="directives"></a>Rivet Apache Directives</h2></div></div><p style="width:90%">
These directives are used within the Apache httpd server
configuration files to modify Apache Rivet's behaviour.
</p><div class="variablelist"><dl><dt><span class="term">
@@ -104,4 +104,4 @@
<span style="font-family:monospace"><b>RivetServerConf</b></span>, except that they are
only valid for the directory where they are specified, and
its subdirectories.
- </div></div></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="commands.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Apache Rivet�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�Rivet Tcl Commands and Variables</td></tr></table></div></body></html>
+ </div></div></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="installation.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="commands.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Apache Rivet Installation�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�Rivet Tcl Commands and Variables</td></tr></table></div></body></html>
1.2 +3 -3 tcl-rivet/doc/html/help.html
Index: help.html
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/help.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- help.html 29 Sep 2002 23:09:05 -0000 1.1
+++ help.html 2 Oct 2002 19:15:00 -0000 1.2
@@ -1,5 +1,5 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Resources - How to Get Help</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"><link rel="home" href="index.html" title="Apache Rivet"><link rel="up" href="index.html" title="Apache Rivet"><link rel="previous" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="next" href="internals.html" title="Rivet Internals"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Resources - How to Get Help</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="commands.html">Prev</a>�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="internals.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="help"></a>Resources - How to Get Help</h2></div></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347126"></a>Mailing Lists</h3></div></div><p style="width:90%">
+<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Resources - How to Get Help</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"><link rel="home" href="index.html" title="Apache Rivet"><link rel="up" href="index.html" title="Apache Rivet"><link rel="previous" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="next" href="internals.html" title="Rivet Internals"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Resources - How to Get Help</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="commands.html">Prev</a>�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="internals.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="help"></a>Resources - How to Get Help</h2></div></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347185"></a>Mailing Lists</h3></div></div><p style="width:90%">
The Rivet mailing list is the first place you should turn for
help, if you haven't found the solution to your problem in the
documentation. Send email to
@@ -10,7 +10,7 @@
<tt><<a href="mailto:rivet-list-subscribe@tcl.apache.org">rivet-<i><tt>list</tt></i>-subscribe@tcl.apache.org</a>></tt>.
</p><p style="width:90%">
The mailing list archives are available at <a href="http://www.apachelabs.org" target="_top">http://www.apachelabs.org</a>
- </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347172"></a>Web Sites</h3></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347231"></a>Web Sites</h3></div></div><p style="width:90%">
There are several web sites that cover Apache and Tcl
extensively.
</p><div class="itemizedlist"><ul type="disc"><li><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
@@ -27,7 +27,7 @@
</div></li><li><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
<a href="http://wiki.tcl.tk" target="_top">http://wiki.tcl.tk</a> is the Tcl'ers Wiki, a
free-form place to search for answers and ask for help.
- </div></li></ul></div></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347254"></a>Bug Tracking System</h3></div></div><p style="width:90%">
+ </div></li></ul></div></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347313"></a>Bug Tracking System</h3></div></div><p style="width:90%">
Apache Rivet uses the Apache Bug Tracking system at <a href="http://nagoya.apache.org/bugzilla/" target="_top">http://nagoya.apache.org/bugzilla/</a>. Here,
you can report problems, or check and see if existing issues
are already known and being dealt with.
1.2 +26 -66 tcl-rivet/doc/html/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/index.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.html 29 Sep 2002 23:09:05 -0000 1.1
+++ index.html 2 Oct 2002 19:15:00 -0000 1.2
@@ -1,67 +1,27 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Apache Rivet</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"><link rel="home" href="index.html" title="Apache Rivet"><link rel="next" href="directives.html" title="Rivet Apache Directives"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Apache Rivet</th></tr><tr><td width="20%" align="left">�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="directives.html">Next</a></td></tr></table><hr></div><div class="article"><div class="titlepage"><div><h1 class="title"><a name="id5343475"></a>Apache Rivet</h1></div><div><div class="author"><h3 class="author">David Welton</h3></div></div><div><div class="author"><h3 class="author">Damon Courtney</h3></div></div><div><p class="copyright">Copyright � 2002 Apache Software Foundation</p></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="index.html#id5341909">Apache Rivet Installation</a></dt><dt><a href="directives.html">Rivet Apache Directives</a></dt><dt><a href="commands.html">Rivet Tcl Commands and Variables</a></dt><dt><a href="help.html">Resources - How to Get Help</a></dt><dd><dl><dt><a href="help.html#id5347126">Mailing Lists</a></dt><dt><a href="help.html#id5347172">Web Sites</a></dt><dt><a href="help.html#id5347254">Bug Tracking System</a></dt></dl></dd><dt><a href="internals.html">Rivet Internals</a></dt><dd><dl><dt><a href="internals.html#id5347294">Initialization</a></dt><dt><a href="internals.html#id5347331">RivetChan</a></dt><dt><a href="internals.html#id5347360">Page Parsing, Execution and Cacheing</a></dt></dl></dd><dt><a href="upgrading.html">Upgrading from mod_dtcl or NeoWebScript</a></dt><dd><dl><dt><a href="upgrading.html#id5347439">mod_dtcl</a></dt><dt><a href="upgrading.html#id5347455">NeoWebScript</a></dt></dl></dd></dl></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="id5341909"></a>Apache Rivet Installation</h2></div></div><div class="procedure"><ol type="1"><li><p class="title"><b>Check Dependencies</b></p><p style="width:90%">
- To install Rivet, you will need Tcl 8.2 or greater and
- Apache 1.3.xx. It is known to run on Linux, FreeBSD,
- OpenBSD, and Solaris and HPUX. Windows NT is also possible
- - please see the directions in the distribution.
- </p></li><li><p class="title"><b>Get Rivet</b></p><p style="width:90%">
- Download the sources at <a href="http://tcl.apache.org/rivet/download" target="_top">http://tcl.apache.org/rivet/download</a>. Currently
- the only way to obtain Rivet. In the future, we hope to
- have a FreeBSD port, Debian package, RPM's, and windows
- binaries.
- </p></li><li><p class="title"><b>Get and Install Apache Sources</b></p><p style="width:90%">
- If you don't have them, or if you want to build Rivet as a
- static (built in) part of the Apache web server, you need
- the source code to Apache, which is available from <a href="http://httpd.apache.org/" target="_top">http://httpd.apache.org/</a>. Otherwise, you don't need
- to perform this step. Infact, we recommend that you build
- Rivet as a shared object, and therefore, build it seperately
- from Apache.
- </p></li><li><p class="title"><b>Uncompress Sources</b></p><p style="width:90%">
- We will assume that you have Apache installed at this point.
- You must uncompress the Rivet sources in the directory where you
- wish to compile them.
-
- </p><div style="background:#bbffbb ; width:80ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting">gunzip tcl-rivet-X.X.X.tar.gz
-tar -xvf tcl-rivet-X.X.X.tar.gz</div><p style="width:90%">
-
- </p></li><li><p class="title"><b>Building Rivet</b></p><p style="width:90%">
- Rivet uses a unique build system which we created especially
- for this project. It utilizes the information included in
- Apache and Tcl regarding their configurations, in order to
- compile itself via a series of Tcl scripts, which are
- located in the <tt>buildscripts/</tt> directory.
- </p><ol type="a"><li><p class="title"><b>Edit src/make.tcl</b></p><p style="width:90%">
- It may be necessary to edit
- <tt>src/make.tcl</tt> by hand in order to
- set certain options. Try the next step first, and see
- if it's successful.
- </p></li><li><p style="width:90%">At this point, you are ready to run the build
- system:</p><div style="background:#bbffbb ; width:80ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting">cd src/
-./make.tcl <i><tt>option</tt></i></div><p style="width:90%">where <i><tt>option</tt></i> can be
- either <tt><span style="text-decoration:underline">shared</span></tt> or
- <tt><span style="text-decoration:underline">static</span></tt>.
- </p></li><li><p class="title"><b>Install</b></p><p style="width:90%">
- Now, you are ready to run the <span style="font-family:monospace"><b>./make
- install</b></span> command to install the resulting
- files. This should copy the shared object (like
- <tt>mod_rivet.so</tt>, if one was
- successfully created, into Apache's
- <tt>libexec</tt> directory, as well as
- install some support scripts and various code.
- </p></li></ol></li><li><p class="title"><b>Apache Configuration Files</b></p><p style="width:90%">
- Rivet is relatively easy to configure - we start off by
- adding the module itself:
- </p><div style="background:#bbffbb ; width:80ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting">LoadModule rivet_module <i><tt>/usr/lib/apache/1.3/mod_rivet.so</tt></i></div><p style="width:90%">
- This tells Apache to load the Rivet shared object, wherever
- it happens to reside on your file system. Now we have to
- tell Apache what kind of files are "Rivet" files and how to
- process them:
- </p><div style="background:#bbffbb ; width:80ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting">AddType application/x-httpd-rivet .rvt
-AddType application/x-rivet-tcl .tcl</div><p style="width:90%">
- These tell Apache to process files with the
- <tt>.rvt</tt> and <tt>.tcl</tt>
- extensions as Rivet files.
- </p><p style="width:90%">
- For other directives that Rivet provides for Apache
- configuration, please see <a href="directives.html#directives" title="Rivet Apache Directives">the section called “Rivet Apache Directives”</a>.
- </p></li></ol></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left">�</td><td width="20%" align="center">�</td><td width="40%" align="right">�<a accesskey="n" href="directives.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">�</td><td width="20%" align="center">�</td><td width="40%" align="right" valign="top">�Rivet Apache Directives</td></tr></table></div></body></html>
+<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Apache Rivet</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"><link rel="home" href="index.html" title="Apache Rivet"><link rel="next" href="installation.html" title="Apache Rivet Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Apache Rivet</th></tr><tr><td width="20%" align="left">�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="installation.html">Next</a></td></tr></table><hr></div><div class="article"><div class="titlepage"><div><h1 class="title"><a name="id5343471"></a>Apache Rivet</h1></div><div><div class="author"><h3 class="author">David Welton</h3><div class="affiliation"><div class="address"><p>
+ <tt><<a href="mailto:davidw@apache.org">davidw@apache.org</a>></tt>
+ </p></div></div></div></div><div><div class="author"><h3 class="author">Damon Courtney</h3><div class="affiliation"><div class="address"><p>
+ <tt><<a href="mailto:damon@apache.org">damon@apache.org</a>></tt>
+ </p></div></div></div></div><div><p class="copyright">Copyright � 2002 Apache Software Foundation</p></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="index.html#id5343609">Introduction to Apache Rivet</a></dt><dt><a href="installation.html">Apache Rivet Installation</a></dt><dt><a href="directives.html">Rivet Apache Directives</a></dt><dt><a href="commands.html">Rivet Tcl Commands and Variables</a></dt><dt><a href="help.html">Resources - How to Get Help</a></dt><dd><dl><dt><a href="help.html#id5347185">Mailing Lists</a></dt><dt><a href="help.html#id5347231">Web Sites</a></dt><dt><a href="help.html#id5347313">Bug Tracking System</a></dt></dl></dd><dt><a href="internals.html">Rivet Internals</a></dt><dd><dl><dt><a href="internals.html#id5347353">Initialization</a></dt><dt><a href="internals.html#id5347390">RivetChan</a></dt><dt><a href="internals.html#id5347419">Page Parsing, Execution and Cacheing</a></dt></dl></dd><dt><a href="upgrading.html">Upgrading from mod_dtcl or NeoWebScript</a></dt><dd><dl><dt><a href="upgrading.html#id5347498">mod_dtcl</a></dt><dt><a href="upgrading.html#id5347513">NeoWebScript</a></dt></dl></dd></dl></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="id5343609"></a>Introduction to Apache Rivet</h2></div></div><p style="width:90%">
+ Apache Rivet is a system for creating dynamic web content via a
+ programming language integrated with Apache Web Server. It is
+ designed to be fast, powerful and extensible, consume few system
+ resources, be easy to learn, and to provide the user with a
+ platform that can also be used for other programming tasks
+ outside the web (GUI's, system administration tasks, text
+ processing, database manipulation, XML, and so on). In order to
+ meet these goals, we have chosen the Tcl programming language to
+ combine with the Apache Web Server.
+ </p><p style="width:90%">
+ In this manual, we aim to help get you started, and then
+ writing productive code as quickly as possible, as well as
+ giving you ideas on how to best take advantage of Rivet's
+ architecture to create different styles of web site.
+ </p><p style="width:90%">
+ This documentation is a work in progress, and, like everything
+ else about Apache Rivet, it is Free Software. If you see
+ something that needs improving, and have ideas or suggestions,
+ don't hesitate to let us know. If you want to contribute
+ directly, better yet!
+ </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left">�</td><td width="20%" align="center">�</td><td width="40%" align="right">�<a accesskey="n" href="installation.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">�</td><td width="20%" align="center">�</td><td width="40%" align="right" valign="top">�Apache Rivet Installation</td></tr></table></div></body></html>
1.2 +3 -3 tcl-rivet/doc/html/internals.html
Index: internals.html
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/internals.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- internals.html 29 Sep 2002 23:09:05 -0000 1.1
+++ internals.html 2 Oct 2002 19:15:00 -0000 1.2
@@ -4,7 +4,7 @@
code is removed, and changes are made. The best place to look
is the source code itself. If you are interested in the changes
themselves FIXME.
- </p><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347294"></a>Initialization</h3></div></div><p style="width:90%">
+ </p><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347353"></a>Initialization</h3></div></div><p style="width:90%">
When Apache is started, (or when child Apache processes are
started if a threaded Tcl is used),
<tt>Rivet_InitTclStuff</tt> is called, which
@@ -15,7 +15,7 @@
executes Rivet's <tt>init.tcl</tt>. The caching
system is also set up, and if there is a
<span style="font-family:monospace"><b>GlobalInitScript</b></span>, it is run.
- </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347331"></a>RivetChan</h3></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347390"></a>RivetChan</h3></div></div><p style="width:90%">
The RivetChan system was created in
order to have an actual Tcl channel that we could redirect
standard output to. This lets us use, for instance, the
@@ -25,7 +25,7 @@
Tcl's regular standard output is replaced with an instance of
this channel type, so that, by default, output will go to the
web page.
- </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347360"></a>Page Parsing, Execution and Cacheing</h3></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347419"></a>Page Parsing, Execution and Cacheing</h3></div></div><p style="width:90%">
When a Rivet page is requested, it is transformed into an
ordinary Tcl script by parsing the file for the <? ?>
processing instruction tags. Everything outside these tags
1.2 +2 -2 tcl-rivet/doc/html/upgrading.html
Index: upgrading.html
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/upgrading.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- upgrading.html 29 Sep 2002 23:09:05 -0000 1.1
+++ upgrading.html 2 Oct 2002 19:15:00 -0000 1.2
@@ -6,8 +6,8 @@
compatibility was not a primary goal when creating Rivet, but we
do provide this information which may be of use to those wishing
to upgrade from mod_dtcl or NWS installations.
- </p><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347439"></a>mod_dtcl</h3></div></div><p style="width:90%">
+ </p><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347498"></a>mod_dtcl</h3></div></div><p style="width:90%">
Rivet was originally based on the dtcl code, but it has
changed (improved!) quite a bit. The concepts remain the
same, but many of the commands have changed.
- </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347455"></a>NeoWebScript</h3></div></div><p style="width:90%">TODO</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="internals.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html">Up</a></td><td width="40%" align="right">�</td></tr><tr><td width="40%" align="left" valign="top">Rivet Internals�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�</td></tr></table></div></body></html>
+ </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347513"></a>NeoWebScript</h3></div></div><p style="width:90%">TODO</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="internals.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html">Up</a></td><td width="40%" align="right">�</td></tr><tr><td width="40%" align="left" valign="top">Rivet Internals�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�</td></tr></table></div></body></html>
1.1 tcl-rivet/doc/html/installation.html
Index: installation.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Apache Rivet Installation</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"><link rel="home" href="index.html" title="Apache Rivet"><link rel="up" href="index.html" title="Apache Rivet"><link rel="previous" href="index.html" title="Apache Rivet"><link rel="next" href="directives.html" title="Rivet Apache Directives"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Apache Rivet Installation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a>�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="directives.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="installation"></a>Apache Rivet Installation</h2></div></div><div class="procedure"><ol type="1"><li><p class="title"><b>Check Dependencies</b></p><p style="width:90%">
To install Rivet, you will need Tcl 8.2 or greater and
Apache 1.3.xx. It is known to run on Linux, FreeBSD,
OpenBSD, and Solaris and HPUX. Windows NT is also possible
- please see the directions in the distribution.
</p></li><li><p class="title"><b>Get Rivet</b></p><p style="width:90%">
Download the sources at <a href="http://tcl.apache.org/rivet/download" target="_top">http://tcl.apache.org/rivet/download</a>. Currently
the only way to obtain Rivet. In the future, we hope to
have a FreeBSD port, Debian package, RPM's, and windows
binaries.
</p></li><li><p class="title"><b>Get and Install Apache Sources</b></p><p style="width:90%">
If you don't have them, or if you want to build Rivet as a
static (built in) part of the Apache web server, you need
the source code to Apache, which is available from <a href="http://httpd.apache.org/" target="_top">http://httpd.apache.org/</a>. Otherwise, you don't need
to perform this step. Infact, we recommend that you build
Rivet as a shared object, and therefore, build it seperately
from Apache.
</p></li><li><p class="title"><b>Uncompress Sources</b></p><p style="width:90%">
We will assume that you have Apache installed at this point.
You must uncompress the Rivet sources in the directory where you
wish to compile them.
</p><div style="background:#bbffbb ; width:80ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting">gunzip tcl-rivet-X.X.X.tar.gz
tar -xvf tcl-rivet-X.X.X.tar.gz</div><p style="width:90%">
</p></li><li><p class="title"><b>Building Rivet</b></p><p style="width:90%">
Rivet uses a unique build system which we created especially
for this project. It utilizes the information included in
Apache and Tcl regarding their configurations, in order to
compile itself via a series of Tcl scripts, which are
located in the <tt>buildscripts/</tt> directory.
</p><ol type="a"><li><p class="title"><b>Edit src/make.tcl</b></p><p style="width:90%">
It may be necessary to edit
<tt>src/make.tcl</tt> by hand in order to
set certain options. Try the next step first, and see
if it's successful.
</p></li><li><p style="width:90%">At this point, you are ready to run the build
system:</p><div style="background:#bbffbb ; width:80ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting">cd src/
./make.tcl <i><tt>option</tt></i></div><p style="width:90%">where <i><tt>option</tt></i> can be
either <tt><span style="text-decoration:underline">shared</span></tt> or
<tt><span style="text-decoration:underline">static</span></tt>.
</p></li><li><p class="title"><b>Install</b></p><p style="width:90%">
Now, you are ready to run the <span style="font-family:monospace"><b>./make
install</b></span> command to install the resulting
files. This should copy the shared object (like
<tt>mod_rivet.so</tt>, if one was
successfully created, into Apache's
<tt>libexec</tt> directory, as well as
install some support scripts and various code.
</p></li></ol></li><li><p class="title"><b>Apache Configuration Files</b></p><p style="width:90%">
Rivet is relatively easy to configure - we start off by
adding the module itself:
</p><div style="background:#bbffbb ; width:80ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting">LoadModule rivet_module <i><tt>/usr/lib/apache/1.3/mod_rivet.so</tt></i></div><p style="width:90%">
This tells Apache to load the Rivet shared object, wherever
it happens to reside on your file system. Now we have to
tell Apache what kind of files are "Rivet" files and how to
process them:
</p><div style="background:#bbffbb ; width:80ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting">AddType application/x-httpd-rivet .rvt
AddType application/x-rivet-tcl .tcl</div><p style="width:90%">
These tell Apache to process files with the
<tt>.rvt</tt> and <tt>.tcl</tt>
extensions as Rivet files.
</p><p style="width:90%">
For other directives that Rivet provides for Apache
configuration, please see <a href="directives.html#directives" title="Rivet Apache Directives">the section called “Rivet Apache Directives”</a>.
</p></li></ol></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="directives.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Apache Rivet�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�Rivet Apache Directives</td></tr></table></div></body></html>
1.2 +47 -47 tcl-rivet/doc/packages/dio/dio.html
Index: dio.html
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/packages/dio/dio.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- dio.html 29 Sep 2002 23:09:05 -0000 1.1
+++ dio.html 2 Oct 2002 19:15:00 -0000 1.2
@@ -1,6 +1,6 @@
-<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>DIO</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><div><h1 class="title"><a name="id5329831"></a>DIO</h1></div><div><p class="releaseinfo">
+<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>DIO</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><div><h1 class="title"><a name="id5331164"></a>DIO</h1></div><div><p class="releaseinfo">
$Id$
- </p></div><div><p class="copyright">Copyright � 2002 Apache Software Foundation</p></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="#id5328012">DIO SECTION TITLE</a></dt></dl></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="id5328012"></a>DIO SECTION TITLE</h2></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="#id5332198">DIO</a> - Database Interface Objects</dt></dl></div><div class="refentry"><a name="id5332198"></a><div class="titlepage"></div><div class="refnamediv"><h2 align="center">DIO — Database Interface Objects</h2></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::DIO::handle</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>interface</tt></i></span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span>? ?<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>?</span></div></div><div class="refsect1"><h2>Description</h2><blockquote>
+ </p></div><div><p class="copyright">Copyright � 2002 Apache Software Foundation</p></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="#id5329635">DIO SECTION TITLE</a></dt></dl></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="id5329635"></a>DIO SECTION TITLE</h2></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="#id5331925">DIO</a> - Database Interface Objects</dt></dl></div><div class="refentry"><a name="id5331925"></a><div class="titlepage"></div><div class="refnamediv"><h2 align="center">DIO — Database Interface Objects</h2></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::DIO::handle</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>interface</tt></i></span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span>? (<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>)</span></div></div><div class="refsect1"><h2>Description</h2><blockquote>
<span style="font-family:monospace"><b>DIO</b></span> is designed to be a generic,
object-oriented interface to SQL databases. Its main goal
is to be as generic as possible, but since not all SQL
@@ -16,16 +16,16 @@
an object of that name. If there is no
<tt><span style="text-decoration:underline">objectName</span></tt> given, DIO will automatically
generate a unique object ID
- </blockquote></div><div class="refsect1"><h2>Options</h2><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-host</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>hostname</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </blockquote></div><div class="refsect1"><h2>Options</h2><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-host</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>hostname</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
The hostname of the computer to connect to. If none
is given, DIO assumes the local host.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-port</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>portNumber</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">The port number to connect to on <tt><span style="text-decoration:underline">hostname</span></tt>.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-user</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>username</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">The username you wish to login to the server as.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-pass</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>password</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">The password to login to the server with.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-db</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>database</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-port</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>portNumber</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">The port number to connect to on <tt><span style="text-decoration:underline">hostname</span></tt>.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-user</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>username</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">The username you wish to login to the server as.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-pass</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>password</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">The password to login to the server with.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-db</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>database</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
The name of the database to connect to.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-table</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>tableName</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-table</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>tableName</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
The default table to use when using built-in commands
- for storing and fetching.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-keyfield</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>keyFieldname</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ for storing and fetching.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-keyfield</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>keyFieldname</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
The default field to use as the primary key when using
- built-in commands for storing and fetching.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-autokey</span> <span style="font-family:monospace; text-decoration:underline">1</span> | <span style="font-family:monospace; text-decoration:underline">0</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ built-in commands for storing and fetching.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-autokey</span> <span style="font-family:monospace; text-decoration:underline">1</span> | <span style="font-family:monospace; text-decoration:underline">0</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
If this option is set to 1, DIO will attempt to
determine an automatic key for
<tt><span style="text-decoration:underline">keyField</span></tt> when storing and fetching.
@@ -33,31 +33,31 @@
<tt><span style="text-decoration:underline">sequence</span></tt> also be specified. In the
case of MySQL, where sequences do not exist, autokey
must be used in conjunction with a table which has a
- field specified as AUTO.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-sequence</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>sequenceName</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ field specified as AUTO.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-sequence</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>sequenceName</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
If DIO is automatically generating keys, it will use
this sequence as a means to gain a unique number for
- the stored key.</div></div></dd></dl></div></div><div class="refsect1"><h2>DIO Object Commands</h2><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">array</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>request</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ the stored key.</div></div></dd></dl></div></div><div class="refsect1"><h2>DIO Object Commands</h2><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">array</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>request</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Execute <tt><span style="text-decoration:underline">request</span></tt> as a SQL query and
create an array from the first record found. The
array is set with the fields of the table and the
- values of the record found.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">autokey</span> ?<span style="font-family:monospace; text-decoration:underline">value</span> | <span style="font-family:monospace; text-decoration:underline">boolean</span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ values of the record found.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">autokey</span> (<span style="font-family:monospace; text-decoration:underline">value</span> | <span style="font-family:monospace; text-decoration:underline">boolean</span>)</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current autokey value. If
<tt><span style="text-decoration:underline">value</span></tt> is specified, it sets a new
- value for the autokey option.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">close</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex"> Close the current database connection. This command is
- automatically called when the DIO object is destroyed.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">db</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ value for the autokey option.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">close</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex"> Close the current database connection. This command is
+ automatically called when the DIO object is destroyed.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">db</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current database. If
<tt><span style="text-decoration:underline">value</span></tt> is specified, it sets a new
value for the database. In most cases, the DIO object
will automatically connect to the new database when
- this option is changed.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">delete</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>key</tt></i></span> ?<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ this option is changed.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">delete</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>key</tt></i></span> (<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>)</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Delete a record from the database where the primary
- key matches <tt><span style="text-decoration:underline">key</span></tt>.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">destroy</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ key matches <tt><span style="text-decoration:underline">key</span></tt>.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">destroy</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Destroy the DIO object.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">errorinfo</span> ?<span style="font-family:monospace; text-decoration:underline">value</span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex"><tt><span style="text-decoration:underline">errorinfo</span></tt> contains the value of
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">errorinfo</span> ?<span style="font-family:monospace; text-decoration:underline">value</span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex"><tt><span style="text-decoration:underline">errorinfo</span></tt> contains the value of
the last error, if any, to occur while executing a
request. When a request fails for any reason, this
variable is filled with the error message from the SQL
- interface package.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">exec</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>request</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ interface package.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">exec</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>request</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Execute <tt><span style="text-decoration:underline">request</span></tt> as an SQL query.
When the exec command is called, the query is
executed, and a DIO result object is returned. From
@@ -65,55 +65,55 @@
information about the query status and records in a
generic way. See <a href="#resultobj" title="Result Object Commands">Result
Object Commands</a>
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">fetch</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>key</tt></i></span> <span style="font-family:monospace; text-decoration:underline"><i><tt>arrayName</tt></i></span> ?<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">fetch</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>key</tt></i></span> <span style="font-family:monospace; text-decoration:underline"><i><tt>arrayName</tt></i></span> (<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>)</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Fetch a record from the database where the primary key
matches <tt><span style="text-decoration:underline">key</span></tt> and store the result in
an array called <tt><span style="text-decoration:underline">arrayName</span></tt>.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">host</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">host</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current host value. If
<tt><span style="text-decoration:underline">value</span></tt> is specified, it sets a new
value for the host.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">keyfield</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">keyfield</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current keyfield. If
<tt><span style="text-decoration:underline">value</span></tt> is specified, it sets a new
value for the keyfield.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">keys</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>pattern</tt></i></span>? ?<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">keys</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>pattern</tt></i></span>? (<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>)</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return a list of keys in the database. If
<tt><span style="text-decoration:underline">pattern</span></tt> is specified, only the keys
matching will be returned.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">lastkey</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">lastkey</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the last key that was used from
<tt><span style="text-decoration:underline">sequence</span></tt>. If sequence has not been
specified, this command returns an empty string.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">list</span> <span style="font-family:monospace; text-decoration:underline">request</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">list</span> <span style="font-family:monospace; text-decoration:underline">request</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Execute <tt><span style="text-decoration:underline">request</span></tt> as a SQL query and
return a list of the first column of each record
found.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">nextkey</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Increment <tt><span style="text-decoration:underline">sequence</span></tt> and return the
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">nextkey</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Increment <tt><span style="text-decoration:underline">sequence</span></tt> and return the
next key to be used. If sequence has not been
specified, this command returns an empty
- string.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">open</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Open the connection to the current database. This
+ string.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">open</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Open the connection to the current database. This
command is automatically called from any command which
- accesses the database.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">pass</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ accesses the database.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">pass</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current pass value. If
<tt><span style="text-decoration:underline">value</span></tt> is specified, it sets a new
value for the password.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">port</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Return the current port value. If <tt><span style="text-decoration:underline">value</span></tt> is
- specified, it sets a new value for the port.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">sequence</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">port</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Return the current port value. If <tt><span style="text-decoration:underline">value</span></tt> is
+ specified, it sets a new value for the port.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">sequence</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current sequence value. If <tt><span style="text-decoration:underline">value</span></tt> is
specified, it sets a new value for the sequence.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">store</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>arrayName</tt></i></span> ?<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">store</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>arrayName</tt></i></span> (<span style="font-family:monospace; text-decoration:underline">-option</span> | <span style="font-family:monospace; text-decoration:underline"><i><tt>option</tt></i></span> | <span style="font-family:monospace; text-decoration:underline">...</span>)</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Store <tt><span style="text-decoration:underline">arrayName</span></tt> in the database.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">string</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>request</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">string</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>request</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Execute <tt><span style="text-decoration:underline">request</span></tt> as a SQL query and
return a string containing the first record
- found.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">table</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Return the current table. If
+ found.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">table</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Return the current table. If
<tt><span style="text-decoration:underline">value</span></tt> is specified, it sets a new
- value for the table.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">user</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ value for the table.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>objectName</tt></i></span> <span style="font-family:monospace; text-decoration:underline">user</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current user value. If
<tt><span style="text-decoration:underline">value</span></tt> is specified, it sets a new
value for the user.
- </div></div></dd></dl></div></div><div class="refsect1"><a name="resultobj"></a><h2>Result Object Commands</h2><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">autocache</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd></dl></div></div><div class="refsect1"><a name="resultobj"></a><h2>Result Object Commands</h2><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">autocache</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current autocache value. If
<tt><span style="text-decoration:underline">value</span></tt> is specified, it sets a new
value for autocache.
@@ -124,13 +124,13 @@
row is being cached in the result object itself and
will no longer need to access the SQL result.
<span class="emphasis"><em>Default is true</em></span>.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">cache</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">cache</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Cache the results of the current SQL result in the
result object itself. This means that even if the
database connection is closed and all the results of
the DIO object are lost, this result object will still
maintain a cached copy of its records.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">errorcode</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">errorcode</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current errorcode value. If <tt><span style="text-decoration:underline">value</span></tt>
is specified, it sets a new value for errorcode.
</div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
@@ -139,14 +139,14 @@
statement which created this object. This variable
can be used to determine the success or failure of a
query.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">errorinfo</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">errorinfo</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current errorinfo value. If <tt><span style="text-decoration:underline">value</span></tt>
is specified, it sets a new value for errorinfo.
</div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
If an error occurred during the SQL query, DIO
attempts to set the value of <tt><span style="text-decoration:underline">errorinfo</span></tt> to the
resulting error message.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">fields</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">fields</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current fields value. If
<tt><span style="text-decoration:underline">value</span></tt> is specified, it sets a new
value for fields.
@@ -154,39 +154,39 @@
<tt><span style="text-decoration:underline">fields</span></tt> contains the list of fields
used in this query. The fields are in order of the
fields retrieved for each row.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">forall</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>-type</tt></i></span> <span style="font-family:monospace; text-decoration:underline"><i><tt>varName</tt></i></span> <span style="font-family:monospace; text-decoration:underline"><i><tt>body</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">forall</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>-type</tt></i></span> <span style="font-family:monospace; text-decoration:underline"><i><tt>varName</tt></i></span> <span style="font-family:monospace; text-decoration:underline"><i><tt>body</tt></i></span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Execute <tt><span style="text-decoration:underline">body</span></tt> over each record in the
result object.
- </div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Types:</div><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-array</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Types:</div><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-array</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Create varName as an array where the indexes are
the names of the fields in the table and the
values are the values of the current row.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-keyvalue</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-keyvalue</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Set varName to a list containing key-value pairs
of fields and values from the current
row. (-field value -field value)
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-list</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-list</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Set varName to a list that contains the values
of the current row.
- </div></div></dd></dl></div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">next</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>-type</tt></i></span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>varName</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd></dl></div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">next</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>-type</tt></i></span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>varName</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Retrieve the next record in the result object.
- </div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Types:</div><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-array</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">Types:</div><div class="variablelist"><dl><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-array</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Create varName as an array where the indexes are
the names of the fields in the table and the
values are the values of the current row.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-keyvalue</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-keyvalue</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Set varName to a list containing key-value pairs
of fields and values from the current
row. (-field value -field value)
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-list</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">-list</span></span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Set varName to a list that contains the values
of the current row.
- </div></div></dd></dl></div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">numrows</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd></dl></div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">numrows</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current numrows value. If <tt><span style="text-decoration:underline">value</span></tt> is
specified, it sets a new value for numrows.
</div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
<tt><span style="text-decoration:underline">numrows</span></tt> is the number of rows in this result.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">resultid</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">resultid</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current resultid value. If <tt><span style="text-decoration:underline">value</span></tt> is
specified, it sets a new value for resultid.
</div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
@@ -194,7 +194,7 @@
pointer which was given us by the database. This
variable is not generic and should not really be used,
but it's there if you want it.
- </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">rowid</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline"><i><tt>resultObj</tt></i></span> <span style="font-family:monospace; text-decoration:underline">rowid</span> ?<span style="font-family:monospace; text-decoration:underline"><i><tt>value</tt></i></span>?</span></div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Return the current rowid value. If <tt><span style="text-decoration:underline">value</span></tt> is
specified, it sets a new value for rowid.
</div><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-dev-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-dev-help@tcl.apache.org