hholzgra Sat Mar 2 08:29:54 2002 EDT
Modified files:
/phpdoc/en/functions dbplus.xml
Log:
indentation/whitespace
Index: phpdoc/en/functions/dbplus.xml
diff -u phpdoc/en/functions/dbplus.xml:1.22 phpdoc/en/functions/dbplus.xml:1.23
--- phpdoc/en/functions/dbplus.xml:1.22 Sat Mar 2 07:54:56 2002
+++ phpdoc/en/functions/dbplus.xml Sat Mar 2 08:29:54 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.22 $ -->
+<!-- $Revision: 1.23 $ -->
<reference id="ref.dbplus">
<title>DB++ Functions</title>
<titleabbrev>DB++</titleabbrev>
@@ -85,229 +85,229 @@
<section id="dbplus.constants">
<title>Predefined Constants</title>
- <section id="dbplus.errorcodes">
- <title>db++ error codes</title>
- <para>
- <table>
- <title>DB++ Error Codes</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>PHP Constant</entry>
- <entry>db++ constant</entry>
- <entry>meaning</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>DBPLUS_ERR_NOERR</entry>
- <entry>ERR_NOERR</entry>
- <entry>Null error condition</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_DUPLICATE</entry>
- <entry>ERR_DUPLICATE</entry>
- <entry>Tried to insert a duplicate tuple</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_EOSCAN</entry>
- <entry>ERR_EOSCAN</entry>
- <entry>End of scan from rget()</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_EMPTY</entry>
- <entry>ERR_EMPTY</entry>
- <entry>Relation is empty (server)</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_CLOSE</entry>
- <entry>ERR_CLOSE</entry>
- <entry>The server can't close</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_WLOCKED</entry>
- <entry>ERR_WLOCKED</entry>
- <entry>The record is write locked</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_LOCKED</entry>
- <entry>ERR_LOCKED</entry>
- <entry>Relation was already locked</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_NOLOCK</entry>
- <entry>ERR_NOLOCK</entry>
- <entry>Relation cannot be locked</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_READ</entry>
- <entry>ERR_READ</entry>
- <entry>Read error on relation</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_WRITE</entry>
- <entry>ERR_WRITE</entry>
- <entry>Write error on relation</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_CREATE</entry>
- <entry>ERR_CREATE</entry>
- <entry>Create() system call failed</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_LSEEK</entry>
- <entry>ERR_LSEEK</entry>
- <entry>Lseek() system call failed</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_LENGTH</entry>
- <entry>ERR_LENGTH</entry>
- <entry>Tuple exceeds maximum length</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_OPEN</entry>
- <entry>ERR_OPEN</entry>
- <entry>Open() system call failed</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_WOPEN</entry>
- <entry>ERR_WOPEN</entry>
- <entry>Relation already opened for writing</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_MAGIC</entry>
- <entry>ERR_MAGIC</entry>
- <entry>File is not a relation</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_VERSION</entry>
- <entry>ERR_VERSION</entry>
- <entry>File is a very old relation</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_PGSIZE</entry>
- <entry>ERR_PGSIZE</entry>
- <entry>Relation uses a different page size</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_CRC</entry>
- <entry>ERR_CRC</entry>
- <entry>Invalid crc in the superpage</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_PIPE</entry>
- <entry>ERR_PIPE</entry>
- <entry>Piped relation requires lseek()</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_NIDX</entry>
- <entry>ERR_NIDX</entry>
- <entry>Too many secondary indices</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_MALLOC</entry>
- <entry>ERR_MALLOC</entry>
- <entry>Malloc() call failed</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_NUSERS</entry>
- <entry>ERR_NUSERS</entry>
- <entry>Error use of max users</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_PREEXIT</entry>
- <entry>ERR_PREEXIT</entry>
- <entry>Caused by invalid usage</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_ONTRAP</entry>
- <entry>ERR_ONTRAP</entry>
- <entry>Caused by a signal</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_PREPROC</entry>
- <entry>ERR_PREPROC</entry>
- <entry>Error in the preprocessor</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_DBPARSE</entry>
- <entry>ERR_DBPARSE</entry>
- <entry>Error in the parser</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_DBRUNERR</entry>
- <entry>ERR_DBRUNERR</entry>
- <entry>Run error in db</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_DBPREEXIT</entry>
- <entry>ERR_DBPREEXIT</entry>
- <entry>Exit condition caused by prexit() * procedure</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_WAIT</entry>
- <entry>ERR_WAIT</entry>
- <entry>Wait a little (Simple only)</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_CORRUPT_TUPLE</entry>
- <entry>ERR_CORRUPT_TUPLE</entry>
- <entry>A client sent a corrupt tuple</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_WARNING0</entry>
- <entry>ERR_WARNING0</entry>
- <entry>
- The Simple routines encountered a non fatal error which was
- corrected
- </entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_PANIC</entry>
- <entry>ERR_PANIC</entry>
- <entry>
- The server should not really die but after a disaster
- send ERR_PANIC to all its clients
- </entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_FIFO</entry>
- <entry>ERR_FIFO</entry>
- <entry>Can't create a fifo</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_PERM</entry>
- <entry>ERR_PERM</entry>
- <entry>Permission denied</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_TCL</entry>
- <entry>ERR_TCL</entry>
- <entry>TCL_error</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_RESTRICTED</entry>
- <entry>ERR_RESTRICTED</entry>
- <entry>Only two users</entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_USER</entry>
- <entry>ERR_USER</entry>
- <entry>
- An error in the use of the library by an application
- programmer
- </entry>
- </row>
- <row>
- <entry>DBPLUS_ERR_UNKNOWN</entry>
- <entry>ERR_UNKNOWN</entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
- </section>
+ <section id="dbplus.errorcodes">
+ <title>db++ error codes</title>
+ <para>
+ <table>
+ <title>DB++ Error Codes</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>PHP Constant</entry>
+ <entry>db++ constant</entry>
+ <entry>meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>DBPLUS_ERR_NOERR</entry>
+ <entry>ERR_NOERR</entry>
+ <entry>Null error condition</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_DUPLICATE</entry>
+ <entry>ERR_DUPLICATE</entry>
+ <entry>Tried to insert a duplicate tuple</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_EOSCAN</entry>
+ <entry>ERR_EOSCAN</entry>
+ <entry>End of scan from rget()</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_EMPTY</entry>
+ <entry>ERR_EMPTY</entry>
+ <entry>Relation is empty (server)</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_CLOSE</entry>
+ <entry>ERR_CLOSE</entry>
+ <entry>The server can't close</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_WLOCKED</entry>
+ <entry>ERR_WLOCKED</entry>
+ <entry>The record is write locked</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_LOCKED</entry>
+ <entry>ERR_LOCKED</entry>
+ <entry>Relation was already locked</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_NOLOCK</entry>
+ <entry>ERR_NOLOCK</entry>
+ <entry>Relation cannot be locked</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_READ</entry>
+ <entry>ERR_READ</entry>
+ <entry>Read error on relation</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_WRITE</entry>
+ <entry>ERR_WRITE</entry>
+ <entry>Write error on relation</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_CREATE</entry>
+ <entry>ERR_CREATE</entry>
+ <entry>Create() system call failed</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_LSEEK</entry>
+ <entry>ERR_LSEEK</entry>
+ <entry>Lseek() system call failed</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_LENGTH</entry>
+ <entry>ERR_LENGTH</entry>
+ <entry>Tuple exceeds maximum length</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_OPEN</entry>
+ <entry>ERR_OPEN</entry>
+ <entry>Open() system call failed</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_WOPEN</entry>
+ <entry>ERR_WOPEN</entry>
+ <entry>Relation already opened for writing</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_MAGIC</entry>
+ <entry>ERR_MAGIC</entry>
+ <entry>File is not a relation</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_VERSION</entry>
+ <entry>ERR_VERSION</entry>
+ <entry>File is a very old relation</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_PGSIZE</entry>
+ <entry>ERR_PGSIZE</entry>
+ <entry>Relation uses a different page size</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_CRC</entry>
+ <entry>ERR_CRC</entry>
+ <entry>Invalid crc in the superpage</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_PIPE</entry>
+ <entry>ERR_PIPE</entry>
+ <entry>Piped relation requires lseek()</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_NIDX</entry>
+ <entry>ERR_NIDX</entry>
+ <entry>Too many secondary indices</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_MALLOC</entry>
+ <entry>ERR_MALLOC</entry>
+ <entry>Malloc() call failed</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_NUSERS</entry>
+ <entry>ERR_NUSERS</entry>
+ <entry>Error use of max users</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_PREEXIT</entry>
+ <entry>ERR_PREEXIT</entry>
+ <entry>Caused by invalid usage</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_ONTRAP</entry>
+ <entry>ERR_ONTRAP</entry>
+ <entry>Caused by a signal</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_PREPROC</entry>
+ <entry>ERR_PREPROC</entry>
+ <entry>Error in the preprocessor</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_DBPARSE</entry>
+ <entry>ERR_DBPARSE</entry>
+ <entry>Error in the parser</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_DBRUNERR</entry>
+ <entry>ERR_DBRUNERR</entry>
+ <entry>Run error in db</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_DBPREEXIT</entry>
+ <entry>ERR_DBPREEXIT</entry>
+ <entry>Exit condition caused by prexit() * procedure</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_WAIT</entry>
+ <entry>ERR_WAIT</entry>
+ <entry>Wait a little (Simple only)</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_CORRUPT_TUPLE</entry>
+ <entry>ERR_CORRUPT_TUPLE</entry>
+ <entry>A client sent a corrupt tuple</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_WARNING0</entry>
+ <entry>ERR_WARNING0</entry>
+ <entry>
+ The Simple routines encountered a non fatal error which was
+ corrected
+ </entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_PANIC</entry>
+ <entry>ERR_PANIC</entry>
+ <entry>
+ The server should not really die but after a disaster
+ send ERR_PANIC to all its clients
+ </entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_FIFO</entry>
+ <entry>ERR_FIFO</entry>
+ <entry>Can't create a fifo</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_PERM</entry>
+ <entry>ERR_PERM</entry>
+ <entry>Permission denied</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_TCL</entry>
+ <entry>ERR_TCL</entry>
+ <entry>TCL_error</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_RESTRICTED</entry>
+ <entry>ERR_RESTRICTED</entry>
+ <entry>Only two users</entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_USER</entry>
+ <entry>ERR_USER</entry>
+ <entry>
+ An error in the use of the library by an application
+ programmer
+ </entry>
+ </row>
+ <row>
+ <entry>DBPLUS_ERR_UNKNOWN</entry>
+ <entry>ERR_UNKNOWN</entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </section>
</section>
</partintro>
@@ -319,11 +319,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_add</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_add</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
This function will add a tuple to a relation. The
@@ -350,12 +350,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>dbplus_aql</methodname>
- <methodparam><type>string</type><parameter>query</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>server</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>dbplus_aql</methodname>
+ <methodparam><type>string</type><parameter>query</parameter></methodparam>
+ <methodparam
+choice="opt"><type>string</type><parameter>server</parameter></methodparam>
+ <methodparam
+choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_aql</function> will execute an AQL
@@ -384,10 +384,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>dbplus_chdir</methodname>
- <methodparam
choice="opt"><type>string</type><parameter>newdir</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>string</type><methodname>dbplus_chdir</methodname>
+ <methodparam
+choice="opt"><type>string</type><parameter>newdir</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_chdir</function> will change the virtual current
@@ -409,11 +409,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_close</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
- &warn.experimental.func;
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_close</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
+ &warn.experimental.func;
<para>
Calling <function>dbplus_close</function> will close a relation
previously opened by <function>dbplus_open</function>.
@@ -428,11 +428,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_curr</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_curr</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the
@@ -464,10 +464,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>dbplus_errcode</methodname>
+ <methodsynopsis>
+ <type>string</type><methodname>dbplus_errcode</methodname>
<methodparam><type>int</type><parameter>errno</parameter></methodparam>
- </methodsynopsis>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_errcode</function> returns a cleartext error
@@ -485,10 +485,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_errno</methodname>
- <void/>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_errno</methodname>
+ <void/>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_errno</function> will return the error code
@@ -507,12 +507,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_find</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter>constraints</parameter></methodparam>
- <methodparam><type>mixed</type><parameter>tuple</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_find</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter>constraints</parameter></methodparam>
+ <methodparam><type>mixed</type><parameter>tuple</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_find</function> will place a constraint on the
@@ -547,11 +547,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_first</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_first</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the first
@@ -581,10 +581,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_flush</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_flush</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_flush</function> will write all changes applied
@@ -606,10 +606,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_freealllocks</methodname>
- <void/>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_freealllocks</methodname>
+ <void/>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_freeaalllocks</function> will free all tuple locks
@@ -630,11 +630,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_freelock</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>string</type><parameter>tname</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_freelock</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>string</type><parameter>tname</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_freelock</function> will release a write lock on
@@ -656,10 +656,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_freerlocks</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_freerlocks</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_freerlocks</function> will free all tuple locks held
@@ -680,11 +680,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_getlock</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>string</type><parameter>tname</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_getlock</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>string</type><parameter>tname</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_getlock</function> will request a write lock on
@@ -707,11 +707,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_getunique</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>int</type><parameter>uniqueid</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_getunique</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>int</type><parameter>uniqueid</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_getunique</function> will obtain a number
@@ -735,12 +735,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_info</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>string</type><parameter>key</parameter></methodparam>
- <methodparam><type>array</type><parameter/></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_info</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>string</type><parameter>key</parameter></methodparam>
+ <methodparam><type>array</type><parameter/></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
@@ -755,11 +755,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_last</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_last</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the last
@@ -789,10 +789,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_lockrel</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_lockrel</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_lockrel</function> will request a write lock
@@ -809,11 +809,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_next</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter/></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_next</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter/></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the next
@@ -843,10 +843,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>dbplus_open</methodname>
- <methodparam><type>string</type><parameter>name</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>dbplus_open</methodname>
+ <methodparam><type>string</type><parameter>name</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
The relation file <parameter>name</parameter> will be opened.
@@ -871,11 +871,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_prev</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_prev</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the next
@@ -905,13 +905,13 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_rchperm</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>int</type><parameter>mask</parameter></methodparam>
- <methodparam><type>string</type><parameter>user</parameter></methodparam>
- <methodparam><type>string</type><parameter>group</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_rchperm</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>int</type><parameter>mask</parameter></methodparam>
+ <methodparam><type>string</type><parameter>user</parameter></methodparam>
+ <methodparam><type>string</type><parameter>group</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rchperm</function> will change access
@@ -929,12 +929,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>dbplus_rcreate</methodname>
- <methodparam><type>string</type><parameter>name</parameter></methodparam>
- <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
- <methodparam
choice="opt"><type>boolean</type><parameter>overwrite</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>dbplus_rcreate</methodname>
+ <methodparam><type>string</type><parameter>name</parameter></methodparam>
+ <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
+ <methodparam
+choice="opt"><type>boolean</type><parameter>overwrite</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rcreate</function> will create a new relation
@@ -964,12 +964,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>dbplus_rcrtexact</methodname>
- <methodparam><type>string</type><parameter>name</parameter></methodparam>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>boolean</type><parameter>overwrite</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>dbplus_rcrtexact</methodname>
+ <methodparam><type>string</type><parameter>name</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>boolean</type><parameter>overwrite</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rcrtexact</function> will create an exact but
@@ -989,12 +989,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>dbplus_rcrtlike</methodname>
- <methodparam><type>string</type><parameter>name</parameter></methodparam>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>int</type><parameter>flag</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>dbplus_rcrtlike</methodname>
+ <methodparam><type>string</type><parameter>name</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>int</type><parameter>flag</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rcrtexact</function> will create an empty copy
@@ -1014,10 +1014,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_resolve</methodname>
-
<methodparam><type>string</type><parameter>relation_name</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_resolve</methodname>
+
+<methodparam><type>string</type><parameter>relation_name</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_resolve</function> will try to resolve the given
@@ -1039,11 +1039,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>dbplus_rkeys</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>dbplus_rkeys</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rkeys</function> will replace the current
@@ -1064,11 +1064,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_restorepos</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_restorepos</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
@@ -1083,10 +1083,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>dbplus_ropen</methodname>
- <methodparam><type>string</type><parameter>name</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>dbplus_ropen</methodname>
+ <methodparam><type>string</type><parameter>name</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_ropen</function> will open the relation
@@ -1106,11 +1106,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_rquery</methodname>
- <methodparam><type>string</type><parameter>query</parameter></methodparam>
- <methodparam><type>string</type><parameter>dbpath</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_rquery</methodname>
+ <methodparam><type>string</type><parameter>query</parameter></methodparam>
+ <methodparam><type>string</type><parameter>dbpath</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rquery</function> performs a local (raw) AQL
@@ -1128,11 +1128,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_rrename</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>string</type><parameter>name</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_rrename</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>string</type><parameter>name</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rrename</function> will change the name of
@@ -1150,12 +1150,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>dbplus_rsecindex</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
- <methodparam><type>int</type><parameter>type</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>dbplus_rsecindex</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
+ <methodparam><type>int</type><parameter>type</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rsecindex</function> will create a new secondary
@@ -1177,10 +1177,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_runlink</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_runlink</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_unlink</function> will close and remove the
@@ -1196,10 +1196,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_rzap</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_rzap</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rzap</function> will remove all tuples from
@@ -1215,10 +1215,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_savepos</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_savepos</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
@@ -1233,11 +1233,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_setindex</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>string</type><parameter>idx_name</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_setindex</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>string</type><parameter>idx_name</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
@@ -1252,11 +1252,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_setindexbynumber</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>int</type><parameter>idx_number</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_setindexbynumber</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>int</type><parameter>idx_number</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
@@ -1271,12 +1271,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>dbplus_sql</methodname>
- <methodparam><type>string</type><parameter>query</parameter></methodparam>
- <methodparam><type>string</type><parameter>server</parameter></methodparam>
- <methodparam><type>string</type><parameter>dbpath</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>resource</type><methodname>dbplus_sql</methodname>
+ <methodparam><type>string</type><parameter>query</parameter></methodparam>
+ <methodparam><type>string</type><parameter>server</parameter></methodparam>
+ <methodparam><type>string</type><parameter>dbpath</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
@@ -1291,11 +1291,11 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_tcl</methodname>
- <methodparam><type>int</type><parameter>sid</parameter></methodparam>
- <methodparam><type>string</type><parameter>script</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_tcl</methodname>
+ <methodparam><type>int</type><parameter>sid</parameter></methodparam>
+ <methodparam><type>string</type><parameter>script</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
A db++ server will prepare a TCL interpreter for each client
@@ -1324,12 +1324,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_tremove</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
- <methodparam
choice="opt"><type>array</type><parameter>current</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_tremove</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter>tuple</parameter></methodparam>
+ <methodparam
+choice="opt"><type>array</type><parameter>current</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_tremove</function> removes
@@ -1349,10 +1349,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_undo</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_undo</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
@@ -1367,10 +1367,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_undoprepare</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_undoprepare</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
@@ -1385,10 +1385,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_unlockrel</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_unlockrel</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_unlockrel</function> will release a write lock
@@ -1404,10 +1404,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_unselect</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_unselect</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
Calling <function>dbplus_unselect</function> will remove a
@@ -1424,12 +1424,12 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_update</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- <methodparam><type>array</type><parameter>old</parameter></methodparam>
- <methodparam><type>array</type><parameter>new</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_update</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ <methodparam><type>array</type><parameter>old</parameter></methodparam>
+ <methodparam><type>array</type><parameter>new</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_update</function> replaces the tuple given by
@@ -1448,10 +1448,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_xlockrel</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_xlockrel</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_xlockrel</function> will request an exclusive
@@ -1471,10 +1471,10 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>dbplus_xunlockrel</methodname>
- <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>int</type><methodname>dbplus_xunlockrel</methodname>
+ <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
+ </methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_xunlockrel</function> will release an exclusive
