hholzgra Tue Sep 18 15:49:36 2001 EDT
Modified files:
/phpdoc/en/functions dbplus.xml
Log:
documentation on AQL query functions
Index: phpdoc/en/functions/dbplus.xml
diff -u phpdoc/en/functions/dbplus.xml:1.14 phpdoc/en/functions/dbplus.xml:1.15
--- phpdoc/en/functions/dbplus.xml:1.14 Mon Sep 17 15:41:07 2001
+++ phpdoc/en/functions/dbplus.xml Tue Sep 18 15:49:36 2001
@@ -1,5 +1,5 @@
<?xml encoding="iso-8859-1"?>
-<!-- $Revision: 1.14 $ -->
+<!-- $Revision: 1.15 $ -->
<reference id="ref.dbplus">
<title>DB++ Functions</title>
<titleabbrev>DB++</titleabbrev>
@@ -335,9 +335,23 @@
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
- <para>
- Not implemented yet.
- </para>
+ <para>
+ <function>dbplus_aql</function> will execute an AQL
+ <parameter>query</parameter> on the given
+ <parameter>server</parameter> and
+ <parameter>dbpath</parameter>.
+ </para>
+ <para>
+ On success it will return a relation handle. The result data may
+ be fetched from this relation by calling
+ <function>dbplus_next</function> and
+ <function>dbplus_current</function>. Other relation access
+ functions will not work on a result relation.
+ </para>
+ <para>
+ Further information on the AQL A... Query Language is provided in
+ the opriginal db++ manual.
+ </para>
</refsect1>
</refentry>
@@ -1121,19 +1135,23 @@
<refentry id="function.dbplus-rquery">
<refnamediv>
<refname>dbplus_rquery</refname>
- <refpurpose></refpurpose>
+ <refpurpose>Perform local (raw) AQL query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>dbplus_rquery</function></funcdef>
- <void/>
+ <paramdef>string <parameter>query</parameter></paramdef>
+ <paramdef>string <parameter>dbpath</parameter></paramdef>
</funcprototype>
</funcsynopsis>
&warn.experimental.func;
<para>
- Not implemented yet.
+ <function>dbplus_rquery</function> performs a local (raw) AQL
+ query using an AQL interpreter embedded into the db++ client
+ library. <function>dbplus_rquery</function> is faster than
+ <function>dbplus_aql</function> but will work on local data only.
</para>
</refsect1>
</refentry>
