diff --git a/functions/dba.xml b/functions/dba.xml index d180bc9b2c..26cc41d4ab 100644 --- a/functions/dba.xml +++ b/functions/dba.xml @@ -8,67 +8,97 @@ style databases. - This is a general abstraction layer for several file-based databases. As - such, functionality is limited to a subset of features modern databases - such as Sleepycat Software's DB2 - support. (This is not to be confused with IBM's DB2 software, which is + This is a general abstraction layer for several file-based databases. + As such, functionality is limited to a common subset of features + supported by modern databases such as + Sleepycat Software's DB2. + (This is not to be confused with IBM's DB2 software, which is supported through the ODBC functions.) - The behaviour of various aspects depend on the implementation of the + The behaviour of various aspects depends on the implementation of the underlying database. Functions such as dba_optimize and dba_sync will do what they promise for one database and will do nothing for others. - To add support for any of the following handlers, add the - specified --with configure switch to your PHP configure line: - - - - Dbm is the oldest (original) type of Berkeley DB style - databases. You should avoid it, if possible. We do not support - the compatibility functions built into DB2 and gdbm, because - they are only compatible on the source code level, but cannot - handle the original dbm format. (--with-dbm) - - - - - Ndbm is a newer type and more flexible than dbm. It still has - most of the arbitrary limits of dbm (therefore it is - deprecated). (--with-ndbm) - - - - - Gdbm is the GNU database - manager. (--with-gdbm) - - - - - DB2 is Sleepycat Software's - DB2. It is described as "a programmatic toolkit that - provides high-performance built-in database support for both - standalone and client/server applications." (--with-db2) - - - - - DB3 is Sleepycat Software's - DB3. (--with-db3) - - - - - Cdb is "a fast, reliable, lightweight package for creating and - reading constant databases." It is from the author of qmail and - can be found here. Since it is - constant, we support only reading operations. (--with-cdb) - - - + When invoking the dba_open or + dba_popen functions, one of the following + handler names must be supplied as an argument. The actually + available list of handlers is displayed by invoking + phpinfo. (To add support for any of the + following handlers during the production of PHP, add the + specified --with-XXXX configure switch to + your PHP configure line.) + + List of DBA handlers + + + + Handler + Notes + + + + + dbm + + Dbm is the oldest (original) type of Berkeley DB style + databases. You should avoid it, if possible. We do not support + the compatibility functions built into DB2 and gdbm, because + they are only compatible on the source code level, but cannot + handle the original dbm format. (--with-dbm) + + + + + ndbm + + Ndbm is a newer type and more flexible than dbm. It still has + most of the arbitrary limits of dbm (therefore it is + deprecated). (--with-ndbm) + + + + + gdbm + + Gdbm is the GNU database + manager. (--with-gdbm) + + + + + db2 + + DB2 is Sleepycat Software's + DB2. It is described as "a programmatic toolkit that + provides high-performance built-in database support for both + standalone and client/server applications." (--with-db2) + + + + + db3 + + DB3 is Sleepycat Software's + DB3. (--with-db3) + + + + + cdb + + Cdb is "a fast, reliable, lightweight package for creating and + reading constant databases." It is from the author of qmail and + can be found here. Since it is + constant, we support only reading operations. (--with-cdb) + + + + + +
@@ -96,8 +126,9 @@ dba_close ($id); - DBA is binary safe and does not have any arbitrary limits. It inherits all - limits set by the underlying database implementation. + DBA is binary safe and does not have any arbitrary limits. + However, it inherits all limits set by the underlying + database implementation. All file-based databases must provide a way of setting the file @@ -177,7 +208,7 @@ for ($i = 0; $i < count($handle_later); $i++) Description - string dba_delete + bool dba_delete string key int handle @@ -196,7 +227,7 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - dba_delete returns true or false, if the entry is + dba_delete returns true or false, if the entry is deleted or not deleted, respectively. @@ -234,7 +265,7 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - Dba_exists returns true or false, if the key is found + Dba_exists returns true or false, if the key is found or not found, respectively. @@ -273,7 +304,7 @@ for ($i = 0; $i < count($handle_later); $i++) - Dba_fetch returns the associated string or false, if + Dba_fetch returns the associated string or false, if the key/data pair is found or not found, respectively. @@ -308,12 +339,13 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - Dba_firstkey returns the key or false + Dba_firstkey returns the key or false depending on whether it succeeds or fails, respectively. See also: Dba_nextkey + and example 2 in the DBA overview @@ -350,7 +382,7 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - dba_insert returns true or false, depending on + dba_insert returns true or false, depending on whether it succeeds of fails, respectively. @@ -378,7 +410,7 @@ for ($i = 0; $i < count($handle_later); $i++) dba_nextkey returns the next key of the database - specified by handle and increments the internal + specified by handle and advances the internal key pointer. @@ -386,12 +418,13 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - dba_nextkey returns the key or false depending on + dba_nextkey returns the key or false depending on whether it succeeds or fails, respectively. See also: dba_firstkey + and example 2 in the DBA overview @@ -428,13 +461,14 @@ for ($i = 0; $i < count($handle_later); $i++) create, truncate and read/write access. - handler is the name of the handler which shall be + handler is the name + of the handler which shall be used for accessing path. It is passed all optional parameters given to dba_popen and can act on behalf of them. - dba_popen returns a positive handler id or false, in + dba_popen returns a positive handle or false, in the case the open is successful or fails, respectively. @@ -476,13 +510,14 @@ for ($i = 0; $i < count($handle_later); $i++) create, truncate and read/write access. - handler is the name of the handler which shall be + handler is the name + of the handler which shall be used for accessing path. It is passed all optional parameters given to dba_open and can act on behalf of them. - dba_open returns a positive handler id or false, in + dba_open returns a positive handle or false, in the case the open is successful or fails, respectively. @@ -515,7 +550,7 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - dba_optimize returns true or false, if the + dba_optimize returns true or false, if the optimization succeeds or fails, respectively. @@ -556,7 +591,7 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - dba_replace returns true or false, depending on + dba_replace returns true or false, depending on whether it succeeds of fails, respectively. @@ -590,7 +625,7 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - dba_sync returns true or false, if the + dba_sync returns true or false, if the synchronization succeeds or fails, respectively.