PostgreSQL
181716
RUENRU EN
17.3. Сборка и установка с использованием Autoconf и Make
Пред. НаверхГлава 17. Установка из исходного кодаНачало След.

17.3. Сборка и установка с использованием Autoconf и Make #

17.3.1. Краткий вариант
17.3.2. Процедура установки
17.3.3. Параметры configure
17.3.4. Переменные окружения для configure

17.3.1. Краткий вариант #

./configure
make
su
make install
adduser postgres
mkdir -p /usr/local/pgsql/data
chown postgres /usr/local/pgsql/data
su - postgres
/usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data
/usr/local/pgsql/bin/pg_ctl -D /usr/local/pgsql/data -l logfile start
/usr/local/pgsql/bin/createdb test
/usr/local/pgsql/bin/psql test

Развёрнутый вариант представлен в продолжении этого раздела.

17.3.2. Процедура установки #

  1. Конфигурирование

    На первом шаге установки требуется сконфигурировать дерево установки для вашей системы и выбрать желаемые параметры сборки. Для этого нужно запустить скрипт configure. Чтобы выполнить стандартную сборку, просто введите: 

    ./configure

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

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

    mkdir build_dir
cd build_dir
/путь/к/каталогу/исходного/кода/configure [параметры]
make

    В стандартной конфигурации собираются сервер и утилиты, а также клиентские приложения и интерфейсы, которым требуется только компилятор C. Все файлы по умолчанию устанавливаются в /usr/local/pgsql.

    Вы можете настроить процесс сборки и установки, передав configure один или несколько следующих параметров командной строки. Обычно настраивается место установки или набор дополнительных возможностей, включаемых при сборке. Скрипт configure принимает большое количество параметров, которые описаны в Подразделе 17.3.3.

    Кроме того, configure воспринимает ряд переменных окружения, описанных в Подраздел 17.3.4. Они дают возможность дополнительно настроить конфигурацию.

  2. Сборка

    Чтобы запустить сборку, введите одну из двух команд: 

    make
make all

    (Помните, что нужно использовать GNU make.) Сборка займёт несколько минут, в зависимости от мощности вашего компьютера.

    Если вы хотите собрать всё, что может быть собрано, включая документацию (страницы HTML и man) и дополнительные модули (contrib), введите: 

    make world

    Если вы хотите собрать всё, что может быть собрано, включая дополнительные модули (contrib), но без документации, введите: 

    make world-bin

    Если вы хотите вызывать сборку из другого сборочного файла, а не вручную, вы должны сбросить переменную MAKELEVEL или присвоить ей 0, например так: 

    build-postgresql:
        $(MAKE) -C postgresql MAKELEVEL=0 all

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

  3. Регрессионные тесты

    Если вы хотите протестировать только что собранный сервер, прежде чем устанавливать его, на этом этапе вы можете запустить регрессионные тесты. Регрессионные тесты — это пакет тестов, проверяющих, что PostgreSQL работает на вашем компьютере так, как задумано разработчиками. Введите: 

    make check

    (Это должен выполнять обычный пользователь, не root.) Как интерпретировать результаты проверки, подробно описывается в Главе 33. Вы можете повторить эту проверку позже в любой момент, выполнив ту же команду.

  4. Установка файлов

    Примечание

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

    Чтобы установить PostgreSQL, введите: 

    make install

    При этом файлы будут установлены в каталоги, заданные в Шаг 1. Убедитесь в том, что у вас есть соответствующие разрешения для записи туда. Обычно это действие нужно выполнять от имени root. Также возможно заранее создать целевые каталоги и дать требуемый доступ к ним.

    Чтобы установить документацию (HTML и страницы man), введите: 

    make install-docs

    Если вы собирали цель world, введите вместо этого: 

    make install-world

    При этом также будет установлена документация.

    Если вы собирали цель world без документации, введите вместо этого: 

    make install-world-bin

    Вы можете запустить make install-strip вместо make install, чтобы убрать лишнее из устанавливаемых исполняемых файлов и библиотек. Это позволит сэкономить немного места. Если вы выполняете сборку для отладки, при этом фактически вырежется поддержка отладки, поэтому этот вариант подходит только если отладка больше не планируется. Процедура install-strip пытается оптимизировать объём разумными способами, но не рассчитывайте, что она способна удалить каждый ненужный байт из исполняемого файла. Если вы хотите освободить как можно больше места, вам придётся проделать это вручную.

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

    Установка только клиентской части: Если вы хотите установить только клиентские приложения и интерфейсные библиотеки, можно выполнить эти команды: 

    make -C src/bin install
make -C src/include install
make -C src/interfaces install
make -C doc install

    В src/bin есть несколько программ, применимых только на сервере, но они очень малы.

Удаление: Чтобы отменить установку, воспользуйтесь командой make uninstall. Однако созданные каталоги при этом удалены не будут.

Очистка: После установки вы можете освободить место на диске, удалив файлы сборки из дерева исходного кода, выполнив make clean. При этом файлы, созданные программой configure, будут сохранены, так что позже вы сможете пересобрать всё заново, выполнив make. Чтобы сбросить дерево исходного кода к состоянию, в котором оно распространяется, выполните make distclean. Если вы намерены выполнять сборку одного дерева исходного кода для нескольких платформ, вам придётся делать это и переконфигурировать сборочную среду для каждой. (Также можно использовать отдельное дерево сборки для каждой платформы, чтобы дерево исходного кода оставалось неизменным.)

Если в процессе сборки вы обнаружите, что заданные вами параметры configure оказались ошибочными, либо вы изменили что-то, от чего зависит работа configure (например, обновили пакеты), стоит выполнить make distclean, прежде чем переконфигурировать и пересобирать всё заново. Если этого не сделать, ваши изменения в конфигурации могут распространиться не везде, где они важны.

17.3.3. Параметры configure #

Параметры командной строки configure описываются ниже. Этот список не является исчерпывающим (который можно получить, вызвав ./configure --help). Неописанные здесь параметры предназначены для особых случаев, например для кросс-компиляции, и освещаются в стандартной документации Autoconf.

17.3.3.1. Место установки #

Эти параметры определяют, куда make install будет устанавливать файлы. В большинстве случаев для определения целевого расположения достаточно параметра --prefix. Если же у вас есть особые требования, вы можете установить разные целевые подкаталоги, воспользовавшись другими описанными здесь параметрами. Однако имейте в виду, что при изменении относительного расположения разных подкаталогов ваша инсталляция может оказаться неперемещаемой, то есть её нельзя будет перенести в другое место после развёртывания. (Это ограничение не касается расположения подкаталогов man и doc.) Для получения перемещаемой инсталляции может потребоваться параметр --disable-rpath, описанный далее.

--prefix=ПРЕФИКС #

Разместить все файлы внутри каталога ПРЕФИКС, а не в /usr/local/pgsql. Собственно файлы будут установлены в различные подкаталоги этого каталога; в самом каталоге ПРЕФИКС никакие файлы не размещаются.

--exec-prefix=ИСП-ПРЕФИКС #

