PHP Conference Nagoya 2025

dba_open

(PHP 4, PHP 5, PHP 7, PHP 8)

dba_openÖffnet eine Datenbank

Beschreibung

dba_open(
    string $path,
    string $mode,
    ?string $handler = null,
    int $permission = 0644,
    int $map_size = 0,
    ?int $flags = null
): Dba\Connection|false

dba_open() stellt eine Datenbankinstanz für path mit mode her und verwendet dabei handler.

Parameter-Liste

path

Ein gültiger Pfad im Dateisystem.

mode

Das ist r für lesenden Zugriff, w für lesenden und schreibenden Zugriff auf eine existierende Datenbank, c für lesenden und schreibenden Zugriff und Erstellen der Datenbank, falls sie noch nicht existiert, und n für das Erstellen einer Datenbank, bzw. deren Zurücksetzen auf die Größe 0, falls sie schon existiert, und lesenden und schreibenden Zugriff. Die Datenbank wird im BTree-Modus erzeugt. Andere Modi, wie Hash oder Queue, werden nicht unterstützt.

Zusätzlich kann mit dem nächsten Buchstaben die Datenbank-Sperrmethode festgelegt werden. Verwenden Sie l, um die Datenbank mit einer .lck-Datei zu sperren, oder d, um die Datenbank-Datei selbst zu sperren. Es ist wichtig, dass alle Ihre Anwendungen das einheitlich machen.

Falls Sie den Zugriff testen wollen, ohne auf die Sperrung zu warten, können Sie t als dritten Buchstaben anfügen. Wenn Sie sich absolut sicher sind, dass Sie keine Datenbanksperre benötigen, können Sie statt l oder d - verwenden. Wenn weder d oder l noch - verwendet werden, sperrt dba die Datenbank-Datei wie bei Verwendung von d.

Hinweis:

Es kann jeweils nur einen Schreibzugriff auf eine Datenbank-Datei geben. Wenn dba auf einem Webserver verwendet wird und mehr als eine Anfrage Schreibzugriff benötigt, kann nur einer nach dem anderen erledigt werden. Auch das Lesen ist während des Schreibens nicht erlaubt. Die DBA-Erweiterung verwendet Sperren, um dies zu verhindern. Siehe folgende Tabelle:

DBA-Sperrung
schon geöffnet mode = "rl" mode = "rlt" mode = "wl" mode = "wlt" mode = "rd" mode = "rdt" mode = "wd" mode = "wdt"
nicht geöffnet OK OK OK OK OK OK OK OK
mode = "rl" OK OK warten false unzulässig unzulässig unzulässig unzulässig
mode = "wl" warten false warten false unzulässig unzulässig unzulässig unzulässig
mode = "rd" unzulässig unzulässig unzulässig unzulässig OK OK warten false
mode = "wd" unzulässig unzulässig unzulässig unzulässig warten false warten false
  • OK: der zweite Aufruf ist erfolgreich.
  • warten: der zweite Aufruf wartet bis für den ersten dba_close() aufgerufen wird.
  • false: der zweite Aufruf gibt false zurück.
  • unzulässig: Sie dürfen beim Parameter mode die Modifikatoren "l" und "d" nicht zusammen verwenden.

handler

Der Name des Handlers, der für den Zugriff auf path benutzt werden soll. Er bekommt alle optionalen Argumente übergeben, die der Funktion dba_open() mitgegeben wurden, und kann damit in deren Name verfahren. Wenn handler null ist, wird der Standard-Handler aufgerufen.

permission

Ein optionaler Integer-Parameter, der an den Treiber übergeben wird. Er hat dieselbe Bedeutung wie der Parameter permissions bei chmod(). Der Standardwert ist 0644.

Der Parameter permission wird vom db1-, db2-, db3-, db4-, dbm-, gdbm-, ndbm- und lmdb-Treiber unterstützt.

map_size

Ein optionaler Integer-Parameter, der an den Treiber übergeben wird. Sein Wert sollte ein Vielfaches der Größe einer Speicherseite (Page Size) des Betriebssystems sein. Wenn Null angegeben wird, wird die Standard-Map-Size verwendet.

Der Parameter map_size wird nur vom lmdb-Treiber akzeptiert.

flags

