Примеры программ

Пример 1. Первый образец программы, использующей libpq


/* Проверка C-версии libpq, клиентской библиотеки QHB. */

#include <stdio.h>
#include <stdlib.h>
#include "libpq-fe.h"

static void
exit_nicely(PGconn *conn)
{
    PQfinish(conn);
    exit(1);
}

int
main(int argc, char **argv)
{
    const char *conninfo;
    PGconn     *conn;
    PGresult   *res;
    int         nFields;
    int         i,
                j;

    /*
     * Если пользователь передает параметр в командной строке, использовать ее как
     * строку информации о подключении (conninfo); в противном случае по умолчанию
     * установить dbname=qhb и использовать для всех остальных параметров подключения
     * переменные среды или значения по умолчанию.
     */
    if (argc > 1)
        conninfo = argv[1];
    else
        conninfo = "dbname = qhb";

    /* Установить соединение с базой данных */
    conn = PQconnectdb(conninfo);

    /* Проверить, что соединение с сервером было успешно установлено */
    if (PQstatus(conn) != CONNECTION_OK)
    {
        fprintf(stderr, "%s", PQerrorMessage(conn));
        exit_nicely(conn);
    }

    /*
     * Установить постоянно защищенный путь поиска, чтобы неблагонамеренные
     * пользователи не могли перехватить управление.
     */
    res = PQexec(conn,
                 "SELECT pg_catalog.set_config('search_path', '', false)");
    if (PQresultStatus(res) != PGRES_TUPLES_OK)
    {
        fprintf(stderr, "SET failed: %s", PQerrorMessage(conn));
        PQclear(res);
        exit_nicely(conn);
    }

    /*
     * Когда объект PGresult больше не нужен, функция PQclear обязательно должна
     * его очистить во избежание утечек памяти
     */
    PQclear(res);

    /*
     * В нашем тестовом случае используется курсор, и для этого нам нужно находиться
     * внутри блока транзакции. Мы могли бы обработать его целиком с помощью одной
     * функции PQexec() в команде «select * from pg_database», но это было бы
     * слишком просто для хорошего примера.
     */

    /* Начать блок транзакции */
    res = PQexec(conn, "BEGIN");
    if (PQresultStatus(res) != PGRES_COMMAND_OK)
    {
        fprintf(stderr, "BEGIN command failed: %s", PQerrorMessage(conn));
        PQclear(res);
        exit_nicely(conn);
    }
    PQclear(res);

    /*
     * Извлечь строки из pg_database, системного каталога баз данных
     */
    res = PQexec(conn, "DECLARE myportal CURSOR FOR select * from pg_database");
    if (PQresultStatus(res) != PGRES_COMMAND_OK)
    {
        fprintf(stderr, "DECLARE CURSOR failed: %s", PQerrorMessage(conn));
        PQclear(res);
        exit_nicely(conn);
    }
    PQclear(res);

    res = PQexec(conn, "FETCH ALL in myportal");
    if (PQresultStatus(res) != PGRES_TUPLES_OK)
    {
        fprintf(stderr, "FETCH ALL failed: %s", PQerrorMessage(conn));
        PQclear(res);
        exit_nicely(conn);
    }

    /* сначала вывести имена атрибутов */
    nFields = PQnfields(res);
    for (i = 0; i < nFields; i++)
        printf("%-15s", PQfname(res, i));
    printf("\n\n");

    /* затем вывести строки */
    for (i = 0; i < PQntuples(res); i++)
    {
        for (j = 0; j < nFields; j++)
            printf("%-15s", PQgetvalue(res, i, j));
        printf("\n");
    }

    PQclear(res);

    /* закрыть портал ... мы не утруждаем себя проверкой на ошибки ... */
    res = PQexec(conn, "CLOSE myportal");
    PQclear(res);

    /* завершить транзакцию */
    res = PQexec(conn, "END");
    PQclear(res);

    /* закрыть соединение с базой данных и провести очистку */
    PQfinish(conn);

    return 0;
}

Пример 2. Второй образец программы, использующей libpq