Вы можете установить архитектурно-зависимые файлы в размещение с другим префиксом, ИСП-ПРЕФИКС, отличным от ПРЕФИКС. Это бывает полезно для совместного использования таких файлов несколькими системами. По умолчанию ИСП-ПРЕФИКС считается равным ПРЕФИКС и все файлы, архитектурно-зависимые и независимые, устанавливаются в одно дерево каталогов, что вам скорее всего и нужно.

--bindir=КАТАЛОГ #

Задаёт каталог для исполняемых двоичных программ. По умолчанию это ИСП-ПРЕФИКС/bin, что обычно означает /usr/local/pgsql/bin.

--sysconfdir=КАТАЛОГ #

Задаёт каталог для различных файлов конфигурации, ПРЕФИКС/etc по умолчанию.

--libdir=КАТАЛОГ #

Задаёт каталог для установки библиотек и динамически загружаемых модулей. Значение по умолчанию — ИСП-ПРЕФИКС/lib.

--includedir=КАТАЛОГ #

Задаёт каталог для установки заголовочных файлов C и C++. Значение по умолчанию — ПРЕФИКС/include.

--datarootdir=КАТАЛОГ #

Задаёт корневой каталог для разного рода статических файлов. Этот параметр определяет только базу для некоторых из следующих параметров. Значение по умолчанию — ПРЕФИКС/share.

--datadir=КАТАЛОГ #

Задаёт каталог для статических файлов данных, используемых установленными программами. Значение по умолчанию — DATAROOTDIR. Заметьте, что это совсем не тот каталог, в котором будут размещены файлы базы данных.

--localedir=КАТАЛОГ #

Задаёт каталог для установки данных локализации, в частности, каталогов перевода сообщений. Значение по умолчанию — DATAROOTDIR/locale.

--mandir=КАТАЛОГ #

Страницы man, поставляемые в составе PostgreSQL, будут установлены в этот каталог, в соответствующие подкаталоги manx. Значение по умолчанию — DATAROOTDIR/man.

--docdir=КАТАЛОГ #

Задаёт корневой каталог для установки файлов документации, кроме страниц «man». Этот параметр только определяет базу для следующих параметров. Значение по умолчанию — DATAROOTDIR/doc/postgresql.

--htmldir=КАТАЛОГ #

В этот каталог будет помещена документация PostgreSQL в формате HTML. Значение по умолчанию — DATAROOTDIR.

Примечание

Чтобы PostgreSQL можно было установить в стандартные системные размещения (например, в /usr/local/include), не затрагивая пространство имён остальной системы, приняты определённые меры. Во-первых, к путям datadir, sysconfdir и docdir автоматически добавляется строка «/postgresql», если только полный развёрнутый путь каталога уже не содержит строку «postgres» или «pgsql». Так, если вы выберете в качестве префикса /usr/local, документация будет установлена в /usr/local/doc/postgresql, но с префиксом /opt/postgres она будет помещена в /opt/postgres/doc. Внешние заголовочные файлы C для клиентских интерфейсов устанавливаются в includedir, не загрязняя пространство имён. Внутренние и серверные заголовочные файлы устанавливаются в частные подкаталоги внутри includedir. Чтобы узнать, как обращаться к заголовочным файлам того или иного интерфейса, обратитесь к документации этого интерфейса. Наконец, для динамически загружаемых модулей, если требуется, будет также создан частный подкаталог внутри libdir.

17.3.3.2. Функциональность PostgreSQL #

В этом разделе описаны параметры, включающую различную функциональность PostgreSQL, которая по умолчанию не собирается. Многие из этих компонентов не собираются по умолчанию, потому что требуют дополнительного программного обеспечения, о чём говорится в Разделе 17.1.

--enable-nls[=ЯЗЫКИ] #

Включает поддержку национальных языков (NLS, Native Language Support), то есть возможность выводить сообщения программы не только на английском языке. Значение ЯЗЫКИ представляет необязательный список кодов языков через пробел, поддержка которых вам нужна, например: --enable-nls='de fr ru'. (Пересечение заданного вами списка и множества действительно доступных переводов будет вычислено автоматически.) Если список не задаётся, устанавливаются все доступные переводы.

Для использования этой возможности вам потребуется реализация API Gettext.

--with-perl #

Включает поддержку языка PL/Perl на стороне сервера.

--with-python #

Включает поддержку языка PL/Python на стороне сервера.

--with-tcl #

Включает поддержку языка PL/Tcl на стороне сервера.

--with-tclconfig=КАТАЛОГ #

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

--with-llvm #

Включает поддержку JIT-компиляции (см. Главу 32) на базе LLVM. Для этого должна быть установлена библиотека LLVM. В настоящее время требуется версия LLVM не ниже 3.9.

Программа llvm-config будет использоваться для выяснения требуемых параметров компиляции. Поиск её будет выполняться в заданных путях PATH по имени llvm-config, а затем llvm-config-$major-$minor для всех поддерживаемых версий. Если нужную программу найти таким образом не удастся, воспользуйтесь переменной LLVM_CONFIG и укажите путь к корректному llvm-config. Например: 

./configure ... --with-llvm LLVM_CONFIG='/path/to/llvm/bin/llvm-config'

Для поддержки LLVM требуется совместимый компилятор clang (указываемый, если это требуется, в переменной окружения CLANG) и работающий компилятор C++ (указываемый, если требуется, в переменной окружения CXX).

--with-lz4 #

Собрать с поддержкой сжатия LZ4.

--with-zstd #

Собрать с поддержкой сжатия Zstandard.

--with-ssl=БИБЛИОТЕКА #

Включает поддержку соединений SSL (зашифрованных). Единственной поддерживаемой БИБЛИОТЕКОЙ является openssl. Для такой сборки необходимо установить пакет OpenSSL. Скрипт configure проверит наличие необходимых заголовочных файлов и библиотек, чтобы убедиться в целостности инсталляции OpenSSL до начала сборки.

--with-openssl #

Устаревший вариант указания --with-ssl=openssl.

--with-gssapi #

Включает поддержку аутентификации GSSAPI. Для GSSAPI необходимо установить MIT Kerberos. На многих платформах подсистема GSSAPI (входящая в состав MIT Kerberos) устанавливается не в то размещение, которое просматривается по умолчанию (например, /usr/include, /usr/lib), так что помимо этого параметра вам придётся задать параметры --with-includes и --with-libraries. Скрипт configure проверит наличие необходимых заголовочных файлов и библиотек, чтобы убедиться в целостности инсталляции GSSAPI, прежде чем продолжить.

--with-ldap #

Включает поддержку LDAP для проверки подлинности и получения параметров соединения (за дополнительными сведениями обратитесь к Разделу 34.18 и Разделу 21.10). В Unix для этого нужно установить пакет OpenLDAP. В Windows используется стандартная библиотека WinLDAP. Скрипт configure проверит наличие необходимых заголовочных файлов и библиотек, чтобы убедиться в целостности инсталляции OpenLDAP, прежде чем продолжить.

--with-pam #

Включает поддержку PAM (Pluggable Authentication Modules, подключаемых модулей аутентификации).

--with-bsd-auth #

Включает поддержку аутентификации BSD. (Инфраструктура аутентификации BSD в настоящее время доступна только в OpenBSD.)

