(PHP 5 >= 5.1.0, PHP 7, PHP 8)
pg_prepare — Sendet eine Aufforderung an den Server, eine vorbereitete Anfrage mit den übergebenen Parametern zu erzeugen und wartet auf ihre Beendigung
$connection = ?, string $stmtname, string $query): PgSql\Result|falsepg_prepare() erzeugt eine vorbereitete Abfrage, die später mit pg_execute() oder pg_send_execute() ausgeführt werden kann. Dank dieser Eigenschaft brauchen wiederholt ausgeführte Abfragen nur ein einziges Mal geparst und geplant werden, anstatt bei jeder Ausführung.
Diese Funktion erzeugt aus der Abfrage query eine
vorbereitete Abfrage mit dem Namen stmtname.
query darf nur ein einzelnes SQL-Kommando enthalten.
stmtname kann "" sein, um eine
unbenannte Abfrage zu erzeugen, wobei zuvor definierte unbenannte Abfragen
automatisch überschrieben werden. Falls der Name der vorbereiteten Abfrage
in der aktuellen Datenbanksitzung schon vergeben ist, wird ein Fehler
zurückgegeben. Falls irgendwelche Parameter übergeben wurden, werden diese
in query als $1,
$2 usw. referenziert.
Vorbereitete Abfragen, die mit pg_prepare() erzeugt
wurden, können ebenso mit dem SQL-Kommando PREPARE
erzeugt werden (allerdings ist pg_prepare() flexibler,
weil Parametertypen nicht vorab deklariert werden müssen). Obwohl es keine
PHP-Funktion zum Löschen vorbereiteter Anfragen gibt, können diese mit dem
SQL-Kommando DEALLOCATE gelöscht werden.
connectionEine PgSql\Connection-Instanz.
Falls connection nicht angegeben wurde, wird die Standardverbindung benutzt.
Das ist die zuletzt mit pg_connect() oder pg_pconnect() aufgebaute Verbindung.
Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
stmtname
Der Name, unter dem die vorbereitete Abfrage gespeichert wird. Dieser
muss für jede Verbindung eindeutig sein. Falls ""
angegeben wurde, wird eine unbenannte Abfrage erzeugt, die alle zuvor
definierten unbenannten Abfragen überschreibt.
query
Die parametrisierte vorbereitete Abfrage. Diese darf nur ein einziges
SQL-Kommando enthalten (mehrere Kommandos, durch Semikolon getrennt,
sind nicht zulässig). Falls Parameter übergeben werden, werden sie als
$1, $2, ... referenziert.
Bei Erfolg wird eine PgSql\Result-Instanz zurückgegeben.
Bei einem Fehler wird false zurückgegeben.
| Version | Beschreibung |
|---|---|
| 8.1.0 | Gibt nun eine PgSql\Result-Instanz zurück; vorher wurde eine Ressource zurückgegeben. |
| 8.1.0 |
Der Parameter connection erwartet nun eine PgSql\Connection-Instanz;
vorher wurde eine Ressource erwartet.
|
Beispiel #1 pg_prepare()-Beispiel
<?php
// Verbindung zu einer Datenbank namens "mary" aufbauen
$dbconn = pg_connect("dbname=mary");
// Abfrage vorbereiten
$result = pg_prepare($dbconn, "my_query", 'SELECT * FROM shops WHERE name = $1');
// Die vorbereitete Abfrage ausführen. Es ist zu beachten, dass es
// nicht nötig ist, den String "Joe's Widgets" zu maskieren.
$result = pg_execute($dbconn, "my_query", array("Joe's Widgets"));
// Dieselbe Abfrage mit einem anderen Parameter nochmal ausführen
$result = pg_execute($dbconn, "my_query", array("Clothes Clothes Clothes"));
?>
SQL is often a complicated piece of code by itself, so you may wish put it inside a "here doc." This will help you read it wherever it appears and test it by itself via a command-line or gui client.
$sql = <<<SQL
SELECT a.foo, b.bar, c.baz
FROM
table_a a
LEFT JOIN
table_b b
ON (
a.a_id = b.a_id
)
JOIN
table_c c
ON (
b.c_id = c.c_id
)
WHERE c.name = $1
SQL;If you decide to deallocate (unprepare) a previously prepared sql command it might be better to quote the sql name as in
DEALLOCATE "theNameOfMySQL"
instead of (the more natural)
DEALLOCATE theNameOfMySQL
PostgerSQL preserves the case of your identifiers if, and only if, you quote them. The pg_prepare function preserves the case of the sql name you use.
A complete example would be
$sql = 'SELECT * FROM user WHERE cod_user = $1';
$sqlName = 'selectUserByCode';
if (!pg_prepare ($sqlName, $sql)) {
die("Can't prepare '$sql': " . pg_last_error());
}
$rs = pg_execute($sqlName, array(1));
do whatever you want with $rs and finally
$sql = sprintf(
'DEALLOCATE "%s"',
pg_escape_string($sqlName)
);
if(!pg_query($sql)) {
die("Can't query '$sql': " . pg_last_error());
}I had some problems with this function. When you use pg_prepare() with a function like date_trunc('day', $1) you need to specify the data type.
The solution was use the Pear MDB2 but with some changes in code. The original code try to use pg_prepare() too, with errors.The given name cannot be the statement itself.
It has a maximum length and will truncate.
If two queries begin the same way, only the first one will be used.Note that if you are preparing a query with an in clause with a list of items, you will need to prepare each item separately.
$result = pg_prepare($dbconn, "my_query", 'SELECT * FROM shops WHERE name IN($1,$2,$3)');
$result = pg_execute($dbconn, "my_query", array("coffee", "beer", "hard"));
This means that you can't just prepare a query with an arbitrary in() list.