(PHP 5 >= 5.1.0, PHP 7, PHP 8)
pg_prepare — Отправляет на сервер запрос на подготовку SQL-запроса с параметрами-заполнителями и ждёт, пока завершится подготовка запроса
Функция pg_prepare() подготавливает SQL-запрос, который затем запустит функция pg_execute() или pg_send_execute(). Функция помогает разбирать и планировать команды только один раз, а не каждый раз при выполнении, а потом многократно выполнять такие команды. Функция pg_prepare() поддерживает соединения только с БД PostgreSQL 7.4 или новее; функция не будет работать c серверами предыдущих версий.
Функция создает подготовленный запрос с названием stmtname
из строки query, которая содержит одну команду.
Значение параметра stmtname указывают как пустую строку "",
чтобы создать безымянный запрос, который автоматически заменяет предыдущий безымянный запрос;
в остальных случаях попытка назвать запрос именем, которое уже определили в текущей сессии,
вызовет ошибку. Параметры, которые передали при выполнении запроса,
указывают на обозначения $1, $2 и т. д. в запросе query.
Подготовленные для функции pg_prepare() запросы создают также SQL-командой
PREPARE, но функция pg_prepare() гибче,
поскольку не заставляет указывать типы параметров.
Хотя в PHP нет функции для удаления подготовленного запроса,
это сделает SQL-команда DEALLOCATE.
connectionЭкземпляр
класса PgSql\Connection.
Функция выберет соединение по умолчанию, если параметр connection не указали.
Соединение по умолчанию — последнее соединение, которое установила функция pg_connect()
или pg_pconnect().
Начиная с PHP 8.1.0 выбор функцией соединения по умолчанию устарел.
stmtname
Уникальное в пределах сессии имя, которым функция назовёт подготовленный запрос.
Функция создаст безымянный запрос, который перезапишет предыдущий безымянный запрос
текущей сессии, если задали пустую строку "".
query
Один параметризованный SQL-запрос; несколько запросов через точку с запятой не поддерживаются.
Параметры, которые передали, относятся к обозначениям запроса $1, $2 и т. д.
Функция возвращает экземпляр PgSql\Result в случае успешного выполнения или false, если возникла ошибка.
| Версия | Описание |
|---|---|
| 8.1.0 | Функция возвращает экземпляр класса PgSql\Result; раньше функция возвращала ресурс (resource). |
| 8.1.0 |
Параметр connection теперь ожидает экземпляр
класса PgSql\Connection; раньше параметр ожидал ресурс (resource).
|
Пример #1 Пример подготовки запроса функцией pg_prepare()
<?php
// Подключение к базе данных "mary"
$dbconn = pg_connect("dbname=mary");
// Подготовка запроса
$result = pg_prepare($dbconn, "my_query", 'SELECT * FROM shops WHERE name = $1');
// Запуск запроса на выполнение. Обратите внимание: спецсимволы в строке "Joe's Widgets"
// не заэкранированы
$result = pg_execute($dbconn, "my_query", array("Joe's Widgets"));
// Запуск на выполнение того же запроса, но с другим параметром
$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.