--with-systemd #

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

--with-bonjour #

Включает поддержку Bonjour, протокола автоматического обнаружения служб. Для этого Bonjour должен поддерживаться самой операционной системой. Рекомендуется для macOS.

--with-uuid=БИБЛИОТЕКА #

Собрать модуль uuid-ossp (предоставляющий функции для генерирования UUID), используя заданную библиотеку UUID. БИБЛИОТЕКА может быть следующей:

  • bsd, чтобы использовались функции получения UUID, имеющиеся во FreeBSD и некоторых других системах на базе BSD

  • e2fs, чтобы использовалась библиотека получения UUID, созданная в рамках проекта e2fsprogs; эта библиотека присутствует в большинстве систем Linux и macOS, также её можно найти и для других платформ.

  • ossp, чтобы использовалась библиотека OSSP UUID

--with-ossp-uuid #

Устаревший вариант указания --with-uuid=ossp.

--with-libxml #

Собрать с libxml2, включая тем самым поддержку SQL/XML. Для этого требуется libxml версии 2.6.23 или новее.

Для определения нужных параметров компиляции и компоновки PostgreSQL обратится к pkg-config, если эта программа установлена, и запросит у неё информацию о libxml2. В противном случае будет вызвана программа xml2-config, входящая в состав libxml2. Вариант с pkg-config предпочтительнее, так как он лучше работает в конфигурации сборки для разных архитектур.

Для использования libxml2 в нестандартном размещении вы можете задать переменные окружения для pkg-config (см. документацию pkg-config) или указать в переменной окружения XML2_CONFIG путь к программе xml2-config, относящейся к нужной инсталляции libxml2, либо задать непосредственно переменные XML2_CFLAGS и XML2_LIBS. (Если программа pkg-config установлена, переопределить предоставляемую ей информацию о нахождении libxml2 можно, установив переменную XML2_CONFIG или присвоив непустые значения обеим переменным XML2_CFLAGS и XML2_LIBS.)

--with-libxslt #

Собрать с libxslt, включая тем самым возможность выполнять XSL-преобразования XML-документов в модуле xml2. Для этого также должен быть указан ключ --with-libxml.

17.3.3.3. Отключение функциональности #

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

--without-icu #

Отключает поддержку библиотеки ICU, что отключает возможность использовать правила сортировки ICU (см. Раздел 24.2).

--without-readline #

Запрещает использование библиотеки Readline (а также libedit). При этом отключается редактирование командной строки и история в psql.

--with-libedit-preferred #

Отдаёт предпочтение библиотеке libedit с лицензией BSD, а не Readline (GPL). Этот параметр имеет значение, только если установлены обе библиотеки; по умолчанию в этом случае используется Readline.

--without-zlib #

Запрещает использование библиотеки Zlib. При этом отключается поддержка сжатых архивов утилитами pg_dump и pg_restore.

--disable-spinlocks #

Позволяет провести сборку, если PostgreSQL не может воспользоваться циклическими блокировками CPU на данной платформе. Отсутствие таких блокировок приводит к кардинальному снижению производительности, поэтому использовать этот вариант следует, только если сборка прерывается и выдаётся сообщение, что ваша платформа эти блокировки не поддерживает. Если вы не можете собрать PostgreSQL на вашей платформе без этого указания, сообщите о данной проблеме разработчикам PostgreSQL.

--disable-atomics #

Отключает использование атомарных операций процессора. На архитектурах, где такие операции отсутствуют, этот параметр никак не действует. Там же, где они поддерживаются, отказ от их использования приведёт к падению производительности. Этот параметр полезен только для отладки и для сравнительной оценки быстродействия.

--disable-thread-safety #

Отключает потокобезопасное поведение клиентских библиотек. При этом параллельные потоки программ на базе libpq и ECPG не будут безопасно контролировать собственные дескрипторы соединений. Используйте это только на тех платформах, где отсутствует полноценная поддержка потоков.

17.3.3.4. Особенности процесса сборки #

--with-includes=КАТАЛОГИ #

Значение КАТАЛОГИ представляет список каталогов через двоеточие, которые будут просмотрены компилятором при поиске заголовочных файлов. Если дополнительные пакеты (например, GNU Readline) установлены у вас в нестандартное расположение, вам придётся использовать этот параметр и, возможно, также добавить соответствующий параметр --with-libraries.

Пример: --with-includes=/opt/gnu/include:/usr/sup/include.

--with-libraries=КАТАЛОГИ #

Значение КАТАЛОГИ представляет список каталогов через двоеточие, в котором следует искать библиотеки. Возможно, вам потребуется использовать этот параметр (и соответствующий --with-includes), если какие-то пакеты установлены у вас в нестандартное размещение.

Пример: --with-libraries=/opt/gnu/lib:/usr/sup/lib.

--with-system-tzdata=КАТАЛОГ #

В PostgreSQL включена собственная база данных часовых поясов, необходимая для операций с датой и временем. На самом деле эта база данных совместима с базой часовых поясов IANA, поставляемой в составе многих операционных систем FreeBSD, Linux, Solaris, поэтому устанавливать её дополнительно может быть излишне. С этим параметром вместо базы данных, включённой в пакет исходного кода PostgreSQL, будет использоваться системная база данных часовых поясов, находящаяся в заданном КАТАЛОГЕ. КАТАЛОГ должен задаваться абсолютным путём (в ряде операционных систем принят путь /usr/share/zoneinfo). Заметьте, что процедура установки не будет проверять несоответствия или ошибки в данных часовых поясов. Поэтому, используя этот параметр, рекомендуется выполнить регрессионные тесты, чтобы убедиться, что выбранная вами база данных часовых поясов работает корректно с PostgreSQL.

Этот параметр в основном предназначен для тех, кто собирает двоичные пакеты для дистрибутивов и хорошо знает свою операционную систему. Основной плюс от использования системных данных в том, что пакет PostgreSQL не придётся обновлять при изменениях местных определений часовых поясов. Ещё один плюс заключается в упрощении кросс-компиляции, так как при инсталляции не требуется собирать базу данных часовых поясов.

--with-extra-version=СТРОКА #

Заданная СТРОКА добавляется к номеру версии PostgreSQL. Это можно использовать, например, чтобы двоичные файлы, собранные из промежуточных снимков Git или кода с дополнительными правками, отличались от стандартных дополнительной строкой в версии, например, содержащей идентификатор git describe или номер выпуска дистрибутивного пакета.

--disable-rpath #

Не добавлять в исполняемые файлы PostgreSQL атрибут, с которым они будут искать разделяемые библиотеки в каталоге библиотек инсталляции (см. --libdir). На большинстве платформ этот атрибут задаёт абсолютный путь к каталогу библиотек, поэтому этот вариант не подходит, если вы намерены перемещать готовую инсталляцию. Однако вам в любом случае нужно каким-то образом указать, где исполняемые файлы могут найти разделяемые библиотеки. Обычно для этого нужно настроить механизм динамического связывания в операционной системе, указав нужный каталог библиотек; за подробностями обратитесь к Подразделу 17.5.1.

17.3.3.5. Разное #

