From fd7f27cd80c9dbaeb5f023823eccf4946eec6013 Mon Sep 17 00:00:00 2001
From: Hartmut Holzgraefe <hholzgra@php.net>
Date: Tue, 18 Sep 2001 19:49:36 +0000
Subject: [PATCH] documentation on AQL query functions

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@57744 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/dbplus.xml | 32 +++++++++++++++++++++++++-------
 1 file changed, 25 insertions(+), 7 deletions(-)

diff --git a/functions/dbplus.xml b/functions/dbplus.xml
index eba9b7baba..c46b42834e 100644
--- a/functions/dbplus.xml
+++ b/functions/dbplus.xml
@@ -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>