PostgreSQL : Документация: 17: pgbench : Компания Postgres Professional

pgbench
Пред.	Наверх	Клиентские приложения PostgreSQL	Начало	След.

pgbench

pgbench — запустить тест производительности PostgreSQL

Синтаксис

pgbench -i [параметр...] [dbname]

pgbench [параметр...] [dbname]

Описание

pgbench — это простая программа для запуска тестов производительности PostgreSQL. Она многократно выполняет одну последовательность команд, возможно в параллельных сеансах базы данных, а затем вычисляет среднюю скорость транзакций (число транзакций в секунду). По умолчанию pgbench тестирует сценарий, примерно соответствующий TPC-B, который состоит из пяти команд SELECT, UPDATE и INSERT в одной транзакции. Однако вы можете легко протестировать и другие сценарии, написав собственные скрипты транзакций.

Типичный вывод pgbench выглядит так:

transaction type: <builtin: TPC-B (sort of)>
scaling factor: 10
query mode: simple
number of clients: 10
number of threads: 1
maximum number of tries: 1
number of transactions per client: 1000
number of transactions actually processed: 10000/10000
number of failed transactions: 0 (0.000%)
latency average = 11.013 ms
latency stddev = 7.351 ms
initial connection time = 45.758 ms
tps = 896.967014 (without initial connection time)

В первых семи строках выводятся значения некоторых самых важных параметров. В шестой строке выводится максимальное число повторов транзакций с ошибками сериализации или взаимоблокировки (за подробностями обратитесь к Повторы и отказы из-за ошибок сериализации/взаимоблокировки). В восьмой строке показывается количество выполненных и запланированных транзакций (произведение числа клиентов и числа транзакций для одного клиента); эти количества будут различаться, только если выполнение завершится досрочно или какие-либо команды SQL завершатся ошибкой. (В режиме -T выводится только число фактически выполненных транзакций.) В следующей строке выводится количество транзакций, не выполненных из-за ошибок сериализации или взаимоблокировок (за подробностями обратитесь к Повторы и отказы из-за ошибок сериализации/взаимоблокировки). В последней строке показывается число транзакций в секунду.

Для запускаемого по умолчанию теста типа TPC-B требуется предварительно подготовить определённые таблицы. Чтобы создать и наполнить эти таблицы, следует запустить pgbench с ключом -i (инициализировать). (Если вы применяете нестандартный скрипт, это не требуется, но тем не менее нужно подготовить конфигурацию, нужную вашему тесту.) Запуск инициализации выглядит так:

pgbench -i [ другие-параметры ] имя_базы

где имя_базы — имя уже существующей базы, в которой будет проводиться тест. (Чтобы указать, как подключиться к серверу баз данных, вы также можете добавить параметры -h, -p и/или -U.)

Внимание

pgbench -i создаёт четыре таблицы pgbench_accounts, pgbench_branches, pgbench_history и pgbench_tellers, предварительно уничтожая существующие таблицы с этими именами. Если вы вдруг используете эти имена в своей базе данных, обязательно переключитесь на другую базу!

С «коэффициентом масштаба», по умолчанию равным 1, эти таблицы изначально содержат такое количество строк:

table                   # of rows
---------------------------------
pgbench_branches        1
pgbench_tellers         10
pgbench_accounts        100000
pgbench_history         0

Эти числа можно (и в большинстве случаев даже нужно) увеличить, воспользовавшись параметром -s (коэффициент масштаба). При этом также может быть полезен ключ -F (фактор заполнения).

Подготовив требуемую конфигурацию, можно запустить тест производительности командой без -i, то есть:

pgbench [ параметры ] имя_базы

Практически во всех случаях, чтобы получить полезные результаты, необходимо передать какие-либо дополнительные параметры. Наиболее важные параметры: -c (число клиентов), -t (число транзакций), -T (длительность) и -f (файл со скриптом). Полный список параметров приведён ниже.

Параметры

Следующий список разделён на три подраздела: одни параметры используются при инициализации базы данных, другие при проведении тестирования, а третьи в обоих случаях.

Параметры инициализации

pgbench принимает следующие аргументы командной строки для инициализации:

[-d] dbname [--dbname=]dbname #

Указывает имя базы, в которой будет проводиться тест. Если имя не задано, то используется значение переменной окружения PGDATABASE. Если и переменная не задана, то в качестве имени базы будет взято имя пользователя, под которым осуществляется подключение.

-i --initialize #

Требуется для вызова режима инициализации.

-I этапы_инициализации --init-steps=этапы_инициализации #

Выполнять только выбранные из всех обычных подготовительных этапов. В параметре этапы_инициализации отдельные символы для каждого этапа выбирают, какие этапы должны выполняться. Все этапы выполняются в определённом порядке. Список этапов по умолчанию: dtgvp. Полный перечень подготовительных этапов:

d (Drop, удалить) #

Удалить все существующие таблицы pgbench.

t (create Tables, создать таблицы) #

Создать таблицы, используемые стандартным сценарием pgbench, а именно: pgbench_accounts, pgbench_branches, pgbench_history и pgbench_tellers.

g или G (Generate data, сгенерировать данные на стороне клиента или на стороне сервера) #

Сгенерировать данные и загрузить их в стандартные таблицы, заменив все уже существующие данные.

С ключом g (выбирающим генерирование данных на стороне клиента), данные формируются в клиентском коде pgbench, а затем передаются на сервер. При этом соединение клиент/сервер нагружается командой COPY. С PostgreSQL версии 14 или выше pgbench использует параметр FREEZE для ускорения последующей операции VACUUM, за исключением таблицы pgbench_accounts, если применяется секционирование. С использованием ключа g после каждых 100 000 строк выдаётся сообщение о прогрессе генерации данных для всех таблиц.

С ключом G (выбирающим генерирование данных на стороне сервера), клиентский код pgbench передаёт на сервер только небольшие запросы, а собственно формированием данных занимается сервер. В этом случае сетевое соединение не нагружается, но возрастает нагрузка на сервер. При генерировании данных с ключом G никакие сообщения о ходе операции не выдаются.

По умолчанию при инициализации базы данные генерируются на стороне клиента (то есть подразумевается ключ g).

v (Vacuum, очистка) #

Вызывать VACUUM для стандартных таблиц.

p (create Primary keys, создать первичные ключи) #

Создать первичные ключи в стандартных таблицах.

f (create Foreign keys, создать внешние ключи) #

Создать ограничения внешних ключей между стандартными таблицами. (Заметьте, что это действие по умолчанию не выполняется.)

-F фактор_заполнения --fillfactor=фактор_заполнения #

Создать таблицы pgbench_accounts, pgbench_tellers и pgbench_branches с заданным фактором заполнения. Значение по умолчанию — 100.

-n --no-vacuum #

Не выполнять очистку во время инициализации. (Этот параметр выключает этап инициализации v, даже если он был указан в -I.)

-q --quiet #

Переключить вывод в немногословный режим, когда выводится только одно сообщение о прогрессе в 5 секунд. В режиме по умолчанию одно сообщение выводится на каждые 100000 строк, при этом за секунду обычно выводится довольно много строк (особенно на хорошем оборудовании).

Этот параметр не оказывает влияния, если в -I выбран вариант G.

-s коэффициент_масштаба --scale=коэффициент_масштаба #

Умножить число генерируемых строк на заданный коэффициент. Например, с ключом -s 100 в таблицу pgbench_accounts будут записаны 10 000 000 строк. Значение по умолчанию — 1. При коэффициенте, равном 20 000 или больше, столбцы, содержащие идентификаторы счетов (столбцы aid), перейдут к большим целым числам (типу bigint), чтобы в них могли уместиться все возможные значения идентификаторов.

--foreign-keys #

Создать ограничения внешних ключей между стандартными таблицами. (Этот ключ добавляет этап f к последовательности подготовительных этапов, если он отсутствует.)

--index-tablespace=табл_пространство_индексов #

Создать индексы в указанном табличном пространстве, а не в пространстве по умолчанию.

--partition-method=ИМЯ #

Создать секционированную таблицу pgbench_accounts, применив метод ИМЯ (это может быть range или hash). Для использования этого параметра необходимо, чтобы было задано ненулевое значение --partitions. Если этот параметр не указывается, подразумевается метод range.

--partitions=ЧИСЛО #

Создать секционированную таблицу pgbench_accounts с заданным ЧИСЛОМ секций примерно равного размера в соответствии с масштабированным количеством счетов. По умолчанию подразумевается число 0, то есть таблица не секционируется.

--tablespace=табличное_пространство #

Создать таблицы в указанном табличном пространстве, а не в пространстве по умолчанию.

--unlogged-tables #

Создать все таблицы как нежурналируемые, а не как постоянные таблицы.

Параметры тестирования производительности

pgbench принимает следующие аргументы командной строки для тестирования производительности:

-b имя_скрипта[@вес] --builtin=имя_скрипта[@вес] #

Добавляет в список скриптов, которые будут выполняться, указанный встроенный скрипт. В число встроенных скриптов входят tpcb-like, simple-update и select-only. Также принимаются однозначные начала их имён. Со специальным именем list программа выводит список встроенных скриптов и немедленно завершается.

Дополнительно можно задать целочисленный вес после @, меняющий вероятность выбора этого скрипта относительно других. По умолчанию вес считается равным 1. Подробности следуют ниже.

-c клиенты --client=клиенты #

Число имитируемых клиентов, то есть число одновременных сеансов базы данных. Значение по умолчанию — 1.

-C --connect #

Устанавливать новое подключение для каждой транзакции вместо одного для каждого клиента. Это полезно для оценивания издержек подключений.

-D имя_переменной=значение --define=имя_переменной=значение #

Определить переменную для пользовательского скрипта (см. ниже). Параметр -D может добавляться неоднократно.

-f имя_файла[@вес] --file=имя_файла[@вес] #

Добавить в список выполняемых скриптов скрипт транзакции из файла имя_файла.

Дополнительно можно задать целочисленный вес после @, меняющий вероятность выбора этого скрипта относительно других. По умолчанию вес считается равным 1. (Если вам нужно передать имя скрипта, содержащее символ @, добавьте к такому имени вес, чтобы исключить неоднозначность прочтения, например filen@me@1.) Подробности следуют ниже.

-j потоки --jobs=потоки #

Число рабочих потоков в pgbench. Использовать нескольких потоков может быть полезно на многопроцессорных компьютерах. Клиенты распределяются по доступным потокам равномерно, насколько это возможно. Значение по умолчанию — 1.

-l --log #

Записать информацию о каждой транзакции в файл протокола. Подробности описаны ниже.

-L предел --latency-limit=предел #

Транзакции, продолжающиеся дольше указанного предела (в миллисекундах), подсчитываются и отмечаются отдельно, как опаздывающие.

В режиме ограничения скорости (--rate=...) транзакции, которые отстают от графика более чем на заданный предел (в мс) и поэтому никак не могут уложиться в отведённый интервал, не передаются серверу вовсе. Они подсчитываются и отмечаются отдельно как пропущенные.

Когда используется параметр --max-tries, транзакция, прерванная из-за аномалии сериализации или взаимоблокировки, не будет повторяться, если общее время всех её повторений превышает предел в миллисекундах. Чтобы ограничить только общее время повторений, а не их количество, установите значение --max-tries=0. По умолчанию параметр --max-tries имеет значение 1, и транзакции с ошибками сериализации/взаимоблокировки не повторяются. Подробнее о повторных попытках выполнения таких транзакций рассказывается в Повторы и отказы из-за ошибок сериализации/взаимоблокировки.

-M режим_запросов --protocol=режим_запросов #

Протокол, выбираемый для передачи запросов на сервер:

simple: использовать простой протокол запросов.
extended: использовать расширенный протокол запросов.
prepared: использовать расширенный протокол запросов с подготовленными операторами.

В режиме prepared pgbench повторно использует результат разбора запроса, начиная со второй итерации, и поэтому работает быстрее, чем в других режимах.

По умолчанию выбирается простой протокол запросов. (За подробностями обратитесь к Главе 53.)

-n --no-vacuum #

Не производить очистку таблиц перед запуском теста. Этот параметр необходим, если вы применяете собственный сценарий, не затрагивающий стандартные таблицы pgbench_accounts, pgbench_branches, pgbench_history и pgbench_tellers.

-N --skip-some-updates #

Запустить встроенный упрощённый скрипт simple-update. Краткий вариант записи -b simple-update.

-P сек --progress=сек #

Выводить отчёт о прогрессе через заданное число секунд (сек). Выдаваемый отчёт включает время, прошедшее с момента запуска, скорость (в TPS) с момента предыдущего отчёта, а также среднее время ожидания транзакций, стандартное отклонение и количество неуспешных транзакций с момента последнего отчёта. В режиме ограничения скорости (-R) время ожидания вычисляется относительно назначенного времени запуска транзакции, а не фактического времени её начала, так что оно включает и среднее время отставания от графика. Когда параметр --max-tries включает повторение транзакций после ошибок сериализации/взаимоблокировок, в отчёт добавляется количество повторявшихся транзакций и общее число повторов.

-r --report-per-command #

Выдать следующую статистику по каждой команде после завершения теста: среднюю длительность выполнения операторов (время выполнения с точки зрения клиента), число отказов и повторений вследствие ошибок сериализации и взаимоблокировки в этой команде. Статистика повторений отображается в отчёте, только если параметр --max-tries не равен 1.

-R скорость передачи --rate=скорость передачи #

Выполнять транзакции, ориентируясь на заданную скорость, а не максимально быстро (по умолчанию). Скорость задаётся в транзакциях в секунду. Если заданная скорость превышает максимально возможную, это ограничение скорости не повлияет на результаты.

Для получения нужной скорости транзакции запускаются со случайными задержками, имеющими распределение Пуассона. При этом запланированное время запуска отсчитывается от начального времени, а не от завершения предыдущей транзакции. Это означает, что если какие-то транзакции отстанут от изначально рассчитанного времени завершения, всё же возможно, что последующие нагонят график.

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

Если ограничение --latency-limit задаётся вместе с --rate, транзакция может заведомо не вписываться в отведённое ей время, если предыдущая транзакция завершится слишком поздно, так как ожидаемое время окончания транзакции отсчитывается от времени запуска по графику. Такие транзакции не передаются серверу, а пропускаются и подсчитываются отдельно.