/*
 *      Проверка интерфейса асинхронного уведомления
 *
 * Запустить эту программу, затем из psql в отдельном окне выполнить
 *   NOTIFY TBL2;
 * Повторить четыре раза, чтобы эта программа завершилась.
 *
 * Или, если вы хотите проявить изобретательность, попробуйте это:
 * заполнить базу данных с помощью следующих команд:
 *
 *   CREATE SCHEMA TESTLIBPQ2;
 *   SET search_path = TESTLIBPQ2;
 *   CREATE TABLE TBL1 (i int4);
 *   CREATE TABLE TBL2 (i int4);
 *   CREATE RULE r1 AS ON INSERT TO TBL1 DO
 *     (INSERT INTO TBL2 VALUES (new.i); NOTIFY TBL2);
 *
 * Запустить эту программу, затем из psql четыре раза выполнить следующее:
 *
 *   INSERT INTO TESTLIBPQ2.TBL1 VALUES (10);
 */

#ifdef WIN32
#include <windows.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <sys/time.h>
#include <sys/types.h>
#ifdef HAVE_SYS_SELECT_H
#include <sys/select.h>
#endif

#include "libpq-fe.h"

static void
exit_nicely(PGconn *conn)
{
    PQfinish(conn);
    exit(1);
}

int
main(int argc, char **argv)
{
    const char *conninfo;
    PGconn     *conn;
    PGresult   *res;
    PGnotify   *notify;
    int         nnotifies;

    /*
     * Если пользователь передает параметр в командной строке, использовать ее как
     * строку информации о подключении (conninfo); в противном случае по умолчанию
     * установить dbname=qhb и использовать для всех остальных параметров подключения
     * переменные среды или значения по умолчанию.
     */
    if (argc > 1)
        conninfo = argv[1];
    else
        conninfo = "dbname = qhb";

    /* Установить соединение с базой данных */
    conn = PQconnectdb(conninfo);

    /* Проверить, что соединение с сервером было успешно установлено */
    if (PQstatus(conn) != CONNECTION_OK)
    {
        fprintf(stderr, "%s", PQerrorMessage(conn));
        exit_nicely(conn);
    }

    /*
     * Установить постоянно защищенный путь поиска, чтобы неблагонамеренные
     * пользователи не могли перехватить управление.
     */
    res = PQexec(conn,
                 "SELECT pg_catalog.set_config('search_path', '', false)");
    if (PQresultStatus(res) != PGRES_TUPLES_OK)
    {
        fprintf(stderr, "SET failed: %s", PQerrorMessage(conn));
        PQclear(res);
        exit_nicely(conn);
    }

    /*
     * Когда объект PGresult больше не нужен, функция PQclear обязательно должна
     * его очистить во избежание утечек памяти
     */
    PQclear(res);

    /*
     * Выполнить команду LISTEN, чтобы включить уведомления из NOTIFY правила.
     */
    res = PQexec(conn, "LISTEN TBL2");
    if (PQresultStatus(res) != PGRES_COMMAND_OK)
    {
        fprintf(stderr, "LISTEN command failed: %s", PQerrorMessage(conn));
        PQclear(res);
        exit_nicely(conn);
    }
    PQclear(res);

    /* Выйти после получения четырех уведомлений. */
    nnotifies = 0;
    while (nnotifies < 4)
    {
        /*
         * Находиться в режиме ожидания, пока в соединении что-нибудь не произойдет.
         * Мы используем для ожидания ввода select(2), но также можно использовать
         * poll() или подобные ей средства.
         */
        int         sock;
        fd_set      input_mask;

        sock = PQsocket(conn);

        if (sock < 0)
            break;              /* не должно происходить */

        FD_ZERO(&input_mask);
        FD_SET(sock, &input_mask);

        if (select(sock + 1, &input_mask, NULL, NULL, NULL) < 0)
        {
            fprintf(stderr, "select() failed: %s\n", strerror(errno));
            exit_nicely(conn);
        }

        /* Теперь проверить, есть ли входные данные */
        PQconsumeInput(conn);
        while ((notify = PQnotifies(conn)) != NULL)
        {
            fprintf(stderr,
                    "ASYNC NOTIFY of '%s' received from backend PID %d\n",
                    notify->relname, notify->be_pid);
            PQfreemem(notify);
            nnotifies++;
            PQconsumeInput(conn);
        }
    }

    fprintf(stderr, "Done.\n");

    /* закрыть соединение с базой данных и провести очистку */
    PQfinish(conn);

    return 0;
}