Из следующих параметров чаще всего применяется, особенно в тестовых сборках, параметр --with-pgport, позволяющий изменить номер порта по умолчанию. Другие описанные в этом разделе параметры рекомендуется использовать только опытным пользователям.

--with-pgport=НОМЕР #

Задаёт НОМЕР порта по умолчанию для сервера и клиентов. Стандартное значение — 5432. Этот порт всегда можно изменить позже, но если вы укажете другой номер здесь, и сервер, и клиенты будут скомпилированы с одним значением, что очень удобно. Обычно менять это значение имеет смысл, только если вы намерены запускать в одной системе несколько серверов PostgreSQL.

--with-krb-srvnam=ИМЯ #

Задаёт имя по умолчанию для субъекта-службы Kerberos, используемое GSSAPI (по умолчанию это postgres). Обычно менять его имеет смысл только в сборке для среды Windows, где оно должно быть задано в верхнем регистре (POSTGRES).

--with-segsize=РАЗМЕР_СЕГМЕНТА #

Задаёт размер сегмента (в гигабайтах). Сервер делит большие таблицы на несколько файлов в файловой системе, ограничивая размер каждого данным размером сегмента. Это позволяет обойти ограничения на размер файлов, существующие на многих платформах. Размер сегмента по умолчанию, 1 гигабайт, безопасен для всех поддерживаемых платформ. Если же ваша операционная система поддерживает «большие файлы» (а сегодня это поддерживают почти все), вы можете установить больший размер сегмента. Это позволит уменьшить число файловых дескрипторов, используемых при работе с очень большими таблицами. Но будьте осторожны, чтобы выбранное значение не превысило максимум, поддерживаемый вашей платформой и файловыми системами, которые вы будете применять. Возможно, допустимый размер файла будет ограничиваться и другими утилитами, которые вы захотите использовать, например tar. Рекомендуется, хотя и не требуется, чтобы это значение было степенью 2. Заметьте, что с изменением этого значения нарушается совместимость формата базы на диске, то есть вы не сможете использовать pg_upgrade для перехода к сборке с другим размером сегмента.

--with-blocksize=РАЗМЕР_БЛОКА #

Задаёт размер блока (в килобайтах). Эта величина будет единицей хранения и ввода-вывода данных таблиц. Значение по умолчанию, 8 килобайт, достаточно универсально; но в особых случаях может быть оправдан другой размер блока. Это значение должно быть степенью 2 от 1 до 32 (в килобайтах). Заметьте, что с изменением этого значения нарушается совместимость формата базы на диске, то есть вы не сможете использовать pg_upgrade для перехода к сборке с другим размером блока.

--with-wal-blocksize=РАЗМЕР_БЛОКА #

Задаёт размер блока WAL (в килобайтах) Эта величина будет единицей хранения и ввода-вывода записей WAL. Значение по умолчанию, 8 килобайт, достаточно универсально; но в особых случаях может быть оправдан другой размер блока. Это значение должно быть степенью 2 от 1 до 64 (в килобайтах). Заметьте, что с изменением этого значения нарушается совместимость формата базы на диске, то есть вы не сможете использовать pg_upgrade для перехода к сборке с другим размером блока WAL.

17.3.3.6. Параметры для разработчиков #

Большинство параметров в этом разделе имеют ценность только для разработки или отладки PostgreSQL. Использовать их в производственных сборках не рекомендуется, кроме, возможно, ключа --enable-debug, позволяющего получить подробную информацию об ошибке, в случае, если вы столкнётесь с проблемой. На платформах, поддерживающих DTrace, также может иметь смысл использовать для производственной сборки --enable-dtrace.

При сборке инсталляции, которая будет использоваться для отладки внутреннего кода сервера, рекомендуется как минимум использовать параметры --enable-debug и --enable-cassert.

--enable-debug #

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

--enable-cassert #

Включает для сервера проверочные утверждения, проверяющие множество условий, которые «не должны происходить». Это бесценно в процессе разработки кода, но эти проверки могут значительно замедлить работу сервера. Кроме того, включение этих проверок не обязательно увеличит стабильность вашего сервера! Проверочные утверждения не категоризируются по важности, поэтому относительно безвредная ошибка может привести к перезапуску сервера, если утверждение не выполнится. Применять это следует, только если вы занимаетесь разработкой или испытываете бета-версию, но не в производственной среде.

--enable-tap-tests #

Включает тесты по технологии Perl TAP. Для этого у вас должен быть установлен Perl и модуль IPC::Run. За дополнительными сведениями обратитесь к Разделу 33.4.

--enable-depend #

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

--enable-coverage #

При использовании GCC все программы и библиотеки компилируются с инструментарием, оценивающим покрытие кода тестами. Если его запустить, в каталоге сборки будут сформированы файлы с метриками покрытия кода. За дополнительными сведениями обратитесь к Разделу 33.5. Этот параметр предназначен только для GCC и только для использования в процессе разработки.

--enable-profiling #

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

--enable-dtrace #

Включает при компиляции PostgreSQL поддержку средства динамической трассировки DTrace. За дополнительными сведениями обратитесь к Разделу 28.5.

Задать расположение программы dtrace можно в переменной окружения DTRACE. Часто это необходимо, потому что dtrace обычно устанавливается в каталог /usr/sbin, который может отсутствовать в PATH.

Дополнительные параметры командной строки для dtrace можно задать в переменной окружения DTRACEFLAGS. В Solaris, чтобы включить поддержку DTrace для 64-битной сборки, необходимо передать параметр DTRACEFLAGS="-64". Например, с компилятором GCC: 

./configure CC='gcc -m64' --enable-dtrace DTRACEFLAGS='-64' ...

С компилятором Sun: 

./configure CC='/opt/SUNWspro/bin/cc -xtarget=native64' --enable-dtrace DTRACEFLAGS='-64' ...
--with-segsize-blocks=SEGSIZE_BLOCKS #

Указывает размер сегмента отношения в блоках. Если указан и данный параметр, и --with-segsize, применяется данный параметр. Он предназначен только для разработчиков и позволяет тестировать код, связанный с сегментом.

17.3.4. Переменные окружения для configure #

Помимо описанных выше обычных парамеров командной строки скрипт configure воспринимает ряд переменных окружения. Эти переменные можно задать в командной строке configure, например так: 

./configure CC=/opt/bin/gcc CFLAGS='-O2 -pipe'

При таком указании переменная окружения несколько отличается от параметра командной строки. Также можно задать переменные окружения предварительно: 

export CC=/opt/bin/gcc
export CFLAGS='-O2 -pipe'
./configure

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

Из описанных здесь переменных окружения чаще всего используются CC и CFLAGS. Если вы предпочитаете компилятор C, отличный от выбираемого скриптом configure, укажите его в переменной CC. По умолчанию configure выбирает gcc (если он находится) или стандартный компилятор платформы (обычно cc). Подобным образом при необходимости можно переопределить флаги компилятора по умолчанию с помощью переменной CFLAGS.

Ниже приведён список значимых переменных, которые можно установить таким образом:

BISON #

программа Bison

CC #

компилятор C

CFLAGS #

параметры, передаваемые компилятору C