Большое значение отклонения от графика свидетельствует о том, что система не успевает выполнять транзакции с заданной скоростью и выбранным числом клиентов и потоков. Когда среднее время ожидания транзакции превышает запланированный интервал между транзакциями, каждая последующая транзакция будет отставать от графика, и чем дольше будет выполняться тестирование, тем больше будет отставание. Когда это наблюдается, нужно уменьшить скорость транзакций.

-s коэффициент_масштаба --scale=коэффициент_масштаба #

Показать заданный коэффициент масштаба в выводе pgbench. Для встроенных тестов это не требуется; корректный коэффициент масштаба будет получен в результате подсчёта строк в таблице pgbench_branches. Однако при использовании только нестандартных тестов (запускаемых с ключом -f) без этого параметра в качестве коэффициента масштаба будет выводиться 1.

-S --select-only #

Запустить встроенный скрипт select-only (только выборка). Краткий вариант записи -b select-only.

-t транзакции --transactions=транзакции #

Число транзакций, которые будут выполняться каждым клиентом (по умолчанию 10).

-T секунды --time=секунды #

Выполнять тест с ограничением по времени (в секундах), а не по числу транзакций для каждого клиента. Параметры -t и -T являются взаимоисключающими.

-v --vacuum-all #

Очищать все четыре стандартные таблицы перед запуском теста. Без параметров -n и -v pgbench будет очищать от старых записей таблицы pgbench_tellers и pgbench_branches, а также опустошать pgbench_history.

--aggregate-interval=секунды #

Длительность интервала агрегации (в секундах). Может использоваться только с ключом -l. С данным параметром в протокол выводится сводка по интервалам, как описано ниже.

--exit-on-abort #

Немедленно завершить работу, если клиент отключается из-за ошибки. Без этого параметра, даже если один клиент отключается, другие клиенты продолжат работать в соответствии с параметром -t или -T, а pgbench выведет неполные результаты.

Обратите внимание, что ошибки сериализации или взаимоблокировки не прерывают работу клиента. За дополнительными сведениями обратитесь к Повторы и отказы из-за ошибок сериализации/взаимоблокировки.

--failures-detailed #

Выдавать информацию об ошибках в протоколе по транзакциям и в протоколе с агрегированием, а также в основном отчёте и в отчётах по скриптам, группируя её по типам:

ошибки сериализации;
ошибки взаимоблокировки;

За подробностями обратитесь к Повторы и отказы из-за ошибок сериализации/взаимоблокировки.

--log-prefix=префикс #

Задать префикс имён файлов для файлов протоколов, создаваемых с ключом --log. Префикс по умолчанию — pgbench_log.

--max-tries=число_попыток #

Разрешить повторение транзакций с ошибками сериализации/взаимоблокировки и установить максимальное число попыток выполнения транзакций. Этот параметр можно комбинировать с параметром --latency-limit, который ограничивает общее время всех попыток для транзакции; также заметьте, что нельзя выбрать неограниченное количество попыток (--max-tries=0), не определив --latency-limit или --time. Значение по умолчанию — 1, то есть транзакции с ошибками сериализации/взаимоблокировки повторяться не будут. Подробнее о повторении таких транзакций рассказывается в Повторы и отказы из-за ошибок сериализации/взаимоблокировки.

--progress-timestamp #

При отображении прогресса (с параметром -P) выводить текущее время (в формате Unix), а не количество секунд от начала запуска. Время задаётся в секундах с точностью до миллисекунд. Это помогает сравнивать журналы, записываемые разными средствами.

--random-seed=затравка #

Установить затравку для генератора случайных чисел. Инициализирует генератор случайных чисел, который затем выдаёт последовательность начальных состояний отдельных генераторов для каждого потока. затравка может принимать следующие значения: time (по умолчанию, затравка базируется на текущем времени), rand (задействовать надёжный генератор случайных чисел или выдать ошибку, если он отсутствует) или беззнаковое десятичное число. Генератор случайных чисел может вызываться явно из скрипта pgbench (функциями random...) или неявно (например, для планирования выполнения транзакций с ключом --rate). В случае установки значения явным образом оно выводится в терминале. Любое значение, допустимое в качестве затравки, можно также задать в переменной окружения PGBENCH_RANDOM_SEED. Чтобы заданная затравка применялась во всех возможных случаях использования, задайте этот параметр первым или установите переменную окружения.

Явное указание определённой затравки позволяет точно воспроизвести выполнение pgbench в части использования случайных чисел. Так как случайное состояние поддерживается внутри потока, это означает, что выполнение pgbench при одинаковых запусках повторится в точности, если один поток используется одним клиентом и отсутствуют внешние зависимости или зависимости от данных. Со статистической точки зрения точное воспроизведение выполнения нежелательно, так как это может скрыть вариативность производительности или показать завышенную скорость, например из-за попадания в одни и те же страницы данных. Однако это может быть очень полезно для отладки, например, для повторения редкого сценария, приводящего к ошибке. Используйте данную возможность обдуманно.

--sampling-rate=скорость передачи #

Частота выборки для записи данных в протокол, изменяя которую можно уменьшить объём протокола. При указании этого параметра в протокол выводится информация только о заданном проценте транзакций. Со значением 1.0 в нём будут отмечаться все транзакции, а с 0.05 только 5%.

Обрабатывая протокол, не забудьте учесть частоту выборки. Например, вычисляя скорость (TPS), вам нужно будет соответственно умножить содержащиеся в нём числа (например, с частотой выборки 0.01 вы получите только 1/100 фактической скорости).

--show-script=имя_скрипта #

Вывести код встроенного скрипта имя_скрипта в stderr и сразу завершиться.

--verbose-errors #

Выводить сообщения обо всех ошибках сериализации/взаимоблокировки и отказах (ошибках, после которых транзакция не повторяется) с информацией о том, как ограничиваются повторения и насколько достигается ограничение. (Учтите, что в этом случае объём вывода может значительно увеличиться.) За подробностями обратитесь к Повторы и отказы из-за ошибок сериализации/взаимоблокировки.

Общие параметры

Программа pgbench также принимает следующие общие аргументы командной строки, определяющие параметры подключения и прочие общие параметры:

--debug #: Выводить отладочные сообщения.
-h компьютер --host=компьютер #: Адрес сервера баз данных
-p порт --port=порт #: Номер порта сервера баз данных
-U имя_пользователя --username=имя_пользователя #: Имя пользователя для подключения
-V --version #: Вывести версию pgbench и завершиться.
-? --help #: Вывести справку об аргументах командной строки pgbench и завершиться.

Код завершения

В случае успешного выполнения возвращается код 0. Код завершения 1 указывает на статичные проблемы, например ошибки в параметрах командной строки или непредвиденные внутренние ошибки. В случае ошибок, возникающих на ранних этапах при запуске теста, например при сбое начального подключения, кодом завершения также будет 1. При возникновении ошибок во время выполнения, например при обращении к базе данных или выполнении скрипта, выдаётся код завершения 2. В последнем случае pgbench выведет частичные результаты, если не указан параметр --exit-on-abort.

Переменные окружения

PGDATABASE PGHOST PGPORT PGUSER #: Параметры подключения по умолчанию.

Как и большинство других утилит PostgreSQL, приложение также использует переменные окружения, поддерживаемые libpq (см. Раздел 32.15).

Переменная окружения PG_COLOR выбирает вариант использования цвета в диагностических сообщениях. Возможные значения: always (всегда), auto (автоматически) и never (никогда).

Примечания

Каково содержание «транзакции», которую выполняет pgbench?

Программа pgbench выполняет тестовые скрипты, выбирая их случайным образом из заданного списка. Это могут быть как встроенные скрипты, задаваемые аргументами -b, так и пользовательские, задаваемые аргументами -f. Для каждого скрипта можно задать относительный вес после @, чтобы скорректировать вероятность его выбора. По умолчанию вес считается равным 1. Скрипты с весом 0 игнорируются.

Стандартный встроенный скрипт (также вызываемый с ключом -b tpcb-like) выдаёт семь команд в транзакции со случайно выбранными aid, tid, bid и delta. Его сценарий написан по мотивам теста производительности TPC-B, но это не собственно TPC-B, потому он называется так.

BEGIN;
UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
END;

При выборе встроенного скрипта simple-update (или указании -N) шаги 4 и 5 исключаются из транзакции. Это позволяет избежать конкуренции при обращении к этим таблицам, но тест становится ещё менее похожим на TPC-B.

При выборе встроенного теста select-only (или указании -S) выполняется только SELECT.

Пользовательские скрипты

Программа pgbench поддерживает запуск пользовательских сценариев оценки производительности, позволяя заменять стандартный скрипт транзакции (описанный выше) скриптом, считываемым из файла (с параметром -f). В этом случае «транзакцией» считается одно выполнение данного скрипта.

Файл скрипта содержит одну или несколько команд SQL, разделённых точкой с запятой. Пустые строки и строки, начинающиеся с --, игнорируются. В файлах скриптов также могут содержаться «метакоманды», которые обрабатывает сама программа pgbench, как описано ниже.

Примечание

До версии PostgreSQL 9.6, SQL-команды в файлах скриптов завершались символами перевода строки, и поэтому они не могли занимать несколько строк. Теперь для разделения последовательных команд SQL требуется добавлять точку с запятой (хотя без неё можно обойтись в конце SQL-команды, за которой идёт метакоманда). Если вам нужно создать файл скрипта, работающий и со старыми версиями pgbench, записывайте каждую команду SQL в отдельной строке и завершайте её точкой с запятой.

Предполагается, что скрипты pgbench не содержат незавершённых блоков SQL-транзакций. Если по достижении клиентом конца скрипта окажется, что блок последней транзакции не завершён, работа клиента будет прервана.

Для файлов скриптов реализован простой механизм подстановки переменных. Имя переменных должно состоять из букв (буквы могут быть не латинскими), подчёркиваний и цифр (но цифра не может быть первым символом). Переменные можно задать в командной строке параметрами -D, описанными выше, или метакомандами, рассматриваемыми ниже. Помимо переменных, которые можно установить параметрами командной строки -D, есть несколько автоматически устанавливаемых переменных; они перечислены в Таблице 298. Если значение этих переменных задаётся в параметре -D, оно переопределяет автоматическое значение. Когда значение переменной определено, его можно вставить в команду SQL, написав :имя_переменной. Каждый клиентский сеанс, если их несколько, получает собственный набор переменных. В одном операторе pgbench поддерживает до 255 ссылок на переменные.

Таблица 298. Автоматические переменные pgbench

Переменная	Описание
`client_id`	уникальное число, идентифицирующее клиентский сеанс (начиная с нуля)
`default_seed`	затравка, по умолчанию используемая в функциях, вычисляющих хеш и псевдослучайные перестановки
`random_seed`	затравка генератора случайных чисел (в отсутствие переопределения с ключом `-D`)
`scale`	текущий коэффициент масштаба

Метакоманды в скрипте начинаются с обратной косой черты (\) и обычно продолжаются до конца строки, хотя их можно переносить на следующую строку последовательностью символов: обратная косая, возврат каретки. Аргументы метакоманд разделяются пробелами. Поддерживаемые метакоманды представлены ниже:

\gset [префикс] \aset [префикс] #

Эти команды могут применяться для завершения SQL-запросов вместо завершающей точки с запятой (;).

Когда используется команда \gset, ожидается, что предыдущий SQL-запрос возвратит одну строку; значения столбцов будут сохранены в переменные с именами столбцов, а если указан префикс, он будет добавлен в эти имена.

Когда используется команда \aset, значения столбцов всех совмещённых SQL-запросов (разделённых \;) будут сохранены в переменные, названные по именам столбцов с добавлением префикса, если он задан. Если запрос не возвращает в результате строки, присваивание не выполняется и в этом можно убедиться, проверив, существует ли переменная. Если запрос возвращает несколько строк, в переменных сохраняется последнее значение.

Команды \gset и \aset нельзя использовать в конвейерном режиме, так как ко времени, когда результаты запросов могут понадобиться команде, они ещё не будут готовы.

В следующем примере итоговый баланс счёта из первого запроса попадает в переменную abalance, а целочисленные значения из третьего запроса попадают в переменные p_two и p_three. Результат второго запроса отбрасывается. Результаты двух последних запросов объединяются и сохраняются в переменных four и five.

UPDATE pgbench_accounts
  SET abalance = abalance + :delta
  WHERE aid = :aid
  RETURNING abalance \gset
-- объединяет два запроса
SELECT 1 \;
SELECT 2 AS two, 3 AS three \gset p_
SELECT 4 AS four \; SELECT 5 AS five \aset

\if выражение \elif выражение \else \endif #

Эта группа команд реализует вкладываемые условные блоки, подобные \if выражение в psql. В качестве условных задаются те же выражения, что и в \set, при этом истинным считается любое ненулевое значение.

\set имя_переменной выражение #

Устанавливает для переменной имя_переменной значение, вычисленное из выражения. Выражение может содержать константу NULL, логические константы TRUE и FALSE, целочисленные константы (например, 5432), константы с плавающей точкой (например, 3.14159), ссылки на переменные :имя_переменной, операторы с обычными для SQL приоритетами и ассоциативностью, вызовы функций, общие условные SQL-выражения CASE, а также скобки.

Функции и большинство операторов возвращают NULL для аргументов NULL.

При проверке условия отличные от нуля числовые значения воспринимаются как TRUE, а числовые нулевые значения и NULL — как FALSE.

При переполнениях, вызванных слишком большими числами с плавающей точкой или целыми, а также целочисленными операциями (+, -, * и /), выдаются ошибки.

Если в конструкции CASE отсутствует заключительное ELSE, значением по умолчанию считается NULL.

Примеры:

\set ntellers 10 * :scale
\set aid (1021 * random(1, 100000 * :scale)) % \
           (100000 * :scale) + 1
\set divx CASE WHEN :x <> 0 THEN :y/:x ELSE NULL END

\sleep номер [ us | ms | s ] #

Приостанавливает выполнение скрипта на заданное число микросекунд (us), миллисекунд (ms) или секунд (s). Когда единицы не указываются, подразумеваются секунды. Здесь число может быть целочисленной константой или ссылкой :имя_переменной на переменную с целочисленным значением.

Пример:

\sleep 10 ms

\setshell имя_переменной команда [ аргумент ... ] #

Присваивает переменной имя_переменной результат команды оболочки команда с указанными аргументами. Эта команда должна просто выдать целочисленное значение в стандартный вывод.