Die Flags, die an den Datenbanktreiber übergeben werden. Falls null, werden die Standard-Flags bereitgestellt. Derzeit unterstützt nur der LMDB-Treiber die Flags DBA_LMDB_USE_SUB_DIR und DBA_LMDB_NO_SUB_DIR.

Rückgabewerte

Gibt bei Erfolg eine Instanz von Dba\Connection zurück. Bei einem Fehler wird false zurückgegeben.

Fehler/Exceptions

Wenn handler null ist, aber kein Standard-Handler zur Verfügung steht, wird false zurückgegeben und ein Fehler der Stufe E_WARNING ausgegeben.

Changelog

Version Beschreibung
8.4.0 Gibt nun eine Instanz von Dba\Connection zurück; zuvor wurde eine Ressource zurückgegeben.
8.2.0 Der Parameter flags wurde hinzugefügt.
8.2.0 Der Parameter handler ist nun nullable (akzeptiert den null-Wert).
7.3.14, 7.4.2 Der lmdb-Treiber unterstützt nun zusätzlich den Parmeter map_size.

Siehe auch

add a note

User Contributed Notes 6 notes

up
1
doppelbauer at gmail dot com
18 years ago
Windows does not support locking the database. You may use $_ENV to determine the OS:

$locking = (stripos($_ENV['OS'],'windows') === false ? 'd' : 'l');
up
0
dracoirs at gmail dot com
14 years ago
Apache doesn't support Berkeley DB Btree, so you can't manipulate use db4 as the type of database if you want to do DBM authentication with Apache.

gdbm seemed to work fine though, even though it supposedly using Btree instead of hash. It makes you wonder why Apache would use hash for one dbmtype versus btree for another.

So since Apache and PHP don't have options to choose the method for the Berkeley DBs, you are out of luck.
up
0
mskala at ansuz dot sooke dot bc dot ca
16 years ago
As of GDBM version 1.8.3, GDBM's underlying open call uses non-blocking calls to flock() on systems that have flock(). As a result, calls with "rd" or "wd" locking modes will return error ("Can't be reader" or "Can't be writer") instead of waiting. Use "rl" or "wl" instead, to make PHP do its own locking external to GDBM.
up
0
xy ät affenkrieger.de
18 years ago
If you get some strange errors like
dba_open(): myDbFilename.db : Permission denied
than you are propably using PHP on a Windoze machine. You have to make sure that the following conditions are met:

1) Use an absolute path to your db file. Relative paths will cause problems with locking
2) Specify a locking mode - that's the second character of the mode-argument, or else opening a dba-file will cause several notices/warnings etc.

And a final, general note:
3) Always use the english PHP doc on this site - the translations are often old as hell and miss important informations

HTH, Nils.
up
-2
trohit at blue bottle dot com
17 years ago
Here's a simple example to use the dba_open function

<?php

$id
= dba_open("/tmp/test.db", "n", "gdbm");

if (!
$id) {
echo
"dba_open failed\n";
exit;
}

dba_replace("key", "This is an example!", $id);

if (
dba_exists("key", $id)) {
echo
dba_fetch("key", $id);
dba_delete("key", $id);
}

dba_close($id);
?>
up
-5
cbemerine at gmail dot com
15 years ago
Note the “c” create flag does not work if MySQL was built with the “cdb” DBA handler compile option which is common for many distros. By definition the cdb DBA handler is optimized for reading/writing and “no updates are allowed.”

<?php
$dbh
= dba_open( "./data2/productz", "c", "cdb") or die( "Couldn't open Database" );
?>

instead use

<?php
$dbh
= dba_open( "./data2/productz", "n", "cdb" ) or die( "Couldnt open Database" );
?>

generates this error message in the /var/log/apache2/error.log:
[Sun Sep 06 04:18:15 2009] [error] [client 192.168.1.125] PHP Warning: dba_open(./data2/productz,c) [<a href='function.dba-open'>function.dba-open</a>]: Driver initialization failed for handler: cdb: Update operations are not supported in /var/www/projects/testcdb-c.php on line 43

see user contributed comment under dba_handlers() to see which DBA handlers are supported by your build of MySQL and note about using “cdb” compiled DBA systems:

also see user contributed comment under dba_replace() about incompatibilities with cdb DBA handler compiled MySQL systems.
To Top