SELECT
SELECT, TABLE, WITH — получить строки из таблицы или представления
Синтаксис
[ WITH [ RECURSIVE ]запрос_WITH
[, ...] ] SELECT [ ALL | DISTINCT [ ON (выражение
[, ...] ) ] ] [ * |выражение
[ [ AS ]имя_результата
] [, ...] ] [ FROMэлемент_FROM
[, ...] ] [ WHEREусловие
] [ GROUP BYэлемент_группирования
[, ...] ] [ HAVINGусловие
] [ WINDOWимя_окна
AS (определение_окна
) [, ...] ] [ { UNION | INTERSECT | EXCEPT } [ ALL | DISTINCT ]выборка
] [ ORDER BYвыражение
[ ASC | DESC | USINGоператор
] [ NULLS { FIRST | LAST } ] [, ...] ] [ LIMIT {число
| ALL } ] [ OFFSETначало
[ ROW | ROWS ] ] [ FETCH { FIRST | NEXT } [число
] { ROW | ROWS } ONLY ] [ FOR { UPDATE | NO KEY UPDATE | SHARE | KEY SHARE } [ OFимя_таблицы
[, ...] ] [ NOWAIT | SKIP LOCKED ] [...] ] Здесь допускаетсяэлемент_FROM
: [ ONLY ]имя_таблицы
[ * ] [ [ AS ]псевдоним
[ (псевдоним_столбца
[, ...] ) ] ] [ TABLESAMPLEметод_выборки
(аргумент
[, ...] ) [ REPEATABLE (затравка
) ] ] [ LATERAL ] (выборка
) [ AS ]псевдоним
[ (псевдоним_столбца
[, ...] ) ]имя_запроса_WITH
[ [ AS ]псевдоним
[ (псевдоним_столбца
[, ...] ) ] ] [ LATERAL ]имя_функции
( [аргумент
[, ...] ] ) [ WITH ORDINALITY ] [ [ AS ]псевдоним
[ (псевдоним_столбца
[, ...] ) ] ] [ LATERAL ]имя_функции
( [аргумент
[, ...] ] ) [ AS ]псевдоним
(определение_столбца
[, ...] ) [ LATERAL ]имя_функции
( [аргумент
[, ...] ] ) AS (определение_столбца
[, ...] ) [ LATERAL ] ROWS FROM(имя_функции
( [аргумент
[, ...] ] ) [ AS (определение_столбца
[, ...] ) ] [, ...] ) [ WITH ORDINALITY ] [ [ AS ]псевдоним
[ (псевдоним_столбца
[, ...] ) ] ]элемент_FROM
тип_соединения
элемент_FROM
{ ONусловие_соединения
| USING (столбец_соединения
[, ...] ) }элемент_FROM
NATURALтип_соединения
элемент_FROM
элемент_FROM
CROSS JOINэлемент_FROM
иэлемент_группирования
может быть следующим: ( )выражение
(выражение
[, ...] ) ROLLUP ( {выражение
| (выражение
[, ...] ) } [, ...] ) CUBE ( {выражение
| (выражение
[, ...] ) } [, ...] ) GROUPING SETS (элемент_группирования
[, ...] ) изапрос_WITH
:имя_запроса_WITH
[ (имя_столбца
[, ...] ) ] AS (выборка
|values
|insert
|update
|delete
) TABLE [ ONLY ]имя_таблицы
[ * ]
Описание
SELECT
получает строки из множества таблиц (возможно, пустого). Общая процедура выполнения SELECT
следующая:
Выполняются все запросы в списке
WITH
. По сути они формируют временные таблицы, к которым затем можно обращаться в спискеFROM
. Запрос вWITH
выполняется только один раз, даже если он фигурирует в спискеFROM
неоднократно. (См. ПредложениеWITH
ниже.)Вычисляются все элементы в списке
FROM
. (Каждый элемент в спискеFROM
представляет собой реальную или виртуальную таблицу.) Если списокFROM
содержит несколько элементов, они объединяются перекрёстным соединением. (См. ПредложениеFROM
ниже.)Если указано предложение
WHERE
, все строки, не удовлетворяющие условию, исключаются из результата. (См. ПредложениеWHERE
ниже.)Если присутствует указание
GROUP BY
, либо в запросе вызываются агрегатные функции, вывод разделяется по группам строк, соответствующим одному или нескольким значениям, а затем вычисляются результаты агрегатных функций. Если добавлено предложениеHAVING
, оно исключает группы, не удовлетворяющие заданному условию. (См. Подраздел «ПредложениеGROUP BY
» и Подраздел «ПредложениеHAVING
» ниже.) Хотя столбцы вывода запроса номинально вычисляются на следующем шаге, на них также можно ссылаться (по имени или порядковому номеру) в предложенииGROUP BY
.Вычисляются фактические выходные строки по заданным в
SELECT
выражениям для каждой выбранной строки или группы строк. (См. СписокSELECT
ниже.)SELECT DISTINCT
исключает из результата повторяющиеся строки.SELECT DISTINCT ON
исключает строки, совпадающие по всем указанным выражениям.SELECT ALL
(по умолчанию) возвращает все строки результата, включая дубликаты. (См. ПредложениеDISTINCT
ниже.)Операторы
UNION
,INTERSECT
иEXCEPT
объединяют вывод нескольких командSELECT
в один результирующий набор. ОператорUNION
возвращает все строки, представленные в одном, либо обоих наборах результатов. ОператорINTERSECT
возвращает все строки, представленные строго в обоих наборах. ОператорEXCEPT
возвращает все строки, представленные в первом наборе, но не во втором. Во всех трёх случаях повторяющиеся строки исключаются из результата, если явно не указаноALL
. Чтобы явно обозначить, что выдаваться должны только неповторяющиеся строки, можно добавить избыточное словоDISTINCT
. Заметьте, что в данном контексте по умолчанию подразумеваетсяDISTINCT
, хотя в самомSELECT
по умолчанию подразумеваетсяALL
. (См. ПредложениеUNION
+, ПредложениеINTERSECT
и ПредложениеEXCEPT
ниже.)Если присутствует предложение
ORDER BY
, возвращаемые строки сортируются в указанном порядке. В отсутствиеORDER BY
строки возвращаются в том порядке, в каком системе будет проще их выдать. (См. ПредложениеORDER BY
ниже.)Если указано предложение
LIMIT
(илиFETCH FIRST
) либоOFFSET
, операторSELECT
возвращает только подмножество строк результата. (См. ПредложениеLIMIT
ниже.)Если указано
FOR UPDATE
,FOR NO KEY UPDATE
,FOR SHARE
илиFOR KEY SHARE
, операторSELECT
блокирует выбранные строки, защищая их от одновременных изменений. (См. Предложение блокировки ниже.)
Для всех столбцов, задействованных в команде SELECT
, необходимо иметь право SELECT
. Применение блокировок FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
или FOR KEY SHARE
требует также права UPDATE
(как минимум для одного столбца в каждой выбранной для блокировки таблице).
Параметры
Предложение WITH
Предложение WITH
позволяет задать один или несколько подзапросов, к которым затем можно обратиться по имени в основном запросе. Эти подзапросы по сути действуют как временные таблицы или представления в процессе выполнения главного запроса. Каждый подзапрос может представлять собой оператор SELECT
, TABLE
, VALUES
, INSERT
, UPDATE
или DELETE
. При использовании в WITH
оператора, изменяющего данные, (INSERT
, UPDATE
или DELETE
) обычно добавляется предложение RETURNING
. Заметьте, что именно результат RETURNING
, а не нижележащая таблица, изменяемая запросом, формирует временную таблицу, которую затем читает основной запрос. Если RETURNING
опущено, оператор тем не менее выполняется, но не выдаёт никакого результата, так что на него нельзя сослаться как на таблицу в основном запросе.
Имя (без схемы) должно быть указано для каждого запроса WITH
. Также можно задать необязательный список с именами столбцов; если он опущен, имена столбцов формируются из результата подзапроса.
Если указано RECURSIVE
, подзапрос SELECT
может ссылаться сам на себя по имени. Такой подзапрос должен иметь форму
нерекурсивная_часть
UNION [ ALL | DISTINCT ]рекурсивная_часть
, где рекурсивная ссылка на сам запрос может находиться только справа от UNION
. Для одного запроса допускается только одна рекурсивная ссылка на него же. Операторы, изменяющие данные, не могут быть рекурсивными, но результат рекурсивного запроса SELECT
в таких операторах можно использовать. За примером обратитесь к Разделу 7.8.
Ещё одна особенность RECURSIVE
в том, что запросы WITH
могут быть неупорядоченными: запрос может ссылаться на другой, идущий в списке после него. (Однако циклические ссылки или взаимная рекурсия не поддерживаются.) Без RECURSIVE
запрос в WITH
может ссылаться только на запросы того же уровня в WITH
, предшествующие ему в списке WITH
.
Ключевое свойство запросов WITH
состоит в том, что они вычисляются один раз для всего основного запроса, даже если в основном запросе содержатся несколько ссылок на них. В частности, гарантируется, что операторы, изменяющие данные, будут выполняться ровно один раз, вне зависимости от того, будет ли их результат прочитан основным запросом и в каком объёме.
Когда в предложении WITH
задаются несколько запросов, RECURSIVE
следует указывать только единожды, сразу после WITH
. Это указание будет действовать на все запросы в предложении WITH
, хотя оно никак не скажется на запросах, не использующих рекурсию или ссылки на последующие запросы.
Основной запрос и все запросы WITH
, условно говоря, выполняются одновременно. Это значит, что действие оператора, изменяющего данные в WITH
, не будут видеть другие части запроса, кроме как прочитав его вывод RETURNING
. Если два таких оператора попытаются изменить одну строку, результат будет неопределённым.
За дополнительными сведениями обратитесь к Разделу 7.8.
Предложение FROM
В предложении FROM
перечисляются одна или несколько таблиц, служащих источниками данных для SELECT
. Если указано несколько источников, результатом будет декартово произведение (перекрёстное соединение) всех их строк. Но обычно в запрос добавляются уточняющие условия (в предложении WHERE
), которые ограничивают набор строк небольшим подмножеством этого произведения.
Предложение FROM
может содержать следующие элементы:
имя_таблицы
Имя (возможно, дополненное схемой) существующей таблицы или представления. Если перед именем таблицы указано
ONLY
, считывается только заданная таблица. БезONLY
считывается и заданная таблица, и все её потомки (если таковые есть). После имени таблицы можно также добавить необязательное указание*
, чтобы явно обозначить, что блокировка затрагивает и все дочерние таблицы.псевдоним
Альтернативное имя для элемента списка
FROM
. Этот псевдоним используется для краткости или для исключения неоднозначности с замкнутыми соединениями (когда одна таблица читается неоднократно). Когда задаётся псевдоним, он полностью скрывает настоящее имя таблицы или функции; например, при записиFROM foo AS f
, в продолжении запросаSELECT
к этому элементуFROM
нужно обращаться по имениf
, а неfoo
. Если задан псевдоним таблицы, за ним можно также написать список псевдонимов столбцов, который определит альтернативные имена для столбцов таблицы.TABLESAMPLE
метод_выборки
(аргумент
[, ...] ) [ REPEATABLE (затравка
) ]Предложение
TABLESAMPLE
, сопровождающееимя_таблицы
, показывает, что для получения подмножества строк в этой таблице должен применяться указанныйметод_выборки
. Эта выборка предшествует применению любых других фильтров, например, в предложенииWHERE
. В стандартный дистрибутив Postgres Pro включены два метода выборки,BERNOULLI
иSYSTEM
; другие методы выборки можно установить в базу данных через расширения.Методы выборки
BERNOULLI
иSYSTEM
принимают единственныйаргумент
, определяющий, какой процент таблицы должен попасть в выборку, от 0 до 100. Этот аргумент может задаваться любым выражением со значением типаreal
. (Другие методы выборки могут принимать дополнительные или другие параметры.) Оба этих метода возвращают случайную выборку таблицы, содержащую примерно указанный процент строк таблицы. МетодBERNOULLI
сканирует всю таблицу и выбирает или игнорирует отдельные строки независимо, с заданной вероятностью. МетодSYSTEM
строит выборку на уровне блоков, определяя для каждого блока шанс его задействовать, и возвращает все строки из каждого задействуемого блока. МетодSYSTEM
работает значительно быстрееBERNOULLI
, когда выбирается небольшой процент строк, но он может выдавать менее случайную выборку таблицы из-за эффектов кучности.В необязательном предложении
REPEATABLE
задаётсязатравка
— число или выражение, задающее отправное значение для генератора случайных чисел в методе выборки. Значением затравки может быть любое отличное от NULL число с плавающей точкой. Два запроса, в которых указаны одинаковые значения затравки иаргумента
, выдадут одну и ту же выборку таблицы при условии неизменности содержимого таблицы. Но с разными значениями затравки выборки обычно получаются разными. В отсутствие предложенияREPEATABLE
для каждого запроса выдаётся новая случайная выборка, в зависимости от затравки, сгенерированной системой. Заметьте, что некоторые дополнительные методы выборки не принимают предложениеREPEATABLE
и выдают разные выборки при каждом использовании.выборка
Предложение
FROM
может содержать вложенный запросSELECT
. Можно считать, что из его результата создаётся временная таблица на время выполнения основной командыSELECT
. Заметьте, что вложенный запросSELECT
должен заключаться в скобки и для него должен задаваться псевдоним. Здесь также можно использовать команду VALUES.имя_запроса_WITH
На запрос
WITH
можно ссылаться по имени, как если бы имя запроса представляло имя таблицы. (На самом деле запросWITH
скрывает любую реальную таблицу с тем же именем для основного запроса. Если необходимо обратиться к одноимённой реальной таблице, можно дополнить имя этой таблицы именем схемы.) Для этого имени можно задать псевдоним, так же, как и для имени таблицы.имя_функции
В предложении
FROM
могут содержаться вызовы функций. (Это особенно полезно для функций, возвращающих множества, но в принципе можно использовать любые функции.) Можно считать, что из результата функции создаётся временная таблица на время выполнения основной командыSELECT
. Если вызов функции сопровождается необязательным предложениемWITH ORDINALITY
, после всех выдаваемых функцией столбцов в вывод добавляется ещё один столбец с номерами строк.Псевдоним для функции можно задать так же, как и для таблицы. Если этот псевдоним задан, за ним можно также написать список псевдонимов столбцов, который определит альтернативные имена для атрибутов составного типа результата функции, включая имя столбца, который может быть добавлен предложением
ORDINALITY
.Несколько вызовов функций можно объединить в одном элементе предложения
FROM
, заключив их в конструкциюROWS FROM( ... )
. Выводом такого элемента будет соединение первых строк всех функций, затем вторых строк и т. д. Если одни функции выдают меньше строк, чем другие, недостающие данные заменяются значениями NULL, так что общее число возвращаемых строк всегда будет равняться максимальному числу строк из возвращённых всеми функциями.Если функция определена как возвращающая тип данных
record
, для неё нужно указать псевдоним или ключевое словоAS
, за которым должен идти список определений столбцов в форме(
. Список определений столбцов должен соответствовать фактическому количеству и типу столбцов, возвращаемых функцией.имя_столбца
тип_данных
[, ... ])Если при использовании синтаксиса
ROWS FROM( ... )
одна из функций требует наличия списка определений столбцов, этот список лучше разместить после вызова функции внутриROWS FROM( ... )
. Список определений столбцов можно поместить после конструкцииROWS FROM( ... )
, только если вызывается всего одна функция, а предложениеWITH ORDINALITY
отсутствует.Чтобы использовать
ORDINALITY
со списком определений столбцов, необходимо применить записьROWS FROM( ... )
и поместить список с определениями столбцов внутрьROWS FROM( ... )
.тип_соединения
Один из следующих вариантов:
[ INNER ] JOIN
LEFT [ OUTER ] JOIN
RIGHT [ OUTER ] JOIN
FULL [ OUTER ] JOIN
Для типов соединений
INNER
иOUTER
необходимо указать условие соединения, а именно одно из предложенийON
,условие_соединения
USING (
, илистолбец_соединения
[, ...])NATURAL
. Эти предложения описываются ниже.Предложение
JOIN
объединяет два элемента спискаFROM
, которые мы для простоты дальше будем называть «таблицами», хотя на самом деле это может быть любой объект, допустимый в качестве элементаFROM
. Для определения порядка вложенности при необходимости следует использовать скобки. В отсутствие скобок предложенияJOIN
обрабатывается слева направо. В любом случаеJOIN
связывает элементы сильнее, чем запятые, разделяющие элементы в спискеFROM
. Все возможностиJOIN
существуют просто для удобства записи, они не дают ничего такого, чего нельзя было бы получить, применяя обычные предложенияFROM
иWHERE
.LEFT OUTER JOIN
возвращает все строки ограниченного декартова произведения (т. е. все объединённые строки, удовлетворяющие условию соединения) плюс все строки в таблице слева, для которых не находится строк в таблице справа, удовлетворяющих условию. Строка, взятая из таблицы слева, дополняется до полной ширины объединённой таблицы значениями NULL в столбцах таблицы справа. Заметьте, что для определения, какие строки двух таблиц соответствуют друг другу, проверяется только условие самого предложенияJOIN
. Внешние условия проверяются позже.RIGHT OUTER JOIN
, напротив, возвращает все соединённые строки плюс одну строку для каждой строки справа, не имеющей соответствия слева (эта строка дополняется значениями NULL влево). Это предложение введено исключительно для удобства записи, так как его можно легко свести кLEFT OUTER JOIN
, поменяв левую и правую таблицы местами.FULL OUTER JOIN
возвращает все соединённые строки плюс все строки слева, не имеющие соответствия справа, (дополненные значениями NULL вправо) плюс все строки справа, не имеющие соответствия слева (дополненные значениями NULL влево).ON
условие_соединения
Задаваемое
условие_соединения
представляет собой выражение, выдающее значение типаboolean
(как в предложенииWHERE
), которое определяет, какие строки считаются соответствующими при соединении.USING (
столбец_соединения
[, ...] )Предложение вида
USING ( a, b, ... )
представляет собой сокращённую форму записиON таблица_слева.a = таблица_справа.a AND таблица_слева.b = таблица_справа.b ...
. Кроме того,USING
подразумевает, что в результат соединения будет включён только один из пары равных столбцов, но не оба.NATURAL
NATURAL
представляет собой краткую записьUSING
со списком, в котором перечисляются все столбцы двух таблиц, имеющие одинаковые имена. Если одинаковых имён нет, указаниеNATURAL
равнозначноON TRUE
.CROSS JOIN
Предложение
CROSS JOIN
равнозначноINNER JOIN ON (TRUE)
, то есть с ним никакие строки по условию не удаляются. Оба эти предложения формируют простое декартово произведение — тот же результат получится, если указать две таблицы на верхнем уровнеFROM
и добавить в качестве ограничения условие соединения (если оно есть).LATERAL
Ключевое слово
LATERAL
может предварять вложенный запросSELECT
в спискеFROM
. Оно позволяет обращаться в этом вложенномSELECT
к столбцам элементовFROM
, предшествующим ему в спискеFROM
. (БезLATERAL
все вложенные подзапросыSELECT
обрабатываются независимо и не могут ссылаться на другие элементы спискаFROM
.)Слово
LATERAL
можно также добавить перед вызовом функции в спискеFROM
, но в этом случае оно будет избыточным, так как выражения с функциями могут ссылаться на предыдущие элементы спискаFROM
в любом случае.Элемент
LATERAL
может находиться на верхнем уровне спискаFROM
или в деревеJOIN
. В последнем случае он может также ссылаться на любые элементы в левой частиJOIN
, справа от которого он находится.Когда элемент
FROM
содержит ссылкиLATERAL
, запрос выполняется следующим образом: сначала для строки элементаFROM
с целевыми столбцами, или набора строк из нескольких элементовFROM
, содержащих целевые столбцы, вычисляется элементLATERAL
со значениями этих столбцов. Затем результирующие строки обычным образом соединяются со строками, из которых они были вычислены. Эта процедура повторяется для всех строк исходных таблиц.Таблица, служащая источником столбцов, должна быть связана с элементом
LATERAL
соединениемINNER
илиLEFT
, в противном случае не образуется однозначно определяемый набор строк, из которого можно будет получать наборы строк для элементаLATERAL
. Таким образом, хотя конструкция
синтаксически правильная,X
RIGHT JOIN LATERALY
Y
в ней не может обращаться кX
.
Предложение WHERE
Необязательное предложение WHERE
имеет общую форму
WHERE условие
, где условие
— любое выражение, выдающее результат типа boolean
. Любая строка, не удовлетворяющая этому условию, исключается из результата. Строка удовлетворяет условию, если оно возвращает true при подстановке вместо ссылок на переменные фактических значений из этой строки.
Предложение GROUP BY
Необязательное предложение GROUP BY
имеет общую форму
GROUP BY элемент_группирования
[, ...]
GROUP BY
собирает в одну строку все выбранные строки, выдающие одинаковые значения для выражений группировки. В качестве выражения
внутри элемента_группирования
может выступать имя входного столбца, либо имя или порядковый номер выходного столбца (из списка элементов SELECT
), либо произвольное значение, вычисляемое по значениям входных столбцов. В случае неоднозначности имя в GROUP BY
будет восприниматься как имя входного, а не выходного столбца.
Если в элементе группирования задаётся GROUPING SETS
, ROLLUP
или CUBE
, предложение GROUP BY
в целом определяет некоторое число независимых наборов группирования
. Это даёт тот же эффект, что и объединение подзапросов (с UNION ALL
) с отдельными наборами группирования в их предложениях GROUP BY
. Подробнее использование наборов группирования описывается в Подразделе 7.2.4.
Агрегатные функции, если они используются, вычисляются по всем строкам, составляющим каждую группу, и в итоге выдают отдельное значение для каждой группы. (Если агрегатные функции используются без предложения GROUP BY
, запрос выполняется как с одной группой, включающей все выбранные строки.) Набор строк, поступающих в каждую агрегатную функцию, можно дополнительно отфильтровать, добавив предложение FILTER
к вызову агрегатной функции; за дополнительными сведениями обратитесь к Подразделу 4.2.7. С предложением FILTER
на вход агрегатной функции поступают только те строки, которые соответствуют заданному фильтру.
Когда в запросе присутствует предложение GROUP BY
или какая-либо агрегатная функция, выражения в списке SELECT
не могут обращаться к негруппируемым столбцам, кроме как в агрегатных функциях или в случае функциональной зависимости, так как иначе в негруппируемом столбце нужно было бы вернуть более одного возможного значения. Функциональная зависимость образуется, если группируемые столбцы (или их подмножество) составляют первичный ключ таблицы, содержащей негруппируемый столбец.
Имейте в виду, что все агрегатные функции вычисляются перед «скалярными» выражениями в предложении HAVING
или списке SELECT
. Это значит, что например, с помощью выражения CASE
нельзя обойти вычисление агрегатной функции; см. Подраздел 4.2.14.
В настоящее время указания FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
нельзя задать вместе с GROUP BY
.
Предложение HAVING
Необязательное предложение HAVING
имеет общую форму
HAVING условие
Здесь условие
задаётся так же, как и для предложения WHERE
.
HAVING
исключает из результата строки групп, не удовлетворяющих условию. HAVING
отличается от WHERE
: WHERE
фильтрует отдельные строки до применения GROUP BY
, а HAVING
фильтрует строки групп, созданных предложением GROUP BY
. Каждый столбец, фигурирующий в условии
, должен однозначно ссылаться на группируемый столбец, за исключением случаев, когда эта ссылка находится внутри агрегатной функции или негруппируемый столбец функционально зависит от группируемых.
В присутствие HAVING
запрос превращается в группируемый, даже если GROUP BY
отсутствует. То же самое происходит, когда запрос содержит агрегатные функции, но не предложение GROUP BY
. Все выбранные строки считаются формирующими одну группу, а в списке SELECT
и предложении HAVING
можно обращаться к столбцам таблицы только из агрегатных функций. Такой запрос будет выдавать единственную строку, если результат условия HAVING
— true, и ноль строк в противном случае.
В настоящее время указания FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
нельзя задать вместе с HAVING
.
Предложение WINDOW
Необязательное предложение WINDOW
имеет общую форму
WINDOWимя_окна
AS (определение_окна
) [, ...]
Здесь имя_окна
— это имя, на которое можно ссылаться из предложений OVER
или последующих определений окон, а определение_окна
имеет следующий вид:
[имя_существующего_окна
] [ PARTITION BYвыражение
[, ...] ] [ ORDER BYвыражение
[ ASC | DESC | USINGоператор
] [ NULLS { FIRST | LAST } ] [, ...] ] [предложение_рамки
]
Если указано имя_существующего_окна
, оно должно ссылаться на предшествующую запись в списке WINDOW
; новое окно копирует предложение разбиения из этой записи, а также предложение сортировки, если оно присутствует. В этом случае для нового окна нельзя задать собственное предложение PARTITION BY
, а ORDER BY
можно указать, только если его не было у копируемого окна. Новое окно всегда использует собственное предложение рамки; в копируемом окне оно задаваться не должно.
Элементы списка PARTITION BY
интерпретируется во многом так же, как и элементы Предложение GROUP BY
, за исключением того, что это всегда простые выражения, но не имя или номер выходного столбца. Другое различие состоит в том, что эти выражения могут содержать вызовы агрегатных функций, которые не допускаются в обычном предложении GROUP BY
. Здесь они допускаются потому, что формирование окна происходит после группировки и агрегирования.
Подобным образом, элементы списка ORDER BY
интерпретируются во многом так же, как и элементы Предложение ORDER BY
, за исключением того, что выражения в нём всегда принимаются как простые выражения, но не как имя или номер выходного столбца.
Необязательное предложение_рамки
определяет рамку окна для оконных функций, которые зависят от рамки (не все функции таковы). Рамка окна — это набор связанных строк для каждой строки запроса (называемой текущей строкой). В качестве предложения_рамки
может задаваться
{ RANGE | ROWS | GROUPS }начало_рамки
[исключение_рамки
] { RANGE | ROWS | GROUPS } BETWEENначало_рамки
ANDконец_рамки
[исключение_рамки
]
Здесь начало_рамки
и конец_рамки
может задаваться как
UNBOUNDED PRECEDINGсмещение
PRECEDING CURRENT ROWсмещение
FOLLOWING UNBOUNDED FOLLOWING
и исключение_рамки
может быть таким:
EXCLUDE CURRENT ROW EXCLUDE GROUP EXCLUDE TIES EXCLUDE NO OTHERS
Если конец_рамки
опущен, по умолчанию подразумевается CURRENT ROW
. В качестве начала_рамки
нельзя задать UNBOUNDED FOLLOWING
, в качестве конца_рамки
не допускается UNBOUNDED PRECEDING
, и конец_рамки
не может идти в показанном выше списке указаний начало_рамки
AND конец_рамки
перед началом_рамки
— например, синтаксис RANGE BETWEEN CURRENT ROW AND
не допускается.смещение
PRECEDING
По умолчанию рамка образуется предложением RANGE UNBOUNDED PRECEDING
, что по сути то же, что RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW
; оно устанавливает рамку так, что она включает все строки от начала раздела до последней строки, родственной текущей (строки, которые согласно указанному для окна предложению ORDER BY
считаются равными текущей; если ORDER BY
отсутствует, все строки считаются родственными). Вообще UNBOUNDED PRECEDING
означает, что рамка начинается с первой строки раздела, а UNBOUNDED FOLLOWING
означает, что рамка заканчивается на последней строке раздела, независимо от режима RANGE
, ROWS
или GROUPS
. В режиме ROWS
указание CURRENT ROW
означает, что рамка начинается или заканчивается текущей строкой; но в режиме RANGE
или GROUPS
оно означает, что рамка начинается или заканчивается первой или последней строкой, родственной текущей, согласно порядку ORDER BY
. Варианты смещение
PRECEDING
и смещение
FOLLOWING
означают разное в зависимости от режима рамки. В режиме ROWS
целочисленное смещение
определяет сдвиг, с которым начало рамки позиционируется перед текущей строкой, а конец рамки — после текущей строки. В режиме GROUPS
целочисленное смещение
аналогичным образом определяет сдвиг относительно группы строк, родственных текущей, где группа родственных строк — группа строк, считающихся равными согласно предложению ORDER BY
для данного окна. В режиме RANGE
для указания смещения
необходимо присутствие в определении окна ровно одного столбца ORDER BY
. Тогда рамка будет содержать те строки, в которых значение упорядочивающего столбца не более чем на смещение
меньше (для PRECEDING
) или больше (для FOLLOWING
) значения упорядочивающего столбца в текущей строке. В этом случае тип данных выражения смещение
зависит от типа данных упорядочивающего столбца. Для числовых столбцов это обычно тот же числовой тип, а для столбцов с типом дата/время — тип interval
. Во всех этих случаях значение смещения
должно быть отличным от NULL и неотрицательным. Кроме того, хотя смещение
не обязательно должно быть простой константой, оно не может содержать переменные, агрегатные или оконные функции.
Дополнение исключение_рамки
позволяет исключить из рамки строки, которые окружают текущую строку, даже если они должны быть включены согласно указаниям, определяющим начало и конец рамки. EXCLUDE CURRENT ROW
исключает из рамки текущую строку. EXCLUDE GROUP
исключает из рамки текущую строку и родственные ей согласно порядку сортировки. EXCLUDE TIES
исключает из рамки все родственные строки для текущей, но не собственно текущую строку. EXCLUDE NO OTHERS
просто явно выражает поведение по умолчанию — не исключает ни текущую строку, ни родственные ей.
Учтите, что в режиме ROWS
могут выдаваться непредсказуемые результаты, если согласно порядку, заданному в ORDER BY
, строки сортируются неоднозначно. Режимы RANGE
и GROUPS
предусмотрены для того, чтобы строки, являющиеся родственными в порядке ORDER BY
, обрабатывались одинаково: все строки определённой группы попадут в одну рамку или будут исключены из неё.
Предложение WINDOW
применяется для управления поведением оконных функций, фигурирующих в запросе, в Список SELECT
или Предложение ORDER BY
. Эти функции могут обращаться к элементам WINDOW
по именам в своих предложениях OVER
. При этом элементы WINDOW
не обязательно задействовать в запросе; если они не используются, они просто игнорируются. Оконные функции можно использовать вовсе без элементов WINDOW
, так как в вызове оконной функции можно задать определение окна непосредственно в предложении OVER
. Однако предложение WINDOW
позволяет сократить текст запроса, когда одно и то же определение окна применяется при вызове нескольких оконных функций.
В настоящее время указания FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
нельзя задать вместе с WINDOW
.
Оконные функции подробно описываются в Разделе 3.5, Подразделе 4.2.8 и Подразделе 7.2.5.
Список SELECT
Список SELECT
(между ключевыми словами SELECT
и FROM
) содержит выражения, которые формируют выходные строки оператора SELECT
. Эти выражения могут обращаться (и обычно обращаются) к столбцам, вычисленным в предложении FROM
.
Так же, как в таблице, каждый выходной столбец SELECT
имеет имя. В простом предложении SELECT
это имя просто помечает столбец при выводе, но когда SELECT
представляет собой подзапрос большого запроса, это имя большой запрос видит как имя столбца виртуальной таблицы, созданной подзапросом. Чтобы задать имя для выходного столбца, нужно написать AS
выходное_имя
после выражения столбца. (Слово AS
можно опустить, но только если желаемое выходное имя не совпадает с каким-либо ключевым словом Postgres Pro (см. Приложение C). Чтобы не зависеть от появления новых ключевых слов в будущем, рекомендуется всегда писать AS
, либо заключать имя в двойные кавычки.) Если имя столбца не задать, Postgres Pro выберет его автоматически. Если выражение столбца представляет собой просто ссылку на столбец, то выбранное таким образом имя будет совпадать с именем столбца. В более сложных случаях может использоваться имя функции или типа, либо в отсутствие других вариантов система может сгенерировать имя вроде ?column?
.
По имени выходного столбца можно обратиться к его значению в предложениях ORDER BY
и GROUP BY
, но не в WHERE
или HAVING
; в них вместо имени надо записывать всё выражение.
Вместо выражения в выходном списке можно указать *
, что будет обозначать все столбцы выбранных строк. Кроме того, можно записать
как краткое обозначение всех столбцов, получаемых из данной таблицы. В этих случаях нельзя задать новые имена столбцов с помощью имя_таблицы
.*AS
; именами выходных столбцов будут имена столбцов в таблице.
Согласно стандарту SQL, выражения в выходном списке должны вычисляться до применения DISTINCT
, ORDER BY
или LIMIT
. Это, очевидно, необходимо для DISTINCT
, так как иначе не будет ясно, какие значения должны выдаваться как уникальные. Однако во многих случаях выходные выражения удобнее вычислять после ORDER BY
и LIMIT
; в частности, если в выходном списке содержатся изменчивые или дорогостоящие функции. В этом случае порядок вычисления функций оказывается более интуитивным, а для строк, которые не попадут в результат, не будут производиться вычисления. Postgres Pro фактически будет вычислять выходные выражения после сортировки и ограничения их количества, если эти выражения не фигурируют в DISTINCT
, ORDER BY
или GROUP BY
. (Например, в запросе SELECT f(x) FROM tab ORDER BY 1
функция f(x)
, несомненно, должна вычисляться перед сортировкой.) Выходные выражения, содержащие функции, возвращающие множества, фактически вычисляются после сортировки и до ограничения количества строк, так что LIMIT
будет отбрасывать строки, выдаваемые функцией, возвращающей множество.
Примечание
В Postgres Pro до версии 9.6 никакой порядок вычисления выходных выражений по отношению к сортировке или ограничениям количества не гарантировался; он зависел от формы выбранного плана запроса.
Предложение DISTINCT
Если указано SELECT DISTINCT
, все повторяющиеся строки исключаются из результирующего набора (из каждой группы дубликатов остаётся одна строка). SELECT ALL
делает противоположное: сохраняет все строки; это поведение по умолчанию.
SELECT DISTINCT ON (
сохраняет только первую строку из каждого набора строк, для которого данное выражение даёт одинаковые значения. Выражения выражение
[, ...] )DISTINCT ON
обрабатываются по тем же правилам, что и выражения ORDER BY
(см. выше). Заметьте, что «первая строка» каждого набора непредсказуема, если только не применяется предложение ORDER BY
, определяющее, какие строки должны быть первыми. Например:
SELECT DISTINCT ON (location) location, time, report FROM weather_reports ORDER BY location, time DESC;
возвращает самую последнюю сводку погоды для каждого местоположения. Но если бы мы не добавили ORDER BY
, чтобы значения времени убывали, мы бы получили сводки по местоположениям от непредсказуемого времени.
Выражения DISTINCT ON
должны соответствовать самым левым выражениям в ORDER BY
. Предложение ORDER BY
обычно содержит и другие выражения, которые определяют желаемый порядок строк в каждой группе DISTINCT ON
.
В настоящее время указания FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
нельзя задать вместе с DISTINCT
.
Предложение UNION
+
Предложение UNION
имеет следующую общую форму:
оператор_SELECT
UNION [ ALL | DISTINCT ]оператор_SELECT
Здесь оператор_SELECT
— это любой подзапрос SELECT
без предложений ORDER BY
, LIMIT
, FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
. (ORDER BY
и LIMIT
можно добавить к вложенному выражению, если оно заключено в скобки. Без скобок эти предложения будут восприняты как применяемые к результату UNION
, а не к выражению в его правой части.)
Оператор UNION
вычисляет объединение множеств всех строк, возвращённых заданными запросами SELECT
. Строка оказывается в объединении двух наборов результатов, если она присутствует минимум в одном наборе. Два оператора SELECT
, представляющие прямые операнды UNION
, должны выдавать одинаковое число столбцов, а типы соответствующих столбцов должны быть совместимыми.
Результат UNION
не будет содержать повторяющихся строк, если не указан параметр ALL
. ALL
предотвращает исключение дубликатов. (Таким образом, UNION ALL
обычно работает значительно быстрее, чем UNION
; поэтому, везде, где возможно, следует указывать ALL
.) DISTINCT
можно записать явно, чтобы обозначить, что дублирующиеся строки должны удаляться (это поведение по умолчанию).
При использовании в одном запросе SELECT
нескольких операторов UNION
они вычисляются слева направо, если иной порядок не определяется скобками.
В настоящее время указания FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
нельзя задать ни для результата UNION
, ни для любого из подзапросов UNION
.
Предложение INTERSECT
Предложение INTERSECT
имеет следующую общую форму:
оператор_SELECT
INTERSECT [ ALL | DISTINCT ]оператор_SELECT
Здесь оператор_SELECT
— это любой подзапрос SELECT
без предложений ORDER BY
, LIMIT
, FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
.
Оператор INTERSECT
вычисляет пересечение множеств всех строк, возвращённых заданными запросами SELECT
. Строка оказывается в пересечении двух наборов результатов, если она присутствует в обоих наборах.
Результат INTERSECT
не будет содержать повторяющихся строк, если не указан параметр ALL
. С параметром ALL
строка, повторяющаяся m
раз в левой таблице и n
раз в правой, будет выдана в результирующем наборе min(m
,n
) раз. DISTINCT
можно записать явно, чтобы обозначить, что дублирующиеся строки должны удаляться (это поведение по умолчанию).
При использовании в одном запросе SELECT
нескольких операторов INTERSECT
они вычисляются слева направо, если иной порядок не диктуется скобками. INTERSECT
связывает свои подзапросы сильнее, чем UNION
. Другими словами, A UNION B INTERSECT C
будет восприниматься как A UNION (B INTERSECT C)
.
В настоящее время указания FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
нельзя задать ни для результата INTERSECT
, ни для любого из подзапросов INTERSECT
.
Предложение EXCEPT
Предложение EXCEPT
имеет следующую общую форму:
оператор_SELECT
EXCEPT [ ALL | DISTINCT ]оператор_SELECT
Здесь оператор_SELECT
— это любой подзапрос SELECT
без предложений ORDER BY
, LIMIT
, FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
.
Оператор EXCEPT
вычисляет набор строк, которые присутствуют в результате левого запроса SELECT
, но отсутствуют в результате правого.
Результат EXCEPT
не будет содержать повторяющихся строк, если не указан параметр ALL
. С параметром ALL
строка, повторяющаяся m
раз в левой таблице и n
раз в правой, будет выдана в результирующем наборе max(m
-n
,0) раз. DISTINCT
можно записать явно, чтобы обозначить, что дублирующиеся строки должны удаляться (это поведение по умолчанию).
При использовании в одном запросе SELECT
нескольких операторов EXCEPT
они вычисляются слева направо, если иной порядок не диктуется скобками. EXCEPT
связывает свои подзапросы так же сильно, как UNION
.
В настоящее время указания FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
и FOR KEY SHARE
нельзя задать ни для результата EXCEPT
, ни для любого из подзапросов EXCEPT
.
Предложение ORDER BY
Необязательное предложение ORDER BY
имеет следующую общую форму:
ORDER BYвыражение
[ ASC | DESC | USINGоператор
] [ NULLS { FIRST | LAST } ] [, ...]
Предложение ORDER BY
указывает, что строки результата должны сортироваться согласно заданным выражениям. Если две строки дают равные значения для самого левого выражения, проверяется следующее выражение и т. д. Если их значения оказываются равными для всех заданных выражений, строки возвращаются в порядке, определяемом реализацией.
В качестве выражения
может задаваться имя или порядковый номер выходного столбца (элемента списка SELECT
), либо произвольное выражение со значениями входных столбцов.
Порядковым номером в данном случае считается последовательный номер (при нумерации слева направо) позиции выходного столбца. Возможность указать порядковый номер позволяет выполнить сортировку по столбцу, не имеющему уникального имени. В принципе это не абсолютно необходимо, так как выходному столбцу всегда можно присвоить имя, воспользовавшись предложением AS
.
В предложении ORDER BY
также можно использовать произвольные выражения, в том числе, и со столбцами, отсутствующими в списке результатов SELECT
. Таким образом, следующий оператор вполне корректен:
SELECT name FROM distributors ORDER BY code;
Однако если ORDER BY
применяется к результату UNION
, INTERSECT
или EXCEPT
, в нём можно задать только имя или номер выходного столбца, но не выражение.
Если в качестве выражения ORDER BY
задано простое имя, которому соответствует и выходной, и входной столбец, то ORDER BY
будет воспринимать его как имя выходного столбца. Этот выбор противоположен тому, что делает GROUP BY
в такой же ситуации. Такая несогласованность допущена для соответствия стандарту SQL.
Дополнительно после любого выражения в предложении ORDER BY
можно добавить ключевое слово ASC
(по возрастанию) или DESC
(по убыванию). По умолчанию подразумевается ASC
. Кроме того, можно задать имя специфического оператора сортировки в предложении USING
. Оператор сортировки должен быть членом «меньше» или «больше» некоторого семейства операторов B-дерева. ASC
обычно равнозначно USING <
и DESC
обычно равнозначно USING >
. (Хотя создатель нестандартного типа данных может определить по-другому порядок сортировки по умолчанию и поставить ему в соответствие операторы с другими именами.)
Если указано NULLS LAST
, значения NULL при сортировке оказываются после значений не NULL; с указанием NULLS FIRST
значения NULL оказываются перед значениями не NULL. Если не указано ни то, ни другое, по умолчанию подразумевается NULLS LAST
при явно или неявно выбранном порядке ASC
, либо NULLS FIRST
при порядке DESC
(то есть по умолчанию считается, что значения NULL больше значений не NULL). С предложением USING
порядок NULL по умолчанию зависит от того, является ли указанный оператор оператором «меньше» или «больше».
Заметьте, что параметры сортировки применяются только к тому выражению, за которым они следуют; в частности, ORDER BY x, y DESC
означает не то же самое, что ORDER BY x DESC, y DESC
.
Данные символьных строк сортируются согласно правилу сортировки, установленному для сортируемого столбца. При необходимости это правило можно переопределить, добавив предложение COLLATE
в выражение
, например так: ORDER BY mycolumn COLLATE "en_US"
. За дополнительными сведениями обратитесь к Подразделу 4.2.10 и Разделу 23.2.
Предложение LIMIT
Предложение LIMIT
состоит из двух независимых вложенных предложений:
LIMIT {число
| ALL } OFFSETначало
Здесь число
определяет максимальное количество строк, которое должно быть выдано, тогда как начало
определяет, сколько строк нужно пропустить, прежде чем начать выдавать строки. Когда указаны оба значения, сначала строки пропускаются в количестве, заданном значением начало
, а затем следующие строки выдаются в количестве, не превышающем значения число
.
Если результатом выражения число
оказывается NULL, предложение воспринимается как LIMIT ALL
, т. е. число строк не ограничивается. Если начало
принимает значение NULL, предложение воспринимается как OFFSET 0
.
SQL:2008 вводит другой синтаксис для получения того же результата, и его так же поддерживает Postgres Pro. Он выглядит так:
OFFSETначало
{ ROW | ROWS } FETCH { FIRST | NEXT } [число
] { ROW | ROWS } ONLY
В этом синтаксисе значение начало
или число
в соответствии со стандартом должно быть буквальной константой, параметром или именем переменной; Postgres Pro позволяет использовать и другие выражения, но их обычно нужно заключать в скобки во избежание неоднозначности. Если число
опускается в предложении FETCH
, оно принимает значение 1. Слова ROW
и ROWS
, а также FIRST
и NEXT
являются незначащими и не влияют на поведение этих предложений. Согласно стандарту предложение OFFSET
должно идти перед FETCH
, если они присутствуют вместе; но Postgres Pro менее строг и допускает любой порядок.
Применяя LIMIT
, имеет смысл использовать также предложение ORDER BY
, чтобы строки результата выдавались в определённом порядке. Иначе будут возвращаться непредсказуемые подмножества строк запроса — вы можете запросить строки с десятой по двадцатую, но какой порядок вы имеете в виду? Порядок будет неизвестен, если не добавить ORDER BY
.
Планировщик запроса учитывает ограничение LIMIT
, строя план выполнения запроса, поэтому, вероятнее всего, планы (а значит и порядок строк) будут меняться при разных LIMIT
и OFFSET
. Таким образом, различные значения LIMIT
/OFFSET
, выбирающие разные подмножества результатов запроса, приведут к несогласованности результатов, если не установить предсказуемую сортировку с помощью ORDER BY
. Это не ошибка, а неизбежное следствие того, что SQL не гарантирует вывод результатов запроса в некотором порядке, если порядок не определён явно предложением ORDER BY
.
Возможно даже, что при повторном выполнении одного и того же запроса с LIMIT
будут получены разные подмножества строк таблицы, если предложение ORDER BY
не диктует выбор определённого подмножества. Опять же, это не ошибка; в данном случае детерминированность результата просто не гарантируется.
Предложение блокировки
Предложения блокировки включают в себя FOR UPDATE
, FOR NO KEY UPDATE
, FOR SHARE
и FOR KEY SHARE
; они влияют на то, как SELECT
блокирует строки, получаемые из таблицы.
Предложение блокировки имеет следующую общую форму:
FORвариант_блокировки
[ OFимя_таблицы
[, ...] ] [ NOWAIT | SKIP LOCKED ]
Здесь вариант_блокировки
может быть следующим:
UPDATE NO KEY UPDATE SHARE KEY SHARE
Подробнее о каждом режиме блокировки на уровне строк можно узнать в Подразделе 13.3.2.
Чтобы операция не ждала завершения других транзакций, к блокировке можно добавить указание NOWAIT
или SKIP LOCKED
. С NOWAIT
оператор выдаёт ошибку, а не ждёт, если выбранную строку нельзя заблокировать немедленно. С указанием SKIP LOCKED
выбранные строки, которые нельзя заблокировать немедленно, пропускаются. При этом формируется несогласованное представление данных, так что этот вариант не подходит для общего применения, но может использоваться для исключения блокировок при обращении множества потребителей к таблице типа очереди. Заметьте, что указания NOWAIT
и SKIP LOCKED
применяются только к блокировкам на уровне строк — необходимая блокировка ROW SHARE
уровня таблицы запрашивается обычным способом (см. Главу 13). Если требуется запросить блокировку уровня таблицы без ожидания, можно сначала выполнить LOCK с указанием NOWAIT
.
Если в предложении блокировки указаны определённые таблицы, блокироваться будут только строки, получаемые из этих таблиц; другие таблицы, задействованные в SELECT
, будут прочитаны как обычно. Предложение блокировки без списка таблиц затрагивает все таблицы, задействованные в этом операторе. Если предложение блокировки применяется к представлению или подзапросу, оно затрагивает все таблицы, которые используются в представлении или подзапросе. Однако эти предложения не применяются к запросам WITH
, к которым обращается основной запрос. Если требуется установить блокировку строк в запросе WITH
, предложение блокировки нужно указать непосредственно в этом запросе WITH
.
В случае необходимости задать для разных таблиц разное поведение блокировки, в запрос можно добавить несколько предложений. Если при этом одна и та же таблица упоминается (или неявно затрагивается) в нескольких предложениях блокировки, блокировка устанавливается так, как если бы было указано только одно, самое сильное из них. Подобным образом, если в одном из предложений указано NOWAIT
, для этой таблицы блокировка будет запрашиваться без ожидания. В противном случае она будет обработана в режиме SKIP LOCKED
, если он выбран в любом из затрагивающих её предложений.
Предложения блокировки не могут применяться в контекстах, где возвращаемые строки нельзя чётко связать с отдельными строками таблицы; например, блокировка неприменима при агрегировании.
Когда предложение блокировки находится на верхнем уровне запроса SELECT
, блокируются именно те строки, которые возвращаются запросом; в случае с запросом объединения, блокировке подлежат строки, из которых составляются возвращаемые строки объединения. В дополнение к этому, заблокированы будут строки, удовлетворяющие условиям запроса на момент создания снимка запроса, хотя они не будут возвращены, если с момента снимка они изменятся и перестанут удовлетворять условиям. Если применяется LIMIT
, блокировка прекращается, как только будет получено достаточное количество строк для удовлетворения лимита (но заметьте, что строки, пропускаемые указанием OFFSET
, будут блокироваться). Подобным образом, если предложение блокировки применяется в запросе курсора, блокироваться будут только строки, фактически полученные или пройденные курсором.
Когда предложение блокировки находится в подзапросе SELECT
, блокировке подлежат те строки, которые будет получены внешним запросом от подзапроса. Таких строк может оказаться меньше, чем можно было бы предположить, проанализировав только сам подзапрос, так как условия из внешнего запроса могут способствовать оптимизации выполнения подзапроса. Например, запрос
SELECT * FROM (SELECT * FROM mytable FOR UPDATE) ss WHERE col1 = 5;
заблокирует только строки, в которых col1 = 5
, при том, что в такой записи условие не относится к подзапросу.
Предыдущие версии не могли сохранить блокировку, которая была повышена последующей точкой сохранения. Например, этот код:
BEGIN; SELECT * FROM mytable WHERE key = 1 FOR UPDATE; SAVEPOINT s; UPDATE mytable SET ... WHERE key = 1; ROLLBACK TO s;
не мог сохранить блокировку FOR UPDATE
после ROLLBACK TO
. Это было исправлено в версии 9.3.
Внимание
Возможно, что команда SELECT
, работающая на уровне изоляции READ COMMITTED
и применяющая предложение ORDER BY
вместе с блокировкой, будет возвращать строки не по порядку. Это связано с тем, что ORDER BY
выполняется в первую очередь. Эта команда отсортирует результат, но затем может быть заблокирована, пытаясь получить блокировку одной или нескольких строк. К моменту, когда блокировка SELECT
будет снята, некоторые из сортируемых столбцов могут уже измениться, в результате чего их порядок может быть нарушен (хотя они были упорядочены для исходных значений). При необходимости обойти эту проблему, можно поместить FOR UPDATE/SHARE
в подзапрос, например так:
SELECT * FROM (SELECT * FROM mytable FOR UPDATE) ss ORDER BY column1;
Заметьте, что в результате это приведёт к блокированию всех строк в mytable
, тогда как указание FOR UPDATE
на верхнем уровне могло бы заблокировать только фактически возвращаемые строки. Это может значительно повлиять на производительность, особенно в сочетании ORDER BY
с LIMIT
или другими ограничениями. Таким образом, этот приём рекомендуется, только если ожидается параллельное изменение сортируемых столбцов, а результат должен быть строго отсортирован.
На уровнях изоляции REPEATABLE READ
и SERIALIZABLE
это приведёт к ошибке сериализации (с SQLSTATE
'40001'
), так что на этих уровнях получить строки не по порядку невозможно.
Команда TABLE
Команда
TABLE имя
равнозначна
SELECT * FROM имя
Её можно применять в качестве команды верхнего уровня или как более краткую запись внутри сложных запросов. С командой TABLE
могут использоваться только предложения WITH
, UNION
, INTERSECT
, EXCEPT
, ORDER BY
, LIMIT
, OFFSET
, FETCH
и предложения блокировки FOR
; предложение WHERE
и какие-либо формы агрегирования не поддерживаются.
Примеры
Соединение таблицы films
с таблицей distributors
:
SELECT f.title, f.did, d.name, f.date_prod, f.kind FROM distributors d JOIN films f USING (did); title | did | name | date_prod | kind -------------------+-----+--------------+------------+---------- The Third Man | 101 | British Lion | 1949-12-23 | Drama The African Queen | 101 | British Lion | 1951-08-11 | Romantic ...
Суммирование значений столбца len
(продолжительность) для всех фильмов и группирование результатов по столбцу kind
(типу фильма):
SELECT kind, sum(len) AS total FROM films GROUP BY kind; kind | total ----------+------- Action | 07:34 Comedy | 02:58 Drama | 14:28 Musical | 06:42 Romantic | 04:38
Суммирование значений столбца len
для всех фильмов, группирование результатов по столбцу kind
и вывод только тех групп, общая продолжительность которых меньше 5 часов:
SELECT kind, sum(len) AS total FROM films GROUP BY kind HAVING sum(len) < interval '5 hours'; kind | total ----------+------- Comedy | 02:58 Romantic | 04:38
Следующие два запроса демонстрируют равнозначные способы сортировки результатов по содержимому второго столбца (name
):
SELECT * FROM distributors ORDER BY name; SELECT * FROM distributors ORDER BY 2; did | name -----+------------------ 109 | 20th Century Fox 110 | Bavaria Atelier 101 | British Lion 107 | Columbia 102 | Jean Luc Godard 113 | Luso films 104 | Mosfilm 103 | Paramount 106 | Toho 105 | United Artists 111 | Walt Disney 112 | Warner Bros. 108 | Westward
Следующий пример показывает объединение таблиц distributors
и actors
, ограниченное именами, начинающимися с буквы W в каждой таблице. Интерес представляют только неповторяющиеся строки, поэтому ключевое слово ALL
опущено.
distributors: actors: did | name id | name -----+-------------- ----+---------------- 108 | Westward 1 | Woody Allen 111 | Walt Disney 2 | Warren Beatty 112 | Warner Bros. 3 | Walter Matthau ... ... SELECT distributors.name FROM distributors WHERE distributors.name LIKE 'W%' UNION SELECT actors.name FROM actors WHERE actors.name LIKE 'W%'; name ---------------- Walt Disney Walter Matthau Warner Bros. Warren Beatty Westward Woody Allen
Этот пример показывает, как использовать функцию в предложении FROM
, со списком определений столбцов и без него:
CREATE FUNCTION distributors(int) RETURNS SETOF distributors AS $$ SELECT * FROM distributors WHERE did = $1; $$ LANGUAGE SQL; SELECT * FROM distributors(111); did | name -----+------------- 111 | Walt Disney CREATE FUNCTION distributors_2(int) RETURNS SETOF record AS $$ SELECT * FROM distributors WHERE did = $1; $$ LANGUAGE SQL; SELECT * FROM distributors_2(111) AS (f1 int, f2 text); f1 | f2 -----+------------- 111 | Walt Disney
Пример функции с добавленным столбцом нумерации:
SELECT * FROM unnest(ARRAY['a','b','c','d','e','f']) WITH ORDINALITY; unnest | ordinality --------+---------- a | 1 b | 2 c | 3 d | 4 e | 5 f | 6 (6 rows)
Этот пример показывает, как использовать простое предложение WITH
:
WITH t AS ( SELECT random() as x FROM generate_series(1, 3) ) SELECT * FROM t UNION ALL SELECT * FROM t x -------------------- 0.534150459803641 0.520092216785997 0.0735620250925422 0.534150459803641 0.520092216785997 0.0735620250925422
Заметьте, что запрос WITH
выполняется всего один раз, поэтому мы получаем два одинаковых набора по три случайных значения.
В этом примере WITH RECURSIVE
применяется для поиска всех подчинённых Мери (непосредственных или косвенных) и вывода их уровня косвенности в таблице с информацией только о непосредственных подчинённых:
WITH RECURSIVE employee_recursive(distance, employee_name, manager_name) AS ( SELECT 1, employee_name, manager_name FROM employee WHERE manager_name = 'Mary' UNION ALL SELECT er.distance + 1, e.employee_name, e.manager_name FROM employee_recursive er, employee e WHERE er.employee_name = e.manager_name ) SELECT distance, employee_name FROM employee_recursive;
Заметьте, что это типичная форма рекурсивных запросов: начальное условие, последующий UNION
, а затем рекурсивная часть запроса. Убедитесь в том, что рекурсивная часть запроса в конце концов перестанет возвращать строки, иначе запрос окажется в бесконечном цикле. (За другими примерами обратитесь к Разделу 7.8.)
В этом примере используется LATERAL
для применения функции get_product_names()
, возвращающей множество, для каждой строки таблицы manufacturers
:
SELECT m.name AS mname, pname FROM manufacturers m, LATERAL get_product_names(m.id) pname;
Производители, с которыми в данный момент не связаны никакие продукты, не попадут в результат, так как это внутреннее соединение. Если бы мы захотели включить названия и этих производителей, мы могли бы сделать так:
SELECT m.name AS mname, pname FROM manufacturers m LEFT JOIN LATERAL get_product_names(m.id) pname ON true;
Совместимость
Разумеется, оператор SELECT
совместим со стандартом SQL. Однако не все описанные в стандарте возможности реализованы, а некоторые, наоборот, являются расширениями.
Необязательное предложение FROM
Postgres Pro разрешает опустить предложение FROM
. Это позволяет очень легко вычислять результаты простых выражений:
SELECT 2+2; ?column? ---------- 4
Некоторые другие базы данных SQL не допускают этого, требуя задействовать в SELECT
фиктивную таблицу с одной строкой.
Заметьте, что если предложение FROM
не указано, запрос не может обращаться ни к каким таблицам базы данных. Например, следующий запрос недопустим:
SELECT distributors.* WHERE distributors.name = 'Westward';
До версии 8.1 PostgreSQL мог принимать запросы такого вида, неявно добавляя каждую таблицу, задействованную в запросе, в предложение FROM
этого запроса. Теперь это не допускается.
Пустые списки SELECT
Список выходных выражений после SELECT
может быть пустым, что в результате даст таблицу без столбцов. Стандарт SQL не считает такой синтаксис допустимым, но Postgres Pro допускает его, так как это согласуется с возможностью иметь таблицы с нулём столбцов. Однако когда используется DISTINCT
, пустой список не допускается.
Необязательное ключевое слово AS
В стандарте SQL необязательное ключевое слово AS
можно опустить перед именем выходного столбца, если это имя является допустимым именем столбца (то есть не совпадает с каким-либо зарезервированным ключевым словом). Postgres Pro несколько более строг: AS
требуется, если имя столбца совпадает с любым ключевым словом, зарезервированным или нет. Тем не менее рекомендуется использовать AS
или заключать имена выходных столбцов в кавычки, во избежание конфликтов, возможных при появлении в будущем новых ключевых слов.
В списке FROM
и стандарт, и Postgres Pro позволяют опускать AS
перед псевдонимом, который является незарезервированным ключевым словом. Но для имён выходных столбцов это не подходит из-за синтаксической неоднозначности.
ONLY
и наследование
Стандарт SQL требует заключать в скобки имя таблицы после ONLY
, например SELECT * FROM ONLY (tab1), ONLY (tab2) WHERE ...
. Postgres Pro считает эти скобки необязательными.
Postgres Pro позволяет добавлять в конце *
, чтобы явно обозначить, что дочерние таблицы включаются в рассмотрение, в отличие от поведения с ONLY
. Стандарт не позволяет этого.
(Эти соображения в равной степени касаются всех SQL-команд, поддерживающих параметр ONLY
.)
Ограничения предложения TABLESAMPLE
Предложение TABLESAMPLE
в настоящий момент принимается только для обычных таблиц и материализованных представлений. Однако согласно стандарту SQL оно должно применяться к любым элементам списка FROM
.
Вызовы функций в предложении FROM
Postgres Pro позволяет записать вызов функции непосредственно в виде элемента списка FROM
. В стандарте SQL такой вызов функции требуется помещать во вложенный SELECT
; то есть, запись FROM
примерно равнозначна записи функция
(...) псевдоним
FROM LATERAL (SELECT
. Заметьте, что указание функция
(...)) псевдоним
LATERAL
считается неявным; это связано с тем, что стандарт требует поведения LATERAL
для элемента UNNEST()
в предложении FROM
. Postgres Pro обрабатывает UNNEST()
так же, как и другие функции, возвращающие множества.
Пространства имён в GROUP BY
и ORDER BY
В стандарте SQL-92 предложение ORDER BY
может содержать ссылки только на выходные столбцы по именам или номерам, тогда как GROUP BY
может содержать выражения с именами только входных столбцов. Postgres Pro расширяет оба эти предложения, позволяя также применять другие варианты (но если возникает неоднозначность, он разрешает её согласно стандарту). Postgres Pro также позволяет задавать произвольные выражения в обоих предложениях. Заметьте, что имена, фигурирующие в выражениях, всегда будут восприниматься как имена входных, а не выходных столбцов.
В SQL:1999 и более поздних стандартах введено несколько другое определение, которое не полностью совместимо с SQL-92. Однако в большинстве случаев Postgres Pro будет интерпретировать выражение ORDER BY
или GROUP BY
так, как требует SQL:1999.
Функциональные зависимости
Postgres Pro распознаёт функциональную зависимость (что позволяет опускать столбцы в GROUP BY
), только когда первичный ключ таблицы присутствует в списке GROUP BY
. В стандарте SQL оговариваются дополнительные условия, которые следует учитывать.
LIMIT
и OFFSET
Предложения LIMIT
и OFFSET
относятся к специфическим особенностям Postgres Pro и поддерживаются также в MySQL. В стандарте SQL:2008 для той же цели вводятся предложения OFFSET ... FETCH {FIRST|NEXT} ...
, рассмотренные ранее в Предложение LIMIT
. Этот синтаксис также используется в IBM DB2. (Приложения, написанные для Oracle, часто применяют обходной способ и получают эффект этих предложений, задействуя автоматически генерируемый столбец rownum
, который отсутствует в Postgres Pro.)
FOR NO KEY UPDATE
, FOR UPDATE
, FOR SHARE
, FOR KEY SHARE
Хотя указание FOR UPDATE
есть в стандарте SQL, стандарт позволяет использовать его только в предложении DECLARE CURSOR
. Postgres Pro допускает его использование в любом запросе SELECT
, а также в подзапросах SELECT
, но это является расширением. Варианты FOR NO KEY UPDATE
, FOR SHARE
и FOR KEY SHARE
, а также указания NOWAIT
и SKIP LOCKED
в стандарте отсутствуют.
Изменение данных в WITH
Postgres Pro разрешает использовать INSERT
, UPDATE
и DELETE
в качестве запросов WITH
. Стандарт SQL этого не предусматривает.
Нестандартные предложения
DISTINCT ON ( ... )
— расширение стандарта SQL.
ROWS FROM( ... )
— расширение стандарта SQL.
32.3. Command Execution Functions
Once a connection to a database server has been successfully established, the functions described here are used to perform SQL queries and commands.
32.3.1. Main Functions
-
PQexec
Submits a command to the server and waits for the result.
PGresult *PQexec(PGconn *conn, const char *command);
Returns a
PGresult
pointer or possibly a null pointer. A non-null pointer will generally be returned except in out-of-memory conditions or serious errors such as inability to send the command to the server. ThePQresultStatus
function should be called to check the return value for any errors (including the value of a null pointer, in which case it will returnPGRES_FATAL_ERROR
). UsePQerrorMessage
to get more information about such errors.
The command string can include multiple SQL commands (separated by semicolons). Multiple queries sent in a single PQexec
call are processed in a single transaction, unless there are explicit BEGIN
/COMMIT
commands included in the query string to divide it into multiple transactions. Note however that the returned PGresult
structure describes only the result of the last command executed from the string. Should one of the commands fail, processing of the string stops with it and the returned PGresult
describes the error condition.
-
PQexecParams
Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text.
PGresult *PQexecParams(PGconn *conn, const char *command, int nParams, const Oid *paramTypes, const char * const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat);
PQexecParams
is likePQexec
, but offers additional functionality: parameter values can be specified separately from the command string proper, and query results can be requested in either text or binary format.PQexecParams
is supported only in protocol 3.0 and later connections; it will fail when using protocol 2.0.The function arguments are:
conn
The connection object to send the command through.
command
The SQL command string to be executed. If parameters are used, they are referred to in the command string as
$1
,$2
, etc.nParams
The number of parameters supplied; it is the length of the arrays
paramTypes[]
,paramValues[]
,paramLengths[]
, andparamFormats[]
. (The array pointers can beNULL
whennParams
is zero.)paramTypes[]
Specifies, by OID, the data types to be assigned to the parameter symbols. If
paramTypes
isNULL
, or any particular element in the array is zero, the server infers a data type for the parameter symbol in the same way it would do for an untyped literal string.paramValues[]
Specifies the actual values of the parameters. A null pointer in this array means the corresponding parameter is null; otherwise the pointer points to a zero-terminated text string (for text format) or binary data in the format expected by the server (for binary format).
paramLengths[]
Specifies the actual data lengths of binary-format parameters. It is ignored for null parameters and text-format parameters. The array pointer can be null when there are no binary parameters.
paramFormats[]
Specifies whether parameters are text (put a zero in the array entry for the corresponding parameter) or binary (put a one in the array entry for the corresponding parameter). If the array pointer is null then all parameters are presumed to be text strings.
Values passed in binary format require knowledge of the internal representation expected by the backend. For example, integers must be passed in network byte order. Passing
numeric
values requires knowledge of the server storage format, as implemented insrc/backend/utils/adt/numeric.c::numeric_send()
andsrc/backend/utils/adt/numeric.c::numeric_recv()
.resultFormat
Specify zero to obtain results in text format, or one to obtain results in binary format. (There is not currently a provision to obtain different result columns in different formats, although that is possible in the underlying protocol.)
The primary advantage of PQexecParams
over PQexec
is that parameter values can be separated from the command string, thus avoiding the need for tedious and error-prone quoting and escaping.
Unlike PQexec
, PQexecParams
allows at most one SQL command in the given string. (There can be semicolons in it, but not more than one nonempty command.) This is a limitation of the underlying protocol, but has some usefulness as an extra defense against SQL-injection attacks.
Tip
Specifying parameter types via OIDs is tedious, particularly if you prefer not to hard-wire particular OID values into your program. However, you can avoid doing so even in cases where the server by itself cannot determine the type of the parameter, or chooses a different type than you want. In the SQL command text, attach an explicit cast to the parameter symbol to show what data type you will send. For example:
SELECT * FROM mytable WHERE x = $1::bigint;
This forces parameter $1
to be treated as bigint
, whereas by default it would be assigned the same type as x
. Forcing the parameter type decision, either this way or by specifying a numeric type OID, is strongly recommended when sending parameter values in binary format, because binary format has less redundancy than text format and so there is less chance that the server will detect a type mismatch mistake for you.
PQprepare
Submits a request to create a prepared statement with the given parameters, and waits for completion.
PGresult *PQprepare(PGconn *conn, const char *stmtName, const char *query, int nParams, const Oid *paramTypes);
PQprepare
creates a prepared statement for later execution withPQexecPrepared
. This feature allows commands to be executed repeatedly without being parsed and planned each time; see PREPARE for details.PQprepare
is supported only in protocol 3.0 and later connections; it will fail when using protocol 2.0.The function creates a prepared statement named
stmtName
from thequery
string, which must contain a single SQL command.stmtName
can be""
to create an unnamed statement, in which case any pre-existing unnamed statement is automatically replaced; otherwise it is an error if the statement name is already defined in the current session. If any parameters are used, they are referred to in the query as$1
,$2
, etc.nParams
is the number of parameters for which types are pre-specified in the arrayparamTypes[]
. (The array pointer can beNULL
whennParams
is zero.)paramTypes[]
specifies, by OID, the data types to be assigned to the parameter symbols. IfparamTypes
isNULL
, or any particular element in the array is zero, the server assigns a data type to the parameter symbol in the same way it would do for an untyped literal string. Also, the query can use parameter symbols with numbers higher thannParams
; data types will be inferred for these symbols as well. (SeePQdescribePrepared
for a means to find out what data types were inferred.)As with
PQexec
, the result is normally aPGresult
object whose contents indicate server-side success or failure. A null result indicates out-of-memory or inability to send the command at all. UsePQerrorMessage
to get more information about such errors.
Prepared statements for use with PQexecPrepared
can also be created by executing SQL PREPARE statements. Also, although there is no libpq function for deleting a prepared statement, the SQL DEALLOCATE statement can be used for that purpose.
-
PQexecPrepared
Sends a request to execute a prepared statement with given parameters, and waits for the result.
PGresult *PQexecPrepared(PGconn *conn, const char *stmtName, int nParams, const char * const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat);
PQexecPrepared
is likePQexecParams
, but the command to be executed is specified by naming a previously-prepared statement, instead of giving a query string. This feature allows commands that will be used repeatedly to be parsed and planned just once, rather than each time they are executed. The statement must have been prepared previously in the current session.PQexecPrepared
is supported only in protocol 3.0 and later connections; it will fail when using protocol 2.0.The parameters are identical to
PQexecParams
, except that the name of a prepared statement is given instead of a query string, and theparamTypes[]
parameter is not present (it is not needed since the prepared statement's parameter types were determined when it was created).-
PQdescribePrepared
Submits a request to obtain information about the specified prepared statement, and waits for completion.
PGresult *PQdescribePrepared(PGconn *conn, const char *stmtName);
PQdescribePrepared
allows an application to obtain information about a previously prepared statement.PQdescribePrepared
is supported only in protocol 3.0 and later connections; it will fail when using protocol 2.0.stmtName
can be""
orNULL
to reference the unnamed statement, otherwise it must be the name of an existing prepared statement. On success, aPGresult
with statusPGRES_COMMAND_OK
is returned. The functionsPQnparams
andPQparamtype
can be applied to thisPGresult
to obtain information about the parameters of the prepared statement, and the functionsPQnfields
,PQfname
,PQftype
, etc provide information about the result columns (if any) of the statement.-
PQdescribePortal
Submits a request to obtain information about the specified portal, and waits for completion.
PGresult *PQdescribePortal(PGconn *conn, const char *portalName);
PQdescribePortal
allows an application to obtain information about a previously created portal. (libpq does not provide any direct access to portals, but you can use this function to inspect the properties of a cursor created with aDECLARE CURSOR
SQL command.)PQdescribePortal
is supported only in protocol 3.0 and later connections; it will fail when using protocol 2.0.portalName
can be""
orNULL
to reference the unnamed portal, otherwise it must be the name of an existing portal. On success, aPGresult
with statusPGRES_COMMAND_OK
is returned. The functionsPQnfields
,PQfname
,PQftype
, etc can be applied to thePGresult
to obtain information about the result columns (if any) of the portal.
The PGresult
structure encapsulates the result returned by the server. libpq application programmers should be careful to maintain the PGresult
abstraction. Use the accessor functions below to get at the contents of PGresult
. Avoid directly referencing the fields of the PGresult
structure because they are subject to change in the future.
-
PQresultStatus
Returns the result status of the command.
ExecStatusType PQresultStatus(const PGresult *res);
PQresultStatus
can return one of the following values:PGRES_EMPTY_QUERY
The string sent to the server was empty.
PGRES_COMMAND_OK
Successful completion of a command returning no data.
PGRES_TUPLES_OK
Successful completion of a command returning data (such as a
SELECT
orSHOW
).PGRES_COPY_OUT
Copy Out (from server) data transfer started.
PGRES_COPY_IN
Copy In (to server) data transfer started.
PGRES_BAD_RESPONSE
The server's response was not understood.
PGRES_NONFATAL_ERROR
A nonfatal error (a notice or warning) occurred.
PGRES_FATAL_ERROR
A fatal error occurred.
PGRES_COPY_BOTH
Copy In/Out (to and from server) data transfer started. This feature is currently used only for streaming replication, so this status should not occur in ordinary applications.
PGRES_SINGLE_TUPLE
The
PGresult
contains a single result tuple from the current command. This status occurs only when single-row mode has been selected for the query (see Section 32.5).
If the result status is
PGRES_TUPLES_OK
orPGRES_SINGLE_TUPLE
, then the functions described below can be used to retrieve the rows returned by the query. Note that aSELECT
command that happens to retrieve zero rows still showsPGRES_TUPLES_OK
.PGRES_COMMAND_OK
is for commands that can never return rows (INSERT
orUPDATE
without aRETURNING
clause, etc.). A response ofPGRES_EMPTY_QUERY
might indicate a bug in the client software.A result of status
PGRES_NONFATAL_ERROR
will never be returned directly byPQexec
or other query execution functions; results of this kind are instead passed to the notice processor (see Section 32.12).-
PQresStatus
Converts the enumerated type returned by
PQresultStatus
into a string constant describing the status code. The caller should not free the result.char *PQresStatus(ExecStatusType status);
-
PQresultErrorMessage
Returns the error message associated with the command, or an empty string if there was no error.
char *PQresultErrorMessage(const PGresult *res);
If there was an error, the returned string will include a trailing newline. The caller should not free the result directly. It will be freed when the associated
PGresult
handle is passed toPQclear
.Immediately following a
PQexec
orPQgetResult
call,PQerrorMessage
(on the connection) will return the same string asPQresultErrorMessage
(on the result). However, aPGresult
will retain its error message until destroyed, whereas the connection's error message will change when subsequent operations are done. UsePQresultErrorMessage
when you want to know the status associated with a particularPGresult
; usePQerrorMessage
when you want to know the status from the latest operation on the connection.-
PQresultVerboseErrorMessage
Returns a reformatted version of the error message associated with a
PGresult
object.char *PQresultVerboseErrorMessage(const PGresult *res, PGVerbosity verbosity, PGContextVisibility show_context);
In some situations a client might wish to obtain a more detailed version of a previously-reported error.
PQresultVerboseErrorMessage
addresses this need by computing the message that would have been produced byPQresultErrorMessage
if the specified verbosity settings had been in effect for the connection when the givenPGresult
was generated. If thePGresult
is not an error result, “PGresult is not an error result” is reported instead. The returned string includes a trailing newline.Unlike most other functions for extracting data from a
PGresult
, the result of this function is a freshly allocated string. The caller must free it usingPQfreemem()
when the string is no longer needed.A NULL return is possible if there is insufficient memory.
PQresultErrorField
Returns an individual field of an error report.
char *PQresultErrorField(const PGresult *res, int fieldcode);
fieldcode
is an error field identifier; see the symbols listed below.NULL
is returned if thePGresult
is not an error or warning result, or does not include the specified field. Field values will normally not include a trailing newline. The caller should not free the result directly. It will be freed when the associatedPGresult
handle is passed toPQclear
.The following field codes are available:
PG_DIAG_SEVERITY
The severity; the field contents are
ERROR
,FATAL
, orPANIC
(in an error message), orWARNING
,NOTICE
,DEBUG
,INFO
, orLOG
(in a notice message), or a localized translation of one of these. Always present.PG_DIAG_SEVERITY_NONLOCALIZED
The severity; the field contents are
ERROR
,FATAL
, orPANIC
(in an error message), orWARNING
,NOTICE
,DEBUG
,INFO
, orLOG
(in a notice message). This is identical to thePG_DIAG_SEVERITY
field except that the contents are never localized. This is present only in reports generated by Postgres Pro versions 9.6 and later.-
PG_DIAG_SQLSTATE
The SQLSTATE code for the error. The SQLSTATE code identifies the type of error that has occurred; it can be used by front-end applications to perform specific operations (such as error handling) in response to a particular database error. For a list of the possible SQLSTATE codes, see Appendix A. This field is not localizable, and is always present.
PG_DIAG_MESSAGE_PRIMARY
The primary human-readable error message (typically one line). Always present.
PG_DIAG_MESSAGE_DETAIL
Detail: an optional secondary error message carrying more detail about the problem. Might run to multiple lines.
PG_DIAG_MESSAGE_HINT
Hint: an optional suggestion what to do about the problem. This is intended to differ from detail in that it offers advice (potentially inappropriate) rather than hard facts. Might run to multiple lines.
PG_DIAG_STATEMENT_POSITION
A string containing a decimal integer indicating an error cursor position as an index into the original statement string. The first character has index 1, and positions are measured in characters not bytes.
PG_DIAG_INTERNAL_POSITION
This is defined the same as the
PG_DIAG_STATEMENT_POSITION
field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client. ThePG_DIAG_INTERNAL_QUERY
field will always appear when this field appears.PG_DIAG_INTERNAL_QUERY
The text of a failed internally-generated command. This could be, for example, a SQL query issued by a PL/pgSQL function.
PG_DIAG_CONTEXT
An indication of the context in which the error occurred. Presently this includes a call stack traceback of active procedural language functions and internally-generated queries. The trace is one entry per line, most recent first.
PG_DIAG_SCHEMA_NAME
If the error was associated with a specific database object, the name of the schema containing that object, if any.
PG_DIAG_TABLE_NAME
If the error was associated with a specific table, the name of the table. (Refer to the schema name field for the name of the table's schema.)
PG_DIAG_COLUMN_NAME
If the error was associated with a specific table column, the name of the column. (Refer to the schema and table name fields to identify the table.)
PG_DIAG_DATATYPE_NAME
If the error was associated with a specific data type, the name of the data type. (Refer to the schema name field for the name of the data type's schema.)
PG_DIAG_CONSTRAINT_NAME
If the error was associated with a specific constraint, the name of the constraint. Refer to fields listed above for the associated table or domain. (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.)
PG_DIAG_SOURCE_FILE
The file name of the source-code location where the error was reported.
PG_DIAG_SOURCE_LINE
The line number of the source-code location where the error was reported.
PG_DIAG_SOURCE_FUNCTION
The name of the source-code function reporting the error.
Note
The fields for schema name, table name, column name, data type name, and constraint name are supplied only for a limited number of error types; see Appendix A. Do not assume that the presence of any of these fields guarantees the presence of another field. Core error sources observe the interrelationships noted above, but user-defined functions may use these fields in other ways. In the same vein, do not assume that these fields denote contemporary objects in the current database.
The client is responsible for formatting displayed information to meet its needs; in particular it should break long lines as needed. Newline characters appearing in the error message fields should be treated as paragraph breaks, not line breaks.
Errors generated internally by libpq will have severity and primary message, but typically no other fields. Errors returned by a pre-3.0-protocol server will include severity and primary message, and sometimes a detail message, but no other fields.
Note that error fields are only available from
PGresult
objects, notPGconn
objects; there is noPQerrorField
function.PQclear
Frees the storage associated with a
PGresult
. Every command result should be freed viaPQclear
when it is no longer needed.void PQclear(PGresult *res);
You can keep a
PGresult
object around for as long as you need it; it does not go away when you issue a new command, nor even if you close the connection. To get rid of it, you must callPQclear
. Failure to do this will result in memory leaks in your application.
32.3.2. Retrieving Query Result Information
These functions are used to extract information from a PGresult
object that represents a successful query result (that is, one that has status PGRES_TUPLES_OK
or PGRES_SINGLE_TUPLE
). They can also be used to extract information from a successful Describe operation: a Describe's result has all the same column information that actual execution of the query would provide, but it has zero rows. For objects with other status values, these functions will act as though the result has zero rows and zero columns.
-
PQntuples
Returns the number of rows (tuples) in the query result. (Note that
PGresult
objects are limited to no more thanINT_MAX
rows, so anint
result is sufficient.)int PQntuples(const PGresult *res);
-
PQnfields
Returns the number of columns (fields) in each row of the query result.
int PQnfields(const PGresult *res);
-
PQfname
Returns the column name associated with the given column number. Column numbers start at 0. The caller should not free the result directly. It will be freed when the associated
PGresult
handle is passed toPQclear
.char *PQfname(const PGresult *res, int column_number);
NULL
is returned if the column number is out of range.-
PQfnumber
Returns the column number associated with the given column name.
int PQfnumber(const PGresult *res, const char *column_name);
-1 is returned if the given name does not match any column.
The given name is treated like an identifier in an SQL command, that is, it is downcased unless double-quoted. For example, given a query result generated from the SQL command:
SELECT 1 AS FOO, 2 AS "BAR";
we would have the results:
PQfname(res, 0) foo PQfname(res, 1) BAR PQfnumber(res, "FOO") 0 PQfnumber(res, "foo") 0 PQfnumber(res, "BAR") -1 PQfnumber(res, "\"BAR\"") 1
-
PQftable
Returns the OID of the table from which the given column was fetched. Column numbers start at 0.
Oid PQftable(const PGresult *res, int column_number);
InvalidOid
is returned if the column number is out of range, or if the specified column is not a simple reference to a table column, or when using pre-3.0 protocol. You can query the system tablepg_class
to determine exactly which table is referenced.The type
Oid
and the constantInvalidOid
will be defined when you include the libpq header file. They will both be some integer type.-
PQftablecol
Returns the column number (within its table) of the column making up the specified query result column. Query-result column numbers start at 0, but table columns have nonzero numbers.
int PQftablecol(const PGresult *res, int column_number);
Zero is returned if the column number is out of range, or if the specified column is not a simple reference to a table column, or when using pre-3.0 protocol.
-
PQfformat
Returns the format code indicating the format of the given column. Column numbers start at 0.
int PQfformat(const PGresult *res, int column_number);
Format code zero indicates textual data representation, while format code one indicates binary representation. (Other codes are reserved for future definition.)
-
PQftype
Returns the data type associated with the given column number. The integer returned is the internal OID number of the type. Column numbers start at 0.
Oid PQftype(const PGresult *res, int column_number);
You can query the system table
pg_type
to obtain the names and properties of the various data types. The OIDs of the built-in data types are defined in the fileinclude/server/catalog/pg_type.h
in the install directory.-
PQfmod
Returns the type modifier of the column associated with the given column number. Column numbers start at 0.
int PQfmod(const PGresult *res, int column_number);
The interpretation of modifier values is type-specific; they typically indicate precision or size limits. The value -1 is used to indicate “no information available”. Most data types do not use modifiers, in which case the value is always -1.
-
PQfsize
Returns the size in bytes of the column associated with the given column number. Column numbers start at 0.
int PQfsize(const PGresult *res, int column_number);
PQfsize
returns the space allocated for this column in a database row, in other words the size of the server's internal representation of the data type. (Accordingly, it is not really very useful to clients.) A negative value indicates the data type is variable-length.-
PQbinaryTuples
Returns 1 if the
PGresult
contains binary data and 0 if it contains text data.int PQbinaryTuples(const PGresult *res);
This function is deprecated (except for its use in connection with
COPY
), because it is possible for a singlePGresult
to contain text data in some columns and binary data in others.PQfformat
is preferred.PQbinaryTuples
returns 1 only if all columns of the result are binary (format 1).-
PQgetvalue
Returns a single field value of one row of a
PGresult
. Row and column numbers start at 0. The caller should not free the result directly. It will be freed when the associatedPGresult
handle is passed toPQclear
.char *PQgetvalue(const PGresult *res, int row_number, int column_number);
For data in text format, the value returned by
PQgetvalue
is a null-terminated character string representation of the field value. For data in binary format, the value is in the binary representation determined by the data type'stypsend
andtypreceive
functions. (The value is actually followed by a zero byte in this case too, but that is not ordinarily useful, since the value is likely to contain embedded nulls.)An empty string is returned if the field value is null. See
PQgetisnull
to distinguish null values from empty-string values.The pointer returned by
PQgetvalue
points to storage that is part of thePGresult
structure. One should not modify the data it points to, and one must explicitly copy the data into other storage if it is to be used past the lifetime of thePGresult
structure itself.-
PQgetisnull
Tests a field for a null value. Row and column numbers start at 0.
int PQgetisnull(const PGresult *res, int row_number, int column_number);
This function returns 1 if the field is null and 0 if it contains a non-null value. (Note that
PQgetvalue
will return an empty string, not a null pointer, for a null field.)-
PQgetlength
Returns the actual length of a field value in bytes. Row and column numbers start at 0.
int PQgetlength(const PGresult *res, int row_number, int column_number);
This is the actual data length for the particular data value, that is, the size of the object pointed to by
PQgetvalue
. For text data format this is the same asstrlen()
. For binary format this is essential information. Note that one should not rely onPQfsize
to obtain the actual data length.-
PQnparams
Returns the number of parameters of a prepared statement.
int PQnparams(const PGresult *res);
This function is only useful when inspecting the result of
PQdescribePrepared
. For other types of queries it will return zero.-
PQparamtype
Returns the data type of the indicated statement parameter. Parameter numbers start at 0.
Oid PQparamtype(const PGresult *res, int param_number);
This function is only useful when inspecting the result of
PQdescribePrepared
. For other types of queries it will return zero.-
PQprint
Prints out all the rows and, optionally, the column names to the specified output stream.
void PQprint(FILE *fout, /* output stream */ const PGresult *res, const PQprintOpt *po); typedef struct { pqbool header; /* print output field headings and row count */ pqbool align; /* fill align the fields */ pqbool standard; /* old brain dead format */ pqbool html3; /* output HTML tables */ pqbool expanded; /* expand tables */ pqbool pager; /* use pager for output if needed */ char *fieldSep; /* field separator */ char *tableOpt; /* attributes for HTML table element */ char *caption; /* HTML table caption */ char **fieldName; /* null-terminated array of replacement field names */ } PQprintOpt;
This function was formerly used by psql to print query results, but this is no longer the case. Note that it assumes all the data is in text format.
32.3.3. Retrieving Other Result Information
These functions are used to extract other information from PGresult
objects.
-
PQcmdStatus
Returns the command status tag from the SQL command that generated the
PGresult
.char *PQcmdStatus(PGresult *res);
Commonly this is just the name of the command, but it might include additional data such as the number of rows processed. The caller should not free the result directly. It will be freed when the associated
PGresult
handle is passed toPQclear
.-
PQcmdTuples
Returns the number of rows affected by the SQL command.
char *PQcmdTuples(PGresult *res);
This function returns a string containing the number of rows affected by the SQL statement that generated the
PGresult
. This function can only be used following the execution of aSELECT
,CREATE TABLE AS
,INSERT
,UPDATE
,DELETE
,MOVE
,FETCH
, orCOPY
statement, or anEXECUTE
of a prepared query that contains anINSERT
,UPDATE
, orDELETE
statement. If the command that generated thePGresult
was anything else,PQcmdTuples
returns an empty string. The caller should not free the return value directly. It will be freed when the associatedPGresult
handle is passed toPQclear
.-
PQoidValue
Returns the OID of the inserted row, if the SQL command was an
INSERT
that inserted exactly one row into a table that has OIDs, or aEXECUTE
of a prepared query containing a suitableINSERT
statement. Otherwise, this function returnsInvalidOid
. This function will also returnInvalidOid
if the table affected by theINSERT
statement does not contain OIDs.Oid PQoidValue(const PGresult *res);
-
PQoidStatus
This function is deprecated in favor of
PQoidValue
and is not thread-safe. It returns a string with the OID of the inserted row, whilePQoidValue
returns the OID value.char *PQoidStatus(const PGresult *res);
32.3.4. Escaping Strings for Inclusion in SQL Commands
-
PQescapeLiteral
char *PQescapeLiteral(PGconn *conn, const char *str, size_t length);
PQescapeLiteral
escapes a string for use within an SQL command. This is useful when inserting data values as literal constants in SQL commands. Certain characters (such as quotes and backslashes) must be escaped to prevent them from being interpreted specially by the SQL parser.PQescapeLiteral
performs this operation.PQescapeLiteral
returns an escaped version of thestr
parameter in memory allocated withmalloc()
. This memory should be freed usingPQfreemem()
when the result is no longer needed. A terminating zero byte is not required, and should not be counted inlength
. (If a terminating zero byte is found beforelength
bytes are processed,PQescapeLiteral
stops at the zero; the behavior is thus rather likestrncpy
.) The return string has all special characters replaced so that they can be properly processed by the Postgres Pro string literal parser. A terminating zero byte is also added. The single quotes that must surround Postgres Pro string literals are included in the result string.On error,
PQescapeLiteral
returnsNULL
and a suitable message is stored in theconn
object.Tip
It is especially important to do proper escaping when handling strings that were received from an untrustworthy source. Otherwise there is a security risk: you are vulnerable to “SQL injection” attacks wherein unwanted SQL commands are fed to your database.
Note that it is neither necessary nor correct to do escaping when a data value is passed as a separate parameter in
PQexecParams
or its sibling routines.-
PQescapeIdentifier
char *PQescapeIdentifier(PGconn *conn, const char *str, size_t length);
PQescapeIdentifier
escapes a string for use as an SQL identifier, such as a table, column, or function name. This is useful when a user-supplied identifier might contain special characters that would otherwise not be interpreted as part of the identifier by the SQL parser, or when the identifier might contain upper case characters whose case should be preserved.PQescapeIdentifier
returns a version of thestr
parameter escaped as an SQL identifier in memory allocated withmalloc()
. This memory must be freed usingPQfreemem()
when the result is no longer needed. A terminating zero byte is not required, and should not be counted inlength
. (If a terminating zero byte is found beforelength
bytes are processed,PQescapeIdentifier
stops at the zero; the behavior is thus rather likestrncpy
.) The return string has all special characters replaced so that it will be properly processed as an SQL identifier. A terminating zero byte is also added. The return string will also be surrounded by double quotes.On error,
PQescapeIdentifier
returnsNULL
and a suitable message is stored in theconn
object.Tip
As with string literals, to prevent SQL injection attacks, SQL identifiers must be escaped when they are received from an untrustworthy source.
-
PQescapeStringConn
size_t PQescapeStringConn(PGconn *conn, char *to, const char *from, size_t length, int *error);
PQescapeStringConn
escapes string literals, much likePQescapeLiteral
. UnlikePQescapeLiteral
, the caller is responsible for providing an appropriately sized buffer. Furthermore,PQescapeStringConn
does not generate the single quotes that must surround Postgres Pro string literals; they should be provided in the SQL command that the result is inserted into. The parameterfrom
points to the first character of the string that is to be escaped, and thelength
parameter gives the number of bytes in this string. A terminating zero byte is not required, and should not be counted inlength
. (If a terminating zero byte is found beforelength
bytes are processed,PQescapeStringConn
stops at the zero; the behavior is thus rather likestrncpy
.)to
shall point to a buffer that is able to hold at least one more byte than twice the value oflength
, otherwise the behavior is undefined. Behavior is likewise undefined if theto
andfrom
strings overlap.If the
error
parameter is notNULL
, then*error
is set to zero on success, nonzero on error. Presently the only possible error conditions involve invalid multibyte encoding in the source string. The output string is still generated on error, but it can be expected that the server will reject it as malformed. On error, a suitable message is stored in theconn
object, whether or noterror
isNULL
.PQescapeStringConn
returns the number of bytes written toto
, not including the terminating zero byte.-
PQescapeString
PQescapeString
is an older, deprecated version ofPQescapeStringConn
.size_t PQescapeString (char *to, const char *from, size_t length);
The only difference from
PQescapeStringConn
is thatPQescapeString
does not takePGconn
orerror
parameters. Because of this, it cannot adjust its behavior depending on the connection properties (such as character encoding) and therefore it might give the wrong results. Also, it has no way to report error conditions.PQescapeString
can be used safely in client programs that work with only one Postgres Pro connection at a time (in this case it can find out what it needs to know “behind the scenes”). In other contexts it is a security hazard and should be avoided in favor ofPQescapeStringConn
.-
PQescapeByteaConn
Escapes binary data for use within an SQL command with the type
bytea
. As withPQescapeStringConn
, this is only used when inserting data directly into an SQL command string.unsigned char *PQescapeByteaConn(PGconn *conn, const unsigned char *from, size_t from_length, size_t *to_length);
Certain byte values must be escaped when used as part of a
bytea
literal in an SQL statement.PQescapeByteaConn
escapes bytes using either hex encoding or backslash escaping. See Section 8.4 for more information.The
from
parameter points to the first byte of the string that is to be escaped, and thefrom_length
parameter gives the number of bytes in this binary string. (A terminating zero byte is neither necessary nor counted.) Theto_length
parameter points to a variable that will hold the resultant escaped string length. This result string length includes the terminating zero byte of the result.PQescapeByteaConn
returns an escaped version of thefrom
parameter binary string in memory allocated withmalloc()
. This memory should be freed usingPQfreemem()
when the result is no longer needed. The return string has all special characters replaced so that they can be properly processed by the Postgres Pro string literal parser, and thebytea
input function. A terminating zero byte is also added. The single quotes that must surround Postgres Pro string literals are not part of the result string.On error, a null pointer is returned, and a suitable error message is stored in the
conn
object. Currently, the only possible error is insufficient memory for the result string.-
PQescapeBytea
PQescapeBytea
is an older, deprecated version ofPQescapeByteaConn
.unsigned char *PQescapeBytea(const unsigned char *from, size_t from_length, size_t *to_length);
The only difference from
PQescapeByteaConn
is thatPQescapeBytea
does not take aPGconn
parameter. Because of this,PQescapeBytea
can only be used safely in client programs that use a single Postgres Pro connection at a time (in this case it can find out what it needs to know “behind the scenes”). It might give the wrong results if used in programs that use multiple database connections (usePQescapeByteaConn
in such cases).-
PQunescapeBytea
Converts a string representation of binary data into binary data — the reverse of
PQescapeBytea
. This is needed when retrievingbytea
data in text format, but not when retrieving it in binary format.unsigned char *PQunescapeBytea(const unsigned char *from, size_t *to_length);
The
from
parameter points to a string such as might be returned byPQgetvalue
when applied to abytea
column.PQunescapeBytea
converts this string representation into its binary representation. It returns a pointer to a buffer allocated withmalloc()
, orNULL
on error, and puts the size of the buffer into_length
. The result must be freed usingPQfreemem
when it is no longer needed.This conversion is not exactly the inverse of
PQescapeBytea
, because the string is not expected to be “escaped” when received fromPQgetvalue
. In particular this means there is no need for string quoting considerations, and so no need for aPGconn
parameter.