Здесь команда и каждый аргумент может быть либо текстовой константой, либо ссылкой на переменную :имя_переменной. Если вы хотите записать аргумент, начинающийся с двоеточия, добавьте перед аргументом дополнительное двоеточие.

Пример:

\setshell назначаемая_переменная команда строковый_аргумент :переменная ::строка_начинающаяся_двоеточием

\shell команда [ аргумент ... ] #

Действует так же, как и \setshell, но не учитывает результат команды.

Пример:

\shell команда строковый_аргумент :переменная ::строка_начинающаяся_двоеточием

\startpipeline \syncpipeline \endpipeline #

Эта группа команд осуществляет конвейеризацию SQL-операторов. Конвейер должен начинаться с команды \startpipeline и заканчиваться командой \endpipeline. В промежутке между ними может быть любое количество команд \syncpipeline, которые посылают сообщение синхронизации, не прерывая текущий конвейер и не очищая буфер отправки. В конвейерном режиме команды передаются серверу, не дожидаясь результатов предыдущих команд. За подробностями обратитесь к Разделу 32.5. Для конвейерного режима должен использоваться расширенный протокол запросов.

Встроенные операторы

Перечисленные в Таблице 299 арифметические, битовые и логические операторы, а также операторы сравнения встроены в pgbench и могут применяться в выражениях в \set. Эти операторы приведены в порядке возрастания их приоритета. Не считая явно отмеченных исключений, операторы с двумя числовыми аргументами будут выдавать результат в типе с плавающей точкой, если какой-либо аргумент имеет такой тип; в противном случае результат будет целочисленным.

Таблица 299. Операторы pgbench

Оператор Описание Примеры
`boolean` `OR` `boolean` → `boolean` Логическое ИЛИ `5 or 0` → `TRUE`
`boolean` `AND` `boolean` → `boolean` Логическое И `3 and 0` → `FALSE`
`NOT` `boolean` → `boolean` Логическое НЕ `not false` → `TRUE`
`boolean` `IS [NOT] (NULL\|TRUE\|FALSE)` → `boolean` Логические проверки значений `1 is null` → `FALSE`
`значение` `ISNULL\|NOTNULL` → `boolean` Проверки на NULL `1 notnull` → `TRUE`
`номер` `=` `номер` → `boolean` Равно `5 = 4` → `FALSE`
`номер` `<>` `номер` → `boolean` Не равно `5 <> 4` → `TRUE`
`номер` `!=` `номер` → `boolean` Не равно `5 != 5` → `FALSE`
`номер` `<` `номер` → `boolean` Меньше `5 < 4` → `FALSE`
`номер` `<=` `номер` → `boolean` Меньше или равно `5 <= 4` → `FALSE`
`номер` `>` `номер` → `boolean` Больше `5 > 4` → `TRUE`
`номер` `>=` `номер` → `boolean` Больше или равно `5 >= 4` → `TRUE`
`integer` `\|` `integer` → `integer` Битовое ИЛИ `1 \| 2` → `3`
`integer` `#` `integer` → `integer` Битовое исключающее ИЛИ `1 # 3` → `2`
`integer` `&` `integer` → `integer` Битовое И `1 & 3` → `1`
`~` `integer` → `integer` Битовое НЕ `~ 1` → `-2`
`integer` `<<` `integer` → `integer` Битовый сдвиг влево `1 << 2` → `4`
`integer` `>>` `integer` → `integer` Битовый сдвиг вправо `8 >> 2` → `2`
`номер` `+` `номер` → `номер` Сложение `5 + 4` → `9`
`номер` `-` `номер` → `номер` Вычитание `3 - 2.0` → `1.0`
`номер` `` `номер`* → `номер` Умножение `5 * 4` → `20`
`номер` `/` `номер` → `номер` Деление (если оба аргумента целочисленные, результат округляется в сторону нуля) `5 / 3` → `1`
`integer` `%` `integer` → `integer` Остаток от деления `3 % 2` → `1`
`-` `номер` → `номер` Смена знака `- 2.0` → `-2.0`

Оператор

Описание

Примеры

boolean OR boolean → boolean

Логическое ИЛИ

5 or 0 → TRUE

boolean AND boolean → boolean

Логическое И

3 and 0 → FALSE

NOT boolean → boolean

Логическое НЕ

not false → TRUE

boolean IS [NOT] (NULL|TRUE|FALSE) → boolean

Логические проверки значений

1 is null → FALSE

значение ISNULL|NOTNULL → boolean

Проверки на NULL

1 notnull → TRUE

номер = номер → boolean

Равно

5 = 4 → FALSE

номер <> номер → boolean

Не равно

5 <> 4 → TRUE

номер != номер → boolean

Не равно

5 != 5 → FALSE

номер < номер → boolean

Меньше

5 < 4 → FALSE

номер <= номер → boolean

Меньше или равно

5 <= 4 → FALSE

номер > номер → boolean

Больше

5 > 4 → TRUE

номер >= номер → boolean

Больше или равно

5 >= 4 → TRUE

integer | integer → integer

Битовое ИЛИ

1 | 2 → 3

integer # integer → integer

Битовое исключающее ИЛИ

1 # 3 → 2

integer & integer → integer

Битовое И

1 & 3 → 1

~ integer → integer

Битовое НЕ

~ 1 → -2

integer << integer → integer

Битовый сдвиг влево

1 << 2 → 4

integer >> integer → integer

Битовый сдвиг вправо

8 >> 2 → 2

номер + номер → номер

Сложение

5 + 4 → 9

номер - номер → номер

Вычитание

3 - 2.0 → 1.0

номер * номер → номер

Умножение

5 * 4 → 20

номер / номер → номер

Деление (если оба аргумента целочисленные, результат округляется в сторону нуля)

5 / 3 → 1

integer % integer → integer

Остаток от деления

3 % 2 → 1

- номер → номер

Смена знака

- 2.0 → -2.0

Встроенные функции

Функции, перечисленные в Таблице 300, встроены в pgbench и могут применяться в выражениях в метакоманде \set.

Таблица 300. Функции pgbench

Функция Описание Примеры
`abs` ( `число` ) → тип аргумента Модуль числа (абсолютное значение) `abs(-17)` → `17`
`debug` ( `число` ) → тип аргумента Выводит аргумент в stderr и выдаёт его. `debug(5432.1)` → `5432.1`
`double` ( `число` ) → `double` Приводит аргумент к типу с плавающей точкой. `double(5432)` → `5432.0`
`exp` ( `число` ) → `double` Экспонента (`e` возводится в заданную степень) `exp(1.0)` → `2.718281828459045`
`greatest` ( `число` [, `...`] ) → `double` при наличии аргумента(ов) double, иначе — `integer` Выбирает наибольшее значение среди аргументов. `greatest(5, 4, 3, 2)` → `5`
`hash` ( `значение` [, `затравка`] ) → `integer` Псевдоним `hash_murmur2`. `hash(10, 5432)` → `-5817877081768721676`
`hash_fnv1a` ( `значение` [, `затравка`] ) → `integer` Вычисляет хеш по алгоритму хеш FNV-1a `hash_fnv1a(10, 5432)` → `-7793829335365542153`
`hash_murmur2` ( `значение` [, `затравка`] ) → `integer` Вычисляет хеш по алгоритму MurmurHash2 `hash_murmur2(10, 5432)` → `-5817877081768721676`
`int` ( `число` ) → `integer` Приводит аргумент к целочисленному типу. `int(5.4 + 3.8)` → `9`
`least` ( `число` [, `...`] ) → `double` при наличии аргумента(ов) double, иначе — `integer` Выбирает наименьшее значение среди аргументов. `least(5, 4, 3, 2.1)` → `2.1`
`ln` ( `число` ) → `double` Натуральный логарифм `ln(2.718281828459045)` → `1.0`
`mod` ( `целое`, `целое` ) → `integer` Остаток от деления `mod(54, 32)` → `22`
`permute` ( `i`, `size` [, `seed` ] ) → `integer` Переставленное значение `i` в диапазоне `[0, size)`, то есть позиция `i` (по модулю `size`) в псевдослучайной перестановке целых чисел `0...size-1`, полученной с затравкой `seed`, см. ниже. `permute(0, 4)` → `целое между 0 и 3`
`pi` () → `double` Приближённое значение π `pi()` → `3.14159265358979323846`
`pow` ( `x`, `y` ) → `double` `power` ( `x`, `y` ) → `double` Возводит `x` в степень `y` `pow(2.0, 10)` → `1024.0`
`random` ( `lb`, `ub` ) → `integer` Выдаёт случайное целое число с равномерным распределением в интервале `[lb, ub]`. `random(1, 10)` → `целое между 1 и 10`
`random_exponential` ( `lb`, `ub`, `parameter` ) → `integer` Выдаёт случайное целое число с экспоненциальным распределением в интервале `[lb, ub]`, см. ниже. `random_exponential(1, 10, 3.0)` → `целое между 1 и 10`
`random_gaussian` ( `lb`, `ub`, `parameter` ) → `integer` Выдаёт целое число с распределением Гаусса в интервале `[lb, ub]`, см. ниже. `random_gaussian(1, 10, 2.5)` → `целое между 1 и 10`
`random_zipfian` ( `lb`, `ub`, `parameter` ) → `integer` Выдаёт целое число с распределением Ципфа в интервале `[lb, ub]`, см. ниже. `random_zipfian(1, 10, 1.5)` → `целое между 1 и 10`
`sqrt` ( `число` ) → `double` Квадратный корень `sqrt(2.0)` → `1.414213562`

Функция

Описание

Примеры

abs ( число ) → тип аргумента

Модуль числа (абсолютное значение)

abs(-17) → 17

debug ( число ) → тип аргумента

Выводит аргумент в stderr и выдаёт его.

debug(5432.1) → 5432.1

double ( число ) → double

Приводит аргумент к типу с плавающей точкой.

double(5432) → 5432.0

exp ( число ) → double

Экспонента (e возводится в заданную степень)

exp(1.0) → 2.718281828459045

greatest ( число [, ...] ) → double при наличии аргумента(ов) double, иначе — integer

Выбирает наибольшее значение среди аргументов.

greatest(5, 4, 3, 2) → 5

hash ( значение [, затравка] ) → integer

Псевдоним hash_murmur2.

hash(10, 5432) → -5817877081768721676

hash_fnv1a ( значение [, затравка] ) → integer

Вычисляет хеш по алгоритму хеш FNV-1a

hash_fnv1a(10, 5432) → -7793829335365542153

hash_murmur2 ( значение [, затравка] ) → integer

Вычисляет хеш по алгоритму MurmurHash2

hash_murmur2(10, 5432) → -5817877081768721676

int ( число ) → integer

Приводит аргумент к целочисленному типу.

int(5.4 + 3.8) → 9

least ( число [, ...] ) → double при наличии аргумента(ов) double, иначе — integer

Выбирает наименьшее значение среди аргументов.

least(5, 4, 3, 2.1) → 2.1

ln ( число ) → double

Натуральный логарифм

ln(2.718281828459045) → 1.0

mod ( целое, целое ) → integer

Остаток от деления

mod(54, 32) → 22

permute ( i, size [, seed ] ) → integer

Переставленное значение i в диапазоне [0, size), то есть позиция i (по модулю size) в псевдослучайной перестановке целых чисел 0...size-1, полученной с затравкой seed, см. ниже.

permute(0, 4) → целое между 0 и 3

pi () → double

Приближённое значение π

pi() → 3.14159265358979323846

pow ( x, y ) → double

power ( x, y ) → double

Возводит x в степень y

pow(2.0, 10) → 1024.0

random ( lb, ub ) → integer

Выдаёт случайное целое число с равномерным распределением в интервале [lb, ub].

random(1, 10) → целое между 1 и 10

random_exponential ( lb, ub, parameter ) → integer

Выдаёт случайное целое число с экспоненциальным распределением в интервале [lb, ub], см. ниже.

random_exponential(1, 10, 3.0) → целое между 1 и 10

random_gaussian ( lb, ub, parameter ) → integer

Выдаёт целое число с распределением Гаусса в интервале [lb, ub], см. ниже.

random_gaussian(1, 10, 2.5) → целое между 1 и 10

random_zipfian ( lb, ub, parameter ) → integer

Выдаёт целое число с распределением Ципфа в интервале [lb, ub], см. ниже.

random_zipfian(1, 10, 1.5) → целое между 1 и 10

sqrt ( число ) → double

Квадратный корень

sqrt(2.0) → 1.414213562

Функция random выдаёт значения с равномерным распределением, то есть вероятности получения всех чисел в интервале равны. Функции random_exponential, random_gaussian и random_zipfian требуют указания дополнительного параметра типа double, определяющего точную форму распределения.

Для экспоненциального распределения parameter управляет распределением, обрезая быстро спадающее экспоненциальное распределение в точке parameter, а затем это распределение проецируется на целые числа между границами. Точнее говоря, с

f(x) = exp(-parameter * (x - min) / (max - min + 1)) / (1 - exp(-parameter))
значение i между min и max выдаётся с вероятностью: f(i) - f(i + 1).
Интуиция подсказывает, что чем больше parameter, тем чаще будут выдаваться значения, близкие к min, и тем реже значения, близкие к max. Чем parameter ближе к 0, тем более плоским (более равномерным) будет распределение. В грубом приближении при таком распределении наиболее частый 1% значений в диапазоне рядом с min выдаётся parameter% времени. Значение parameter должно быть строго положительным.
Для распределения Гаусса по интервалу строится обычное нормальное распределение (классическая кривая Гаусса в форме колокола) и этот интервал обрезается в точке -parameter слева и +parameter справа. Вероятнее всего при таком распределении выдаются значения из середины интервала. Точнее говоря, если PHI(x) — функция распределения нормальной случайной величины со средним значением mu, равным (max + min) / 2.0, и