Пример 3. Третий образец программы, использующей libpq


/*
 *      Проверка вынесенных параметров и двоичного ввода/вывода.
 *
 * Прежде чем выполнить это, заполните базу данных с помощью следующих команд:
 *
 * CREATE SCHEMA testlibpq3;
 * SET search_path = testlibpq3;
 * SET standard_conforming_strings = ON;
 * CREATE TABLE test1 (i int4, t text, b bytea);
 * INSERT INTO test1 values (1, 'joe''s place', '\000\001\002\003\004');
 * INSERT INTO test1 values (2, 'ho there', '\004\003\002\001\000');
 *
 * Ожидаемый вывод:
 *
 * tuple 0: got
 *  i = (4 bytes) 1
 *  t = (11 bytes) 'joe's place'
 *  b = (5 bytes) \000\001\002\003\004
 *
 * tuple 0: got
 *  i = (4 bytes) 2
 *  t = (8 bytes) 'ho there'
 *  b = (5 bytes) \004\003\002\001\000
 */

#ifdef WIN32
#include <windows.h>
#endif

#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <sys/types.h>
#include "libpq-fe.h"

/* для ntohl/htonl */
#include <netinet/in.h>
#include <arpa/inet.h>


static void
exit_nicely(PGconn *conn)
{
    PQfinish(conn);
    exit(1);
}

/*
 * Эта функция выводит результат запроса в двоичном формате, извлеченный из
 * таблицы, определенной как описано в комментарии выше. Мы разделяем его, потому
 * что функция main() использует ее дважды.
 */
static void
show_binary_results(PGresult *res)
{
    int         i,
                j;
    int         i_fnum,
                t_fnum,
                b_fnum;

    /* Использовать PQfnumber во избежание предположений о порядке полей в результате */
    i_fnum = PQfnumber(res, "i");
    t_fnum = PQfnumber(res, "t");
    b_fnum = PQfnumber(res, "b");

    for (i = 0; i < PQntuples(res); i++)
    {
        char       *iptr;
        char       *tptr;
        char       *bptr;
        int         blen;
        int         ival;

        /* Получить поле значений (мы игнорируем возможность, что они равны NULL!) */
        iptr = PQgetvalue(res, i, i_fnum);
        tptr = PQgetvalue(res, i, t_fnum);
        bptr = PQgetvalue(res, i, b_fnum);

        /*
         * Двоичное представление INT4 находится в сетевом порядке байтов, который
         * лучше привести к локальному порядку байтов.
         */
        ival = ntohl(*((uint32_t *) iptr));

        /*
         * Двоичное представление TEXT является, собственно, текстом, и поскольку
         * libpq любезно добавила к нему нулевой байт, он прекрасно сработает
         * как строка на C.
         *
         * Двоичное представление BYTEA является кучкой байтов, которые могут включать
         * в себя значения NULL, поэтому нам придется обращать внимание на длину поля.
         */
        blen = PQgetlength(res, i, b_fnum);

        printf("tuple %d: got\n", i);
        printf(" i = (%d bytes) %d\n",
               PQgetlength(res, i, i_fnum), ival);
        printf(" t = (%d bytes) '%s'\n",
               PQgetlength(res, i, t_fnum), tptr);
        printf(" b = (%d bytes) ", blen);
        for (j = 0; j < blen; j++)
            printf("\\%03o", bptr[j]);
        printf("\n\n");
    }
}

