dba_popen
(PHP 4, PHP 5, PHP 7, PHP 8)
dba_popen — Open database persistently
Description
string
$path,string
$mode,?string
$handler = null,int
$permission = 0644,int
$map_size = 0,?int
$flags = null): resource|false
dba_popen() establishes a persistent database instance
for path with mode using
handler.
Parameters
-
path -
Commonly a regular path in your filesystem.
-
mode -
It is
rfor read access,wfor read/write access to an already existing database,cfor read/write access and database creation if it doesn't currently exist, andnfor create, truncate and read/write access. -
handler -
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. Ifhandlerisnull, then the default handler is invoked. -
permission -
Optional int parameter which is passed to the driver. It has the same meaning as the
permissionsparameter of chmod(), and defaults to0644.The
db1,db2,db3,db4,dbm,gdbm,ndbm, andlmdbdrivers support thepermissionparameter. -
map_size -
Optional int parameter which is passed to the driver. Its value should be a multiple of the page size of the OS, or zero, to use the default mapsize.
The
lmdbdriver accepts themap_sizeparameter. -
flags -
Allows to pass flags to the DB drivers. Currently, only LMDB with
DBA_LMDB_USE_SUB_DIRandDBA_LMDB_NO_SUB_DIRare supported.
Return Values
Returns a positive handle on success or false on failure.
Errors/Exceptions
false is returned and an E_WARNING level error is issued when
handler is null, but there is no default handler.
Changelog
| Version | Description |
|---|---|
| 8.2.0 |
flags is added.
|
| 8.1.0 |
handler is now nullable.
|
| 7.3.14, 7.4.2 |
The lmdb driver now supports an additional map_size
parameter.
|
add a note