f(x) = PHI(2.0 * parameter * (x - mu) / (max - min + 1)) /
(2.0 * PHI(parameter) - 1)
тогда значение i между min и max включительно выдаётся с вероятностью: f(i + 0.5) - f(i - 0.5). Интуиция подсказывает, что чем больше parameter, тем чаще будут выдаваться значения в середине интервала, и тем реже значения у границ min и max. Около 67% значений будут выдаваться из среднего интервала 1.0 / parameter, то есть плюс/минус 0.5 / parameter от среднего значения, и 95% из среднего интервала 2.0 / parameter, то есть плюс/минус 1.0 / parameter от среднего значения; например, если parameter равен 4.0, 67% значений выдаются из средней четверти (1.0 / 4.0) интервала (то есть от 3.0 / 8.0 до 5.0 / 8.0) и 95% из средней половины (2.0 / 4.0) интервала (из второй и третьей четвертей). Значение parameter не может быть меньше 2.0.
Функция random_zipfian генерирует ограниченное распределение по закону Ципфа. parameter определяет, насколько неравномерно распределение. Чем больше parameter, тем чаще выдаются значения, близкие к началу интервала. Это распределение таково, что при диапазоне, начинающемся с 1, отношение вероятности получить k к вероятности получения k+1 равняется ((k+1)/k)**parameter. Например, random_zipfian(1, ..., 2.5) будет выдавать число 1 примерно в (2/1)**2.5 = 5.66 раза чаще, чем число 2, а оно, в свою очередь, будет выдаваться примерно в (3/2)**2.5 = 2.76 раза чаще, чем 3, и так далее.
Это распределение реализовано в pgbench по материалу книги «Non-Uniform Random Variate Generation» («Генерация неравномерно распределённых случайных чисел» Люк Деврой, стр. 550-551, Springer 1986. Вследствие ограничений алгоритма parameter может принимать значения только в интервале [1.001, 1000].

Примечание

Разрабатывая тест производительности, выбирающий строки неравномерно, учтите, что выбираемые строки могут коррелировать с другими данными, например, идентификаторами, выдаваемыми последовательностями, или физическим расположением строк, а это может искажать оценки производительности.

Чтобы избежать этого, можно использовать функцию permute для перемешивания выбранных строк и устранения таких корреляций, либо выполнить другие дополнительные операции, дающие подобный эффект.

Функции хеширования hash, hash_murmur2 и hash_fnv1a принимают на вход хешируемое значение и необязательный параметр с затравкой. Если значение затравки не задаётся, используется значение переменной :default_seed, которая инициализируется случайным числом (если не задаётся явно ключом командной строки -D).

Функция permute принимает входное значение, размер и необязательный параметр с затравкой. Она получает псевдослучайную перестановку целых чисел в диапазоне [0, размер) и возвращает индекс входного значения в этой перестановке. Выбираемая перестановка зависит от затравки; по умолчанию затравкой будет значение :default_seed. В отличие от функций вычисления хеша, функция permute гарантирует отсутствие пропусков и наложений в выходных значениях. Входные значения, лежащие за границами интервала, пересчитываются по модулю размера. Если значение размера не положительное, эта функция выдаёт ошибку. Функцию permute можно использовать для выравнивания результатов функций, выдающих неравномерно распределённые случайные числа, таких как random_zipfian или random_exponential, чтобы чаще выдаваемые значения не создавали корреляции. Например, следующий скрипт pgbench эмулирует возможную реальную нагрузку, типичную для социальных медиа- и блог-платформ, где несколько пользователей генерируют львиную долю нагрузки:

\set size 1000000
\set r random_zipfian(1, :size, 1.07)
\set k 1 + permute(:r, :size)

В некоторых случаях требуются другие разнообразные распределения, не коррелирующие друг с другом, и тогда может быть полезно дополнительно указать затравку:

\set k1 1 + permute(:r, :size, :default_seed + 123)
\set k2 1 + permute(:r, :size, :default_seed + 321)

Примерно такого же эффекта можно добиться, используя функцию hash:

\set size 1000000
\set r random_zipfian(1, 100 * :size, 1.07)
\set k 1 + abs(hash(:r)) % :size

Но так как hash может порождать коллизии, некоторые значения окажутся пропущенными, а другие будут встречаться чаще других, при том что в исходном распределении этого не наблюдалось.

В качестве примера взгляните на встроенное определение транзакции типа TPC-B:

\set aid random(1, 100000 * :scale)
\set bid random(1, 1 * :scale)
\set tid random(1, 10 * :scale)
\set delta random(-5000, 5000)
BEGIN;
UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
END;

С таким скриптом транзакция на каждой итерации будет обращаться к разным, случайно выбираемым строкам. (Этот пример показывает, почему важно, чтобы в каждом клиентском сеансе были собственные переменные — в противном случае они не будут независимо обращаться к разным строкам.)

Протоколирование транзакций

С параметром -l (но без --aggregate-interval), pgbench записывает информацию о каждой транзакции в протокол. Этот файл протокола будет называться префикс.nnn, где префикс по умолчанию — pgbench_log, а nnn — PID процесса pgbench. Префикс можно сменить, воспользовавшись ключом --log-prefix. Если параметр -j равен 2 или выше, будет создано несколько рабочих потоков, и каждый будет записывать отдельный протокол. Первый рабочий процесс будет использовать файл с тем же именем, что и в стандартном случае с одним потоком, а файлы остальных потоков будут называться префикс.nnn.mmm, где mmm — порядковый номер рабочего процесса, начиная с 1.

Каждая строка в файле протокола описывает одну транзакцию. Она содержит следующие поля, разделённые пробелами:

код_клиента: идентифицирует клиентский сеанс, в котором выполнялась транзакция
число_транзакций: показывает, сколько SQL-транзакций было выполнено в этом сеансе
длительность: общее время транзакции, в микросекундах
номер_скрипта: показывает, какой файл скрипта использовался (это полезно при указании нескольких скриптов ключами -f и -b)
время_эпохи: отметка времени в формате Unix, показывающая, когда транзакция была завершена
время_мкс: микросекунды в отметке времени, показывающей, когда транзакция была завершена
отставание_от_графика: задержка начала транзакции, которая представляет собой разницу между запланированным временем запуска транзакции и фактическим временем запуска, в микросекундах (выводится, только когда указан параметр --rate)
повторные_попытки: число повторений транзакции после ошибок сериализации или взаимоблокировки (выводится, только когда --max-tries не равен одному)

Когда одновременно применяются параметры --rate и --latency-limit, в поле длительность для пропущенных транзакций выводится skipped. Если транзакция завершилась неудачей, в столбце длительность выводится failed. Когда применяется параметр --failures-detailed, вместо длительности для неуспешной транзакции будет указано serialization или deadlock в зависимости от типа ошибки (за дополнительными сведениями обратитесь к Повторы и отказы из-за ошибок сериализации/взаимоблокировки).

Фрагмент протокола, полученного при выполнении с одним клиентом:

0 199 2241 0 1175850568 995598
0 200 2465 0 1175850568 998079
0 201 2513 0 1175850569 608
0 202 2038 0 1175850569 2663

Ещё один пример с --rate=100 и --latency-limit=5 (обратите внимание на дополнительный столбец отставание_от_графика):

0 81 4621 0 1412881037 912698 3005
0 82 6173 0 1412881037 914578 4304
0 83 skipped 0 1412881037 914578 5217
0 83 skipped 0 1412881037 914578 5099
0 83 4722 0 1412881037 916203 3108
0 84 4142 0 1412881037 918023 2333
0 85 2465 0 1412881037 919759 740

В этом примере транзакция 82 опоздала, так как её длительность (6.173 мс) превысила ограничение в 5 мс. Следующие две транзакции были пропущены, так как было слишком поздно их начинать.

Ниже показан фрагмент протокола с отказами и повторными попытками при максимальном числе попыток, равном 10 (обратите внимание на дополнительный столбец повторные_попытки):

3 0 47423 0 1499414498 34501 3
3 1 8333 0 1499414498 42848 0
3 2 8358 0 1499414498 51219 0
4 0 72345 0 1499414498 59433 6
1 3 41718 0 1499414498 67879 4
1 4 8416 0 1499414498 76311 0
3 3 33235 0 1499414498 84469 3
0 0 failed 0 1499414498 84905 9
2 0 failed 0 1499414498 86248 9
3 4 8307 0 1499414498 92788 0

Если применяется параметр --failures-detailed, в графе длительность выводится тип ошибки:

3 0 47423 0 1499414498 34501 3
3 1 8333 0 1499414498 42848 0
3 2 8358 0 1499414498 51219 0
4 0 72345 0 1499414498 59433 6
1 3 41718 0 1499414498 67879 4
1 4 8416 0 1499414498 76311 0
3 3 33235 0 1499414498 84469 3
0 0 serialization 0 1499414498 84905 9
2 0 serialization 0 1499414498 86248 9
3 4 8307 0 1499414498 92788 0

Когда проводится длительное тестирование с большим количеством транзакций, файлы протоколов могут быть очень объёмными. Чтобы в них записывалась только случайная выборка транзакций, можно запустить команду с параметром --sampling-rate.

Протоколирование с агрегированием

С параметром --aggregate-interval для файлов протоколов используется другой формат. Каждая строка протокола описывает один интервал агрегации. Она содержит следующие поля, разделённые пробелами:

начало_интервала: начальное время интервала в формате времени Unix
число_транзакций: количество транзакций в данном интервале
сумма_длительности: суммарная длительность транзакций
сумма_длительности_2: сумма квадратов длительностей транзакций
мин_длительность: минимальная длительность транзакции
макс_длительность: максимальная длительность транзакции
сумма_задержки: сумма задержек начала транзакций (ноль, если не указан параметр --rate)
сумма_задержки_2: сумма квадратов задержек начала транзакций (ноль, если не указан параметр --rate)
мин_задержка: минимальная задержка начала транзакции (ноль, если не указан параметр --rate)
макс_задержка: максимальная задержка начала транзакции (ноль, если не указан параметр --rate)
пропущено_транзакций: число транзакций, пропущенных из-за того, что было слишком поздно их начинать (ноль, если не заданы параметры --rate и --latency-limit)
повторено_транзакций: число транзакций, которые были повторены (ноль, если не указан параметр --max-tries)
повторные_попытки: число повторов после ошибок сериализации или взаимоблокировок (ноль, если параметр --max-tries не единица)
сбои_сериализации: число транзакций, которые были прерваны из-за ошибок сериализации и не были повторены впоследствии (ноль, если не указан параметр --failures-detailed)
сбои_взаимоблокировки: число транзакций, которые были прерваны из-за ошибок взаимоблокировки и не были повторены впоследствии (ноль, если не указан параметр --failures-detailed)

Ниже представлен пример вывода с этим параметром:

pgbench --aggregate-interval=10 --time=20 --client=10 --log --rate=1000 --latency-limit=10 --failures-detailed --max-tries=10 test

1650260552 5178 26171317 177284491527 1136 44462 2647617 7321113867 0 9866 64 7564 28340 4148 0
1650260562 4808 25573984 220121792172 1171 62083 3037380 9666800914 0 9998 598 7392 26621 4527 0

Заметьте, что простой формат протокола (без агрегирования) показывает, какой скрипт использовался для каждой транзакции, в отличие от формата с агрегированием. Таким образом, если вам нужны подобные сведения, но в разрезе скриптов, вам придётся агрегировать данные самостоятельно.

Отчёт по операторам

С параметром -r программа pgbench собирает следующую статистику по каждому оператору:

latency — время выполнения для каждого оператора. pgbench выводит среднее по всем успешным попыткам выполнения оператора.
Число отказов для данного оператора. За дополнительной информацией обратитесь к Повторы и отказы из-за ошибок сериализации/взаимоблокировки.
Число повторов после ошибок сериализации или взаимоблокировки в этом операторе. За дополнительными сведениями обратитесь к Повторы и отказы из-за ошибок сериализации/взаимоблокировки.

В отчёте отображается статистика повторов, только если параметр --max-tries не равен 1.

Все эти значения вычисляются для каждого оператора, выполняемого каждым клиентом, и выдаются после завершения теста.

Для скрипта по умолчанию вывод будет выглядеть примерно так:

starting vacuum...end.
transaction type: <builtin: TPC-B (sort of)>
scaling factor: 1
query mode: simple
number of clients: 10
number of threads: 1
maximum number of tries: 1
number of transactions per client: 1000
number of transactions actually processed: 10000/10000
number of failed transactions: 0 (0.000%)
number of transactions above the 50.0 ms latency limit: 1311/10000 (13.110 %)
latency average = 28.488 ms
latency stddev = 21.009 ms
initial connection time = 69.068 ms
tps = 346.224794 (without initial connection time)
statement latencies in milliseconds and failures:
   0.012  0  \set aid random(1, 100000 * :scale)
   0.002  0  \set bid random(1, 1 * :scale)
   0.002  0  \set tid random(1, 10 * :scale)
   0.002  0  \set delta random(-5000, 5000)
   0.319  0  BEGIN;
   0.834  0  UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
   0.641  0  SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
  11.126  0  UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
  12.961  0  UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
   0.634  0  INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
   1.957  0  END;

Ещё один пример вывода для скрипта по умолчанию с выбором сериализуемого уровня изоляции (PGOPTIONS='-c default_transaction_isolation=serializable' pgbench ...):

starting vacuum...end.
transaction type: <builtin: TPC-B (sort of)>
scaling factor: 1
query mode: simple
number of clients: 10
number of threads: 1
maximum number of tries: 10
number of transactions per client: 1000
number of transactions actually processed: 6317/10000
number of failed transactions: 3683 (36.830%)
number of transactions retried: 7667 (76.670%)
total number of retries: 45339
number of transactions above the 50.0 ms latency limit: 106/6317 (1.678 %)
latency average = 17.016 ms
latency stddev = 13.283 ms
initial connection time = 45.017 ms
tps = 186.792667 (without initial connection time)
statement latencies in milliseconds, failures and retries:
  0.006     0      0  \set aid random(1, 100000 * :scale)
  0.001     0      0  \set bid random(1, 1 * :scale)
  0.001     0      0  \set tid random(1, 10 * :scale)
  0.001     0      0  \set delta random(-5000, 5000)
  0.385     0      0  BEGIN;
  0.773     0      1  UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
  0.624     0      0  SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
  1.098   320   3762  UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
  0.582  3363  41576  UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
  0.465     0      0  INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
  1.933     0      0  END;

Если задействуется несколько файлов скриптов, все статистические данные выводятся отдельно для каждого файла.

Учтите, что сбор дополнительных временных показателей влечёт некоторые издержки и приводит к снижению средней скорости и, как результат, падению TPS. На сколько именно снизится скорость, во многом зависит от платформы и оборудования. Хороший способ оценить, каковы эти издержки — сравнить средние значения TPS, получаемые с подсчётом времени операторов и без такого подсчёта.

Повторы и отказы из-за ошибок сериализации/взаимоблокировки

При выполнении pgbench могут возникать ошибки трёх основных типов:

Ошибки основной программы. Они являются наиболее серьёзными и всегда приводят к немедленному завершению pgbench с соответствующим сообщением об ошибке. К ним относятся:
- ошибки, возникшие при запуске pgbench (например, из-за недопустимого значения параметра);
- ошибки в режиме инициализации (например, запрос из встроенного скрипта не смог создать таблицу);
- ошибки перед запуском потоков (например, не удалось подключиться к серверу базы данных, синтаксическая ошибка в метакоманде, сбой при создании потока);
- непредвиденные внутренние ошибки pgbench.
Ошибки при обслуживании клиентов в потоке выполнения (например, клиент не смог установить соединение с сервером, сокет для подключения клиента к серверу стал недействительным). В таких случаях все клиенты этого потока останавливаются, а другие потоки продолжают работать. Однако если указать параметр --exit-on-abort, остановятся все потоки.
Непосредственно клиентские ошибки. Они вызывают немедленное завершение pgbench с соответствующим сообщением только в случае непредвиденной внутренней ошибки pgbench или если указан параметр --exit-on-abort. В других случаях они могут вызвать лишь прерывание работы проблемного клиента, в то время как другие клиенты продолжат работу (однако некоторые клиентские ошибки обрабатываются без прерывания работы клиента и информация о них выдаётся отдельно, см. ниже). Далее в этом разделе ошибками считаются только непосредственно клиентские ошибки, а не внутренние ошибки pgbench.

Работа клиента прерывается в случае серьёзной ошибки; например, если было потеряно соединение с сервером баз данных или достигнут конец скрипта, а последняя транзакция не завершена. Кроме того, работа клиента прерывается, если выполнение команды SQL или метакоманды завершается сбоем по причинам, отличным от ошибок сериализации или взаимоблокировки. Если же команда SQL завершается ошибкой сериализации или взаимоблокировки, работа клиента продолжается. В таких случаях текущая транзакция откатывается, при этом клиентские переменные получают значения, которые они имели до начала этой транзакции (предполагается, что один скрипт транзакции содержит только одну транзакцию; за подробностями обратитесь к Каково содержание «транзакции», которую выполняет pgbench?). Транзакции с ошибками сериализации или взаимоблокировки повторяются после отката до успешного завершения либо до максимального числа повторений (которое задаётся параметром --max-tries), максимальной длительности повторений (которая задаётся параметром --latency-limit) или до истечения времени теста (это время задаётся параметром --time). Если последняя попытка завершается неудачей, транзакция считается неудачной, но работа клиента не прерывается.

Примечание

Если параметр --max-tries не указан, транзакции никогда не повторяются после ошибок сериализации или взаимоблокировки, так как его значение по умолчанию равно 1. Чтобы ограничить только общую длительность попыток, задайте неограниченное количество попыток (--max-tries=0) и установите параметр --latency-limit. Вы также можете ограничить общую продолжительность теста при неограниченном количестве попыток, используя параметр --time.

Учтите особенность повторения скриптов, содержащих несколько транзакций: скрипт всегда будет повторяться целиком, так что успешные транзакции в нём могут выполняться многократно.

Также учтите особенность повторения транзакций, содержащих команды оболочки. В отличие от результатов команд SQL, результаты команд оболочки не отменяются, за исключением значения переменной команды \setshell.

Длительность успешной транзакции включает общее время выполнения транзакции с учётом откатов и повторов. Измеряется длительность только для успешных транзакций и команд.

Количество неуспешных транзакций выводится в основном отчёте. Если параметр --max-tries не равен 1, основной отчёт также содержит статистику повторов: общее число транзакций, которые повторялись, и общее число повторов всех транзакций. Отчёт по скриптам наследует все эти поля от основного отчёта. Если параметр --max-tries не равен 1, статистика повторных попыток также отображается в отчёте по операторам.

Если вы хотите, чтобы в протоколе c агрегированием, а также в основном отчёте, отчёте по транзакциям и отчёте по скриптам сбои группировались по базовым типам, используйте параметр --failures-detailed. Если же вы хотите видеть все отдельные ошибки и отказы (ошибки, после которых транзакция не повторяется), а также видеть, как ограничиваются повторения и насколько достигается ограничение, используйте параметр --verbose-errors.

Табличные методы доступа

Можно определить табличный метод доступа к таблицам pgbench. В переменной окружения PGOPTIONS задаются конфигурационные параметры БД, которые передаются в PostgreSQL через командную строку (см. Подраздел 19.1.4). Например, табличный метод доступа по умолчанию к таблицам, создаваемым pgbench, под названием wuzza можно определить так:

PGOPTIONS='-c default_table_access_method=wuzza'

Полезные советы

Используя pgbench, можно без особого труда получить абсолютно бессмысленные числа. Последуйте приведённым советам, чтобы получить полезные результаты.

Во-первых, никогда не доверяйте тестам, которые выполняются всего несколько секунд. Воспользуйтесь параметром -t и -T и установите время выполнения не меньше нескольких минут, чтобы избавиться от шума в средних значениях. В некоторых случаях для получения воспроизводимых результатов тестирование должно продолжаться несколько часов. Чтобы понять, были ли получены воспроизводимые значения, имеет смысл запустить тестирование несколько раз.

Для стандартного сценария по типу TPC-B начальный коэффициент масштаба (-s) должен быть не меньше числа клиентов, с каким вы намерены проводить тестирование (-c); в противном случае вы, по большому счёту, будете замерять время конкурентных изменений. Таблица pgbench_branches содержит всего -s строк, а каждая транзакция хочет изменить одну из них, так что если значение -c превышает -s, это несомненно приведёт к тому, что многие транзакции будут блокироваться другими.

Стандартный сценарий тестирования также довольно сильно зависит от того, сколько времени прошло с момента инициализации таблиц: накопление неактуальных строк и «мёртвого» пространства в таблицах влияет на результаты. Чтобы правильно оценить результаты, необходимо учитывать, сколько всего изменений было произведено и когда выполнялась очистка. Если же включена автоочистка, это может быть чревато непредсказуемыми изменениями оценок производительности.

Полезность результатов pgbench также может ограничиваться тем, что тестирование с большим числом клиентских сеансов само по себе нагружает систему. Этого можно избежать, запуская pgbench на другом компьютере, не на сервере баз данных, хотя при этом большое значение имеет скорость сети. Иногда, оценивая производительность одного сервера, полезно запускать даже несколько экземпляров pgbench параллельно, на отдельных клиентских компьютерах.

Безопасность

Если к базе данных, которая не приведена в соответствие шаблону безопасного использования схем, имеют доступ недоверенные пользователи, не запускайте pgbench в этой базе. Программа pgbench использует неполные имена и не настраивает для себя путь поиска.

Пред.	Наверх	След.
pg_basebackup	Начало	pg_combinebackup

pgbench
Prev	Up	PostgreSQL Client Applications	Home	Next

pgbench

pgbench — run a benchmark test on PostgreSQL

Synopsis

pgbench -i [option...] [dbname]

pgbench [option...] [dbname]

Description

pgbench is a simple program for running benchmark tests on PostgreSQL. It runs the same sequence of SQL commands over and over, possibly in multiple concurrent database sessions, and then calculates the average transaction rate (transactions per second). By default, pgbench tests a scenario that is loosely based on TPC-B, involving five SELECT, UPDATE, and INSERT commands per transaction. However, it is easy to test other cases by writing your own transaction script files.

Typical output from pgbench looks like:

transaction type: <builtin: TPC-B (sort of)>
scaling factor: 10
query mode: simple
number of clients: 10
number of threads: 1
maximum number of tries: 1
number of transactions per client: 1000
number of transactions actually processed: 10000/10000
number of failed transactions: 0 (0.000%)
latency average = 11.013 ms
latency stddev = 7.351 ms
initial connection time = 45.758 ms
tps = 896.967014 (without initial connection time)

The first seven lines report some of the most important parameter settings. The sixth line reports the maximum number of tries for transactions with serialization or deadlock errors (see Failures and Serialization/Deadlock Retries for more information). The eighth line reports the number of transactions completed and intended (the latter being just the product of number of clients and number of transactions per client); these will be equal unless the run failed before completion or some SQL command(s) failed. (In -T mode, only the actual number of transactions is printed.) The next line reports the number of failed transactions due to serialization or deadlock errors (see Failures and Serialization/Deadlock Retries for more information). The last line reports the number of transactions per second.

The default TPC-B-like transaction test requires specific tables to be set up beforehand. pgbench should be invoked with the -i (initialize) option to create and populate these tables. (When you are testing a custom script, you don't need this step, but will instead need to do whatever setup your test needs.) Initialization looks like:

pgbench -i [ other-options ] dbname

where dbname is the name of the already-created database to test in. (You may also need -h, -p, and/or -U options to specify how to connect to the database server.)

Caution

pgbench -i creates four tables pgbench_accounts, pgbench_branches, pgbench_history, and pgbench_tellers, destroying any existing tables of these names. Be very careful to use another database if you have tables having these names!

At the default “scale factor” of 1, the tables initially contain this many rows:

table                   # of rows
---------------------------------
pgbench_branches        1
pgbench_tellers         10
pgbench_accounts        100000
pgbench_history         0

You can (and, for most purposes, probably should) increase the number of rows by using the -s (scale factor) option. The -F (fillfactor) option might also be used at this point.

Once you have done the necessary setup, you can run your benchmark with a command that doesn't include -i, that is

pgbench [ options ] dbname

In nearly all cases, you'll need some options to make a useful test. The most important options are -c (number of clients), -t (number of transactions), -T (time limit), and -f (specify a custom script file). See below for a full list.

Options

The following is divided into three subsections. Different options are used during database initialization and while running benchmarks, but some options are useful in both cases.

Initialization Options

pgbench accepts the following command-line initialization arguments:

[-d] dbname [--dbname=]dbname #

Specifies the name of the database to test in. If this is not specified, the environment variable PGDATABASE is used. If that is not set, the user name specified for the connection is used.

-i --initialize #

Required to invoke initialization mode.

-I init_steps --init-steps=init_steps #

Perform just a selected set of the normal initialization steps. init_steps specifies the initialization steps to be performed, using one character per step. Each step is invoked in the specified order. The default is dtgvp. The available steps are:

d (Drop) #

Drop any existing pgbench tables.

t (create Tables) #

Create the tables used by the standard pgbench scenario, namely pgbench_accounts, pgbench_branches, pgbench_history, and pgbench_tellers.

g or G (Generate data, client-side or server-side) #

Generate data and load it into the standard tables, replacing any data already present.

With g (client-side data generation), data is generated in pgbench client and then sent to the server. This uses the client/server bandwidth extensively through a COPY. pgbench uses the FREEZE option with version 14 or later of PostgreSQL to speed up subsequent VACUUM, except on the pgbench_accounts table if partitions are enabled. Using g causes logging to print one message every 100,000 rows while generating data for all tables.

With G (server-side data generation), only small queries are sent from the pgbench client and then data is actually generated in the server. No significant bandwidth is required for this variant, but the server will do more work. Using G causes logging not to print any progress message while generating data.

The default initialization behavior uses client-side data generation (equivalent to g).

v (Vacuum) #

Invoke VACUUM on the standard tables.

p (create Primary keys) #

Create primary key indexes on the standard tables.

f (create Foreign keys) #

Create foreign key constraints between the standard tables. (Note that this step is not performed by default.)

-F fillfactor --fillfactor=fillfactor #

Create the pgbench_accounts, pgbench_tellers and pgbench_branches tables with the given fillfactor. Default is 100.

-n --no-vacuum #

Perform no vacuuming during initialization. (This option suppresses the v initialization step, even if it was specified in -I.)

-q --quiet #

Switch logging to quiet mode, producing only one progress message per 5 seconds. The default logging prints one message each 100,000 rows, which often outputs many lines per second (especially on good hardware).

This setting has no effect if G is specified in -I.

-s scale_factor --scale=scale_factor #

Multiply the number of rows generated by the scale factor. For example, -s 100 will create 10,000,000 rows in the pgbench_accounts table. Default is 1. When the scale is 20,000 or larger, the columns used to hold account identifiers (aid columns) will switch to using larger integers (bigint), in order to be big enough to hold the range of account identifiers.

--foreign-keys #

Create foreign key constraints between the standard tables. (This option adds the f step to the initialization step sequence, if it is not already present.)

--index-tablespace=index_tablespace #

Create indexes in the specified tablespace, rather than the default tablespace.

--partition-method=NAME #

Create a partitioned pgbench_accounts table with NAME method. Expected values are range or hash. This option requires that --partitions is set to non-zero. If unspecified, default is range.

--partitions=NUM #

Create a partitioned pgbench_accounts table with NUM partitions of nearly equal size for the scaled number of accounts. Default is 0, meaning no partitioning.

--tablespace=tablespace #

Create tables in the specified tablespace, rather than the default tablespace.

--unlogged-tables #

Create all tables as unlogged tables, rather than permanent tables.

Benchmarking Options

pgbench accepts the following command-line benchmarking arguments:

-b scriptname[@weight] --builtin=scriptname[@weight] #

Add the specified built-in script to the list of scripts to be executed. Available built-in scripts are: tpcb-like, simple-update and select-only. Unambiguous prefixes of built-in names are accepted. With the special name list, show the list of built-in scripts and exit immediately.

Optionally, write an integer weight after @ to adjust the probability of selecting this script versus other ones. The default weight is 1. See below for details.

-c clients --client=clients #

Number of clients simulated, that is, number of concurrent database sessions. Default is 1.

-C --connect #

Establish a new connection for each transaction, rather than doing it just once per client session. This is useful to measure the connection overhead.

-D varname=value --define=varname=value #

Define a variable for use by a custom script (see below). Multiple -D options are allowed.

-f filename[@weight] --file=filename[@weight] #

Add a transaction script read from filename to the list of scripts to be executed.

Optionally, write an integer weight after @ to adjust the probability of selecting this script versus other ones. The default weight is 1. (To use a script file name that includes an @ character, append a weight so that there is no ambiguity, for example filen@me@1.) See below for details.

-j threads --jobs=threads #

Number of worker threads within pgbench. Using more than one thread can be helpful on multi-CPU machines. Clients are distributed as evenly as possible among available threads. Default is 1.

-l --log #

Write information about each transaction to a log file. See below for details.

-L limit --latency-limit=limit #

Transactions that last more than limit milliseconds are counted and reported separately, as late.

When throttling is used (--rate=...), transactions that lag behind schedule by more than limit ms, and thus have no hope of meeting the latency limit, are not sent to the server at all. They are counted and reported separately as skipped.

When the --max-tries option is used, a transaction which fails due to a serialization anomaly or from a deadlock will not be retried if the total time of all its tries is greater than limit ms. To limit only the time of tries and not their number, use --max-tries=0. By default, the option --max-tries is set to 1 and transactions with serialization/deadlock errors are not retried. See Failures and Serialization/Deadlock Retries for more information about retrying such transactions.

-M querymode --protocol=querymode #

Protocol to use for submitting queries to the server:

simple: use simple query protocol.
extended: use extended query protocol.
prepared: use extended query protocol with prepared statements.

In the prepared mode, pgbench reuses the parse analysis result starting from the second query iteration, so pgbench runs faster than in other modes.

The default is simple query protocol. (See Chapter 53 for more information.)

-n --no-vacuum #

Perform no vacuuming before running the test. This option is necessary if you are running a custom test scenario that does not include the standard tables pgbench_accounts, pgbench_branches, pgbench_history, and pgbench_tellers.

-N --skip-some-updates #

Run built-in simple-update script. Shorthand for -b simple-update.

-P sec --progress=sec #

Show progress report every sec seconds. The report includes the time since the beginning of the run, the TPS since the last report, and the transaction latency average, standard deviation, and the number of failed transactions since the last report. Under throttling (-R), the latency is computed with respect to the transaction scheduled start time, not the actual transaction beginning time, thus it also includes the average schedule lag time. When --max-tries is used to enable transaction retries after serialization/deadlock errors, the report includes the number of retried transactions and the sum of all retries.

-r --report-per-command #

Report the following statistics for each command after the benchmark finishes: the average per-statement latency (execution time from the perspective of the client), the number of failures, and the number of retries after serialization or deadlock errors in this command. The report displays retry statistics only if the --max-tries option is not equal to 1.

-R rate --rate=rate #

Execute transactions targeting the specified rate instead of running as fast as possible (the default). The rate is given in transactions per second. If the targeted rate is above the maximum possible rate, the rate limit won't impact the results.

The rate is targeted by starting transactions along a Poisson-distributed schedule time line. The expected start time schedule moves forward based on when the client first started, not when the previous transaction ended. That approach means that when transactions go past their original scheduled end time, it is possible for later ones to catch up again.

When throttling is active, the transaction latency reported at the end of the run is calculated from the scheduled start times, so it includes the time each transaction had to wait for the previous transaction to finish. The wait time is called the schedule lag time, and its average and maximum are also reported separately. The transaction latency with respect to the actual transaction start time, i.e., the time spent executing the transaction in the database, can be computed by subtracting the schedule lag time from the reported latency.

If --latency-limit is used together with --rate, a transaction can lag behind so much that it is already over the latency limit when the previous transaction ends, because the latency is calculated from the scheduled start time. Such transactions are not sent to the server, but are skipped altogether and counted separately.

A high schedule lag time is an indication that the system cannot process transactions at the specified rate, with the chosen number of clients and threads. When the average transaction execution time is longer than the scheduled interval between each transaction, each successive transaction will fall further behind, and the schedule lag time will keep increasing the longer the test run is. When that happens, you will have to reduce the specified transaction rate.

-s scale_factor --scale=scale_factor #

Report the specified scale factor in pgbench's output. With the built-in tests, this is not necessary; the correct scale factor will be detected by counting the number of rows in the pgbench_branches table. However, when testing only custom benchmarks (-f option), the scale factor will be reported as 1 unless this option is used.

-S --select-only #

Run built-in select-only script. Shorthand for -b select-only.

-t transactions --transactions=transactions #

Number of transactions each client runs. Default is 10.

-T seconds --time=seconds #

Run the test for this many seconds, rather than a fixed number of transactions per client. -t and -T are mutually exclusive.

-v --vacuum-all #

Vacuum all four standard tables before running the test. With neither -n nor -v, pgbench will vacuum the pgbench_tellers and pgbench_branches tables, and will truncate pgbench_history.

--aggregate-interval=seconds #

Length of aggregation interval (in seconds). May be used only with -l option. With this option, the log contains per-interval summary data, as described below.

--exit-on-abort #

Exit immediately when any client is aborted due to some error. Without this option, even when a client is aborted, other clients could continue their run as specified by -t or -T option, and pgbench will print an incomplete results in this case.

Note that serialization failures or deadlock failures do not abort the client, so they are not affected by this option. See Failures and Serialization/Deadlock Retries for more information.

--failures-detailed #

Report failures in per-transaction and aggregation logs, as well as in the main and per-script reports, grouped by the following types:

serialization failures;
deadlock failures;

See Failures and Serialization/Deadlock Retries for more information.

--log-prefix=prefix #

Set the filename prefix for the log files created by --log. The default is pgbench_log.

--max-tries=number_of_tries #

Enable retries for transactions with serialization/deadlock errors and set the maximum number of these tries. This option can be combined with the --latency-limit option which limits the total time of all transaction tries; moreover, you cannot use an unlimited number of tries (--max-tries=0) without --latency-limit or --time. The default value is 1 and transactions with serialization/deadlock errors are not retried. See Failures and Serialization/Deadlock Retries for more information about retrying such transactions.

--progress-timestamp #

When showing progress (option -P), use a timestamp (Unix epoch) instead of the number of seconds since the beginning of the run. The unit is in seconds, with millisecond precision after the dot. This helps compare logs generated by various tools.

--random-seed=seed #

Set random generator seed. Seeds the system random number generator, which then produces a sequence of initial generator states, one for each thread. Values for seed may be: time (the default, the seed is based on the current time), rand (use a strong random source, failing if none is available), or an unsigned decimal integer value. The random generator is invoked explicitly from a pgbench script (random... functions) or implicitly (for instance option --rate uses it to schedule transactions). When explicitly set, the value used for seeding is shown on the terminal. Any value allowed for seed may also be provided through the environment variable PGBENCH_RANDOM_SEED. To ensure that the provided seed impacts all possible uses, put this option first or use the environment variable.

Setting the seed explicitly allows to reproduce a pgbench run exactly, as far as random numbers are concerned. As the random state is managed per thread, this means the exact same pgbench run for an identical invocation if there is one client per thread and there are no external or data dependencies. From a statistical viewpoint reproducing runs exactly is a bad idea because it can hide the performance variability or improve performance unduly, e.g., by hitting the same pages as a previous run. However, it may also be of great help for debugging, for instance re-running a tricky case which leads to an error. Use wisely.

--sampling-rate=rate #

Sampling rate, used when writing data into the log, to reduce the amount of log generated. If this option is given, only the specified fraction of transactions are logged. 1.0 means all transactions will be logged, 0.05 means only 5% of the transactions will be logged.

Remember to take the sampling rate into account when processing the log file. For example, when computing TPS values, you need to multiply the numbers accordingly (e.g., with 0.01 sample rate, you'll only get 1/100 of the actual TPS).

--show-script=scriptname #

Show the actual code of builtin script scriptname on stderr, and exit immediately.

--verbose-errors #

Print messages about all errors and failures (errors without retrying) including which limit for retries was exceeded and how far it was exceeded for the serialization/deadlock failures. (Note that in this case the output can be significantly increased.) See Failures and Serialization/Deadlock Retries for more information.

Common Options

pgbench also accepts the following common command-line arguments for connection parameters and other common settings:

--debug #: Print debugging output.
-h hostname --host=hostname #: The database server's host name
-p port --port=port #: The database server's port number
-U login --username=login #: The user name to connect as
-V --version #: Print the pgbench version and exit.
-? --help #: Show help about pgbench command line arguments, and exit.

Exit Status

A successful run will exit with status 0. Exit status 1 indicates static problems such as invalid command-line options or internal errors which are supposed to never occur. Early errors that occur when starting benchmark such as initial connection failures also exit with status 1. Errors during the run such as database errors or problems in the script will result in exit status 2. In the latter case, pgbench will print partial results if --exit-on-abort option is not specified.

Environment

PGDATABASE PGHOST PGPORT PGUSER #: Default connection parameters.

This utility, like most other PostgreSQL utilities, uses the environment variables supported by libpq (see Section 32.15).

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

Notes

What Is the “Transaction” Actually Performed in pgbench?

pgbench executes test scripts chosen randomly from a specified list. The scripts may include built-in scripts specified with -b and user-provided scripts specified with -f. Each script may be given a relative weight specified after an @ so as to change its selection probability. The default weight is 1. Scripts with a weight of 0 are ignored.

The default built-in transaction script (also invoked with -b tpcb-like) issues seven commands per transaction over randomly chosen aid, tid, bid and delta. The scenario is inspired by the TPC-B benchmark, but is not actually TPC-B, hence the name.

BEGIN;
UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
END;

If you select the simple-update built-in (also -N), steps 4 and 5 aren't included in the transaction. This will avoid update contention on these tables, but it makes the test case even less like TPC-B.

If you select the select-only built-in (also -S), only the SELECT is issued.

Custom Scripts

pgbench has support for running custom benchmark scenarios by replacing the default transaction script (described above) with a transaction script read from a file (-f option). In this case a “transaction” counts as one execution of a script file.

A script file contains one or more SQL commands terminated by semicolons. Empty lines and lines beginning with -- are ignored. Script files can also contain “meta commands”, which are interpreted by pgbench itself, as described below.

Note

Before PostgreSQL 9.6, SQL commands in script files were terminated by newlines, and so they could not be continued across lines. Now a semicolon is required to separate consecutive SQL commands (though an SQL command does not need one if it is followed by a meta command). If you need to create a script file that works with both old and new versions of pgbench, be sure to write each SQL command on a single line ending with a semicolon.

It is assumed that pgbench scripts do not contain incomplete blocks of SQL transactions. If at runtime the client reaches the end of the script without completing the last transaction block, it will be aborted.

There is a simple variable-substitution facility for script files. Variable names must consist of letters (including non-Latin letters), digits, and underscores, with the first character not being a digit. Variables can be set by the command-line -D option, explained above, or by the meta commands explained below. In addition to any variables preset by -D command-line options, there are a few variables that are preset automatically, listed in Table 298. A value specified for these variables using -D takes precedence over the automatic presets. Once set, a variable's value can be inserted into an SQL command by writing :variablename. When running more than one client session, each session has its own set of variables. pgbench supports up to 255 variable uses in one statement.

Table 298. pgbench Automatic Variables

Variable	Description
`client_id`	unique number identifying the client session (starts from zero)
`default_seed`	seed used in hash and pseudorandom permutation functions by default
`random_seed`	random generator seed (unless overwritten with `-D`)
`scale`	current scale factor

Script file meta commands begin with a backslash (\) and normally extend to the end of the line, although they can be continued to additional lines by writing backslash-return. Arguments to a meta command are separated by white space. These meta commands are supported:

\gset [prefix] \aset [prefix] #

These commands may be used to end SQL queries, taking the place of the terminating semicolon (;).

When the \gset command is used, the preceding SQL query is expected to return one row, the columns of which are stored into variables named after column names, and prefixed with prefix if provided.

When the \aset command is used, all combined SQL queries (separated by \;) have their columns stored into variables named after column names, and prefixed with prefix if provided. If a query returns no row, no assignment is made and the variable can be tested for existence to detect this. If a query returns more than one row, the last value is kept.

\gset and \aset cannot be used in pipeline mode, since the query results are not yet available by the time the commands would need them.

The following example puts the final account balance from the first query into variable abalance, and fills variables p_two and p_three with integers from the third query. The result of the second query is discarded. The result of the two last combined queries are stored in variables four and five.

UPDATE pgbench_accounts
  SET abalance = abalance + :delta
  WHERE aid = :aid
  RETURNING abalance \gset
-- compound of two queries
SELECT 1 \;
SELECT 2 AS two, 3 AS three \gset p_
SELECT 4 AS four \; SELECT 5 AS five \aset

\if expression \elif expression \else \endif #

This group of commands implements nestable conditional blocks, similarly to psql's \if expression. Conditional expressions are identical to those with \set, with non-zero values interpreted as true.

\set varname expression #

Sets variable varname to a value calculated from expression. The expression may contain the NULL constant, Boolean constants TRUE and FALSE, integer constants such as 5432, double constants such as 3.14159, references to variables :variablename, operators with their usual SQL precedence and associativity, function calls, SQL CASE generic conditional expressions and parentheses.

Functions and most operators return NULL on NULL input.

For conditional purposes, non zero numerical values are TRUE, zero numerical values and NULL are FALSE.

Too large or small integer and double constants, as well as integer arithmetic operators (+, -, * and /) raise errors on overflows.

When no final ELSE clause is provided to a CASE, the default value is NULL.

Examples:

\set ntellers 10 * :scale
\set aid (1021 * random(1, 100000 * :scale)) % \
           (100000 * :scale) + 1
\set divx CASE WHEN :x <> 0 THEN :y/:x ELSE NULL END

\sleep number [ us | ms | s ] #

Causes script execution to sleep for the specified duration in microseconds (us), milliseconds (ms) or seconds (s). If the unit is omitted then seconds are the default. number can be either an integer constant or a :variablename reference to a variable having an integer value.

Example:

\sleep 10 ms

\setshell varname command [ argument ... ] #

Sets variable varname to the result of the shell command command with the given argument(s). The command must return an integer value through its standard output.

command and each argument can be either a text constant or a :variablename reference to a variable. If you want to use an argument starting with a colon, write an additional colon at the beginning of argument.

Example:

\setshell variable_to_be_assigned command literal_argument :variable ::literal_starting_with_colon

\shell command [ argument ... ] #

Same as \setshell, but the result of the command is discarded.

Example:

\shell command literal_argument :variable ::literal_starting_with_colon

\startpipeline \syncpipeline \endpipeline #

This group of commands implements pipelining of SQL statements. A pipeline must begin with a \startpipeline and end with an \endpipeline. In between there may be any number of \syncpipeline commands, which sends a sync message without ending the ongoing pipeline and flushing the send buffer. In pipeline mode, statements are sent to the server without waiting for the results of previous statements. See Section 32.5 for more details. Pipeline mode requires the use of extended query protocol.

Built-in Operators

The arithmetic, bitwise, comparison and logical operators listed in Table 299 are built into pgbench and may be used in expressions appearing in \set. The operators are listed in increasing precedence order. Except as noted, operators taking two numeric inputs will produce a double value if either input is double, otherwise they produce an integer result.

Table 299. pgbench Operators

Operator Description Example(s)
`boolean` `OR` `boolean` → `boolean` Logical OR `5 or 0` → `TRUE`
`boolean` `AND` `boolean` → `boolean` Logical AND `3 and 0` → `FALSE`
`NOT` `boolean` → `boolean` Logical NOT `not false` → `TRUE`
`boolean` `IS [NOT] (NULL\|TRUE\|FALSE)` → `boolean` Boolean value tests `1 is null` → `FALSE`
`value` `ISNULL\|NOTNULL` → `boolean` Nullness tests `1 notnull` → `TRUE`
`number` `=` `number` → `boolean` Equal `5 = 4` → `FALSE`
`number` `<>` `number` → `boolean` Not equal `5 <> 4` → `TRUE`
`number` `!=` `number` → `boolean` Not equal `5 != 5` → `FALSE`
`number` `<` `number` → `boolean` Less than `5 < 4` → `FALSE`
`number` `<=` `number` → `boolean` Less than or equal to `5 <= 4` → `FALSE`
`number` `>` `number` → `boolean` Greater than `5 > 4` → `TRUE`
`number` `>=` `number` → `boolean` Greater than or equal to `5 >= 4` → `TRUE`
`integer` `\|` `integer` → `integer` Bitwise OR `1 \| 2` → `3`
`integer` `#` `integer` → `integer` Bitwise XOR `1 # 3` → `2`
`integer` `&` `integer` → `integer` Bitwise AND `1 & 3` → `1`
`~` `integer` → `integer` Bitwise NOT `~ 1` → `-2`
`integer` `<<` `integer` → `integer` Bitwise shift left `1 << 2` → `4`
`integer` `>>` `integer` → `integer` Bitwise shift right `8 >> 2` → `2`
`number` `+` `number` → `number` Addition `5 + 4` → `9`
`number` `-` `number` → `number` Subtraction `3 - 2.0` → `1.0`
`number` `` `number`* → `number` Multiplication `5 * 4` → `20`
`number` `/` `number` → `number` Division (truncates the result towards zero if both inputs are integers) `5 / 3` → `1`
`integer` `%` `integer` → `integer` Modulo (remainder) `3 % 2` → `1`
`-` `number` → `number` Negation `- 2.0` → `-2.0`

Operator

Description

Example(s)

boolean OR boolean → boolean

Logical OR

5 or 0 → TRUE

boolean AND boolean → boolean

Logical AND

3 and 0 → FALSE

NOT boolean → boolean

Logical NOT

not false → TRUE

boolean IS [NOT] (NULL|TRUE|FALSE) → boolean

Boolean value tests

1 is null → FALSE

value ISNULL|NOTNULL → boolean

Nullness tests

1 notnull → TRUE

number = number → boolean

Equal

5 = 4 → FALSE

number <> number → boolean

Not equal

5 <> 4 → TRUE

number != number → boolean

Not equal

5 != 5 → FALSE

number < number → boolean

Less than

5 < 4 → FALSE

number <= number → boolean

Less than or equal to

5 <= 4 → FALSE

number > number → boolean

Greater than

5 > 4 → TRUE

number >= number → boolean

Greater than or equal to

5 >= 4 → TRUE

integer | integer → integer

Bitwise OR

1 | 2 → 3

integer # integer → integer

Bitwise XOR

1 # 3 → 2

integer & integer → integer

Bitwise AND

1 & 3 → 1

~ integer → integer

Bitwise NOT

~ 1 → -2

integer << integer → integer

Bitwise shift left

1 << 2 → 4

integer >> integer → integer

Bitwise shift right

8 >> 2 → 2

number + number → number

Addition

5 + 4 → 9

number - number → number

Subtraction

3 - 2.0 → 1.0

number * number → number

Multiplication

5 * 4 → 20

number / number → number

Division (truncates the result towards zero if both inputs are integers)

5 / 3 → 1

integer % integer → integer

Modulo (remainder)

3 % 2 → 1

- number → number

Negation

- 2.0 → -2.0

Built-In Functions

The functions listed in Table 300 are built into pgbench and may be used in expressions appearing in \set.

Table 300. pgbench Functions

Function Description Example(s)
`abs` ( `number` ) → same type as input Absolute value `abs(-17)` → `17`
`debug` ( `number` ) → same type as input Prints the argument to stderr, and returns the argument. `debug(5432.1)` → `5432.1`
`double` ( `number` ) → `double` Casts to double. `double(5432)` → `5432.0`
`exp` ( `number` ) → `double` Exponential (`e` raised to the given power) `exp(1.0)` → `2.718281828459045`
`greatest` ( `number` [, `...` ] ) → `double` if any argument is double, else `integer` Selects the largest value among the arguments. `greatest(5, 4, 3, 2)` → `5`
`hash` ( `value` [, `seed` ] ) → `integer` This is an alias for `hash_murmur2`. `hash(10, 5432)` → `-5817877081768721676`
`hash_fnv1a` ( `value` [, `seed` ] ) → `integer` Computes FNV-1a hash. `hash_fnv1a(10, 5432)` → `-7793829335365542153`
`hash_murmur2` ( `value` [, `seed` ] ) → `integer` Computes MurmurHash2 hash. `hash_murmur2(10, 5432)` → `-5817877081768721676`
`int` ( `number` ) → `integer` Casts to integer. `int(5.4 + 3.8)` → `9`
`least` ( `number` [, `...` ] ) → `double` if any argument is double, else `integer` Selects the smallest value among the arguments. `least(5, 4, 3, 2.1)` → `2.1`
`ln` ( `number` ) → `double` Natural logarithm `ln(2.718281828459045)` → `1.0`
`mod` ( `integer`, `integer` ) → `integer` Modulo (remainder) `mod(54, 32)` → `22`
`permute` ( `i`, `size` [, `seed` ] ) → `integer` Permuted value of `i`, in the range `[0, size)`. This is the new position of `i` (modulo `size`) in a pseudorandom permutation of the integers `0...size-1`, parameterized by `seed`, see below. `permute(0, 4)` → `an integer between 0 and 3`
`pi` () → `double` Approximate value of π `pi()` → `3.14159265358979323846`
`pow` ( `x`, `y` ) → `double` `power` ( `x`, `y` ) → `double` `x` raised to the power of `y` `pow(2.0, 10)` → `1024.0`
`random` ( `lb`, `ub` ) → `integer` Computes a uniformly-distributed random integer in `[lb, ub]`. `random(1, 10)` → `an integer between 1 and 10`
`random_exponential` ( `lb`, `ub`, `parameter` ) → `integer` Computes an exponentially-distributed random integer in `[lb, ub]`, see below. `random_exponential(1, 10, 3.0)` → `an integer between 1 and 10`
`random_gaussian` ( `lb`, `ub`, `parameter` ) → `integer` Computes a Gaussian-distributed random integer in `[lb, ub]`, see below. `random_gaussian(1, 10, 2.5)` → `an integer between 1 and 10`
`random_zipfian` ( `lb`, `ub`, `parameter` ) → `integer` Computes a Zipfian-distributed random integer in `[lb, ub]`, see below. `random_zipfian(1, 10, 1.5)` → `an integer between 1 and 10`
`sqrt` ( `number` ) → `double` Square root `sqrt(2.0)` → `1.414213562`

Function

Description

Example(s)

abs ( number ) → same type as input

Absolute value

abs(-17) → 17

debug ( number ) → same type as input

Prints the argument to stderr, and returns the argument.

debug(5432.1) → 5432.1

double ( number ) → double

Casts to double.

double(5432) → 5432.0

exp ( number ) → double

Exponential (e raised to the given power)

exp(1.0) → 2.718281828459045

greatest ( number [, ... ] ) → double if any argument is double, else integer

Selects the largest value among the arguments.

greatest(5, 4, 3, 2) → 5

hash ( value [, seed ] ) → integer

This is an alias for hash_murmur2.

hash(10, 5432) → -5817877081768721676

hash_fnv1a ( value [, seed ] ) → integer

Computes FNV-1a hash.

hash_fnv1a(10, 5432) → -7793829335365542153

hash_murmur2 ( value [, seed ] ) → integer

Computes MurmurHash2 hash.

hash_murmur2(10, 5432) → -5817877081768721676

int ( number ) → integer

Casts to integer.

int(5.4 + 3.8) → 9

least ( number [, ... ] ) → double if any argument is double, else integer

Selects the smallest value among the arguments.

least(5, 4, 3, 2.1) → 2.1

ln ( number ) → double

Natural logarithm

ln(2.718281828459045) → 1.0

mod ( integer, integer ) → integer

Modulo (remainder)

mod(54, 32) → 22

permute ( i, size [, seed ] ) → integer

Permuted value of i, in the range [0, size). This is the new position of i (modulo size) in a pseudorandom permutation of the integers 0...size-1, parameterized by seed, see below.

permute(0, 4) → an integer between 0 and 3

pi () → double

Approximate value of π

pi() → 3.14159265358979323846

pow ( x, y ) → double

power ( x, y ) → double

x raised to the power of y

pow(2.0, 10) → 1024.0

random ( lb, ub ) → integer

Computes a uniformly-distributed random integer in [lb, ub].

random(1, 10) → an integer between 1 and 10

random_exponential ( lb, ub, parameter ) → integer

Computes an exponentially-distributed random integer in [lb, ub], see below.

random_exponential(1, 10, 3.0) → an integer between 1 and 10

random_gaussian ( lb, ub, parameter ) → integer

Computes a Gaussian-distributed random integer in [lb, ub], see below.

random_gaussian(1, 10, 2.5) → an integer between 1 and 10

random_zipfian ( lb, ub, parameter ) → integer

Computes a Zipfian-distributed random integer in [lb, ub], see below.

random_zipfian(1, 10, 1.5) → an integer between 1 and 10

sqrt ( number ) → double

Square root

sqrt(2.0) → 1.414213562

The random function generates values using a uniform distribution, that is all the values are drawn within the specified range with equal probability. The random_exponential, random_gaussian and random_zipfian functions require an additional double parameter which determines the precise shape of the distribution.

For an exponential distribution, parameter controls the distribution by truncating a quickly-decreasing exponential distribution at parameter, and then projecting onto integers between the bounds. To be precise, with

f(x) = exp(-parameter * (x - min) / (max - min + 1)) / (1 - exp(-parameter))
Then value i between min and max inclusive is drawn with probability: f(i) - f(i + 1).
Intuitively, the larger the parameter, the more frequently values close to min are accessed, and the less frequently values close to max are accessed. The closer to 0 parameter is, the flatter (more uniform) the access distribution. A crude approximation of the distribution is that the most frequent 1% values in the range, close to min, are drawn parameter% of the time. The parameter value must be strictly positive.
For a Gaussian distribution, the interval is mapped onto a standard normal distribution (the classical bell-shaped Gaussian curve) truncated at -parameter on the left and +parameter on the right. Values in the middle of the interval are more likely to be drawn. To be precise, if PHI(x) is the cumulative distribution function of the standard normal distribution, with mean mu defined as (max + min) / 2.0, with

f(x) = PHI(2.0 * parameter * (x - mu) / (max - min + 1)) /
(2.0 * PHI(parameter) - 1)
then value i between min and max inclusive is drawn with probability: f(i + 0.5) - f(i - 0.5). Intuitively, the larger the parameter, the more frequently values close to the middle of the interval are drawn, and the less frequently values close to the min and max bounds. About 67% of values are drawn from the middle 1.0 / parameter, that is a relative 0.5 / parameter around the mean, and 95% in the middle 2.0 / parameter, that is a relative 1.0 / parameter around the mean; for instance, if parameter is 4.0, 67% of values are drawn from the middle quarter (1.0 / 4.0) of the interval (i.e., from 3.0 / 8.0 to 5.0 / 8.0) and 95% from the middle half (2.0 / 4.0) of the interval (second and third quartiles). The minimum allowed parameter value is 2.0.
random_zipfian generates a bounded Zipfian distribution. parameter defines how skewed the distribution is. The larger the parameter, the more frequently values closer to the beginning of the interval are drawn. The distribution is such that, assuming the range starts from 1, the ratio of the probability of drawing k versus drawing k+1 is ((k+1)/k)**parameter. For example, random_zipfian(1, ..., 2.5) produces the value 1 about (2/1)**2.5 = 5.66 times more frequently than 2, which itself is produced (3/2)**2.5 = 2.76 times more frequently than 3, and so on.
pgbench's implementation is based on "Non-Uniform Random Variate Generation", Luc Devroye, p. 550-551, Springer 1986. Due to limitations of that algorithm, the parameter value is restricted to the range [1.001, 1000].

Note

When designing a benchmark which selects rows non-uniformly, be aware that the rows chosen may be correlated with other data such as IDs from a sequence or the physical row ordering, which may skew performance measurements.

To avoid this, you may wish to use the permute function, or some other additional step with similar effect, to shuffle the selected rows and remove such correlations.

Hash functions hash, hash_murmur2 and hash_fnv1a accept an input value and an optional seed parameter. In case the seed isn't provided the value of :default_seed is used, which is initialized randomly unless set by the command-line -D option.

permute accepts an input value, a size, and an optional seed parameter. It generates a pseudorandom permutation of integers in the range [0, size), and returns the index of the input value in the permuted values. The permutation chosen is parameterized by the seed, which defaults to :default_seed, if not specified. Unlike the hash functions, permute ensures that there are no collisions or holes in the output values. Input values outside the interval are interpreted modulo the size. The function raises an error if the size is not positive. permute can be used to scatter the distribution of non-uniform random functions such as random_zipfian or random_exponential so that values drawn more often are not trivially correlated. For instance, the following pgbench script simulates a possible real world workload typical for social media and blogging platforms where a few accounts generate excessive load:

\set size 1000000
\set r random_zipfian(1, :size, 1.07)
\set k 1 + permute(:r, :size)

In some cases several distinct distributions are needed which don't correlate with each other and this is when the optional seed parameter comes in handy:

\set k1 1 + permute(:r, :size, :default_seed + 123)
\set k2 1 + permute(:r, :size, :default_seed + 321)

A similar behavior can also be approximated with hash:

\set size 1000000
\set r random_zipfian(1, 100 * :size, 1.07)
\set k 1 + abs(hash(:r)) % :size

However, since hash generates collisions, some values will not be reachable and others will be more frequent than expected from the original distribution.

As an example, the full definition of the built-in TPC-B-like transaction is:

\set aid random(1, 100000 * :scale)
\set bid random(1, 1 * :scale)
\set tid random(1, 10 * :scale)
\set delta random(-5000, 5000)
BEGIN;
UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
END;

This script allows each iteration of the transaction to reference different, randomly-chosen rows. (This example also shows why it's important for each client session to have its own variables — otherwise they'd not be independently touching different rows.)

Per-Transaction Logging

With the -l option (but without the --aggregate-interval option), pgbench writes information about each transaction to a log file. The log file will be named prefix.nnn, where prefix defaults to pgbench_log, and nnn is the PID of the pgbench process. The prefix can be changed by using the --log-prefix option. If the -j option is 2 or higher, so that there are multiple worker threads, each will have its own log file. The first worker will use the same name for its log file as in the standard single worker case. The additional log files for the other workers will be named prefix.nnn.mmm, where mmm is a sequential number for each worker starting with 1.

Each line in a log file describes one transaction. It contains the following space-separated fields:

client_id: identifies the client session that ran the transaction
transaction_no: counts how many transactions have been run by that session
time: transaction's elapsed time, in microseconds
script_no: identifies the script file that was used for the transaction (useful when multiple scripts are specified with -f or -b)
time_epoch: transaction's completion time, as a Unix-epoch time stamp
time_us: fractional-second part of transaction's completion time, in microseconds
schedule_lag: transaction start delay, that is the difference between the transaction's scheduled start time and the time it actually started, in microseconds (present only if --rate is specified)
retries: count of retries after serialization or deadlock errors during the transaction (present only if --max-tries is not equal to one)

When both --rate and --latency-limit are used, the time for a skipped transaction will be reported as skipped. If the transaction ends with a failure, its time will be reported as failed. If you use the --failures-detailed option, the time of the failed transaction will be reported as serialization or deadlock depending on the type of failure (see Failures and Serialization/Deadlock Retries for more information).

Here is a snippet of a log file generated in a single-client run:

0 199 2241 0 1175850568 995598
0 200 2465 0 1175850568 998079
0 201 2513 0 1175850569 608
0 202 2038 0 1175850569 2663

Another example with --rate=100 and --latency-limit=5 (note the additional schedule_lag column):

0 81 4621 0 1412881037 912698 3005
0 82 6173 0 1412881037 914578 4304
0 83 skipped 0 1412881037 914578 5217
0 83 skipped 0 1412881037 914578 5099
0 83 4722 0 1412881037 916203 3108
0 84 4142 0 1412881037 918023 2333
0 85 2465 0 1412881037 919759 740

In this example, transaction 82 was late, because its latency (6.173 ms) was over the 5 ms limit. The next two transactions were skipped, because they were already late before they were even started.

The following example shows a snippet of a log file with failures and retries, with the maximum number of tries set to 10 (note the additional retries column):

3 0 47423 0 1499414498 34501 3
3 1 8333 0 1499414498 42848 0
3 2 8358 0 1499414498 51219 0
4 0 72345 0 1499414498 59433 6
1 3 41718 0 1499414498 67879 4
1 4 8416 0 1499414498 76311 0
3 3 33235 0 1499414498 84469 3
0 0 failed 0 1499414498 84905 9
2 0 failed 0 1499414498 86248 9
3 4 8307 0 1499414498 92788 0

If the --failures-detailed option is used, the type of failure is reported in the time like this:

3 0 47423 0 1499414498 34501 3
3 1 8333 0 1499414498 42848 0
3 2 8358 0 1499414498 51219 0
4 0 72345 0 1499414498 59433 6
1 3 41718 0 1499414498 67879 4
1 4 8416 0 1499414498 76311 0
3 3 33235 0 1499414498 84469 3
0 0 serialization 0 1499414498 84905 9
2 0 serialization 0 1499414498 86248 9
3 4 8307 0 1499414498 92788 0

When running a long test on hardware that can handle a lot of transactions, the log files can become very large. The --sampling-rate option can be used to log only a random sample of transactions.

Aggregated Logging

With the --aggregate-interval option, a different format is used for the log files. Each log line describes one aggregation interval. It contains the following space-separated fields:

interval_start: start time of the interval, as a Unix-epoch time stamp
num_transactions: number of transactions within the interval
sum_latency: sum of transaction latencies
sum_latency_2: sum of squares of transaction latencies
min_latency: minimum transaction latency
max_latency: maximum transaction latency
sum_lag: sum of transaction start delays (zero unless --rate is specified)
sum_lag_2: sum of squares of transaction start delays (zero unless --rate is specified)
min_lag: minimum transaction start delay (zero unless --rate is specified)
max_lag: maximum transaction start delay (zero unless --rate is specified)
skipped: number of transactions skipped because they would have started too late (zero unless --rate and --latency-limit are specified)
retried: number of retried transactions (zero unless --max-tries is not equal to one)
retries: number of retries after serialization or deadlock errors (zero unless --max-tries is not equal to one)
serialization_failures: number of transactions that got a serialization error and were not retried afterwards (zero unless --failures-detailed is specified)
deadlock_failures: number of transactions that got a deadlock error and were not retried afterwards (zero unless --failures-detailed is specified)

Here is some example output generated with this option:

pgbench --aggregate-interval=10 --time=20 --client=10 --log --rate=1000 --latency-limit=10 --failures-detailed --max-tries=10 test

1650260552 5178 26171317 177284491527 1136 44462 2647617 7321113867 0 9866 64 7564 28340 4148 0
1650260562 4808 25573984 220121792172 1171 62083 3037380 9666800914 0 9998 598 7392 26621 4527 0

Notice that while the plain (unaggregated) log format shows which script was used for each transaction, the aggregated format does not. Therefore if you need per-script data, you need to aggregate the data on your own.

Per-Statement Report

With the -r option, pgbench collects the following statistics for each statement:

latency — elapsed transaction time for each statement. pgbench reports an average value of all successful runs of the statement.
The number of failures in this statement. See Failures and Serialization/Deadlock Retries for more information.
The number of retries after a serialization or a deadlock error in this statement. See Failures and Serialization/Deadlock Retries for more information.

The report displays retry statistics only if the --max-tries option is not equal to 1.

All values are computed for each statement executed by every client and are reported after the benchmark has finished.

For the default script, the output will look similar to this:

starting vacuum...end.
transaction type: <builtin: TPC-B (sort of)>
scaling factor: 1
query mode: simple
number of clients: 10
number of threads: 1
maximum number of tries: 1
number of transactions per client: 1000
number of transactions actually processed: 10000/10000
number of failed transactions: 0 (0.000%)
number of transactions above the 50.0 ms latency limit: 1311/10000 (13.110 %)
latency average = 28.488 ms
latency stddev = 21.009 ms
initial connection time = 69.068 ms
tps = 346.224794 (without initial connection time)
statement latencies in milliseconds and failures:
   0.012  0  \set aid random(1, 100000 * :scale)
   0.002  0  \set bid random(1, 1 * :scale)
   0.002  0  \set tid random(1, 10 * :scale)
   0.002  0  \set delta random(-5000, 5000)
   0.319  0  BEGIN;
   0.834  0  UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
   0.641  0  SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
  11.126  0  UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
  12.961  0  UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
   0.634  0  INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
   1.957  0  END;

Another example of output for the default script using serializable default transaction isolation level (PGOPTIONS='-c default_transaction_isolation=serializable' pgbench ...):

starting vacuum...end.
transaction type: <builtin: TPC-B (sort of)>
scaling factor: 1
query mode: simple
number of clients: 10
number of threads: 1
maximum number of tries: 10
number of transactions per client: 1000
number of transactions actually processed: 6317/10000
number of failed transactions: 3683 (36.830%)
number of transactions retried: 7667 (76.670%)
total number of retries: 45339
number of transactions above the 50.0 ms latency limit: 106/6317 (1.678 %)
latency average = 17.016 ms
latency stddev = 13.283 ms
initial connection time = 45.017 ms
tps = 186.792667 (without initial connection time)
statement latencies in milliseconds, failures and retries:
  0.006     0      0  \set aid random(1, 100000 * :scale)
  0.001     0      0  \set bid random(1, 1 * :scale)
  0.001     0      0  \set tid random(1, 10 * :scale)
  0.001     0      0  \set delta random(-5000, 5000)
  0.385     0      0  BEGIN;
  0.773     0      1  UPDATE pgbench_accounts SET abalance = abalance + :delta WHERE aid = :aid;
  0.624     0      0  SELECT abalance FROM pgbench_accounts WHERE aid = :aid;
  1.098   320   3762  UPDATE pgbench_tellers SET tbalance = tbalance + :delta WHERE tid = :tid;
  0.582  3363  41576  UPDATE pgbench_branches SET bbalance = bbalance + :delta WHERE bid = :bid;
  0.465     0      0  INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (:tid, :bid, :aid, :delta, CURRENT_TIMESTAMP);
  1.933     0      0  END;

If multiple script files are specified, all statistics are reported separately for each script file.

Note that collecting the additional timing information needed for per-statement latency computation adds some overhead. This will slow average execution speed and lower the computed TPS. The amount of slowdown varies significantly depending on platform and hardware. Comparing average TPS values with and without latency reporting enabled is a good way to measure if the timing overhead is significant.

Failures and Serialization/Deadlock Retries

When executing pgbench, there are three main types of errors:

Errors of the main program. They are the most serious and always result in an immediate exit from pgbench with the corresponding error message. They include:
- errors at the beginning of pgbench (e.g. an invalid option value);
- errors in the initialization mode (e.g. the query to create tables for built-in scripts fails);
- errors before starting threads (e.g. could not connect to the database server, syntax error in the meta command, thread creation failure);
- internal pgbench errors (which are supposed to never occur...).
Errors when the thread manages its clients (e.g. the client could not start a connection to the database server / the socket for connecting the client to the database server has become invalid). In such cases all clients of this thread stop while other threads continue to work. However, --exit-on-abort is specified, all of the threads stop immediately in this case.
Direct client errors. They lead to immediate exit from pgbench with the corresponding error message in the case of an internal pgbench error (which are supposed to never occur...) or when --exit-on-abort is specified. Otherwise in the worst case they only lead to the abortion of the failed client while other clients continue their run (but some client errors are handled without an abortion of the client and reported separately, see below). Later in this section it is assumed that the discussed errors are only the direct client errors and they are not internal pgbench errors.

A client's run is aborted in case of a serious error; for example, the connection with the database server was lost or the end of script was reached without completing the last transaction. In addition, if execution of an SQL or meta command fails for reasons other than serialization or deadlock errors, the client is aborted. Otherwise, if an SQL command fails with serialization or deadlock errors, the client is not aborted. In such cases, the current transaction is rolled back, which also includes setting the client variables as they were before the run of this transaction (it is assumed that one transaction script contains only one transaction; see What Is the "Transaction" Actually Performed in pgbench? for more information). Transactions with serialization or deadlock errors are repeated after rollbacks until they complete successfully or reach the maximum number of tries (specified by the --max-tries option) / the maximum time of retries (specified by the --latency-limit option) / the end of benchmark (specified by the --time option). If the last trial run fails, this transaction will be reported as failed but the client is not aborted and continues to work.

Note

Without specifying the --max-tries option, a transaction will never be retried after a serialization or deadlock error because its default value is 1. Use an unlimited number of tries (--max-tries=0) and the --latency-limit option to limit only the maximum time of tries. You can also use the --time option to limit the benchmark duration under an unlimited number of tries.

Be careful when repeating scripts that contain multiple transactions: the script is always retried completely, so successful transactions can be performed several times.

Be careful when repeating transactions with shell commands. Unlike the results of SQL commands, the results of shell commands are not rolled back, except for the variable value of the \setshell command.

The latency of a successful transaction includes the entire time of transaction execution with rollbacks and retries. The latency is measured only for successful transactions and commands but not for failed transactions or commands.

The main report contains the number of failed transactions. If the --max-tries option is not equal to 1, the main report also contains statistics related to retries: the total number of retried transactions and total number of retries. The per-script report inherits all these fields from the main report. The per-statement report displays retry statistics only if the --max-tries option is not equal to 1.

If you want to group failures by basic types in per-transaction and aggregation logs, as well as in the main and per-script reports, use the --failures-detailed option. If you also want to distinguish all errors and failures (errors without retrying) by type including which limit for retries was exceeded and how much it was exceeded by for the serialization/deadlock failures, use the --verbose-errors option.

Table Access Methods

You may specify the Table Access Method for the pgbench tables. The environment variable PGOPTIONS specifies database configuration options that are passed to PostgreSQL via the command line (See Section 19.1.4). For example, a hypothetical default Table Access Method for the tables that pgbench creates called wuzza can be specified with:

PGOPTIONS='-c default_table_access_method=wuzza'

Good Practices

It is very easy to use pgbench to produce completely meaningless numbers. Here are some guidelines to help you get useful results.

In the first place, never believe any test that runs for only a few seconds. Use the -t or -T option to make the run last at least a few minutes, so as to average out noise. In some cases you could need hours to get numbers that are reproducible. It's a good idea to try the test run a few times, to find out if your numbers are reproducible or not.

For the default TPC-B-like test scenario, the initialization scale factor (-s) should be at least as large as the largest number of clients you intend to test (-c); else you'll mostly be measuring update contention. There are only -s rows in the pgbench_branches table, and every transaction wants to update one of them, so -c values in excess of -s will undoubtedly result in lots of transactions blocked waiting for other transactions.

The default test scenario is also quite sensitive to how long it's been since the tables were initialized: accumulation of dead rows and dead space in the tables changes the results. To understand the results you must keep track of the total number of updates and when vacuuming happens. If autovacuum is enabled it can result in unpredictable changes in measured performance.

A limitation of pgbench is that it can itself become the bottleneck when trying to test a large number of client sessions. This can be alleviated by running pgbench on a different machine from the database server, although low network latency will be essential. It might even be useful to run several pgbench instances concurrently, on several client machines, against the same database server.

Security

If untrusted users have access to a database that has not adopted a secure schema usage pattern, do not run pgbench in that database. pgbench uses unqualified names and does not manipulate the search path.

Prev	Up	Next
pg_basebackup	Home	pg_combinebackup