int
main(int argc, char **argv)
{
    const char *conninfo;
    PGconn     *conn;
    PGresult   *res;
    const char *paramValues[1];
    int         paramLengths[1];
    int         paramFormats[1];
    uint32_t    binaryIntVal;

    /*
     * Если пользователь передает параметр в командной строке, использовать ее как
     * строку информации о подключении (conninfo); в противном случае по умолчанию
     * установить dbname=qhb и использовать для всех остальных параметров подключения
     * переменные среды или значения по умолчанию
     */
    if (argc > 1)
        conninfo = argv[1];
    else
        conninfo = "dbname = qhb";

    /* Установить соединение с базой данных */
    conn = PQconnectdb(conninfo);

    /* Проверить, что соединение с сервером было успешно установлено */
    if (PQstatus(conn) != CONNECTION_OK)
    {
        fprintf(stderr, "%s", PQerrorMessage(conn));
        exit_nicely(conn);
    }

    /*
     * Установить постоянно защищенный путь поиска, чтобы неблагонамеренные
     * пользователи не могли перехватить управление.
     */
    res = PQexec(conn, "SET search_path = testlibpq3");
    if (PQresultStatus(res) != PGRES_COMMAND_OK)
    {
        fprintf(stderr, "SET failed: %s", PQerrorMessage(conn));
        PQclear(res);
        exit_nicely(conn);
    }
    PQclear(res);

    /*
     * Цель этой программы состоит в том, чтобы проиллюстрировать использование функции
     * PQexecParams() с внешними параметрами, а также двоичную передачу данных.
     *
     * В этом первом примере параметры передаются в виде текста, но результаты
     * возвращаются в двоичном формате. Благодаря внешним параметрам мы можем
     * избежать трудоемкой возни с заключением в кавычки и экранированием, несмотря
     * на то, что данные являются текстом. Обратите внимание, что нам не нужно
     * делать ничего особенного со знаком кавычки в значении параметра.
     */

    /* Вот наше значение внешнего параметра */
    paramValues[0] = "joe's place";

    res = PQexecParams(conn,
                       "SELECT * FROM test1 WHERE t = $1",
                       1,       /* один параметр */
                       NULL,    /* позволить серверу определить тип параметра */
                       paramValues,
                       NULL,    /* длина параметра не нужна, поскольку это текст */
                       NULL,    /* применить по умолчанию ко все текстовым параметрам */
                       1);      /* попросить двоичные результаты */

    if (PQresultStatus(res) != PGRES_TUPLES_OK)
    {
        fprintf(stderr, "SELECT failed: %s", PQerrorMessage(conn));
        PQclear(res);
        exit_nicely(conn);
    }

    show_binary_results(res);

    PQclear(res);

    /*
     * Во втором примере мы передаем целочисленный параметр в двоичной форме
     * и снова получаем результаты в двоичной форме.
     *
     * Хотя мы и говорим PQexecParams, что позволяем серверу определить тип
     * параметра, в действительности мы вынуждаем его принять решение, преобразуя
     * символ параметра в тексте запроса. Это надежная мера безопасности при
     * передаче двоичных параметров.
     */

    /* Преобразовать целочисленное значение «2» в сетевой порядок байтов */
    binaryIntVal = htonl((uint32_t) 2);

    /* Установить значения массивов параметров для PQexecParams */
    paramValues[0] = (char *) &binaryIntVal;
    paramLengths[0] = sizeof(binaryIntVal);
    paramFormats[0] = 1;        /* двоичный */

    res = PQexecParams(conn,
                       "SELECT * FROM test1 WHERE i = $1::int4",
                       1,       /* один параметр */
                       NULL,    /* позволить серверу определить тип параметра */
                       paramValues,
                       paramLengths,
                       paramFormats,
                       1);      /* попросить двоичные результаты */

    if (PQresultStatus(res) != PGRES_TUPLES_OK)
    {
        fprintf(stderr, "SELECT failed: %s", PQerrorMessage(conn));
        PQclear(res);
        exit_nicely(conn);
    }

    show_binary_results(res);

    PQclear(res);

    /* закрыть соединение с базой данных и провести очистку */
    PQfinish(conn);

    return 0;
}