XVI. Database (dbm-style) abstraction layer functions
These functions build the foundation for accessing Berkeley DB style databases.
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 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. You have to download and install supported dba-Handlers.
Table 1. List of DBA handlers
|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.|
|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).|
|gdbm||Gdbm is the GNU database manager.|
|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.|
|db3||DB3 is Sleepycat Software's DB3.|
|db4||DB4 is Sleepycat Software's DB4. This is available since PHP 5.0.0.|
|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. And since PHP 4.3.0 we support writing (not updating) through the internal cdb library.|
|cdb_make||Since PHP 4.3.0 we support creation (not updating) of cdb files when the bundeled cdb library is used.|
|flatfile||This is available since PHP 4.3.0 for compatibility with the deprecated dbm extension only and should be avoided. However you may use this where files were created in this format. That happens when configure could not find any external library.|
When invoking the dba_open() or dba_popen() functions, one of the handler names must be supplied as an argument. The actually available list of handlers is displayed by invoking phpinfo() or dba_handlers().
By using the --enable-dba=shared configuration option you can build a dynamic loadable modul to enable PHP for basic support of dbm-style databases. You also have to add support for at least one of the following handlers by specifying the --with-XXXX configure switch to your PHP configure line.
Table 2. Supported DBA handlers
|dbm||To enable support for dbm add --with-dbm[=DIR].|
|ndbm||To enable support for ndbm add --with-ndbm[=DIR].|
|gdbm||To enable support for gdbm add --with-gdbm[=DIR].|
To enable support for db2 add --with-db2[=DIR]. |
To enable support for db3 add --with-db3[=DIR]. |
To enable support for db4 add --with-db4[=DIR]. |
To enable support for cdb add --with-cdb[=DIR]. |
To enable support for flatfile add --with-flatfile. |
To enable support for inifile add --with-inifile. |
Note: Up to PHP 4.3.0 you are able to add both db2 and db3 handler but only one of them can be used internally. That means that you cannot have both file formats. Starting with PHP 5.0.0 there is a configuration check avoid such missconfigurations.
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 mode of a new created database, if that is possible at all. The file mode is commonly passed as the fourth argument to dba_open() or dba_popen().
- Table of Contents
- dba_close -- Close database
- dba_delete -- Delete entry specified by key
- dba_exists -- Check whether key exists
- dba_fetch -- Fetch data specified by key
- dba_firstkey -- Fetch first key
- dba_handlers -- List handlers available
- dba_insert -- Insert entry
- dba_list -- List all open database files
- dba_nextkey -- Fetch next key
- dba_open -- Open database
- dba_optimize -- Optimize database
- dba_popen -- Open database persistently
- dba_replace -- Replace or insert entry
- dba_sync -- Synchronize database