hholzgra Mon Sep 17 15:41:07 2001 EDT
Modified files:
/phpdoc/en/functions dbplus.xml
Log:
some additions and resource type fixes
Index: phpdoc/en/functions/dbplus.xml
diff -u phpdoc/en/functions/dbplus.xml:1.13 phpdoc/en/functions/dbplus.xml:1.14
--- phpdoc/en/functions/dbplus.xml:1.13 Sun Sep 16 18:02:15 2001
+++ phpdoc/en/functions/dbplus.xml Mon Sep 17 15:41:07 2001
@@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
-<!-- $Revision: 1.13 $ -->
+<!-- $Revision: 1.14 $ -->
<reference id="ref.dbplus">
<title>DB++ Functions</title>
<titleabbrev>DB++</titleabbrev>
@@ -292,7 +292,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_add</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -324,7 +324,7 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_aql</function></funcdef>
+ <funcdef>resource <function>dbplus_aql</function></funcdef>
<paramdef>string <parameter>query</parameter></paramdef>
<paramdef>string
<parameter><optional>server</optional></parameter>
@@ -335,6 +335,9 @@
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
+ <para>
+ Not implemented yet.
+ </para>
</refsect1>
</refentry>
@@ -377,7 +380,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_close</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -398,7 +401,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_curr</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -483,7 +486,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_find</function></funcdef>
- <paramdef>int <parameter>handle</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter>constraints</parameter></paramdef>
<paramdef>mixed <parameter>tuple</parameter></paramdef>
</funcprototype>
@@ -525,7 +528,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_first</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -561,7 +564,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_flush</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -614,7 +617,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_freelock</function></funcdef>
- <paramdef>int <parameter>handle</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>string <parameter>tname</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -642,7 +645,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_freerlocks</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -668,7 +671,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_getlock</function></funcdef>
- <paramdef>int <parameter>handle</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>string <parameter>tname</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -697,7 +700,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_getunique</function></funcdef>
- <paramdef>int <parameter>handle</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>int <parameter>uniqueid</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -727,12 +730,15 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_info</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>string <parameter>key</parameter></paramdef>
<paramdef>array <parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
+ <para>
+ Not implemented yet.
+ </para>
</refsect1>
</refentry>
@@ -746,7 +752,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_last</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -782,7 +788,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_lockrel</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -804,7 +810,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_next</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -839,7 +845,7 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_open</function></funcdef>
+ <funcdef>resource <function>dbplus_open</function></funcdef>
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -852,7 +858,7 @@
server.
</para>
<para>
- On success a relation file handle (cursor) is returned which must
+ On success a relation file resource (cursor) is returned which must
be used in any subsequent commanads referencing the relation.
Failure leads to a zero return value, the actual error code may
be asked for by calling <function>dbplus_errno</function>.
@@ -870,7 +876,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_prev</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -906,7 +912,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_rchperm</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>int <parameter>mask</parameter></paramdef>
<paramdef>string <parameter>user</parameter></paramdef>
<paramdef>string <parameter>group</parameter></paramdef>
@@ -931,7 +937,7 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_rcreate</function></funcdef>
+ <funcdef>resource <function>dbplus_rcreate</function></funcdef>
<paramdef>string <parameter>name</parameter></paramdef>
<paramdef>mixed <parameter>domlist</parameter></paramdef>
<paramdef>boolean
<parameter><optional>overwrite</optional></parameter></paramdef>
@@ -968,15 +974,20 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_rcrtexact</function></funcdef>
+ <funcdef>resource <function>dbplus_rcrtexact</function></funcdef>
<paramdef>string <parameter>name</parameter></paramdef>
- <paramdef>int <parameter>handle</parameter></paramdef>
- <paramdef>int <parameter>flag</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
+ <paramdef>boolean <parameter>overwrite</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
<para>
- Not implemented yet.
+ <function>dbplus_rcrtexact</function> will create an exact but
+ empty copy of the given <parameter>relation</parameter> under a
+ new <parameter>name</parameter>. An existing relation by the same
+ <parameter>name</parameter> will only be overwritten if
+ <parameter>overwrite</parameter> is TRUE and no other process is
+ currently using the relation.
</para>
</refsect1>
</refentry>
@@ -990,15 +1001,20 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_rcrtlike</function></funcdef>
+ <funcdef>resource <function>dbplus_rcrtlike</function></funcdef>
<paramdef>string <parameter>name</parameter></paramdef>
- <paramdef>int <parameter>handle</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>int <parameter>flag</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
<para>
- Not implemented yet.
+ <function>dbplus_rcrtexact</function> will create an empty copy
+ of the given <parameter>relation</parameter> under a new
+ <parameter>name</parameter>, but with default indices. An
+ existing relation by the same <parameter>name</parameter> will
+ only be overwritten if <parameter>overwrite</parameter> is TRUE
+ and no other process is currently using the relation.
</para>
</refsect1>
</refentry>
@@ -1039,8 +1055,8 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_rkeys</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <funcdef>resource <function>dbplus_rkeys</function></funcdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>mixed <parameter>domlist</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1066,28 +1082,39 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_restorepos</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter>tuple</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
+ <para>
+ Not implemented yet.
+ </para>
</refsect1>
</refentry>
<refentry id="function.dbplus-ropen">
<refnamediv>
<refname>dbplus_ropen</refname>
- <refpurpose>Open relation file ... ???</refpurpose>
+ <refpurpose>Open relation file local</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_ropen</function></funcdef>
+ <funcdef>resource <function>dbplus_ropen</function></funcdef>
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
+ <para>
+ <function>dbplus_ropen</function> will open the relation
+ <parameter>file</parameter> localy for quick access without any
+ client/server overhead. Access is read only and only
+ <function>dbplus_current</function> and
+ <function>dbplus_next</function> may be applied to the returned
+ relation.
+ </para>
</refsect1>
</refentry>
@@ -1105,6 +1132,9 @@
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
+ <para>
+ Not implemented yet.
+ </para>
</refsect1>
</refentry>
@@ -1118,7 +1148,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_rrename</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1141,8 +1171,8 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_rsecindex</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <funcdef>resource <function>dbplus_rsecindex</function></funcdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>mixed <parameter>domlist</parameter></paramdef>
<paramdef>int <parameter>type</parameter></paramdef>
</funcprototype>
@@ -1171,7 +1201,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_runlink</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -1192,7 +1222,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_rzap</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -1213,10 +1243,13 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_savepos</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
+ <para>
+ Not implemented yet.
+ </para>
</refsect1>
</refentry>
@@ -1230,11 +1263,14 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_setindex</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>string <parameter>idx_name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
+ <para>
+ Not implemented yet.
+ </para>
</refsect1>
</refentry>
@@ -1250,11 +1286,14 @@
<funcdef>int
<function>dbplus_setindexbynumber</function>
</funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>int <parameter>idx_number</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
+ <para>
+ Not implemented yet.
+ </para>
</refsect1>
</refentry>
@@ -1267,13 +1306,16 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>dbplus_sql</function></funcdef>
+ <funcdef>resource <function>dbplus_sql</function></funcdef>
<paramdef>string <parameter>query</parameter></paramdef>
<paramdef>string <parameter>server</parameter></paramdef>
<paramdef>string <parameter>dbpath</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
+ <para>
+ Not implemented yet.
+ </para>
</refsect1>
</refentry>
@@ -1322,7 +1364,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_tremove</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter>tuple</parameter></paramdef>
<paramdef>array
<parameter><optional>current</optional></parameter>
@@ -1351,11 +1393,12 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_undo</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
<para>
+ Not implemented yet.
</para>
</refsect1>
</refentry>
@@ -1370,11 +1413,12 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_undoprepare</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
<para>
+ Not implemented yet.
</para>
</refsect1>
</refentry>
@@ -1389,7 +1433,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_unlockrel</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -1410,7 +1454,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_unselect</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -1432,7 +1476,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_update</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
<paramdef>array <parameter>old</parameter></paramdef>
<paramdef>array <parameter>new</parameter></paramdef>
</funcprototype>
@@ -1458,7 +1502,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_xlockrel</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
@@ -1483,7 +1527,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_xunlockrel</function></funcdef>
- <paramdef>int <parameter>relation</parameter></paramdef>
+ <paramdef>resource <parameter>relation</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