CLANG #

путь к программе clang, которая будет подготавливать исходный код для встраивания при компиляции с ключом --with-llvm

CPP #

препроцессор C

CPPFLAGS #

параметры, передаваемые препроцессору C

CXX #

компилятор C++

CXXFLAGS #

параметры, передаваемые компилятору C++

DTRACE #

расположение программы dtrace

DTRACEFLAGS #

параметры, передаваемые программе dtrace

FLEX #

программа Flex

LDFLAGS #

параметры, которые должны использоваться при компоновке исполняемых программ или разделяемых библиотек

LDFLAGS_EX #

дополнительные параметры для компоновки только исполняемых программ

LDFLAGS_SL #

дополнительные параметры для компоновки только разделяемых библиотек

LLVM_CONFIG #

программа llvm-config, помогающая найти инсталляцию LLVM

MSGFMT #

расположение программы msgfmt для поддержки национальных языков

PERL #

Команда, вызывающая интерпретатор Perl. Она помогает определить зависимости для сборки PL/Perl. Значение по умолчанию — perl.

PYTHON #

Команда, вызывающая интерпретатор Python. Она нужна для определения зависимостей при сборке PL/Python. Если это значение не определено, в указанном порядке перебираются следующие варианты: python3 python.

TCLSH #

Команда, вызывающая интерпретатор Tcl. Она помогает определить зависимости для сборки PL/Tcl. Если она не задана, в указанном порядке перебираются следующие варианты: tclsh tcl tclsh8.6 tclsh86 tclsh8.5 tclsh85 tclsh8.4 tclsh84.

XML2_CONFIG #

программа xml2-config, помогающая найти инсталляцию libxml2

Иногда может быть полезно добавить флаги компилятора к набору флагов, ранее заданному на этапе configure. В частности, эта потребность объясняется тем, что параметр gcc -Werror нельзя указать в переменной CFLAGS, передаваемой configure, так как в результате сломаются многие встроенные тесты configure. Чтобы добавить такие флаги, задайте их в переменной среды COPT при запуске make. Содержимое COPT будет добавлено в параметры CFLAGS и LDFLAGS, заданные скриптом configure. Например, вы можете выполнить: 

make COPT='-Werror'

или 

export COPT='-Werror'
make

Примечание

Используя GCC, лучше выполнять сборку с уровнем оптимизации не ниже -O1, так как без оптимизации (-O0) отключаются некоторые важные предупреждения компилятора (например, об использовании неинициализированных переменных). Однако оптимизация ненулевого уровня может затруднить отладку, так как при пошаговом выполнении скомпилированный код обычно не соответствует в точности строкам исходного кода. При возникновении сложностей с отладкой оптимизированного кода, перекомпилируйте интересующие вас файлы с ключом -O0. Это можно сделать, просто передав соответствующий параметр make: make PROFILE=-O0 file.o.

На самом деле переменные окружения COPT и PROFILE обрабатываются сборочными файлами Makefile PostgreSQL одинаково. Поэтому выбор одной из этих переменных — дело вкуса, но обычно разработчики используют PROFILE для одноразовых корректив флагов, а содержимое COPT сохраняют постоянным.

Пред. Наверх След.
17.2. Получение исходного кода Начало 17.4. Сборка и установка с использованием Meson
17.3. Building and Installation with Autoconf and Make
Prev UpChapter 17. Installation from Source CodeHome Next

17.3. Building and Installation with Autoconf and Make #

17.3.1. Short Version
17.3.2. Installation Procedure
17.3.3. configure Options
17.3.4. configure Environment Variables

17.3.1. Short Version #

./configure
make
su
make install
adduser postgres
mkdir -p /usr/local/pgsql/data
chown postgres /usr/local/pgsql/data
su - postgres
/usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data
/usr/local/pgsql/bin/pg_ctl -D /usr/local/pgsql/data -l logfile start
/usr/local/pgsql/bin/createdb test
/usr/local/pgsql/bin/psql test

The long version is the rest of this section.

17.3.2. Installation Procedure #

  1. Configuration

    The first step of the installation procedure is to configure the source tree for your system and choose the options you would like. This is done by running the configure script. For a default installation simply enter: 

    ./configure

    This script will run a number of tests to determine values for various system dependent variables and detect any quirks of your operating system, and finally will create several files in the build tree to record what it found.

    You can also run configure in a directory outside the source tree, and then build there, if you want to keep the build directory separate from the original source files. This procedure is called a VPATH build. Here's how: 

    mkdir build_dir
cd build_dir
/path/to/source/tree/configure [options go here]
make

    The default configuration will build the server and utilities, as well as all client applications and interfaces that require only a C compiler. All files will be installed under /usr/local/pgsql by default.

    You can customize the build and installation process by supplying one or more command line options to configure. Typically you would customize the install location, or the set of optional features that are built. configure has a large number of options, which are described in Section 17.3.3.

    Also, configure responds to certain environment variables, as described in Section 17.3.4. These provide additional ways to customize the configuration.

  2. Build

    To start the build, type either of: 

    make
