35.7. Использование областей дескрипторов
Области дескрипторов SQL дают возможности для более сложной обработки результатов операторов SELECT
, FETCH
и DESCRIBE
. Область дескриптора SQL объединяет в одной структуре данные одной строки и элементы метаданных. Эти метаданные особенно полезны при выполнении динамических SQL-операторов, когда характер результирующих столбцов может быть неизвестен заранее. Postgres Pro предлагает два подхода к использованию областей дескрипторов: именованные области SQL-дескрипторов и области SQLDA в структурах C.
35.7.1. Именованные области SQL-дескрипторов
Именованная область SQL-дескриптора состоит из заголовка, содержащего сведения обо всём дескрипторе, и одного или нескольких дескрипторов элементов, которые по сути описывают отдельные столбцы в строке результата.
Прежде чем вы сможете использовать область SQL-дескриптора, её нужно выделить:
EXEC SQL ALLOCATE DESCRIPTOR идентификатор
;
Заданный идентификатор играет роль «имени переменной» области дескриптора. Когда дескриптор оказывается ненужным, его следует освободить:
EXEC SQL DEALLOCATE DESCRIPTOR идентификатор
;
Чтобы воспользоваться областью дескриптора, её нужно указать в качестве целевого объекта в предложении INTO
, вместо перечисления переменных среды:
EXEC SQL FETCH NEXT FROM mycursor INTO SQL DESCRIPTOR mydesc;
Если набор результатов пуст, в области дескриптора будут тем не менее содержаться метаданные из запроса, то есть имена полей.
Получить метаданные набора результатов для ещё не выполненных подготовленных запросов можно, воспользовавшись оператором DESCRIBE
:
EXEC SQL BEGIN DECLARE SECTION; char *sql_stmt = "SELECT * FROM table1"; EXEC SQL END DECLARE SECTION; EXEC SQL PREPARE stmt1 FROM :sql_stmt; EXEC SQL DESCRIBE stmt1 INTO SQL DESCRIPTOR mydesc;
До PostgreSQL версии 9.0 ключевое слово SQL
было необязательным, так что предложения DESCRIPTOR
и SQL DESCRIPTOR
создавали именованные области SQL-дескрипторов. Теперь оно стало обязательным; без слова SQL
создаются области SQLDA, см. Подраздел 35.7.2.
В операторах DESCRIBE
и FETCH
ключевые слова INTO
и USING
действуют примерно одинаково: они указывают вывести набор результатов и метаданные в область дескриптора.
Возникает вопрос: а как же получить данные из области дескриптора? Область дескриптора можно представить как структуру с именованными полями. Чтобы получить значение поля из заголовка и сохранить его в переменной среды C, нужно выполнить команду:
EXEC SQL GET DESCRIPTORимя
:переменная_среды
=поле
;
В настоящее время определено только одно поле заголовка: COUNT
, которое говорит, сколько областей дескрипторов элементов существует (то есть, сколько столбцов содержится в результате). Переменная среды C должна иметь целочисленный тип. Чтобы получить поле из области дескриптора элемента, нужно выполнить команду:
EXEC SQL GET DESCRIPTORимя
VALUEномер
:переменная_среды
=поле
;
В качестве num
можно задать обычное целое или переменную среды C, содержащую целое число. Допустимые поля:
CARDINALITY
(integer)число строк в наборе результатов
DATA
собственно элемент данных (тип данных поля зависит от запроса)
DATETIME_INTERVAL_CODE
(целое)Когда
TYPE
равно9
,DATETIME_INTERVAL_CODE
содержит значение1
дляDATE
,2
дляTIME
,3
дляTIMESTAMP
,4
дляTIME WITH TIME ZONE
, либо5
дляTIMESTAMP WITH TIME ZONE
.DATETIME_INTERVAL_PRECISION
(целое)не реализовано
INDICATOR
(целое)индикатор (отмечающий значение NULL или усечение значения)
KEY_MEMBER
(целое)не реализовано
LENGTH
(целое)длина данных в символах
NAME
(строка)имя столбца
NULLABLE
(целое)не реализовано
OCTET_LENGTH
(целое)длина символьного представления данных в байтах
PRECISION
(целое)точность (для типа
numeric
)RETURNED_LENGTH
(целое)длина данных в символах
RETURNED_OCTET_LENGTH
(целое)длина символьного представления данных в байтах
SCALE
(целое)масштаб (для типа
numeric
)TYPE
(целое)числовой код типа данных столбца
В операторах EXECUTE
, DECLARE
и OPEN
ключевые слова INTO
и USING
действуют по-разному. Область дескриптора также можно сформировать вручную, чтобы передать входные параметры запросу или курсору, а команда USING SQL DESCRIPTOR
даёт возможность передать входные аргументы параметризованному запросу. Оператор, формирующий именованную область SQL-дескриптора, выглядит так: имя
EXEC SQL SET DESCRIPTORимя
VALUEномер
поле
= :переменная_среды
;
Postgres Pro поддерживает выборку сразу нескольких записей в одном операторе FETCH
и может сохранить их данные в переменной среды С, если эта переменная — массив. Например:
EXEC SQL BEGIN DECLARE SECTION; int id[5]; EXEC SQL END DECLARE SECTION; EXEC SQL FETCH 5 FROM mycursor INTO SQL DESCRIPTOR mydesc; EXEC SQL GET DESCRIPTOR mydesc VALUE 1 :id = DATA;
35.7.2. Области дескрипторов SQLDA
Область дескриптора SQLDA представляет собой структуру языка C, в которую можно получить набор результатов и метаданные запроса. Одна такая структура содержит одну запись из набора данных.
EXEC SQL include sqlda.h; sqlda_t *mysqlda; EXEC SQL FETCH 3 FROM mycursor INTO DESCRIPTOR mysqlda;
Заметьте, что ключевое слово SQL
в этом случае опускается. Замечания относительно применения ключевых слов INTO
и USING
в Подразделе 35.7.1 применимы и здесь, с дополнением. В операторе DESCRIBE
можно полностью опустить ключевое слово DESCRIPTOR
, если присутствует ключевое слово INTO
:
EXEC SQL DESCRIBE prepared_statement INTO mysqlda;
Общая схема использования SQLDA выглядит так:
Подготовить запрос и объявить курсор для него.
Объявить SQLDA для строк результата.
Объявить SQLDA для входных параметров и инициализировать их (выделить память, задать параметры).
Открыть курсор с входной SQLDA.
Выбрать строки из курсора и сохранить их в выходной SQLDA.
Прочитать значения из выходной SQLDA в переменные среды (и преобразовать при необходимости).
Закрыть курсор.
Освободить область памяти, выделенную для входной SQLDA.
35.7.2.1. Структура данных SQLDA
Для SQLDA используются три типа данных: sqlda_t
, sqlvar_t
и struct sqlname
.
Подсказка
Структура данных SQLDA в Postgres Pro подобна той, что используется в IBM DB2 Universal Database, так что часть технической информации по SQLDA в DB2 может быть полезна и для понимания устройства SQLDA в Postgres Pro.
35.7.2.1.1. Структура sqlda_t
Тип структуры sqlda_t
представляет тип собственно SQLDA. Эта структура описывает одну запись. Две или более структур sqlda_t
могут объединяться в связанный список по указателям в поле desc_next
, и таким образом образовывать упорядоченный набор строк. Поэтому, когда выбираются две или более строк, приложение может прочитать их, проследуя по указателям desc_next
во всех узлах sqlda_t
.
Тип sqlda_t
определяется так:
struct sqlda_struct { char sqldaid[8]; long sqldabc; short sqln; short sqld; struct sqlda_struct *desc_next; struct sqlvar_struct sqlvar[1]; }; typedef struct sqlda_struct sqlda_t;
Его поля имеют следующее назначение:
sqldaid
Содержит строковую константу
"SQLDA "
.sqldabc
Содержит размер выделенного пространства в байтах.
sqln
Содержит число входных параметров для параметризованного запроса, когда передаётся в операторы
OPEN
,DECLARE
илиEXECUTE
с ключевым словомUSING
. В структуре, выводимой операторамиSELECT
,EXECUTE
илиFETCH
, данное значение совпадает сsqld
.sqld
Содержит число полей в наборе результатов.
desc_next
Если запрос выдаёт несколько записей, возвращается несколько связанных структур SQLDA, а
desc_next
содержит указатель на следующую запись в списке.sqlvar
Это массив столбцов в наборе результатов.
35.7.2.1.2. Структура sqlvar_t
Тип структуры sqlvar_t
содержит значение столбца и метаданные, в частности, тип и длину. Эта структура определяется так:
struct sqlvar_struct { short sqltype; short sqllen; char *sqldata; short *sqlind; struct sqlname sqlname; }; typedef struct sqlvar_struct sqlvar_t;
Её поля имеют следующее назначение:
sqltype
Содержит идентификатор типа данного поля. Возможные значения перечислены в
enum ECPGttype
вecpgtype.h
.sqllen
Содержит двоичную длину поля, например 4 байта для
ECPGt_int
.sqldata
Указывает на данные. Формат данных описан в Подразделе 35.4.4.
sqlind
Указывает на индикатор NULL. 0 соответствует значению не NULL, -1 — NULL.
sqlname
Имя поля.
35.7.2.1.3. Структура struct sqlname
Структура struct sqlname
содержит имя столбца. Она включена в sqlvar_t
в качестве члена. Эта структура определена так:
#define NAMEDATALEN 64 struct sqlname { short length; char data[NAMEDATALEN]; };
Её поля имеют следующее назначение:
length
Содержит длину имени поля.
data
Содержит собственно имя поля.
35.7.2.2. Получение набора результатов с применением SQLDA
Чтобы получить набор результатов запроса через SQLDA, нужно проделать примерно следующее:
Объявить структуру
sqlda_t
для получения набора результатов.Выполнить команды
FETCH
/EXECUTE
/DESCRIBE
для обработки запроса с указанной SQLDA.Определить число записей в наборе результатов, прочитав
sqln
, член структурыsqlda_t
.Получить значения каждого столбца из элементов
sqlvar[0]
,sqlvar[1]
и т. д., составляющих массив, включённый в структуруsqlda_t
.Перейти к следующей строке (структуре
sqlda_t
) по указателюdesc_next
, члену структурыsqlda_t
.При необходимости повторить эти действия.
Далее показывается, как получить набор результатов через SQLDA.
Сначала объявите структуру sqlda_t
, в которую будет помещён набор результатов.
sqlda_t *sqlda1;
Затем укажите эту SQLDA в команде. В данном примере это команда FETCH
.
EXEC SQL FETCH NEXT FROM cur1 INTO DESCRIPTOR sqlda1;
Обработайте все строки в цикле с переходом по связанному списку.
sqlda_t *cur_sqlda; for (cur_sqlda = sqlda1; cur_sqlda != NULL; cur_sqlda = cur_sqlda->desc_next) { ... }
Внутри этого цикла реализуйте ещё один цикл чтения данных каждого столбца (структуры sqlvar_t
) в строке.
for (i = 0; i < cur_sqlda->sqld; i++) { sqlvar_t v = cur_sqlda->sqlvar[i]; char *sqldata = v.sqldata; short sqllen = v.sqllen; ... }
Чтобы получить значение столбца, прочитайте значение поля sqltype
, члена структуры sqlvar_t
. Затем выберите подходящий способ, в зависимости от типа столбца, копирования данных из поля sqlvar
в переменную среды С.
char var_buf[1024]; switch (v.sqltype) { case ECPGt_char: memset(&var_buf, 0, sizeof(var_buf)); memcpy(&var_buf, sqldata, (sizeof(var_buf) <= sqllen ? sizeof(var_buf) - 1 : sqllen)); break; case ECPGt_int: /* integer */ memcpy(&intval, sqldata, sqllen); snprintf(var_buf, sizeof(var_buf), "%d", intval); break; ... }
35.7.2.3. Передача значений параметров через SQLDA
Чтобы передать параметры подготовленному запросу через SQLDA, нужно проделать примерно следующее:
Создать подготовленный запрос (подготовленный оператор)
Объявить структуру sqlda_t в качестве входной SQLDA.
Выделить область памяти (структуру sqlda_t) для входной SQLDA.
Установить (скопировать) входные значения в выделенной памяти.
Открыть курсор, указав входную SQLDA.
Рассмотрим это на примере.
Сначала создайте подготовленный оператор.
EXEC SQL BEGIN DECLARE SECTION; char query[1024] = "SELECT d.oid, * FROM pg_database d, pg_stat_database s WHERE d.oid = s.datid AND (d.datname = ? OR d.oid = ?)"; EXEC SQL END DECLARE SECTION; EXEC SQL PREPARE stmt1 FROM :query;
Затем выделите память для SQLDA и установите число входных параметров в поле sqln
, члене структуры sqlda_t
. Когда для подготовленного запроса требуются два или более входных параметров, приложение должно выделить дополнительное место в памяти, размер которого вычисляется как (число параметров - 1) * sizeof(sqlvar_t). В показанном здесь примере выделяется место для двух параметров.
sqlda_t *sqlda2; sqlda2 = (sqlda_t *) malloc(sizeof(sqlda_t) + sizeof(sqlvar_t)); memset(sqlda2, 0, sizeof(sqlda_t) + sizeof(sqlvar_t)); sqlda2->sqln = 2; /* число входных переменных */
Выделив память, сохраните значения параметров в массиве sqlvar[]
. (Этот же массив используется для значений столбцов, когда SQLDA получает набор результатов.) В данном примере передаются два параметра: "postgres"
(строкового типа) и 1
(целочисленного типа).
sqlda2->sqlvar[0].sqltype = ECPGt_char; sqlda2->sqlvar[0].sqldata = "postgres"; sqlda2->sqlvar[0].sqllen = 8; int intval = 1; sqlda2->sqlvar[1].sqltype = ECPGt_int; sqlda2->sqlvar[1].sqldata = (char *) &intval; sqlda2->sqlvar[1].sqllen = sizeof(intval);
Откройте курсор с указанием ранее созданной SQLDA, чтобы входные параметры были переданы подготовленному оператору.
EXEC SQL OPEN cur1 USING DESCRIPTOR sqlda2;
Наконец, закончив использование входных SQLDA, необходимо явно освободить выделенную для них память, в отличие от SQLDA, получающих результаты запросов.
free(sqlda2);
35.7.2.4. Пример приложения, использующего SQLDA
Представленный здесь пример программы показывает, как выбрать из системных каталогов статистику доступа к базам данных, определённых входными параметрами.
Это приложение соединяет записи двух системных таблиц, pg_database и pg_stat_database по OID базы данных, и также выбирает и показывает статистику, принимая два входных параметра (база данных postgres
и OID 1
).
Сначала создайте SQLDA для ввода параметров и SQLDA для вывода результатов.
EXEC SQL include sqlda.h; sqlda_t *sqlda1; /* выходной дескриптор */ sqlda_t *sqlda2; /* входной дескриптор */
Затем подключитесь к базе данных, подготовьте оператор и объявите курсор для подготовленного оператора.
int main(void) { EXEC SQL BEGIN DECLARE SECTION; char query[1024] = "SELECT d.oid,* FROM pg_database d, pg_stat_database s WHERE d.oid=s.datid AND ( d.datname=? OR d.oid=? )"; EXEC SQL END DECLARE SECTION; EXEC SQL CONNECT TO testdb AS con1 USER testuser; EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT; EXEC SQL PREPARE stmt1 FROM :query; EXEC SQL DECLARE cur1 CURSOR FOR stmt1;
Затем запишите некоторые значения параметров во входную SQLDA. Выделите память для входной SQLDA и установите количество параметров в sqln
. Запишите тип, значение и длину значения в поля sqltype
, sqldata
и sqllen
структуры sqlvar
.
/* Создать структуру SQLDA для входных параметров. */ sqlda2 = (sqlda_t *) malloc(sizeof(sqlda_t) + sizeof(sqlvar_t)); memset(sqlda2, 0, sizeof(sqlda_t) + sizeof(sqlvar_t)); sqlda2->sqln = 2; /* число входных переменных */ sqlda2->sqlvar[0].sqltype = ECPGt_char; sqlda2->sqlvar[0].sqldata = "postgres"; sqlda2->sqlvar[0].sqllen = 8; intval = 1; sqlda2->sqlvar[1].sqltype = ECPGt_int; sqlda2->sqlvar[1].sqldata = (char *)&intval; sqlda2->sqlvar[1].sqllen = sizeof(intval);
Подготовив входную SQLDA, откройте курсор с ней.
/* Открыть курсор с входными параметрами. */ EXEC SQL OPEN cur1 USING DESCRIPTOR sqlda2;
Выберите строки из открытого курсора в выходную SQLDA. (Обычно, чтобы выбрать все строки в наборе результатов, нужно повторять FETCH
в цикле.)
while (1) { sqlda_t *cur_sqlda; /* Назначить дескриптор курсору */ EXEC SQL FETCH NEXT FROM cur1 INTO DESCRIPTOR sqlda1;
Затем прочитайте выбранные записи из SQLDA, следуя по связанному списку структуры sqlda_t
.
for (cur_sqlda = sqlda1 ; cur_sqlda != NULL ; cur_sqlda = cur_sqlda->desc_next) { ...
Прочитайте все столбцы первой записи. Количество столбцов хранится в поле sqld
, а данные первого столбца в sqlvar[0]
, оба эти поля — члены структуры sqlda_t
.
/* Вывести каждый столбец в строке. */ for (i = 0; i < sqlda1->sqld; i++) { sqlvar_t v = sqlda1->sqlvar[i]; char *sqldata = v.sqldata; short sqllen = v.sqllen; strncpy(name_buf, v.sqlname.data, v.sqlname.length); name_buf[v.sqlname.length] = '\0';
Теперь данные столбцов сохранены в переменной v
. Скопируйте все элементы данных в переменные среды, определив тип столбца по полю v.sqltype
.
switch (v.sqltype) { int intval; double doubleval; unsigned long long int longlongval; case ECPGt_char: memset(&var_buf, 0, sizeof(var_buf)); memcpy(&var_buf, sqldata, (sizeof(var_buf) <= sqllen ? sizeof(var_buf)-1 : sqllen)); break; case ECPGt_int: /* integer */ memcpy(&intval, sqldata, sqllen); snprintf(var_buf, sizeof(var_buf), "%d", intval); break; ... default: ... } printf("%s = %s (type: %d)\n", name_buf, var_buf, v.sqltype); }
Закончив обработку всех записей, закройте курсор и отключитесь от базы данных.
EXEC SQL CLOSE cur1; EXEC SQL COMMIT; EXEC SQL DISCONNECT ALL;
Вся программа показана в Примере 35.1.
Пример 35.1. Пример программы на базе SQLDA
#include <stdlib.h> #include <string.h> #include <stdlib.h> #include <stdio.h> #include <unistd.h> EXEC SQL include sqlda.h; sqlda_t *sqlda1; /* дескриптор для выходных данных */ sqlda_t *sqlda2; /* дескриптор для входных данных */ EXEC SQL WHENEVER NOT FOUND DO BREAK; EXEC SQL WHENEVER SQLERROR STOP; int main(void) { EXEC SQL BEGIN DECLARE SECTION; char query[1024] = "SELECT d.oid,* FROM pg_database d, pg_stat_database s WHERE d.oid=s.datid AND ( d.datname=? OR d.oid=? )"; int intval; unsigned long long int longlongval; EXEC SQL END DECLARE SECTION; EXEC SQL CONNECT TO uptimedb AS con1 USER uptime; EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT; EXEC SQL PREPARE stmt1 FROM :query; EXEC SQL DECLARE cur1 CURSOR FOR stmt1; /* Создать структуру SQLDA для входных параметров */ sqlda2 = (sqlda_t *)malloc(sizeof(sqlda_t) + sizeof(sqlvar_t)); memset(sqlda2, 0, sizeof(sqlda_t) + sizeof(sqlvar_t)); sqlda2->sqln = 2; /* число входных переменных */ sqlda2->sqlvar[0].sqltype = ECPGt_char; sqlda2->sqlvar[0].sqldata = "postgres"; sqlda2->sqlvar[0].sqllen = 8; intval = 1; sqlda2->sqlvar[1].sqltype = ECPGt_int; sqlda2->sqlvar[1].sqldata = (char *) &intval; sqlda2->sqlvar[1].sqllen = sizeof(intval); /* Открыть курсор с входными параметрами. */ EXEC SQL OPEN cur1 USING DESCRIPTOR sqlda2; while (1) { sqlda_t *cur_sqlda; /* Присвоить дескриптор курсору */ EXEC SQL FETCH NEXT FROM cur1 INTO DESCRIPTOR sqlda1; for (cur_sqlda = sqlda1 ; cur_sqlda != NULL ; cur_sqlda = cur_sqlda->desc_next) { int i; char name_buf[1024]; char var_buf[1024]; /* Напечатать каждый столбец в строке. */ for (i=0 ; i<cur_sqlda->sqld ; i++) { sqlvar_t v = cur_sqlda->sqlvar[i]; char *sqldata = v.sqldata; short sqllen = v.sqllen; strncpy(name_buf, v.sqlname.data, v.sqlname.length); name_buf[v.sqlname.length] = '\0'; switch (v.sqltype) { case ECPGt_char: memset(&var_buf, 0, sizeof(var_buf)); memcpy(&var_buf, sqldata, (sizeof(var_buf)<=sqllen ? sizeof(var_buf)-1 : sqllen) ); break; case ECPGt_int: /* integer */ memcpy(&intval, sqldata, sqllen); snprintf(var_buf, sizeof(var_buf), "%d", intval); break; case ECPGt_long_long: /* bigint */ memcpy(&longlongval, sqldata, sqllen); snprintf(var_buf, sizeof(var_buf), "%lld", longlongval); break; default: { int i; memset(var_buf, 0, sizeof(var_buf)); for (i = 0; i < sqllen; i++) { char tmpbuf[16]; snprintf(tmpbuf, sizeof(tmpbuf), "%02x ", (unsigned char) sqldata[i]); strncat(var_buf, tmpbuf, sizeof(var_buf)); } } break; } printf("%s = %s (type: %d)\n", name_buf, var_buf, v.sqltype); } printf("\n"); } } EXEC SQL CLOSE cur1; EXEC SQL COMMIT; EXEC SQL DISCONNECT ALL; return 0; }
Вывод этой программы должен быть примерно таким (некоторые числа будут меняться).
oid = 1 (type: 1) datname = template1 (type: 1) datdba = 10 (type: 1) encoding = 0 (type: 5) datistemplate = t (type: 1) datallowconn = t (type: 1) datconnlimit = -1 (type: 5) datlastsysoid = 11510 (type: 1) datfrozenxid = 379 (type: 1) dattablespace = 1663 (type: 1) datconfig = (type: 1) datacl = {=c/uptime,uptime=CTc/uptime} (type: 1) datid = 1 (type: 1) datname = template1 (type: 1) numbackends = 0 (type: 5) xact_commit = 113606 (type: 9) xact_rollback = 0 (type: 9) blks_read = 130 (type: 9) blks_hit = 7341714 (type: 9) tup_returned = 38262679 (type: 9) tup_fetched = 1836281 (type: 9) tup_inserted = 0 (type: 9) tup_updated = 0 (type: 9) tup_deleted = 0 (type: 9) oid = 11511 (type: 1) datname = postgres (type: 1) datdba = 10 (type: 1) encoding = 0 (type: 5) datistemplate = f (type: 1) datallowconn = t (type: 1) datconnlimit = -1 (type: 5) datlastsysoid = 11510 (type: 1) datfrozenxid = 379 (type: 1) dattablespace = 1663 (type: 1) datconfig = (type: 1) datacl = (type: 1) datid = 11511 (type: 1) datname = postgres (type: 1) numbackends = 0 (type: 5) xact_commit = 221069 (type: 9) xact_rollback = 18 (type: 9) blks_read = 1176 (type: 9) blks_hit = 13943750 (type: 9) tup_returned = 77410091 (type: 9) tup_fetched = 3253694 (type: 9) tup_inserted = 0 (type: 9) tup_updated = 0 (type: 9) tup_deleted = 0 (type: 9)
35.7. Using Descriptor Areas
An SQL descriptor area is a more sophisticated method for processing the result of a SELECT
, FETCH
or a DESCRIBE
statement. An SQL descriptor area groups the data of one row of data together with metadata items into one data structure. The metadata is particularly useful when executing dynamic SQL statements, where the nature of the result columns might not be known ahead of time. Postgres Pro provides two ways to use Descriptor Areas: the named SQL Descriptor Areas and the C-structure SQLDAs.
35.7.1. Named SQL Descriptor Areas
A named SQL descriptor area consists of a header, which contains information concerning the entire descriptor, and one or more item descriptor areas, which basically each describe one column in the result row.
Before you can use an SQL descriptor area, you need to allocate one:
EXEC SQL ALLOCATE DESCRIPTOR identifier
;
The identifier serves as the “variable name” of the descriptor area. When you don't need the descriptor anymore, you should deallocate it:
EXEC SQL DEALLOCATE DESCRIPTOR identifier
;
To use a descriptor area, specify it as the storage target in an INTO
clause, instead of listing host variables:
EXEC SQL FETCH NEXT FROM mycursor INTO SQL DESCRIPTOR mydesc;
If the result set is empty, the Descriptor Area will still contain the metadata from the query, i.e., the field names.
For not yet executed prepared queries, the DESCRIBE
statement can be used to get the metadata of the result set:
EXEC SQL BEGIN DECLARE SECTION; char *sql_stmt = "SELECT * FROM table1"; EXEC SQL END DECLARE SECTION; EXEC SQL PREPARE stmt1 FROM :sql_stmt; EXEC SQL DESCRIBE stmt1 INTO SQL DESCRIPTOR mydesc;
Before PostgreSQL 9.0, the SQL
keyword was optional, so using DESCRIPTOR
and SQL DESCRIPTOR
produced named SQL Descriptor Areas. Now it is mandatory, omitting the SQL
keyword produces SQLDA Descriptor Areas, see Section 35.7.2.
In DESCRIBE
and FETCH
statements, the INTO
and USING
keywords can be used to similarly: they produce the result set and the metadata in a Descriptor Area.
Now how do you get the data out of the descriptor area? You can think of the descriptor area as a structure with named fields. To retrieve the value of a field from the header and store it into a host variable, use the following command:
EXEC SQL GET DESCRIPTORname
:hostvar
=field
;
Currently, there is only one header field defined: COUNT
, which tells how many item descriptor areas exist (that is, how many columns are contained in the result). The host variable needs to be of an integer type. To get a field from the item descriptor area, use the following command:
EXEC SQL GET DESCRIPTORname
VALUEnum
:hostvar
=field
;
num
can be a literal integer or a host variable containing an integer. Possible fields are:
CARDINALITY
(integer)number of rows in the result set
DATA
actual data item (therefore, the data type of this field depends on the query)
DATETIME_INTERVAL_CODE
(integer)When
TYPE
is9
,DATETIME_INTERVAL_CODE
will have a value of1
forDATE
,2
forTIME
,3
forTIMESTAMP
,4
forTIME WITH TIME ZONE
, or5
forTIMESTAMP WITH TIME ZONE
.DATETIME_INTERVAL_PRECISION
(integer)not implemented
INDICATOR
(integer)the indicator (indicating a null value or a value truncation)
KEY_MEMBER
(integer)not implemented
LENGTH
(integer)length of the datum in characters
NAME
(string)name of the column
NULLABLE
(integer)not implemented
OCTET_LENGTH
(integer)length of the character representation of the datum in bytes
PRECISION
(integer)precision (for type
numeric
)RETURNED_LENGTH
(integer)length of the datum in characters
RETURNED_OCTET_LENGTH
(integer)length of the character representation of the datum in bytes
SCALE
(integer)scale (for type
numeric
)TYPE
(integer)numeric code of the data type of the column
In EXECUTE
, DECLARE
and OPEN
statements, the effect of the INTO
and USING
keywords are different. A Descriptor Area can also be manually built to provide the input parameters for a query or a cursor and USING SQL DESCRIPTOR
is the way to pass the input parameters into a parameterized query. The statement to build a named SQL Descriptor Area is below: name
EXEC SQL SET DESCRIPTORname
VALUEnum
field
= :hostvar
;
Postgres Pro supports retrieving more that one record in one FETCH
statement and storing the data in host variables in this case assumes that the variable is an array. E.g.:
EXEC SQL BEGIN DECLARE SECTION; int id[5]; EXEC SQL END DECLARE SECTION; EXEC SQL FETCH 5 FROM mycursor INTO SQL DESCRIPTOR mydesc; EXEC SQL GET DESCRIPTOR mydesc VALUE 1 :id = DATA;
35.7.2. SQLDA Descriptor Areas
An SQLDA Descriptor Area is a C language structure which can be also used to get the result set and the metadata of a query. One structure stores one record from the result set.
EXEC SQL include sqlda.h; sqlda_t *mysqlda; EXEC SQL FETCH 3 FROM mycursor INTO DESCRIPTOR mysqlda;
Note that the SQL
keyword is omitted. The paragraphs about the use cases of the INTO
and USING
keywords in Section 35.7.1 also apply here with an addition. In a DESCRIBE
statement the DESCRIPTOR
keyword can be completely omitted if the INTO
keyword is used:
EXEC SQL DESCRIBE prepared_statement INTO mysqlda;
The general flow of a program that uses SQLDA is:
Prepare a query, and declare a cursor for it.
Declare an SQLDA for the result rows.
Declare an SQLDA for the input parameters, and initialize them (memory allocation, parameter settings).
Open a cursor with the input SQLDA.
Fetch rows from the cursor, and store them into an output SQLDA.
Read values from the output SQLDA into the host variables (with conversion if necessary).
Close the cursor.
Free the memory area allocated for the input SQLDA.
35.7.2.1. SQLDA Data Structure
SQLDA uses three data structure types: sqlda_t
, sqlvar_t
, and struct sqlname
.
Tip
Postgres Pro's SQLDA has a similar data structure to the one in IBM DB2 Universal Database, so some technical information on DB2's SQLDA could help understanding Postgres Pro's one better.
35.7.2.1.1. sqlda_t Structure
The structure type sqlda_t
is the type of the actual SQLDA. It holds one record. And two or more sqlda_t
structures can be connected in a linked list with the pointer in the desc_next
field, thus representing an ordered collection of rows. So, when two or more rows are fetched, the application can read them by following the desc_next
pointer in each sqlda_t
node.
The definition of sqlda_t
is:
struct sqlda_struct { char sqldaid[8]; long sqldabc; short sqln; short sqld; struct sqlda_struct *desc_next; struct sqlvar_struct sqlvar[1]; }; typedef struct sqlda_struct sqlda_t;
The meaning of the fields is:
sqldaid
It contains the literal string
"SQLDA "
.sqldabc
It contains the size of the allocated space in bytes.
sqln
It contains the number of input parameters for a parameterized query in case it's passed into
OPEN
,DECLARE
orEXECUTE
statements using theUSING
keyword. In case it's used as output ofSELECT
,EXECUTE
orFETCH
statements, its value is the same assqld
statementsqld
It contains the number of fields in a result set.
desc_next
If the query returns more than one record, multiple linked SQLDA structures are returned, and
desc_next
holds a pointer to the next entry in the list.sqlvar
This is the array of the columns in the result set.
35.7.2.1.2. sqlvar_t Structure
The structure type sqlvar_t
holds a column value and metadata such as type and length. The definition of the type is:
struct sqlvar_struct { short sqltype; short sqllen; char *sqldata; short *sqlind; struct sqlname sqlname; }; typedef struct sqlvar_struct sqlvar_t;
The meaning of the fields is:
sqltype
Contains the type identifier of the field. For values, see
enum ECPGttype
inecpgtype.h
.sqllen
Contains the binary length of the field. e.g., 4 bytes for
ECPGt_int
.sqldata
Points to the data. The format of the data is described in Section 35.4.4.
sqlind
Points to the null indicator. 0 means not null, -1 means null.
sqlname
The name of the field.
35.7.2.1.3. struct sqlname Structure
A struct sqlname
structure holds a column name. It is used as a member of the sqlvar_t
structure. The definition of the structure is:
#define NAMEDATALEN 64 struct sqlname { short length; char data[NAMEDATALEN]; };
The meaning of the fields is:
length
Contains the length of the field name.
data
Contains the actual field name.
35.7.2.2. Retrieving a Result Set Using an SQLDA
The general steps to retrieve a query result set through an SQLDA are:
Declare an
sqlda_t
structure to receive the result set.Execute
FETCH
/EXECUTE
/DESCRIBE
commands to process a query specifying the declared SQLDA.Check the number of records in the result set by looking at
sqln
, a member of thesqlda_t
structure.Get the values of each column from
sqlvar[0]
,sqlvar[1]
, etc., members of thesqlda_t
structure.Go to next row (
sqlda_t
structure) by following thedesc_next
pointer, a member of thesqlda_t
structure.Repeat above as you need.
Here is an example retrieving a result set through an SQLDA.
First, declare a sqlda_t
structure to receive the result set.
sqlda_t *sqlda1;
Next, specify the SQLDA in a command. This is a FETCH
command example.
EXEC SQL FETCH NEXT FROM cur1 INTO DESCRIPTOR sqlda1;
Run a loop following the linked list to retrieve the rows.
sqlda_t *cur_sqlda; for (cur_sqlda = sqlda1; cur_sqlda != NULL; cur_sqlda = cur_sqlda->desc_next) { ... }
Inside the loop, run another loop to retrieve each column data (sqlvar_t
structure) of the row.
for (i = 0; i < cur_sqlda->sqld; i++) { sqlvar_t v = cur_sqlda->sqlvar[i]; char *sqldata = v.sqldata; short sqllen = v.sqllen; ... }
To get a column value, check the sqltype
value, a member of the sqlvar_t
structure. Then, switch to an appropriate way, depending on the column type, to copy data from the sqlvar
field to a host variable.
char var_buf[1024]; switch (v.sqltype) { case ECPGt_char: memset(&var_buf, 0, sizeof(var_buf)); memcpy(&var_buf, sqldata, (sizeof(var_buf) <= sqllen ? sizeof(var_buf) - 1 : sqllen)); break; case ECPGt_int: /* integer */ memcpy(&intval, sqldata, sqllen); snprintf(var_buf, sizeof(var_buf), "%d", intval); break; ... }
35.7.2.3. Passing Query Parameters Using an SQLDA
The general steps to use an SQLDA to pass input parameters to a prepared query are:
Create a prepared query (prepared statement)
Declare an sqlda_t structure as an input SQLDA.
Allocate memory area (as sqlda_t structure) for the input SQLDA.
Set (copy) input values in the allocated memory.
Open a cursor with specifying the input SQLDA.
Here is an example.
First, create a prepared statement.
EXEC SQL BEGIN DECLARE SECTION; char query[1024] = "SELECT d.oid, * FROM pg_database d, pg_stat_database s WHERE d.oid = s.datid AND (d.datname = ? OR d.oid = ?)"; EXEC SQL END DECLARE SECTION; EXEC SQL PREPARE stmt1 FROM :query;
Next, allocate memory for an SQLDA, and set the number of input parameters in sqln
, a member variable of the sqlda_t
structure. When two or more input parameters are required for the prepared query, the application has to allocate additional memory space which is calculated by (nr. of params - 1) * sizeof(sqlvar_t). The example shown here allocates memory space for two input parameters.
sqlda_t *sqlda2; sqlda2 = (sqlda_t *) malloc(sizeof(sqlda_t) + sizeof(sqlvar_t)); memset(sqlda2, 0, sizeof(sqlda_t) + sizeof(sqlvar_t)); sqlda2->sqln = 2; /* number of input variables */
After memory allocation, store the parameter values into the sqlvar[]
array. (This is same array used for retrieving column values when the SQLDA is receiving a result set.) In this example, the input parameters are "postgres"
, having a string type, and 1
, having an integer type.
sqlda2->sqlvar[0].sqltype = ECPGt_char; sqlda2->sqlvar[0].sqldata = "postgres"; sqlda2->sqlvar[0].sqllen = 8; int intval = 1; sqlda2->sqlvar[1].sqltype = ECPGt_int; sqlda2->sqlvar[1].sqldata = (char *) &intval; sqlda2->sqlvar[1].sqllen = sizeof(intval);
By opening a cursor and specifying the SQLDA that was set up beforehand, the input parameters are passed to the prepared statement.
EXEC SQL OPEN cur1 USING DESCRIPTOR sqlda2;
Finally, after using input SQLDAs, the allocated memory space must be freed explicitly, unlike SQLDAs used for receiving query results.
free(sqlda2);
35.7.2.4. A Sample Application Using SQLDA
Here is an example program, which describes how to fetch access statistics of the databases, specified by the input parameters, from the system catalogs.
This application joins two system tables, pg_database and pg_stat_database on the database OID, and also fetches and shows the database statistics which are retrieved by two input parameters (a database postgres
, and OID 1
).
First, declare an SQLDA for input and an SQLDA for output.
EXEC SQL include sqlda.h; sqlda_t *sqlda1; /* an output descriptor */ sqlda_t *sqlda2; /* an input descriptor */
Next, connect to the database, prepare a statement, and declare a cursor for the prepared statement.
int main(void) { EXEC SQL BEGIN DECLARE SECTION; char query[1024] = "SELECT d.oid,* FROM pg_database d, pg_stat_database s WHERE d.oid=s.datid AND ( d.datname=? OR d.oid=? )"; EXEC SQL END DECLARE SECTION; EXEC SQL CONNECT TO testdb AS con1 USER testuser; EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT; EXEC SQL PREPARE stmt1 FROM :query; EXEC SQL DECLARE cur1 CURSOR FOR stmt1;
Next, put some values in the input SQLDA for the input parameters. Allocate memory for the input SQLDA, and set the number of input parameters to sqln
. Store type, value, and value length into sqltype
, sqldata
, and sqllen
in the sqlvar
structure.
/* Create SQLDA structure for input parameters. */ sqlda2 = (sqlda_t *) malloc(sizeof(sqlda_t) + sizeof(sqlvar_t)); memset(sqlda2, 0, sizeof(sqlda_t) + sizeof(sqlvar_t)); sqlda2->sqln = 2; /* number of input variables */ sqlda2->sqlvar[0].sqltype = ECPGt_char; sqlda2->sqlvar[0].sqldata = "postgres"; sqlda2->sqlvar[0].sqllen = 8; intval = 1; sqlda2->sqlvar[1].sqltype = ECPGt_int; sqlda2->sqlvar[1].sqldata = (char *)&intval; sqlda2->sqlvar[1].sqllen = sizeof(intval);
After setting up the input SQLDA, open a cursor with the input SQLDA.
/* Open a cursor with input parameters. */ EXEC SQL OPEN cur1 USING DESCRIPTOR sqlda2;
Fetch rows into the output SQLDA from the opened cursor. (Generally, you have to call FETCH
repeatedly in the loop, to fetch all rows in the result set.)
while (1) { sqlda_t *cur_sqlda; /* Assign descriptor to the cursor */ EXEC SQL FETCH NEXT FROM cur1 INTO DESCRIPTOR sqlda1;
Next, retrieve the fetched records from the SQLDA, by following the linked list of the sqlda_t
structure.
for (cur_sqlda = sqlda1 ; cur_sqlda != NULL ; cur_sqlda = cur_sqlda->desc_next) { ...
Read each columns in the first record. The number of columns is stored in sqld
, the actual data of the first column is stored in sqlvar[0]
, both members of the sqlda_t
structure.
/* Print every column in a row. */ for (i = 0; i < sqlda1->sqld; i++) { sqlvar_t v = sqlda1->sqlvar[i]; char *sqldata = v.sqldata; short sqllen = v.sqllen; strncpy(name_buf, v.sqlname.data, v.sqlname.length); name_buf[v.sqlname.length] = '\0';
Now, the column data is stored in the variable v
. Copy every datum into host variables, looking at v.sqltype
for the type of the column.
switch (v.sqltype) { int intval; double doubleval; unsigned long long int longlongval; case ECPGt_char: memset(&var_buf, 0, sizeof(var_buf)); memcpy(&var_buf, sqldata, (sizeof(var_buf) <= sqllen ? sizeof(var_buf)-1 : sqllen)); break; case ECPGt_int: /* integer */ memcpy(&intval, sqldata, sqllen); snprintf(var_buf, sizeof(var_buf), "%d", intval); break; ... default: ... } printf("%s = %s (type: %d)\n", name_buf, var_buf, v.sqltype); }
Close the cursor after processing all of records, and disconnect from the database.
EXEC SQL CLOSE cur1; EXEC SQL COMMIT; EXEC SQL DISCONNECT ALL;
The whole program is shown in Example 35.1.
Example 35.1. Example SQLDA Program
#include <stdlib.h> #include <string.h> #include <stdlib.h> #include <stdio.h> #include <unistd.h> EXEC SQL include sqlda.h; sqlda_t *sqlda1; /* descriptor for output */ sqlda_t *sqlda2; /* descriptor for input */ EXEC SQL WHENEVER NOT FOUND DO BREAK; EXEC SQL WHENEVER SQLERROR STOP; int main(void) { EXEC SQL BEGIN DECLARE SECTION; char query[1024] = "SELECT d.oid,* FROM pg_database d, pg_stat_database s WHERE d.oid=s.datid AND ( d.datname=? OR d.oid=? )"; int intval; unsigned long long int longlongval; EXEC SQL END DECLARE SECTION; EXEC SQL CONNECT TO uptimedb AS con1 USER uptime; EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT; EXEC SQL PREPARE stmt1 FROM :query; EXEC SQL DECLARE cur1 CURSOR FOR stmt1; /* Create an SQLDA structure for an input parameter */ sqlda2 = (sqlda_t *)malloc(sizeof(sqlda_t) + sizeof(sqlvar_t)); memset(sqlda2, 0, sizeof(sqlda_t) + sizeof(sqlvar_t)); sqlda2->sqln = 2; /* a number of input variables */ sqlda2->sqlvar[0].sqltype = ECPGt_char; sqlda2->sqlvar[0].sqldata = "postgres"; sqlda2->sqlvar[0].sqllen = 8; intval = 1; sqlda2->sqlvar[1].sqltype = ECPGt_int; sqlda2->sqlvar[1].sqldata = (char *) &intval; sqlda2->sqlvar[1].sqllen = sizeof(intval); /* Open a cursor with input parameters. */ EXEC SQL OPEN cur1 USING DESCRIPTOR sqlda2; while (1) { sqlda_t *cur_sqlda; /* Assign descriptor to the cursor */ EXEC SQL FETCH NEXT FROM cur1 INTO DESCRIPTOR sqlda1; for (cur_sqlda = sqlda1 ; cur_sqlda != NULL ; cur_sqlda = cur_sqlda->desc_next) { int i; char name_buf[1024]; char var_buf[1024]; /* Print every column in a row. */ for (i=0 ; i<cur_sqlda->sqld ; i++) { sqlvar_t v = cur_sqlda->sqlvar[i]; char *sqldata = v.sqldata; short sqllen = v.sqllen; strncpy(name_buf, v.sqlname.data, v.sqlname.length); name_buf[v.sqlname.length] = '\0'; switch (v.sqltype) { case ECPGt_char: memset(&var_buf, 0, sizeof(var_buf)); memcpy(&var_buf, sqldata, (sizeof(var_buf)<=sqllen ? sizeof(var_buf)-1 : sqllen) ); break; case ECPGt_int: /* integer */ memcpy(&intval, sqldata, sqllen); snprintf(var_buf, sizeof(var_buf), "%d", intval); break; case ECPGt_long_long: /* bigint */ memcpy(&longlongval, sqldata, sqllen); snprintf(var_buf, sizeof(var_buf), "%lld", longlongval); break; default: { int i; memset(var_buf, 0, sizeof(var_buf)); for (i = 0; i < sqllen; i++) { char tmpbuf[16]; snprintf(tmpbuf, sizeof(tmpbuf), "%02x ", (unsigned char) sqldata[i]); strncat(var_buf, tmpbuf, sizeof(var_buf)); } } break; } printf("%s = %s (type: %d)\n", name_buf, var_buf, v.sqltype); } printf("\n"); } } EXEC SQL CLOSE cur1; EXEC SQL COMMIT; EXEC SQL DISCONNECT ALL; return 0; }
The output of this example should look something like the following (some numbers will vary).
oid = 1 (type: 1) datname = template1 (type: 1) datdba = 10 (type: 1) encoding = 0 (type: 5) datistemplate = t (type: 1) datallowconn = t (type: 1) datconnlimit = -1 (type: 5) datlastsysoid = 11510 (type: 1) datfrozenxid = 379 (type: 1) dattablespace = 1663 (type: 1) datconfig = (type: 1) datacl = {=c/uptime,uptime=CTc/uptime} (type: 1) datid = 1 (type: 1) datname = template1 (type: 1) numbackends = 0 (type: 5) xact_commit = 113606 (type: 9) xact_rollback = 0 (type: 9) blks_read = 130 (type: 9) blks_hit = 7341714 (type: 9) tup_returned = 38262679 (type: 9) tup_fetched = 1836281 (type: 9) tup_inserted = 0 (type: 9) tup_updated = 0 (type: 9) tup_deleted = 0 (type: 9) oid = 11511 (type: 1) datname = postgres (type: 1) datdba = 10 (type: 1) encoding = 0 (type: 5) datistemplate = f (type: 1) datallowconn = t (type: 1) datconnlimit = -1 (type: 5) datlastsysoid = 11510 (type: 1) datfrozenxid = 379 (type: 1) dattablespace = 1663 (type: 1) datconfig = (type: 1) datacl = (type: 1) datid = 11511 (type: 1) datname = postgres (type: 1) numbackends = 0 (type: 5) xact_commit = 221069 (type: 9) xact_rollback = 18 (type: 9) blks_read = 1176 (type: 9) blks_hit = 13943750 (type: 9) tup_returned = 77410091 (type: 9) tup_fetched = 3253694 (type: 9) tup_inserted = 0 (type: 9) tup_updated = 0 (type: 9) tup_deleted = 0 (type: 9)