(PHP 5 >= 5.1.0, PHP 7, PHP 8)
pg_prepare — Envoie une requête au serveur pour créer une instruction préparée avec les paramètres donnés et attend l'exécution
pg_prepare() crée une requête préparée pour une exécution ultérieure avec pg_execute() ou pg_send_execute(). Cette caractéristique permet aux commandes qui seront utilisées à plusieurs reprises d'être analysées et planifiées qu'une seule fois, plutôt que d'être exécutées chaque fois. pg_prepare() est supportée seulement avec les versions PostgreSQL 7.4 ou plus récentes; la commande échouera si vous l'utilisez avec des versions antérieures.
La fonction crée une requête préparée nommée
stmtname à partir de la chaîne
query, celle-ci doit contenir qu'une seule commande
SQL. stmtname peut être "" pour créer une
requête qui n'est pas nommée. Dans ce cas, les requêtes qui existaient et
qui se trouvaient sans noms sont automatiquement remplacées; autrement, il y
aura une erreur si le nom de la requête est déjà défini dans la session
courante. Si des paramètres sont utilisés, ils sont référés à $1,
$2, etc.
dans query.
Des requêtes préparées à utiliser avec pg_prepare()
peuvent être aussi créées en exécutant la requête SQL
PREPARE. (Par contre, pg_prepare()
est plus flexible puisqu'elle ne nécessite pas que les types des paramètres
soit préspécifiés.) De plus, bien qu'il n'y a pas de fonction PHP pour
supprimer une requête préparée, la requête SQL
DEALLOCATE peut être utilisé pour ce motif.
connection
Une instance PgSql\Connection.
Quand connection est pas spécifié, la connexion par défaut est utilisé.
La connexion par défaut est la dernière connexion faite par
pg_connect() ou pg_pconnect()
À partir de PHP 8.1.0, utiliser la connexion par défaut est obsolète.
stmtname
Le nom à donner à la requête préparée. Il doit être unique à chaque
session. Si une chaîne vide est spécifiée "" alors une requête sans
nom est créée, écrasant les requêtes sans noms précédemment définies.
query
La requête SQL avec ses paramètres. Elle doit contenir seulement une seule
requête. Plusieurs requêtes séparées par des points-virgules ne sont
pas autorisées. Si des paramètres sont utilisés, ils sont référés à
$1, $2, etc.
Une instance PgSql\Result en cas de succès, ou false si une erreur survient.
| Version | Description |
|---|---|
| 8.1.0 | Retourne désormais une instance de PgSql\Result instance ; auparavant, une ressource était retourné. |
| 8.1.0 |
Le paramètre connection attend désormais une instance de
PgSql\Connection ; auparavant, une ressource était attendu.
|
Exemple #1 Exemple avec pg_prepare()
<?php
// Connexion à une base de données nommée "marie"
$dbconn = pg_connect("dbname=marie");
// Prépare une requête pour l'exécution
$result = pg_prepare($dbconn, "my_query", 'SELECT * FROM magasins WHERE nom = $1');
// Exécute la requête préparée. Notez qu'il n'est pas nécessaire d'échapper
// la chaîne "Joe's Widgets"
$result = pg_execute($dbconn, "my_query", array("Joe's Widgets"));
// Exécute la même requête préparée, cette fois avec un paramètre différent
$result = pg_execute($dbconn, "my_query", array("Vêtements Vêtements Vêtements"));
?>
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;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.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());
}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.