make all

    (Remember to use GNU make.) The build will take a few minutes depending on your hardware.

    If you want to build everything that can be built, including the documentation (HTML and man pages), and the additional modules (contrib), type instead: 

    make world

    If you want to build everything that can be built, including the additional modules (contrib), but without the documentation, type instead: 

    make world-bin

    If you want to invoke the build from another makefile rather than manually, you must unset MAKELEVEL or set it to zero, for instance like this: 

    build-postgresql:
        $(MAKE) -C postgresql MAKELEVEL=0 all

    Failure to do that can lead to strange error messages, typically about missing header files.

  3. Regression Tests

    If you want to test the newly built server before you install it, you can run the regression tests at this point. The regression tests are a test suite to verify that PostgreSQL runs on your machine in the way the developers expected it to. Type: 

    make check

    (This won't work as root; do it as an unprivileged user.) See Chapter 33 for detailed information about interpreting the test results. You can repeat this test at any later time by issuing the same command.

  4. Installing the Files

    Note

    If you are upgrading an existing system be sure to read Section 19.6, which has instructions about upgrading a cluster.

    To install PostgreSQL enter: 

    make install

    This will install files into the directories that were specified in Step 1. Make sure that you have appropriate permissions to write into that area. Normally you need to do this step as root. Alternatively, you can create the target directories in advance and arrange for appropriate permissions to be granted.

    To install the documentation (HTML and man pages), enter: 

    make install-docs

    If you built the world above, type instead: 

    make install-world

    This also installs the documentation.

    If you built the world without the documentation above, type instead: 

    make install-world-bin

    You can use make install-strip instead of make install to strip the executable files and libraries as they are installed. This will save some space. If you built with debugging support, stripping will effectively remove the debugging support, so it should only be done if debugging is no longer needed. install-strip tries to do a reasonable job saving space, but it does not have perfect knowledge of how to strip every unneeded byte from an executable file, so if you want to save all the disk space you possibly can, you will have to do manual work.

    The standard installation provides all the header files needed for client application development as well as for server-side program development, such as custom functions or data types written in C.

    Client-only installation:  If you want to install only the client applications and interface libraries, then you can use these commands: 

    make -C src/bin install
make -C src/include install
make -C src/interfaces install
make -C doc install

    src/bin has a few binaries for server-only use, but they are small.

Uninstallation:  To undo the installation use the command make uninstall. However, this will not remove any created directories.

Cleaning:  After the installation you can free disk space by removing the built files from the source tree with the command make clean. This will preserve the files made by the configure program, so that you can rebuild everything with make later on. To reset the source tree to the state in which it was distributed, use make distclean. If you are going to build for several platforms within the same source tree you must do this and re-configure for each platform. (Alternatively, use a separate build tree for each platform, so that the source tree remains unmodified.)

If you perform a build and then discover that your configure options were wrong, or if you change anything that configure investigates (for example, software upgrades), then it's a good idea to do make distclean before reconfiguring and rebuilding. Without this, your changes in configuration choices might not propagate everywhere they need to.

17.3.3. configure Options #

configure's command line options are explained below. This list is not exhaustive (use ./configure --help to get one that is). The options not covered here are meant for advanced use-cases such as cross-compilation, and are documented in the standard Autoconf documentation.

17.3.3.1. Installation Locations #

These options control where make install will put the files. The --prefix option is sufficient for most cases. If you have special needs, you can customize the installation subdirectories with the other options described in this section. Beware however that changing the relative locations of the different subdirectories may render the installation non-relocatable, meaning you won't be able to move it after installation. (The man and doc locations are not affected by this restriction.) For relocatable installs, you might want to use the --disable-rpath option described later.

--prefix=PREFIX #

Install all files under the directory PREFIX instead of /usr/local/pgsql. The actual files will be installed into various subdirectories; no files will ever be installed directly into the PREFIX directory.

--exec-prefix=EXEC-PREFIX #

You can install architecture-dependent files under a different prefix, EXEC-PREFIX, than what PREFIX was set to. This can be useful to share architecture-independent files between hosts. If you omit this, then EXEC-PREFIX is set equal to PREFIX and both architecture-dependent and independent files will be installed under the same tree, which is probably what you want.

--bindir=DIRECTORY #

Specifies the directory for executable programs. The default is EXEC-PREFIX/bin, which normally means /usr/local/pgsql/bin.

--sysconfdir=DIRECTORY #

Sets the directory for various configuration files, PREFIX/etc by default.

--libdir=DIRECTORY #

Sets the location to install libraries and dynamically loadable modules. The default is EXEC-PREFIX/lib.

--includedir=DIRECTORY #

Sets the directory for installing C and C++ header files. The default is PREFIX/include.

--datarootdir=DIRECTORY #

Sets the root directory for various types of read-only data files. This only sets the default for some of the following options. The default is PREFIX/share.

--datadir=DIRECTORY #

Sets the directory for read-only data files used by the installed programs. The default is DATAROOTDIR. Note that this has nothing to do with where your database files will be placed.

--localedir=DIRECTORY #

Sets the directory for installing locale data, in particular message translation catalog files. The default is DATAROOTDIR/locale.

--mandir=DIRECTORY #

The man pages that come with PostgreSQL will be installed under this directory, in their respective manx subdirectories. The default is DATAROOTDIR/man.

--docdir=DIRECTORY #

Sets the root directory for installing documentation files, except “man” pages. This only sets the default for the following options. The default value for this option is DATAROOTDIR/doc/postgresql.

--htmldir=DIRECTORY #

The HTML-formatted documentation for PostgreSQL will be installed under this directory. The default is DATAROOTDIR.

Note

Care has been taken to make it possible to install PostgreSQL into shared installation locations (such as /usr/local/include) without interfering with the namespace of the rest of the system. First, the string “/postgresql” is automatically appended to datadir, sysconfdir, and docdir, unless the fully expanded directory name already contains the string “postgres” or “pgsql”. For example, if you choose /usr/local as prefix, the documentation will be installed in /usr/local/doc/postgresql, but if the prefix is /opt/postgres, then it will be in /opt/postgres/doc. The public C header files of the client interfaces are installed into includedir and are namespace-clean. The internal header files and the server header files are installed into private directories under includedir. See the documentation of each interface for information about how to access its header files. Finally, a private subdirectory will also be created, if appropriate, under libdir for dynamically loadable modules.

17.3.3.2. PostgreSQL Features #

The options described in this section enable building of various PostgreSQL features that are not built by default. Most of these are non-default only because they require additional software, as described in Section 17.1.

--enable-nls[=LANGUAGES] #

Enables Native Language Support (NLS), that is, the ability to display a program's messages in a language other than English. LANGUAGES is an optional space-separated list of codes of the languages that you want supported, for example --enable-nls='de fr'. (The intersection between your list and the set of actually provided translations will be computed automatically.) If you do not specify a list, then all available translations are installed.

To use this option, you will need an implementation of the Gettext API.

--with-perl #

Build the PL/Perl server-side language.

--with-python #

Build the PL/Python server-side language.

--with-tcl #

Build the PL/Tcl server-side language.

--with-tclconfig=DIRECTORY #

Tcl installs the file tclConfig.sh, which contains configuration information needed to build modules interfacing to Tcl. This file is normally found automatically at a well-known location, but if you want to use a different version of Tcl you can specify the directory in which to look for tclConfig.sh.

--with-llvm #

Build with support for LLVM based JIT compilation (see Chapter 32). This requires the LLVM library to be installed. The minimum required version of LLVM is currently 3.9.

llvm-config will be used to find the required compilation options. llvm-config, and then llvm-config-$major-$minor for all supported versions, will be searched for in your PATH. If that would not yield the desired program, use LLVM_CONFIG to specify a path to the correct llvm-config. For example 

./configure ... --with-llvm LLVM_CONFIG='/path/to/llvm/bin/llvm-config'

LLVM support requires a compatible clang compiler (specified, if necessary, using the CLANG environment variable), and a working C++ compiler (specified, if necessary, using the CXX environment variable).

--with-lz4 #

Build with LZ4 compression support.

--with-zstd #

Build with Zstandard compression support.

--with-ssl=LIBRARY #

Build with support for SSL (encrypted) connections. The only LIBRARY supported is openssl. This requires the OpenSSL package to be installed. configure will check for the required header files and libraries to make sure that your OpenSSL installation is sufficient before proceeding.

--with-openssl #

Obsolete equivalent of --with-ssl=openssl.

--with-gssapi #

Build with support for GSSAPI authentication. MIT Kerberos is required to be installed for GSSAPI. On many systems, the GSSAPI system (a part of the MIT Kerberos installation) is not installed in a location that is searched by default (e.g., /usr/include, /usr/lib), so you must use the options --with-includes and --with-libraries in addition to this option. configure will check for the required header files and libraries to make sure that your GSSAPI installation is sufficient before proceeding.

--with-ldap #

Build with LDAP support for authentication and connection parameter lookup (see Section 34.18 and Section 21.10 for more information). On Unix, this requires the OpenLDAP package to be installed. On Windows, the default WinLDAP library is used. configure will check for the required header files and libraries to make sure that your OpenLDAP installation is sufficient before proceeding.

--with-pam #

Build with PAM (Pluggable Authentication Modules) support.

--with-bsd-auth #

Build with BSD Authentication support. (The BSD Authentication framework is currently only available on OpenBSD.)

--with-systemd #

Build with support for systemd service notifications. This improves integration if the server is started under systemd but has no impact otherwise; see Section 19.3 for more information. libsystemd and the associated header files need to be installed to use this option.

--with-bonjour #

Build with support for Bonjour automatic service discovery. This requires Bonjour support in your operating system. Recommended on macOS.

--with-uuid=LIBRARY #

Build the uuid-ossp module (which provides functions to generate UUIDs), using the specified UUID library. LIBRARY must be one of:

  • bsd to use the UUID functions found in FreeBSD and some other BSD-derived systems

  • e2fs to use the UUID library created by the e2fsprogs project; this library is present in most Linux systems and in macOS, and can be obtained for other platforms as well

  • ossp to use the OSSP UUID library

--with-ossp-uuid #

Obsolete equivalent of --with-uuid=ossp.

--with-libxml #

Build with libxml2, enabling SQL/XML support. Libxml2 version 2.6.23 or later is required for this feature.

To detect the required compiler and linker options, PostgreSQL will query pkg-config, if that is installed and knows about libxml2. Otherwise the program xml2-config, which is installed by libxml2, will be used if it is found. Use of pkg-config is preferred, because it can deal with multi-architecture installations better.

To use a libxml2 installation that is in an unusual location, you can set pkg-config-related environment variables (see its documentation), or set the environment variable XML2_CONFIG to point to the xml2-config program belonging to the libxml2 installation, or set the variables XML2_CFLAGS and XML2_LIBS. (If pkg-config is installed, then to override its idea of where libxml2 is you must either set XML2_CONFIG or set both XML2_CFLAGS and XML2_LIBS to nonempty strings.)

--with-libxslt #

Build with libxslt, enabling the xml2 module to perform XSL transformations of XML. --with-libxml must be specified as well.

17.3.3.3. Anti-Features #

The options described in this section allow disabling certain PostgreSQL features that are built by default, but which might need to be turned off if the required software or system features are not available. Using these options is not recommended unless really necessary.

--without-icu #

Build without support for the ICU library, disabling the use of ICU collation features (see Section 24.2).

--without-readline #

Prevents use of the Readline library (and libedit as well). This option disables command-line editing and history in psql.

--with-libedit-preferred #

Favors the use of the BSD-licensed libedit library rather than GPL-licensed Readline. This option is significant only if you have both libraries installed; the default in that case is to use Readline.

--without-zlib #

Prevents use of the Zlib library. This disables support for compressed archives in pg_dump and pg_restore.

--disable-spinlocks #

Allow the build to succeed even if PostgreSQL has no CPU spinlock support for the platform. The lack of spinlock support will result in very poor performance; therefore, this option should only be used if the build aborts and informs you that the platform lacks spinlock support. If this option is required to build PostgreSQL on your platform, please report the problem to the PostgreSQL developers.

--disable-atomics #

Disable use of CPU atomic operations. This option does nothing on platforms that lack such operations. On platforms that do have them, this will result in poor performance. This option is only useful for debugging or making performance comparisons.

--disable-thread-safety #

Disable the thread-safety of client libraries. This prevents concurrent threads in libpq and ECPG programs from safely controlling their private connection handles. Use this only on platforms with deficient threading support.

17.3.3.4. Build Process Details #

--with-includes=DIRECTORIES #

DIRECTORIES is a colon-separated list of directories that will be added to the list the compiler searches for header files. If you have optional packages (such as GNU Readline) installed in a non-standard location, you have to use this option and probably also the corresponding --with-libraries option.

Example: --with-includes=/opt/gnu/include:/usr/sup/include.

--with-libraries=DIRECTORIES #

DIRECTORIES is a colon-separated list of directories to search for libraries. You will probably have to use this option (and the corresponding --with-includes option) if you have packages installed in non-standard locations.

Example: --with-libraries=/opt/gnu/lib:/usr/sup/lib.

--with-system-tzdata=DIRECTORY #

PostgreSQL includes its own time zone database, which it requires for date and time operations. This time zone database is in fact compatible with the IANA time zone database provided by many operating systems such as FreeBSD, Linux, and Solaris, so it would be redundant to install it again. When this option is used, the system-supplied time zone database in DIRECTORY is used instead of the one included in the PostgreSQL source distribution. DIRECTORY must be specified as an absolute path. /usr/share/zoneinfo is a likely directory on some operating systems. Note that the installation routine will not detect mismatching or erroneous time zone data. If you use this option, you are advised to run the regression tests to verify that the time zone data you have pointed to works correctly with PostgreSQL.

This option is mainly aimed at binary package distributors who know their target operating system well. The main advantage of using this option is that the PostgreSQL package won't need to be upgraded whenever any of the many local daylight-saving time rules change. Another advantage is that PostgreSQL can be cross-compiled more straightforwardly if the time zone database files do not need to be built during the installation.

--with-extra-version=STRING #

Append STRING to the PostgreSQL version number. You can use this, for example, to mark binaries built from unreleased Git snapshots or containing custom patches with an extra version string, such as a git describe identifier or a distribution package release number.

--disable-rpath #

Do not mark PostgreSQL's executables to indicate that they should search for shared libraries in the installation's library directory (see --libdir). On most platforms, this marking uses an absolute path to the library directory, so that it will be unhelpful if you relocate the installation later. However, you will then need to provide some other way for the executables to find the shared libraries. Typically this requires configuring the operating system's dynamic linker to search the library directory; see Section 17.5.1 for more detail.

17.3.3.5. Miscellaneous #

It's fairly common, particularly for test builds, to adjust the default port number with --with-pgport. The other options in this section are recommended only for advanced users.

--with-pgport=NUMBER #

Set NUMBER as the default port number for server and clients. The default is 5432. The port can always be changed later on, but if you specify it here then both server and clients will have the same default compiled in, which can be very convenient. Usually the only good reason to select a non-default value is if you intend to run multiple PostgreSQL servers on the same machine.

--with-krb-srvnam=NAME #

The default name of the Kerberos service principal used by GSSAPI. postgres is the default. There's usually no reason to change this unless you are building for a Windows environment, in which case it must be set to upper case POSTGRES.

--with-segsize=SEGSIZE #

Set the segment size, in gigabytes. Large tables are divided into multiple operating-system files, each of size equal to the segment size. This avoids problems with file size limits that exist on many platforms. The default segment size, 1 gigabyte, is safe on all supported platforms. If your operating system has “largefile” support (which most do, nowadays), you can use a larger segment size. This can be helpful to reduce the number of file descriptors consumed when working with very large tables. But be careful not to select a value larger than is supported by your platform and the file systems you intend to use. Other tools you might wish to use, such as tar, could also set limits on the usable file size. It is recommended, though not absolutely required, that this value be a power of 2. Note that changing this value breaks on-disk database compatibility, meaning you cannot use pg_upgrade to upgrade to a build with a different segment size.

--with-blocksize=BLOCKSIZE #

Set the block size, in kilobytes. This is the unit of storage and I/O within tables. The default, 8 kilobytes, is suitable for most situations; but other values may be useful in special cases. The value must be a power of 2 between 1 and 32 (kilobytes). Note that changing this value breaks on-disk database compatibility, meaning you cannot use pg_upgrade to upgrade to a build with a different block size.

--with-wal-blocksize=BLOCKSIZE #

Set the WAL block size, in kilobytes. This is the unit of storage and I/O within the WAL log. The default, 8 kilobytes, is suitable for most situations; but other values may be useful in special cases. The value must be a power of 2 between 1 and 64 (kilobytes). Note that changing this value breaks on-disk database compatibility, meaning you cannot use pg_upgrade to upgrade to a build with a different WAL block size.

17.3.3.6. Developer Options #

Most of the options in this section are only of interest for developing or debugging PostgreSQL. They are not recommended for production builds, except for --enable-debug, which can be useful to enable detailed bug reports in the unlucky event that you encounter a bug. On platforms supporting DTrace, --enable-dtrace may also be reasonable to use in production.

When building an installation that will be used to develop code inside the server, it is recommended to use at least the options --enable-debug and --enable-cassert.

--enable-debug #

Compiles all programs and libraries with debugging symbols. This means that you can run the programs in a debugger to analyze problems. This enlarges the size of the installed executables considerably, and on non-GCC compilers it usually also disables compiler optimization, causing slowdowns. However, having the symbols available is extremely helpful for dealing with any problems that might arise. Currently, this option is recommended for production installations only if you use GCC. But you should always have it on if you are doing development work or running a beta version.

--enable-cassert #

Enables assertion checks in the server, which test for many “cannot happen” conditions. This is invaluable for code development purposes, but the tests can slow down the server significantly. Also, having the tests turned on won't necessarily enhance the stability of your server! The assertion checks are not categorized for severity, and so what might be a relatively harmless bug will still lead to server restarts if it triggers an assertion failure. This option is not recommended for production use, but you should have it on for development work or when running a beta version.

--enable-tap-tests #

Enable tests using the Perl TAP tools. This requires a Perl installation and the Perl module IPC::Run. See Section 33.4 for more information.

--enable-depend #

Enables automatic dependency tracking. With this option, the makefiles are set up so that all affected object files will be rebuilt when any header file is changed. This is useful if you are doing development work, but is just wasted overhead if you intend only to compile once and install. At present, this option only works with GCC.

--enable-coverage #

If using GCC, all programs and libraries are compiled with code coverage testing instrumentation. When run, they generate files in the build directory with code coverage metrics. See Section 33.5 for more information. This option is for use only with GCC and when doing development work.

--enable-profiling #

If using GCC, all programs and libraries are compiled so they can be profiled. On backend exit, a subdirectory will be created that contains the gmon.out file containing profile data. This option is for use only with GCC and when doing development work.

--enable-dtrace #

Compiles PostgreSQL with support for the dynamic tracing tool DTrace. See Section 28.5 for more information.

To point to the dtrace program, the environment variable DTRACE can be set. This will often be necessary because dtrace is typically installed under /usr/sbin, which might not be in your PATH.

Extra command-line options for the dtrace program can be specified in the environment variable DTRACEFLAGS. On Solaris, to include DTrace support in a 64-bit binary, you must specify DTRACEFLAGS="-64". For example, using the GCC compiler: 

./configure CC='gcc -m64' --enable-dtrace DTRACEFLAGS='-64' ...

Using Sun's compiler: 

./configure CC='/opt/SUNWspro/bin/cc -xtarget=native64' --enable-dtrace DTRACEFLAGS='-64' ...

--with-segsize-blocks=SEGSIZE_BLOCKS #

Specify the relation segment size in blocks. If both --with-segsize and this option are specified, this option wins. This option is only for developers, to test segment related code.

17.3.4. configure Environment Variables #

In addition to the ordinary command-line options described above, configure responds to a number of environment variables. You can specify environment variables on the configure command line, for example: 

./configure CC=/opt/bin/gcc CFLAGS='-O2 -pipe'

In this usage an environment variable is little different from a command-line option. You can also set such variables beforehand: 

export CC=/opt/bin/gcc
export CFLAGS='-O2 -pipe'
./configure

This usage can be convenient because many programs' configuration scripts respond to these variables in similar ways.

The most commonly used of these environment variables are CC and CFLAGS. If you prefer a C compiler different from the one configure picks, you can set the variable CC to the program of your choice. By default, configure will pick gcc if available, else the platform's default (usually cc). Similarly, you can override the default compiler flags if needed with the CFLAGS variable.

Here is a list of the significant variables that can be set in this manner:

BISON #

Bison program

CC #

C compiler

CFLAGS #

options to pass to the C compiler

CLANG #

path to clang program used to process source code for inlining when compiling with --with-llvm

CPP #

C preprocessor

CPPFLAGS #

options to pass to the C preprocessor

CXX #

C++ compiler

CXXFLAGS #

options to pass to the C++ compiler

DTRACE #

location of the dtrace program

DTRACEFLAGS #

options to pass to the dtrace program

FLEX #

Flex program

LDFLAGS #

options to use when linking either executables or shared libraries

LDFLAGS_EX #

additional options for linking executables only

LDFLAGS_SL #

additional options for linking shared libraries only

LLVM_CONFIG #

llvm-config program used to locate the LLVM installation

MSGFMT #

msgfmt program for native language support

PERL #

Perl interpreter program. This will be used to determine the dependencies for building PL/Perl. The default is perl.

PYTHON #

Python interpreter program. This will be used to determine the dependencies for building PL/Python. If this is not set, the following are probed in this order: python3 python.

TCLSH #

Tcl interpreter program. This will be used to determine the dependencies for building PL/Tcl. If this is not set, the following are probed in this order: tclsh tcl tclsh8.6 tclsh86 tclsh8.5 tclsh85 tclsh8.4 tclsh84.

XML2_CONFIG #

xml2-config program used to locate the libxml2 installation

Sometimes it is useful to add compiler flags after-the-fact to the set that were chosen by configure. An important example is that gcc's -Werror option cannot be included in the CFLAGS passed to configure, because it will break many of configure's built-in tests. To add such flags, include them in the COPT environment variable while running make. The contents of COPT are added to both the CFLAGS and LDFLAGS options set up by configure. For example, you could do 

make COPT='-Werror'

or 

export COPT='-Werror'
make

Note

If using GCC, it is best to build with an optimization level of at least -O1, because using no optimization (-O0) disables some important compiler warnings (such as the use of uninitialized variables). However, non-zero optimization levels can complicate debugging because stepping through compiled code will usually not match up one-to-one with source code lines. If you get confused while trying to debug optimized code, recompile the specific files of interest with -O0. An easy way to do this is by passing an option to make: make PROFILE=-O0 file.o.

The COPT and PROFILE environment variables are actually handled identically by the PostgreSQL makefiles. Which to use is a matter of preference, but a common habit among developers is to use PROFILE for one-time flag adjustments, while COPT might be kept set all the time.

Prev Up Next
17.2. Getting the Source Home 17.4. Building and Installation with Meson
FAQ