diff --git a/reference/dba/functions/dba-open.xml b/reference/dba/functions/dba-open.xml index cdb6c6c2008e..8342ed1aa4a1 100644 --- a/reference/dba/functions/dba-open.xml +++ b/reference/dba/functions/dba-open.xml @@ -11,8 +11,10 @@ resourcefalsedba_open stringpath stringmode - stringhandler - stringargs + stringnullhandler&null; + intpermission0644 + intmap_size0 + intnullflags&null; dba_open establishes a database instance for @@ -20,6 +22,7 @@ handler. + &reftitle.parameters; @@ -154,42 +157,56 @@ 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. + shall be used for accessing path. It is passed + all optional parameters given to dba_open and + can act on behalf of them. If handler is &null;, + then the default handler is invoked. - args + permission - Optional &string; parameters which are passed to the driver. - - - The cdb, cdb_make, flatfile, - inifile, qdbm and tcadb drivers - do not support additional parameters. + Optional &integer; parameter which is passed to the driver. It has the same meaning as + the permissions parameter of chmod, + and defaults to 0644. The db1, db2, db3, db4, dbm, gdbm, - and ndbm drivers supports a single additional parameter $filemode, - which has the same meaning as the $mode parameter of chmod, - and defaults to 0644. + ndbm, and lmdb drivers support the + permission parameter. + + + + + map_size + + + Optional &integer; 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 map size. - The lmdb driver accepts two additional parameters. The first - allows to specify the $filemode (see description above), and the - second to specify the $mapsize, where the value should be a multiple - of the page size of the OS, or zero, to use the default mapsize. The $mapsize - parameter is supported as of PHP 7.3.14 and 7.4.2, respectively. + Only the lmdb driver accepts the map_size parameter. + + + + + flags + + + Flags to pass to the database drivers. If &null; the default flags will be provided. + Currently, only the LMDB driver supports the following flags + DBA_LMDB_USE_SUB_DIR and + DBA_LMDB_NO_SUB_DIR. + &reftitle.returnvalues; @@ -197,6 +214,14 @@ + + &reftitle.errors; + + &false; is returned and an E_WARNING level error is issued when + handler is &null;, but there is no default handler. + + + &reftitle.changelog; @@ -208,10 +233,22 @@ + + 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 $mapsize + The lmdb driver now supports an additional map_size parameter. @@ -230,7 +267,6 @@ -