9.26. Системные информационные функции и операторы #
- 9.26.1. Функции получения информации о сеансе
- 9.26.2. Функции для проверки прав доступа
- 9.26.3. Функции для определения видимости
- 9.26.4. Функции для обращения к системным каталогам
- 9.26.5. Функции получения информации и адресации объектов
- 9.26.6. Функции получения комментариев
- 9.26.7. Функции проверки допустимости данных
- 9.26.8. Функции получения информации об идентификаторах транзакций и снимках состояния
- 9.26.9. Функции получения информации о фиксации транзакций
- 9.26.10. Функции управления данными
- 9.26.2. Функции для проверки прав доступа
Функции, описанные в этом разделе, предназначены для получения различной информации о сервере PostgreSQL.
9.26.1. Функции получения информации о сеансе #
В Таблице 9.68 перечислен ряд функций, предназначенных для получения информации о текущем сеансе и системе.
В дополнение к перечисленным здесь функциям существуют также функции, связанные с подсистемой статистики, которые тоже предоставляют системную информацию. Подробнее они рассматриваются в Подразделе 26.2.2.
Таблица 9.68. Функции получения информации о сеансе
Функция Описание |
|---|
Выдаёт имя текущей базы данных. (В стандарте SQL базы данных называются «каталогами», поэтому стандарту соответствует написание |
Выдаёт текст запроса, выполняемого в данный момент, в том виде, в каком его передал клиент (может состоять из нескольких операторов). |
Аналог |
Выдаёт имя первой схемы в пути поиска (или значение NULL, если путь поиска пустой). В эту схему будут добавляться таблицы и другие объекты, при создании которых схема не указывается явно. |
Выдаёт массив имён всех схем, в настоящее время представленных в действующем пути поиска, по порядку их приоритета. (Элементы текущего значения search_path, которым не соответствуют существующие схемы, опускаются). Если логический аргумент равен |
Выдаёт имя пользователя в текущем контексте выполнения. |
Выдаёт IP-адрес текущего клиента либо |
Выдаёт номер TCP-порта текущего клиента либо |
Выдаёт IP-адрес, через который сервер принял текущее подключение, либо NULL, если текущее подключение установлено через Unix-сокет. |
Выдаёт номер TCP-порта, через который сервер принял текущее подключение, либо |
Выдаёт идентификатор серверного процесса, обслуживающего текущий сеанс. |
Выдаёт массив с идентификаторами процессов сеансов, которые блокируют серверный процесс с указанным идентификатором, либо пустой массив, если указанный серверный процесс не найден или не заблокирован. Один серверный процесс блокирует другой, если он либо удерживает блокировку, конфликтующую с блокировкой, запрашиваемой вторым (жёсткая блокировка), либо ожидает блокировку, которая вызвала бы конфликт с запросом блокировки заблокированного процесса и находится перед ней в очереди ожидания (мягкая блокировка). При распараллеливании запросов эта функция всегда выдаёт видимые клиентом идентификаторы процессов (то есть, результаты Частые вызовы этой функции могут отразиться на производительности базы данных, так как ей нужен монопольный доступ к общему состоянию менеджера блокировок, пусть и на короткое время. |
Выдаёт время, когда в последний раз сервер загружал файлы конфигурации. (Если текущий сеанс начался раньше, она возвращает время, когда эти файлы были перезагружены для данного сеанса, так что в разных сеансах это значение может немного различаться. В противном случае это будет время, когда файлы конфигурации считал главный процесс.) |
Выдаёт путь к файлу журнала, в настоящее время используемому сборщиком сообщений. Этот путь состоит из пути каталога log_directory и имени конкретного файла. Если сборщик сообщений отключён, выдаётся значение |
Выдаёт OID временной схемы текущего сеанса или 0, если такой схемы нет (в рамках сеанса не создавались временные таблицы). |
Выдаёт true, если заданный OID относится к временной схеме другого сеанса. (Это может быть полезно, например для исключения временных таблиц других сеансов из общего списка при просмотре таблиц базы данных.) |
Выдаёт true, если в данном сеансе доступна JIT-компиляция (см. Главу 30) и параметр конфигурации jit включён. |
Выдаёт список имён каналов асинхронных уведомлений, по которым текущий сеанс принимает сигналы. |
Выдаёт долю (0–1) максимального размера очереди асинхронных уведомлений, в настоящее время занятую уведомлениями, ожидающими обработки. За дополнительными сведениями обратитесь к LISTEN и NOTIFY. |
Выдаёт время, когда был запущен сервер. |
Выдаёт массив с идентификаторами процессов сеансов, которые блокируют серверный процесс с указанным идентификатором, не давая ему получить безопасный снимок, либо выдаёт пустой массив, если такой серверный процесс не найден или он не заблокирован. Сеанс, выполняющий транзакцию уровня Частые вызовы этой функции могут отразиться на производительности сервера, так как ей нужен доступ к общему состоянию менеджера предикатных блокировок, пусть и на короткое время. |
Выдаёт текущий уровень вложенности в триггерах Postgres Pro (0, если эта функция вызывается не из тела триггера, непосредственно или косвенно). |
Выдаёт имя пользователя сеанса. |
Возвращает метод аутентификации и идентификационную информацию (если есть), которые пользователь представил во время цикла аутентификации до того, как ему была назначена роль базы данных. Он представлен как |
Аналог |
Выдаёт текстовую строку, описывающую версию сервера PostgreSQL. Эту информацию также можно получить из переменной server_version или, в более машинно-ориентированном формате, из переменной server_version_num. При разработке программ следует использовать функцию |
Выдаёт текстовую строку, описывающую версию сервера Postgres Pro. |
Выдаёт текстовую строку, описывающую редакцию Postgres Pro, например |
Выдаёт идентификатор состояния исходного кода, из которого скомпилирован Postgres Pro. |
Примечание
Функции current_catalog, current_role, current_schema, current_user, session_user и user имеют особый синтаксический статус в SQL: они должны вызываться без скобок после имени. Postgres Pro позволяет добавить скобки в вызове current_schema, но не других функций.
Функция session_user обычно возвращает имя пользователя, установившего текущее соединение с базой данных, но суперпользователи могут изменить это имя, выполнив команду SET SESSION AUTHORIZATION. Функция current_user возвращает идентификатор пользователя, по которому будут проверяться его права. Обычно это тот же пользователь, что и пользователь сеанса, но его можно сменить с помощью SET ROLE. Этот идентификатор также меняется при выполнении функций с атрибутом SECURITY DEFINER. На языке Unix пользователь сеанса называется «реальным», а текущий — «эффективным». Имена current_role и user являются синонимами current_user. (В стандарте SQL current_role и current_user имеют разное значение, но в Postgres Pro они не различаются, так как пользователи и роли объединены в единую сущность.)
9.26.2. Функции для проверки прав доступа #
В Таблице 9.69 показаны функции, позволяющие программно проверить права доступа к объектам. (Подробнее о правах рассказывается в Разделе 5.7.) Этим функциям в качестве идентификатора пользователя, для которого запрашиваются права, можно передать его имя или OID (pg_authid.oid), а также можно передать public (это будет указывать на псевдороль PUBLIC). Кроме того, аргумент user можно полностью опустить, тогда будет подразумеваться current_user. Объект, права для доступа к которому запрашиваются, также можно задать по имени или по OID. Когда указывается имя объекта, его можно дополнить именем схемы, если это уместно. Запрашиваемое право записывается текстовой строкой, которая должна задавать одно из прав доступа, соответствующих типу объекта (например, SELECT). Дополнительно к названию права можно добавить WITH GRANT OPTION и проверить, разрешено ли пользователю передавать это право другим. Кроме того, в одном параметре можно перечислить несколько прав через запятую, и тогда функция возвратит true, если пользователь имеет какие-либо из них. (Регистр в названии прав не имеет значения, а между ними (но не внутри) разрешены пробельные символы.) Пара примеров:
SELECT has_table_privilege('myschema.mytable', 'select');
SELECT has_table_privilege('joe', 'mytable', 'INSERT, SELECT WITH GRANT OPTION');Таблица 9.69. Функции для проверки прав доступа
Функция Описание |
|---|
Имеет ли пользователь указанное право для какого-либо столбца таблицы? Ответ положительный, когда он имеет это право для всей таблицы или ему дано соответствующее право на уровне столбцов хотя бы для одного столбца. Возможные права: |
Имеет ли пользователь указанное право для заданного столбца таблицы? Ответ положительный, когда он имеет это право для всей таблицы или ему дано соответствующее право на уровне столбца. Столбец можно задать по имени или номеру атрибута ( |
Имеет ли пользователь указанное право в базе данных? Возможные права: |
Имеет ли пользователь право для обёртки сторонних данных? На данный момент возможно только одно право: |
Имеет ли пользователь право для функции? Возможно единственное право: При указании функции по имени, а не по OID, допускаются те же входные значения, что и для типа SELECT has_function_privilege('joeuser', 'myfunc(int, text)', 'execute'); |
Имеет ли пользователь право для языка? Возможно единственное право: |
Имеет ли пользователь право для параметра конфигурации? Регистр в имени параметра игнорируется. Возможные права: |
Имеет ли пользователь право для схемы? Возможные права: |
Имеет ли пользователь право для последовательности? Возможные права: |
Имеет ли пользователь право для стороннего сервера? На данный момент возможно только одно право: |
Имеет ли пользователь право для таблицы? Возможные права: |
Имеет ли пользователь право для табличного пространства? Возможно единственное право: |
Имеет ли пользователь право для типа данных? Возможно единственное право: |
Имеет ли пользователь право для роли? Возможные права: |
Действует ли защита на уровне строк для заданной таблицы в контексте текущего пользователя в текущем окружении? |
В Таблице 9.70 показаны операторы, предназначенные для работы с типом aclitem, который представляет в системном каталоге права доступа. О содержании значений этого типа рассказывается в Разделе 5.7.
Таблица 9.70. Операторы для типа aclitem
В Таблице 9.71 приведены дополнительные функции, предназначенные для работы с типом aclitem.
Таблица 9.71. Функции для типа aclitem
Функция Описание |
|---|
Выдаёт массив с элементами |
Возвращает массив |
Конструирует значение |
9.26.3. Функции для определения видимости #
В Таблице 9.72 показаны функции, определяющие видимость объекта с текущим путём поиска схем. К примеру, таблица считается видимой, если содержащая её схема включена в путь поиска и нет другой таблицы с тем же именем, которая была бы найдена в этом пути раньше. Другими словами, к этой таблице можно будет обратиться просто по её имени, без явного указания схемы. Просмотреть список всех видимых таблиц можно так:
SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);
Объект, представляющий функцию и оператор, считаются видимым в пути поиска, если при просмотре пути не находится предшествующий ему другой объект с тем же именем и типами аргументов. Для семейств и классов операторов помимо имени объекта во внимание принимается также связанный метод доступа к индексу.
Таблица 9.72. Функции для определения видимости
Всем этим функциям должен передаваться OID проверяемого объекта. Если вы хотите проверить объект по имени, удобнее использовать типы-псевдонимы OID (regclass, regtype, regprocedure, regoperator, regconfig или regdictionary), например:
SELECT pg_type_is_visible('myschema.widget'::regtype);Заметьте, что проверять таким способом имена без указания схемы не имеет большого смысла — если имя удастся распознать, значит и объект будет видимым.
9.26.4. Функции для обращения к системным каталогам #
В Таблице 9.73 перечислены функции, извлекающие информацию из системных каталогов.
Таблица 9.73. Функции для обращения к системным каталогам
Функция Описание |
|---|
Выдаёт в формате SQL имя типа данных, определяемого по OID и, возможно, модификатору типа. Если модификатор неизвестен, вместо него можно передать NULL. |
Преобразует предоставленное имя кодировки в целое число, представляющее внутренний идентификатор, используемый в некоторых таблицах системного каталога. Возвращает |
Преобразует целое число, используемое в качестве внутреннего идентификатора кодировки в некоторых таблицах системного каталога, в понятное имя. Возвращает пустую строку, если указан неправильный номер кодировки. |
Возвращает набор записей, описывающих отношения внешних ключей, существующие в системных каталогах Postgres Pro. Столбец |
Восстанавливает команду, создающую ограничение. (Текст команды не является изначальным, он восстанавливается путём декомпиляции.) |
Декомпилирует внутреннюю форму выражений, находящихся в системных каталогах, например, выражений, задающих значения по умолчанию. Если выражение может содержать Vars (переменные), передайте во втором параметре OID отношения, к которому обращается данное выражение; в противном случае достаточно передать 0. |
Восстанавливает команду, создающую функцию или процедуру. (Текст команды не является изначальным, он восстанавливается путём декомпиляции.) В результате выдаётся полноценный оператор |
Восстанавливает список аргументов для функции или процедуры в том виде, в каком он должен задаваться в команде |
Восстанавливает список аргументов, необходимый для однозначной идентификации функции или процедуры, в том виде, в каком он должен задаваться, например в |
Восстанавливает для функции предложение |
Восстанавливает команду, создающую индекс. (Текст команды не является изначальным, он восстанавливается путём декомпиляции.) Если передаётся значение |
Выдаёт набор записей, описывающих ключевые слова, которые воспринимает сервер. Столбец |
Восстанавливает определение ограничения секции. (Текст команды не является изначальным, он восстанавливается путём декомпиляции.) |
Восстанавливает определение ключа секционирования секционированной таблицы в той форме, которую он имел бы в предложении |
Восстанавливает команду, создающую правило. (Текст команды не является изначальным, он восстанавливается путём декомпиляции.) |
Выдаёт имя последовательности, связанной со столбцом, либо NULL, если такой последовательности нет. Для столбца идентификации это будет последовательность, созданная для него неявно внутри. Для столбцов, имеющих один из последовательных типов ( Обычно эта функция применяется для получения текущего значения последовательности для столбца идентификации или последовательного столбца, например так: SELECT currval(pg_get_serial_sequence('sometable', 'id')); |
Восстанавливает команду, создающую объект расширенной статистики. (Текст команды не является изначальным, он восстанавливается путём декомпиляции.) |
Восстанавливает команду, создающую триггер. (Текст команды не является изначальным, он восстанавливается путём декомпиляции.) |
Выдаёт имя роли по заданному OID. |
Восстанавливает команду |
Восстанавливает команду |
Восстанавливает команду |
Проверяет, имеет ли столбец индекса заданное свойство. Типичные свойства столбцов описаны в Таблице 9.74. (Заметьте, что расширенные методы доступа могут определять для своих индексов дополнительные свойства.) Если заданное имя свойства не известно или не применимо к конкретному объекту, либо если OID или номер столбца не указывают на существующий объект, эта функция возвращает |
Проверяет, имеет ли индекс заданное свойство. Типичные свойства индексов описаны в Таблице 9.74. (Заметьте, что расширенные методы доступа могут определять для своих индексов дополнительные свойства.) Если заданное имя свойства не известно или не применимо к конкретному объекту, либо если OID не указывает на существующий объект, эта функция возвращает |
Проверяет, имеет ли метод доступа индекса заданное свойство. Свойства методов доступа описаны в Таблице 9.76. Если заданное имя свойства неизвестно или не применимо к конкретному объекту, либо если OID не указывает на существующий объект, эта функция возвращает |
Выдаёт набор параметров хранилища, представленных значением из |
Возвращает массив флагов, связанных с данным параметром GUC, или |
Выдаёт набор OID баз данных, объекты которых размещены в заданном табличном пространстве. Если эта функция возвращает строки, это означает, что табличное пространство не пустое и удалить его нельзя. Какие именно объекты находятся в табличном пространстве, можно определить, подключаясь к базам данных, OID которых сообщила |
Выдаёт путь в файловой системе к местоположению заданного табличного пространства. |
Выдаёт OID типа данных для переданного значения. Это может быть полезно для разрешения проблем или динамического создания SQL-запросов. Эта функция объявлена как возвращающая тип Пример: SELECT pg_typeof(33);
pg_typeof
-----------
integer
SELECT typlen FROM pg_type WHERE oid = pg_typeof(33);
typlen
--------
4 |
Выдаёт имя правила сортировки для переданного значения. Это значение может быть заключено в кавычки и дополнено схемой. Если с выражением аргумента не связано правило сортировки, возвращается Пример: SELECT collation for (description) FROM pg_description LIMIT 1;
pg_collation_for
------------------
"default"
SELECT collation for ('foo' COLLATE "de_DE");
pg_collation_for
------------------
"de_DE" |
Переводит в OID текстовое имя отношения. Подобный результат можно получить, приведя строку с именем к типу |
Переводит в OID текстовое имя правила сортировки. Подобный результат можно получить, приведя строку с именем к типу |
Переводит в OID текстовое имя схемы. Подобный результат можно получить, приведя строку с именем к типу |
Переводит в OID текстовое имя оператора. Подобный результат можно получить, приведя строку с именем к типу |
Переводит в OID текстовое имя оператора с указанием типов параметров. Подобный результат можно получить, приведя строку с именем к типу |
Переводит в OID текстовое имя функции или процедуры. Подобный результат можно получить, приведя строку с именем к типу |
Переводит в OID текстовое имя функции или процедуры с указанием типов аргументов. Подобный результат можно получить, приведя строку с именем к типу |
Переводит в OID текстовое имя профиля. Подобный результат можно получить, приведя строку с именем к типу |
Переводит в OID текстовое имя роли. Подобный результат можно получить, приведя строку с именем к типу |
Переводит в OID текстовое имя типа. Подобный результат можно получить, приведя строку с именем к типу |
Многие из функций, восстанавливающих (декомпилирующих) объекты БД, принимают дополнительный флаг pretty, в котором можно передать true для визуального улучшения вывода. При этом будут убраны лишние скобки и добавлены пробельные символы, чтобы текст был более разборчивым. Преобразованный вывод легче читается, но формат по умолчанию с большей вероятностью будет успешно восприниматься будущими версиями Postgres Pro, поэтому для выгрузки содержимого БД рекомендуется избегать использования визуально улучшенного формата. Если параметр pretty равен false, это равнозначно его отсутствию.
Таблица 9.74. Свойства столбца индекса
| Имя | Описание |
|---|---|
asc | Сортируется ли столбец по возрастанию при сканировании вперёд? |
desc | Сортируется ли столбец по убыванию при сканировании вперёд? |
nulls_first | Выдаются ли NULL в начале при сканирования вперёд? |
nulls_last | Выдаются ли NULL в конце при сканировании вперёд? |
orderable | Связан ли со столбцом некоторый порядок сортировки? |
distance_orderable | Может ли столбец сканироваться по порядку оператором «расстояния», например, ORDER BY столбец <-> константа ? |
returnable | Может ли значение столбца быть получено при сканировании только индекса? |
search_array | Поддерживает ли столбец внутренними средствами поиск столбец = ANY(массив)? |
search_nulls | Поддерживает ли столбец поиск IS NULL и IS NOT NULL? |
Таблица 9.75. Свойства индекса
| Имя | Описание |
|---|---|
clusterable | Может ли индекс использоваться в команде CLUSTER? |
index_scan | Поддерживает ли индекс простое сканирование (не по битовой карте)? |
bitmap_scan | Поддерживает ли индекс сканирование по битовой карте? |
backward_scan | Может ли в процессе сканирования меняться направление (для поддержки перемещения курсора FETCH BACKWARD без необходимости материализации)? |
Таблица 9.76. Свойства метода доступа индекса
| Имя | Описание |
|---|---|
can_order | Поддерживает ли метод доступа ASC, DESC и связанные ключевые слова в CREATE INDEX? |
can_unique | Поддерживает ли метод доступа уникальные индексы? |
can_multi_col | Поддерживает ли метод доступа индексы по нескольким столбцам? |
can_exclude | Поддерживает ли метод доступа ограничения-исключения? |
can_include | Поддерживает ли метод доступа предложение INCLUDE команды CREATE INDEX? |
Таблица 9.77. Флаги параметров GUC
| Флаг | Описание |
|---|---|
EXPLAIN | Параметры с этим флагом включаются в команды EXPLAIN (SETTINGS). |
NO_SHOW_ALL | Параметры с этим флагом исключаются из команд SHOW ALL. |
NO_RESET | Параметры с этим флагом не поддерживают команды RESET. |
NO_RESET_ALL | Параметры с этим флагом исключаются из команд RESET ALL. |
NOT_IN_SAMPLE | Параметры с этим флагом не включаются в postgresql.conf по умолчанию. |
RUNTIME_COMPUTED | Параметры с этим флагом вычисляются во время выполнения. |
9.26.5. Функции получения информации и адресации объектов #
В Таблице 9.78 перечислены функции, связанные с идентификацией и адресацией объектов баз данных.
Таблица 9.78. Функции получения информации и адресации объектов
9.26.6. Функции получения комментариев #
Функции, перечисленные в Таблице 9.79, извлекают комментарии, заданные для объектов с помощью команды COMMENT. Если найти комментарий для заданных параметров не удаётся, они возвращают NULL.
Таблица 9.79. Функции получения комментариев
9.26.7. Функции проверки допустимости данных #
Функции, показанные в Таблица 9.80, могут быть полезны для проверки допустимости предлагаемых входных данных.
Таблица 9.80. Функции проверки допустимости данных
9.26.8. Функции получения информации об идентификаторах транзакций и снимках состояния #
Функции, показанные в Таблице 9.81, выдают информацию о транзакциях сервера в виде, подходящем для экспорта. В основном эти функции используются, чтобы определить, какие транзакции были зафиксированы между двумя снимками состояния.
Таблица 9.81. Функции получения информации об идентификаторах транзакций и снимках состояния
Функция Описание |
|---|
Возвращает количество транзакций между указанным идентификатором транзакции и текущим значением счётчика транзакций. |
Возвращает количество идентификаторов мультитранзакций между указанным идентификатором мультитранзакций и текущим значением счётчика мультитранзакций. |
Выдаёт идентификатор текущей транзакции. Если у текущей транзакции ещё нет идентификатора (она не успела выполнить какие-либо изменения в базе), он будет ей назначен; подробнее см. Раздел 71.1. Если выполняется в подтранзакции, выдаёт идентификатор транзакции верхнего уровня; подробнее см. Раздел 71.3. |
Выдаёт идентификатор текущей транзакции или |
Выдаёт состояние фиксации транзакции. Результатом будет одно из значений: |
Возвращает текущий снимок состояния — структуру данных, показывающую идентификаторы транзакций, которые выполняются в момент снимка. В снимок включаются только идентификаторы транзакций верхнего уровня; идентификаторы подтранзакций не отображаются; за подробностями обратитесь к Разделу 71.3. |
Выдаёт набор идентификаторов выполняющихся транзакций, содержащихся в снимке. |
Выдаёт значение |
Выдаёт |
Видна ли транзакция с указанным идентификатором в данном снимке (то есть, была ли она завершена до момента получения снимка)? Обратите внимание, что эта функция не выдаст правильный ответ, если ей передать идентификатор подтранзакции (subxid); за подробностями обратитесь к Разделу 71.3. |
Выдаёт идентификатор транзакции и режима блокировки для каждого члена с заданным идентификатором мультитранзакции. Режимы блокировок |
Внутренний тип идентификаторов транзакций, xid, имеет размер 32 бита и значения в нём повторяются через каждые 4 миллиарда транзакций. Однако функции, показанные в Таблице 9.81, за исключением age, mxid_age и pg_get_multixact_members, используют 64-битный тип xid8, значения которого не повторяются на протяжении всей жизни сервера и могут быть приведены к типу xid, если требуется (подробное описание находится в Разделе 71.1). Тип данных pg_snapshot содержит информацию о видимости транзакций в определённый момент времени. Его компоненты описаны в Таблице 9.82. В текстовом виде pg_snapshot представляется как . Например, запись xmin:xmax:список_xip10:20:10,14,15 обозначает xmin=10, xmax=20, xip_list=10, 14, 15.
Таблица 9.82. Состав информации о снимке
| Имя | Описание |
|---|---|
xmin | Минимальный идентификатор транзакции среди всех активных. Все транзакции, идентификаторы которых меньше xmin, уже либо зафиксированы и видимы, либо отменены и «мертвы». |
xmax | Идентификатор на один больше идентификатора последней завершённой транзакции. Все транзакции, идентификаторы которых больше или равны xmax, на момент получения снимка ещё не завершены и не являются видимыми. |
xip_list | Транзакции, выполняющиеся в момент получения снимка. Транзакции с такими идентификаторами, для которых xmin <= , не попавшие в этот список, были уже завершены на момент получения снимка, и поэтому либо видимы, либо «мертвы», в зависимости от варианта завершения. Идентификаторы подтранзакций (subxid) в этот список не включаются. |
До версии 13 в Postgres Pro отсутствовал тип xid8, поэтому предлагались вариации этих функций, в которых 64-битные XID представлялись в типе bigint, а для информации о снимке использовался отдельный тип txid_snapshot. В названиях этих старых функций фигурирует txid. Они по-прежнему поддерживаются для обратной совместимости, но могут быть удалены в будущем. См. Таблицу 9.83.
Таблица 9.83. Устаревшие функции получения информации об идентификаторах транзакций и снимках состояния
9.26.9. Функции получения информации о фиксации транзакций #
Функции, показанные в Таблице 9.84, выдают информацию о времени фиксации уже завершённых транзакций. Результат этих функций будет полезным, только когда включён параметр конфигурации track_commit_timestamp и только для транзакций, зафиксированных после его включения. Информация о временной метке фиксации удаляется во время очистки.
Таблица 9.84. Функции получения информации о фиксации транзакций
9.26.10. Функции управления данными #
Функции, показанные в Таблице 9.85, выдают информацию, записываемую во время initdb, например, версию каталога. Они также выводят сведения о журнале предзаписи и контрольных точках. Эта информация относится ко всему кластеру, а не к отдельной базе. Данные функции выдают практически ту же информацию, и из того же источника, что и pg_controldata.
Таблица 9.85. Функции управления данными
Функция Описание |
|---|
Выдаёт информацию о текущем состоянии контрольных точек, показанную в Таблице 9.86. |
Выдаёт информацию о текущем состоянии управляющего файла, показанную в Таблице 9.87. |
Выдаёт информацию о состоянии инициализации кластера, показанную в Таблице 9.88. |
Выдаёт информацию о состоянии восстановления, как показано в Таблице 9.89. |
Таблица 9.86. Столбцы результата pg_control_checkpoint
| Имя столбца | Тип данных |
|---|---|
checkpoint_lsn | pg_lsn |
redo_lsn | pg_lsn |
redo_wal_file | text |
timeline_id | integer |
prev_timeline_id | integer |
full_page_writes | boolean |
next_xid | text |
next_oid | oid |
next_multixact_id | xid |
next_multi_offset | xid |
oldest_xid | xid |
oldest_xid_dbid | oid |
oldest_active_xid | xid |
oldest_multi_xid | xid |
oldest_multi_dbid | oid |
oldest_commit_ts_xid | xid |
newest_commit_ts_xid | xid |
checkpoint_time | timestamp with time zone |
Таблица 9.87. Столбцы результата pg_control_system
| Имя столбца | Тип данных |
|---|---|
pg_control_version | integer |
catalog_version_no | integer |
system_identifier | bigint |
pg_control_last_modified | timestamp with time zone |
pg_control_edition | text |
Таблица 9.88. Столбцы результата pg_control_init
| Имя столбца | Тип данных |
|---|---|
max_data_alignment | integer |
database_block_size | integer |
blocks_per_segment | integer |
wal_block_size | integer |
bytes_per_wal_segment | integer |
max_identifier_length | integer |
max_index_columns | integer |
max_toast_chunk_size | integer |
large_object_chunk_size | integer |
float8_pass_by_value | boolean |
data_page_checksum_version | integer |
Таблица 9.89. Столбцы результата pg_control_recovery
| Имя столбца | Тип данных |
|---|---|
min_recovery_end_lsn | pg_lsn |
min_recovery_end_timeline | integer |
backup_start_lsn | pg_lsn |
backup_end_lsn | pg_lsn |
end_of_backup_record_required | boolean |
9.26. System Information Functions and Operators #
- 9.26.1. Session Information Functions
- 9.26.2. Access Privilege Inquiry Functions
- 9.26.3. Schema Visibility Inquiry Functions
- 9.26.4. System Catalog Information Functions
- 9.26.5. Object Information and Addressing Functions
- 9.26.6. Comment Information Functions
- 9.26.7. Data Validity Checking Functions
- 9.26.8. Transaction ID and Snapshot Information Functions
- 9.26.9. Committed Transaction Information Functions
- 9.26.10. Control Data Functions
- 9.26.2. Access Privilege Inquiry Functions
The functions described in this section are used to obtain various information about a PostgreSQL installation.
9.26.1. Session Information Functions #
Table 9.68 shows several functions that extract session and system information.
In addition to the functions listed in this section, there are a number of functions related to the statistics system that also provide system information. See Section 26.2.25 for more information.
Table 9.68. Session Information Functions
Function Description |
|---|
Returns the name of the current database. (Databases are called “catalogs” in the SQL standard, so |
Returns the text of the currently executing query, as submitted by the client (which might contain more than one statement). |
This is equivalent to |
Returns the name of the schema that is first in the search path (or a null value if the search path is empty). This is the schema that will be used for any tables or other named objects that are created without specifying a target schema. |
Returns an array of the names of all schemas presently in the effective search path, in their priority order. (Items in the current search_path setting that do not correspond to existing, searchable schemas are omitted.) If the Boolean argument is |
Returns the user name of the current execution context. |
Returns the IP address of the current client, or |
Returns the IP port number of the current client, or |
Returns the IP address on which the server accepted the current connection, or |
Returns the IP port number on which the server accepted the current connection, or |
Returns the process ID of the server process attached to the current session. |
Returns an array of the process ID(s) of the sessions that are blocking the server process with the specified process ID from acquiring a lock, or an empty array if there is no such server process or it is not blocked. One server process blocks another if it either holds a lock that conflicts with the blocked process's lock request (hard block), or is waiting for a lock that would conflict with the blocked process's lock request and is ahead of it in the wait queue (soft block). When using parallel queries the result always lists client-visible process IDs (that is, Frequent calls to this function could have some impact on database performance, because it needs exclusive access to the lock manager's shared state for a short time. |
Returns the time when the server configuration files were last loaded. If the current session was alive at the time, this will be the time when the session itself re-read the configuration files (so the reading will vary a little in different sessions). Otherwise it is the time when the postmaster process re-read the configuration files. |
Returns the path name of the log file currently in use by the logging collector. The path includes the log_directory directory and the individual log file name. The result is |
Returns the OID of the current session's temporary schema, or zero if it has none (because it has not created any temporary tables). |
Returns true if the given OID is the OID of another session's temporary schema. (This can be useful, for example, to exclude other sessions' temporary tables from a catalog display.) |
Returns true if a JIT compiler extension is available (see Chapter 30) and the jit configuration parameter is set to |
Returns the set of names of asynchronous notification channels that the current session is listening to. |
Returns the fraction (0–1) of the asynchronous notification queue's maximum size that is currently occupied by notifications that are waiting to be processed. See LISTEN and NOTIFY for more information. |
Returns the time when the server started. |
Returns an array of the process ID(s) of the sessions that are blocking the server process with the specified process ID from acquiring a safe snapshot, or an empty array if there is no such server process or it is not blocked. A session running a Frequent calls to this function could have some impact on database performance, because it needs access to the predicate lock manager's shared state for a short time. |
Returns the current nesting level of Postgres Pro triggers (0 if not called, directly or indirectly, from inside a trigger). |
Returns the session user's name. |
Returns the authentication method and the identity (if any) that the user presented during the authentication cycle before they were assigned a database role. It is represented as |
This is equivalent to |
Returns a string describing the PostgreSQL server's version. You can also get this information from server_version, or for a machine-readable version use server_version_num. Software developers should use |
Returns a string describing the Postgres Pro server's version. |
Returns a string describing Postgres Pro edition, i.e. |
Returns the commit ID of Postgres Pro source files. |
Note
current_catalog, current_role, current_schema, current_user, session_user, and user have special syntactic status in SQL: they must be called without trailing parentheses. In Postgres Pro, parentheses can optionally be used with current_schema, but not with the others.
The session_user is normally the user who initiated the current database connection; but superusers can change this setting with SET SESSION AUTHORIZATION. The current_user is the user identifier that is applicable for permission checking. Normally it is equal to the session user, but it can be changed with SET ROLE. It also changes during the execution of functions with the attribute SECURITY DEFINER. In Unix parlance, the session user is the “real user” and the current user is the “effective user”. current_role and user are synonyms for current_user. (The SQL standard draws a distinction between current_role and current_user, but Postgres Pro does not, since it unifies users and roles into a single kind of entity.)
9.26.2. Access Privilege Inquiry Functions #
Table 9.69 lists functions that allow querying object access privileges programmatically. (See Section 5.7 for more information about privileges.) In these functions, the user whose privileges are being inquired about can be specified by name or by OID (pg_authid.oid), or if the name is given as public then the privileges of the PUBLIC pseudo-role are checked. Also, the user argument can be omitted entirely, in which case the current_user is assumed. The object that is being inquired about can be specified either by name or by OID, too. When specifying by name, a schema name can be included if relevant. The access privilege of interest is specified by a text string, which must evaluate to one of the appropriate privilege keywords for the object's type (e.g., SELECT). Optionally, WITH GRANT OPTION can be added to a privilege type to test whether the privilege is held with grant option. Also, multiple privilege types can be listed separated by commas, in which case the result will be true if any of the listed privileges is held. (Case of the privilege string is not significant, and extra whitespace is allowed between but not within privilege names.) Some examples:
SELECT has_table_privilege('myschema.mytable', 'select');
SELECT has_table_privilege('joe', 'mytable', 'INSERT, SELECT WITH GRANT OPTION');
Table 9.69. Access Privilege Inquiry Functions
Function Description |
|---|
Does user have privilege for any column of table? This succeeds either if the privilege is held for the whole table, or if there is a column-level grant of the privilege for at least one column. Allowable privilege types are |
Does user have privilege for the specified table column? This succeeds either if the privilege is held for the whole table, or if there is a column-level grant of the privilege for the column. The column can be specified by name or by attribute number ( |
Does user have privilege for database? Allowable privilege types are |
Does user have privilege for foreign-data wrapper? The only allowable privilege type is |
Does user have privilege for function? The only allowable privilege type is When specifying a function by name rather than by OID, the allowed input is the same as for the
SELECT has_function_privilege('joeuser', 'myfunc(int, text)', 'execute');
|
Does user have privilege for language? The only allowable privilege type is |
Does user have privilege for configuration parameter? The parameter name is case-insensitive. Allowable privilege types are |
Does user have privilege for schema? Allowable privilege types are |
Does user have privilege for sequence? Allowable privilege types are |
Does user have privilege for foreign server? The only allowable privilege type is |
Does user have privilege for table? Allowable privilege types are |
Does user have privilege for tablespace? The only allowable privilege type is |
Does user have privilege for data type? The only allowable privilege type is |
Does user have privilege for role? Allowable privilege types are |
Is row-level security active for the specified table in the context of the current user and current environment? |
Table 9.70 shows the operators available for the aclitem type, which is the catalog representation of access privileges. See Section 5.7 for information about how to read access privilege values.
Table 9.70. aclitem Operators
Table 9.71 shows some additional functions to manage the aclitem type.
Table 9.71. aclitem Functions
Function Description |
|---|
Constructs an |
Returns the |
Constructs an |
9.26.3. Schema Visibility Inquiry Functions #
Table 9.72 shows functions that determine whether a certain object is visible in the current schema search path. For example, a table is said to be visible if its containing schema is in the search path and no table of the same name appears earlier in the search path. This is equivalent to the statement that the table can be referenced by name without explicit schema qualification. Thus, to list the names of all visible tables:
SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);
For functions and operators, an object in the search path is said to be visible if there is no object of the same name and argument data type(s) earlier in the path. For operator classes and families, both the name and the associated index access method are considered.
Table 9.72. Schema Visibility Inquiry Functions
All these functions require object OIDs to identify the object to be checked. If you want to test an object by name, it is convenient to use the OID alias types (regclass, regtype, regprocedure, regoperator, regconfig, or regdictionary), for example:
SELECT pg_type_is_visible('myschema.widget'::regtype);
Note that it would not make much sense to test a non-schema-qualified type name in this way — if the name can be recognized at all, it must be visible.
9.26.4. System Catalog Information Functions #
Table 9.73 lists functions that extract information from the system catalogs.
Table 9.73. System Catalog Information Functions
Function Description |
|---|
Returns the SQL name for a data type that is identified by its type OID and possibly a type modifier. Pass NULL for the type modifier if no specific modifier is known. |
Converts the supplied encoding name into an integer representing the internal identifier used in some system catalog tables. Returns |
Converts the integer used as the internal identifier of an encoding in some system catalog tables into a human-readable string. Returns an empty string if an invalid encoding number is provided. |
Returns a set of records describing the foreign key relationships that exist within the Postgres Pro system catalogs. The |
Reconstructs the creating command for a constraint. (This is a decompiled reconstruction, not the original text of the command.) |
Decompiles the internal form of an expression stored in the system catalogs, such as the default value for a column. If the expression might contain Vars, specify the OID of the relation they refer to as the second parameter; if no Vars are expected, passing zero is sufficient. |
Reconstructs the creating command for a function or procedure. (This is a decompiled reconstruction, not the original text of the command.) The result is a complete |
Reconstructs the argument list of a function or procedure, in the form it would need to appear in within |
Reconstructs the argument list necessary to identify a function or procedure, in the form it would need to appear in within commands such as |
Reconstructs the |
Reconstructs the creating command for an index. (This is a decompiled reconstruction, not the original text of the command.) If |
Returns a set of records describing the SQL keywords recognized by the server. The |
Reconstructs the definition of a partition constraint. (This is a decompiled reconstruction, not the original text of the command.) |
Reconstructs the definition of a partitioned table's partition key, in the form it would have in the |
Reconstructs the creating command for a rule. (This is a decompiled reconstruction, not the original text of the command.) |
Returns the name of the sequence associated with a column, or NULL if no sequence is associated with the column. If the column is an identity column, the associated sequence is the sequence internally created for that column. For columns created using one of the serial types ( A typical use is in reading the current value of the sequence for an identity or serial column, for example:
SELECT currval(pg_get_serial_sequence('sometable', 'id'));
|
Reconstructs the creating command for an extended statistics object. (This is a decompiled reconstruction, not the original text of the command.) |
Reconstructs the creating command for a trigger. (This is a decompiled reconstruction, not the original text of the command.) |
Returns a role's name given its OID. |
Reconstructs the underlying |
Reconstructs the underlying |
Reconstructs the underlying |
Tests whether an index column has the named property. Common index column properties are listed in Table 9.74. (Note that extension access methods can define additional property names for their indexes.) |
Tests whether an index has the named property. Common index properties are listed in Table 9.75. (Note that extension access methods can define additional property names for their indexes.) |
Tests whether an index access method has the named property. Access method properties are listed in Table 9.76. |
Returns the set of storage options represented by a value from |
Returns an array of the flags associated with the given GUC, or |
Returns the set of OIDs of databases that have objects stored in the specified tablespace. If this function returns any rows, the tablespace is not empty and cannot be dropped. To identify the specific objects populating the tablespace, you will need to connect to the database(s) identified by |
Returns the file system path that this tablespace is located in. |
Returns the OID of the data type of the value that is passed to it. This can be helpful for troubleshooting or dynamically constructing SQL queries. The function is declared as returning For example:
SELECT pg_typeof(33);
pg_typeof
-----------
integer
SELECT typlen FROM pg_type WHERE oid = pg_typeof(33);
typlen
--------
4
|
Returns the name of the collation of the value that is passed to it. The value is quoted and schema-qualified if necessary. If no collation was derived for the argument expression, then For example:
SELECT collation for (description) FROM pg_description LIMIT 1;
pg_collation_for
------------------
"default"
SELECT collation for ('foo' COLLATE "de_DE");
pg_collation_for
------------------
"de_DE"
|
Translates a textual relation name to its OID. A similar result is obtained by casting the string to type |
Translates a textual collation name to its OID. A similar result is obtained by casting the string to type |
Translates a textual schema name to its OID. A similar result is obtained by casting the string to type |
Translates a textual operator name to its OID. A similar result is obtained by casting the string to type |
Translates a textual operator name (with parameter types) to its OID. A similar result is obtained by casting the string to type |
Translates a textual function or procedure name to its OID. A similar result is obtained by casting the string to type |
Translates a textual function or procedure name (with argument types) to its OID. A similar result is obtained by casting the string to type |
Translates a textual profile name to its OID. A similar result is obtained by casting the string to type |
Translates a textual role name to its OID. A similar result is obtained by casting the string to type |
Translates a textual type name to its OID. A similar result is obtained by casting the string to type |
Most of the functions that reconstruct (decompile) database objects have an optional pretty flag, which if true causes the result to be “pretty-printed”. Pretty-printing suppresses unnecessary parentheses and adds whitespace for legibility. The pretty-printed format is more readable, but the default format is more likely to be interpreted the same way by future versions of Postgres Pro; so avoid using pretty-printed output for dump purposes. Passing false for the pretty parameter yields the same result as omitting the parameter.
Table 9.74. Index Column Properties
| Name | Description |
|---|---|
asc | Does the column sort in ascending order on a forward scan? |
desc | Does the column sort in descending order on a forward scan? |
nulls_first | Does the column sort with nulls first on a forward scan? |
nulls_last | Does the column sort with nulls last on a forward scan? |
orderable | Does the column possess any defined sort ordering? |
distance_orderable | Can the column be scanned in order by a “distance” operator, for example ORDER BY col <-> constant ? |
returnable | Can the column value be returned by an index-only scan? |
search_array | Does the column natively support col = ANY(array) searches? |
search_nulls | Does the column support IS NULL and IS NOT NULL searches? |
Table 9.75. Index Properties
| Name | Description |
|---|---|
clusterable | Can the index be used in a CLUSTER command? |
index_scan | Does the index support plain (non-bitmap) scans? |
bitmap_scan | Does the index support bitmap scans? |
backward_scan | Can the scan direction be changed in mid-scan (to support FETCH BACKWARD on a cursor without needing materialization)? |
Table 9.76. Index Access Method Properties
| Name | Description |
|---|---|
can_order | Does the access method support ASC, DESC and related keywords in CREATE INDEX? |
can_unique | Does the access method support unique indexes? |
can_multi_col | Does the access method support indexes with multiple columns? |
can_exclude | Does the access method support exclusion constraints? |
can_include | Does the access method support the INCLUDE clause of CREATE INDEX? |
Table 9.77. GUC Flags
| Flag | Description |
|---|---|
EXPLAIN | Parameters with this flag are included in EXPLAIN (SETTINGS) commands. |
NO_SHOW_ALL | Parameters with this flag are excluded from SHOW ALL commands. |
NO_RESET | Parameters with this flag do not support RESET commands. |
NO_RESET_ALL | Parameters with this flag are excluded from RESET ALL commands. |
NOT_IN_SAMPLE | Parameters with this flag are not included in postgresql.conf by default. |
RUNTIME_COMPUTED | Parameters with this flag are runtime-computed ones. |
9.26.5. Object Information and Addressing Functions #
Table 9.78 lists functions related to database object identification and addressing.
Table 9.78. Object Information and Addressing Functions
9.26.6. Comment Information Functions #
The functions shown in Table 9.79 extract comments previously stored with the COMMENT command. A null value is returned if no comment could be found for the specified parameters.
Table 9.79. Comment Information Functions
9.26.7. Data Validity Checking Functions #
The functions shown in Table 9.80 can be helpful for checking validity of proposed input data.
Table 9.80. Data Validity Checking Functions
9.26.8. Transaction ID and Snapshot Information Functions #
The functions shown in Table 9.81 provide server transaction information in an exportable form. The main use of these functions is to determine which transactions were committed between two snapshots.
Table 9.81. Transaction ID and Snapshot Information Functions
Function Description |
|---|
Returns the number of transactions between the supplied transaction id and the current transaction counter. |
Returns the number of multixacts IDs between the supplied multixact ID and the current multixacts counter. |
Returns the current transaction's ID. It will assign a new one if the current transaction does not have one already (because it has not performed any database updates); see Section 71.1 for details. If executed in a subtransaction, this will return the top-level transaction ID; see Section 71.3 for details. |
Returns the current transaction's ID, or |
Reports the commit status of a recent transaction. The result is one of |
Returns a current snapshot, a data structure showing which transaction IDs are now in-progress. Only top-level transaction IDs are included in the snapshot; subtransaction IDs are not shown; see Section 71.3 for details. |
Returns the set of in-progress transaction IDs contained in a snapshot. |
Returns the |
Returns the |
Is the given transaction ID visible according to this snapshot (that is, was it completed before the snapshot was taken)? Note that this function will not give the correct answer for a subtransaction ID (subxid); see Section 71.3 for details. |
Returns the transaction ID and lock mode for each member of the specified multixact ID. The lock modes |
The internal transaction ID type xid is 32 bits wide and wraps around every 4 billion transactions. However, the functions shown in Table 9.81, except age, mxid_age, and pg_get_multixact_members, use a 64-bit type xid8 that does not wrap around during the life of an installation and can be converted to xid by casting if required; see Section 71.1 for details. The data type pg_snapshot stores information about transaction ID visibility at a particular moment in time. Its components are described in Table 9.82. pg_snapshot's textual representation is . For example xmin:xmax:xip_list10:20:10,14,15 means xmin=10, xmax=20, xip_list=10, 14, 15.
Table 9.82. Snapshot Components
| Name | Description |
|---|---|
xmin | Lowest transaction ID that was still active. All transaction IDs less than xmin are either committed and visible, or rolled back and dead. |
xmax | One past the highest completed transaction ID. All transaction IDs greater than or equal to xmax had not yet completed as of the time of the snapshot, and thus are invisible. |
xip_list | Transactions in progress at the time of the snapshot. A transaction ID that is xmin <= and not in this list was already completed at the time of the snapshot, and thus is either visible or dead according to its commit status. This list does not include the transaction IDs of subtransactions (subxids). |
In releases of Postgres Pro before 13 there was no xid8 type, so variants of these functions were provided that used bigint to represent a 64-bit XID, with a correspondingly distinct snapshot data type txid_snapshot. These older functions have txid in their names. They are still supported for backward compatibility, but may be removed from a future release. See Table 9.83.
Table 9.83. Deprecated Transaction ID and Snapshot Information Functions
9.26.9. Committed Transaction Information Functions #
The functions shown in Table 9.84 provide information about when past transactions were committed. They only provide useful data when the track_commit_timestamp configuration option is enabled, and only for transactions that were committed after it was enabled. Commit timestamp information is routinely removed during vacuum.
Table 9.84. Committed Transaction Information Functions
9.26.10. Control Data Functions #
The functions shown in Table 9.85 print information initialized during initdb, such as the catalog version. They also show information about write-ahead logging and checkpoint processing. This information is cluster-wide, not specific to any one database. These functions provide most of the same information, from the same source, as the pg_controldata application.
Table 9.85. Control Data Functions
Function Description |
|---|
Returns information about current checkpoint state, as shown in Table 9.86. |
Returns information about current control file state, as shown in Table 9.87. |
Returns information about cluster initialization state, as shown in Table 9.88. |
Returns information about recovery state, as shown in Table 9.89. |
Table 9.86. pg_control_checkpoint Output Columns
| Column Name | Data Type |
|---|---|
checkpoint_lsn | pg_lsn |
redo_lsn | pg_lsn |
redo_wal_file | text |
timeline_id | integer |
prev_timeline_id | integer |
full_page_writes | boolean |
next_xid | text |
next_oid | oid |
next_multixact_id | xid |
next_multi_offset | xid |
oldest_xid | xid |
oldest_xid_dbid | oid |
oldest_active_xid | xid |
oldest_multi_xid | xid |
oldest_multi_dbid | oid |
oldest_commit_ts_xid | xid |
newest_commit_ts_xid | xid |
checkpoint_time | timestamp with time zone |
Table 9.87. pg_control_system Output Columns
| Column Name | Data Type |
|---|---|
pg_control_version | integer |
catalog_version_no | integer |
system_identifier | bigint |
pg_control_last_modified | timestamp with time zone |
pg_control_edition | text |
Table 9.88. pg_control_init Output Columns
| Column Name | Data Type |
|---|---|
max_data_alignment | integer |
database_block_size | integer |
blocks_per_segment | integer |
wal_block_size | integer |
bytes_per_wal_segment | integer |
max_identifier_length | integer |
max_index_columns | integer |
max_toast_chunk_size | integer |
large_object_chunk_size | integer |
float8_pass_by_value | boolean |
data_page_checksum_version | integer |
Table 9.89. pg_control_recovery Output Columns
| Column Name | Data Type |
|---|---|
min_recovery_end_lsn | pg_lsn |
min_recovery_end_timeline | integer |
backup_start_lsn | pg_lsn |
backup_end_lsn | pg_lsn |
end_of_backup_record_required | boolean |