Postgres Pro Enterprise : Документация: 15: initdb : Компания Postgres Professional

initdb
Пред.	Наверх	Серверные приложения Postgres Pro	Начало	След.

initdb

initdb — создать кластер баз данных Postgres Pro

Синтаксис

initdb [параметр...] [ --pgdata | -D ]каталог

Описание

Команда initdb создаёт новый кластер баз данных Postgres Pro. Кластер — это коллекция баз данных под управлением единого экземпляра сервера.

Создание кластера баз данных заключается в создании каталогов для хранения данных, формировании общих системных таблиц (относящихся ко всему кластеру, а не к какой-либо базе) и создании баз данных postgres, template1 и template0. База postgres используется пользователями, утилитами и сторонними приложениями по умолчанию. Базы template1 и template0 предназначены для использования в качестве исходных баз данных, копии которых будут создавать последующие команды CREATE DATABASE. Базу template0 не следует изменять никогда, но вы можете добавлять объекты в template1, и они по умолчанию будут копироваться в базы данных, создаваемые позже. За подробностями обратитесь к Разделу 22.3.

При попытке создать каталог для хранения данных initdb может столкнуться с нехваткой прав доступа, если этот каталог принадлежит суперпользователю root. В таком случае необходимо назначить пользователя базы данных владельцем этого каталога при помощи chown. Затем выполнить su для смены пользователя и дальнейшего выполнения initdb.

Команда initdb должна выполняться от имени пользователя, под которым будет запускаться сервер, так как ему необходим полный доступ к файлам и каталогам, создаваемым initdb. Сервер не может запускаться от имени суперпользователя, поэтому выполнение команды initdb от его лица будет отклонено.

Из соображений безопасности новый кластер, созданный программой initdb, будет доступен только для владельца кластера. Ключ --allow-group-access позволяет разрешить чтение файлов в кластере всем пользователям, входящим в группу владельца кластера. Это полезно для выполнения резервного копирования от имени непривилегированного пользователя.

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

Выбрать другую локаль для кластера позволяет параметр --locale. Существуют также отдельные параметры --lc-* (см. ниже), позволяющие задать значения для отдельных категорий локали. Учтите, что с неподходящими значениями для разных категорий локали результаты могут быть бессмысленными, поэтому эти значения следует выбирать продуманно.

В качестве библиотеки, реализующей поддержку локалей, можно также использовать библиотеку ICU. Чтобы выбрать её, укажите --locale-provider=icu. (При этом также определяется только значение по умолчанию для создаваемых впоследствии баз данных.) Выбрать определённую локаль ICU позволяет параметр --icu-locale. Заметьте, что даже когда используется провайдер локалей ICU, initdb в любом случае выбирает и инициализирует локали libc в связи с особенностями реализации и для поддержки старого кода.

Если провайдер локалей не задан, он выбирается автоматически на основании значения lc_collate для кластера: для локалей C и POSIX выбирается libc, а для других локалей — icu.

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

Подробнее о параметрах локали можно узнать в Разделе 23.1.

Для изменения кодировки по умолчанию используется параметр --encoding. Узнать об этом больше можно в Разделе 23.3.

Параметры

-A authmethod --auth=authmethod

Параметр определяет метод аутентификации по умолчанию для локальных пользователей, используемый в файле pg_hba.conf (строки host и local). Допустимые значения описаны в Разделе 20.1.

Программа initdb предварительно внесёт указанный метод аутентификации в pg_hba.conf в записи как обычных соединений, так и соединений репликации.

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

--auth-host=authmethod

Параметр указывает метод аутентификации для локальных пользователей, подключающихся по TCP/IP, используемый в pg_hba.conf (строки host).

--auth-local=authmethod

Параметр выбирает метод аутентификации локальных пользователей, подключающихся через Unix-сокет, используемый в pg_hba.conf (строки local).

-D каталог --pgdata=каталог

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

-E кодировка --encoding=кодировка

Устанавливает кодировку по умолчанию для баз-шаблонов. Эта кодировка будет по умолчанию выбираться и для баз данных, создаваемых позже, если вы не переопределите её. В отсутствие этого указания кодировка выбирается, исходя из указанной локали, если используется провайдер локалей libc, а если используется провайдер локалей ICU, выбирается UTF8. Наборы символов, поддерживаемые сервером Postgres Pro, описаны в Подразделе 23.3.1.

-g --allow-group-access

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

--icu-locale=локаль

Указывает идентификатор локали ICU, если используется провайдер локалей ICU. По умолчанию используется значение lc_collate.

-k --data-checksums

Применять контрольные суммы на страницах данных для выявления сбоев при вводе-выводе, которые иначе останутся незамеченными. Расчёт контрольных сумм может повлечь заметное снижение производительности. Когда контрольные суммы включены, они рассчитываются для всех объектов и во всех базах данных. Все ошибки контрольных сумм будут видны в представлении pg_stat_database. За подробностями обратитесь к Разделу 29.2.

По умолчанию кластеры Postgres Pro инициализируются с включёнными контрольными суммами. Чтобы изменить это поведение, добавьте параметр --no-data-checksums.

--no-data-checksums

Отключить контрольные суммы в страницах данных.

По умолчанию кластеры Postgres Pro инициализируются с включёнными контрольными суммами.

--locale=локаль

Устанавливает локаль кластера по умолчанию. Если флаг не указан, локаль устанавливается согласно окружению, в котором исполняется команда initdb. Поддерживаемые локали описаны в Разделе 23.1.

--lc-collate=локаль --lc-ctype=локаль --lc-messages=локаль --lc-monetary=локаль --lc-numeric=локаль --lc-time=локаль

Аналогично --locale устанавливает локаль, но только для заданной категории. Параметр --lc-collate переопределяет параметр --locale независимо от того, указан ли провайдер правил сортировки.

--locale=локаль@provider --lc-collate=локаль@provider

Это устаревшие варианты указания провайдера по сравнению с --locale-provider, где провайдер может принимать значение icu или libc, а локаль задаётся в формате libc. После символа @ может быть задан только один провайдер.

--no-locale

Аналогично флагу --locale=C.

--locale-provider={libc|icu}

Этот параметр выбирает провайдера локалей для баз данных, создаваемых в новом кластере. Его можно переопределить для создаваемых впоследствии баз в команде CREATE DATABASE.

-N --no-sync

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

--no-instructions

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

--pwfile=имя_файла

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

-S --sync-only

Безопасно записывает все файлы базы на диск и останавливается. Другие операции initdb при этом не выполняются. В целом, этот параметр полезен для обеспечения надёжного восстановления после изменения значения fsync с off на on.

--no-tune

По умолчанию использование утилиты pgpro_tune в initdb включено. Чтобы её отключить, используйте этот параметр.

--tune=параметры

Устанавливает параметры для pgpro_tune. За дополнительной информацией обратитесь к их описанию.

-T конфигурация --text-search-config=конфигурация

Устанавливает конфигурацию текстового поиска по умолчанию. За дополнительными сведениями обратитесь к default_text_search_config.

-U имя_пользователя --username=имя_пользователя

Устанавливает имя суперпользователя базы данных. По умолчанию используется имя пользователя ОС, запустившего initdb. По факту, само по себе имя суперпользователя базы данных не важно, но этот параметр позволяет оставить привычное postgres, если имя пользователя ОС другое.

-W --pwprompt

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

-X каталог --waldir=каталог

Этот параметр указывает каталог для хранения журнала предзаписи.

--wal-segsize=размер

Задаёт размер сегмента WAL, в мегабайтах. Такой размер будет иметь каждый отдельный файл в журнале WAL. По умолчанию размер равен 16 мегабайтам. Значение должно задаваться степенью 2 от 1 до 1024 (в мегабайтах). Этот параметр можно установить только во время инициализации и нельзя изменить позже.

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

Другие реже используемые параметры описаны здесь:

-d --debug: Выводит отладочные сообщения загрузчика и ряд других сообщений, не очень интересных широкой публике. Загрузчик — это приложение initdb, используемое для создания каталога таблиц. С этим параметром выдаётся очень много крайне скучных сообщений.
--discard-caches: Запустить загрузчик с параметром debug_discard_caches=1. Это очень сильно замедлит выполнение и полезно только для низкоуровневой отладки.
-L каталог: Указывает initdb, где необходимо искать входные файлы для развёртывания кластера. Обычно это не требуется. Приложение само запросит эти данные, если будет необходимо.
-n --no-clean: По умолчанию, при выявлении ошибки на этапе развёртывания кластера, initdb удаляет все файлы, которые к тому моменту были созданы. Параметр предотвращает очистку файлов для целей отладки.

Другие параметры для тестирования 64-битных идентификаторов транзакций:

-m START_MX_ID --multixact-id=START_MX_ID: Задаёт для нового экземпляра БД начальный идентификатор мультитранзакций в десятичном виде для тестирования обновлений БД, значение по умолчанию — 0.
-o START_MX_OFFSET --multixact-offset=START_MX_OFFSET: Задаёт для нового экземпляра БД начальное смещение мультитранзакций в десятичном виде для тестирования обновлений БД, значение по умолчанию — 0.
-x START_XID --xid=START_XID: Задаёт для нового экземпляра БД начальный идентификатор транзакций в десятичном виде для тестирования обновлений БД, значение по умолчанию — 0.

Прочие параметры:

-V --version: Выводит версию initdb и останавливается.
-? --help: Показывает помощь по аргументам команды initdb и останавливается.

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

PGDATA: Указывает каталог хранения данных кластера, можно изменить параметром -D.
PG_COLOR: Выбирает вариант использования цвета в диагностических сообщениях. Возможные значения: always (всегда), auto (автоматически) и never (никогда).
PGPRO_TUNE: Указывает, нужно ли использовать утилиту pgpro_tune без изменения параметров в командной строке. Если установлено значение disable, действие этой переменной окружения аналогично установлению параметра --no-tune, то есть отключает pgpro_tune. Если задано другое значение и параметр --tune или --no-tune в командной строке явным образом не указан, поведение будет таким же, как если бы для параметра --tune было задано значение PGPRO_TUNE.
TZ: Указывает часовой пояс кластера по умолчанию. Значение — это полное имя часового пояса (см. Подраздел 8.5.3).

Примечания

initdb можно выполнить командой pg_ctl initdb.

См. также

pg_ctl, postgres, Раздел 20.1

Пред.	Наверх	След.
Серверные приложения Postgres Pro	Начало	pg_archivecleanup

initdb
Prev	Up	Postgres Pro Server Applications	Home	Next

initdb

initdb — create a new Postgres Pro database cluster

Synopsis

initdb [option...] [ --pgdata | -D ] directory

Description

initdb creates a new Postgres Pro database cluster. A database cluster is a collection of databases that are managed by a single server instance.

Creating a database cluster consists of creating the directories in which the database data will live, generating the shared catalog tables (tables that belong to the whole cluster rather than to any particular database), and creating the postgres, template1, and template0 databases. The postgres database is a default database meant for use by users, utilities and third party applications. template1 and template0 are meant as source databases to be copied by later CREATE DATABASE commands. template0 should never be modified, but you can add objects to template1, which by default will be copied into databases created later. See Section 22.3 for more details.

Although initdb will attempt to create the specified data directory, it might not have permission if the parent directory of the desired data directory is root-owned. To initialize in such a setup, create an empty data directory as root, then use chown to assign ownership of that directory to the database user account, then su to become the database user to run initdb.

initdb must be run as the user that will own the server process, because the server needs to have access to the files and directories that initdb creates. Since the server cannot be run as root, you must not run initdb as root either. (It will in fact refuse to do so.)

For security reasons the new cluster created by initdb will only be accessible by the cluster owner by default. The --allow-group-access option allows any user in the same group as the cluster owner to read files in the cluster. This is useful for performing backups as a non-privileged user.

initdb initializes the database cluster's default locale and character set encoding. These can also be set separately for each database when it is created. initdb determines those settings for the template databases, which will serve as the default for all other databases. By default, initdb takes the locale settings from the environment, and determines the encoding from the locale settings. This is almost always sufficient, unless there are special requirements.

To choose a different locale for the cluster, use the option --locale. There are also individual options --lc-* (see below) to set values for the individual locale categories. Note that inconsistent settings for different locale categories can give nonsensical results, so this should be used with care.

Alternatively, the ICU library can be used to provide locale services. (Again, this only sets the default for subsequently created databases.) To select this option, specify --locale-provider=icu. To choose the specific ICU locale ID to apply, use the option --icu-locale. Note that for implementation reasons and to support legacy code, initdb will still select and initialize libc locale settings when the ICU locale provider is used.

If the locale provider is not specified, it is set automatically based on the lc_collate value for the cluster: libc is used for the C or POSIX locales, and icu is used for other locales.

When initdb runs, it will print out the locale settings it has chosen. If you have complex requirements or specified multiple options, it is advisable to check that the result matches what was intended.

More details about locale settings can be found in Section 23.1.

To alter the default encoding, use the --encoding. More details can be found in Section 23.3.

Options

-A authmethod --auth=authmethod

This option specifies the default authentication method for local users used in pg_hba.conf (host and local lines). See Section 20.1 for an overview of valid values.

initdb will prepopulate pg_hba.conf entries using the specified authentication method for non-replication as well as replication connections.

Do not use trust unless you trust all local users on your system. trust is the default for ease of installation.

--auth-host=authmethod

This option specifies the authentication method for local users via TCP/IP connections used in pg_hba.conf (host lines).

--auth-local=authmethod

This option specifies the authentication method for local users via Unix-domain socket connections used in pg_hba.conf (local lines).

-D directory --pgdata=directory

This option specifies the directory where the database cluster should be stored. This is the only information required by initdb, but you can avoid writing it by setting the PGDATA environment variable, which can be convenient since the database server (postgres) can find the database directory later by the same variable.

-E encoding --encoding=encoding

Selects the encoding of the template databases. This will also be the default encoding of any database you create later, unless you override it then. The default is derived from the locale, if the libc locale provider is used, or UTF8 if the ICU locale provider is used. The character sets supported by the Postgres Pro server are described in Section 23.3.1.

-g --allow-group-access

Allows users in the same group as the cluster owner to read all cluster files created by initdb. This option is ignored on Windows as it does not support POSIX-style group permissions.

--icu-locale=locale

Specifies the ICU locale ID, if the ICU locale provider is used. The default is the value of lc_collate.

-k --data-checksums

Use checksums on data pages to help detect corruption by the I/O system that would otherwise be silent. Enabling checksums may incur a noticeable performance penalty. If set, checksums are calculated for all objects, in all databases. All checksum failures will be reported in the pg_stat_database view. See Section 29.2 for details.

By default, Postgres Pro clusters are initialized with checksums enabled. To change this behavior, provide the --no-data-checksums option.

--no-data-checksums

Disable checksums on data pages.

By default, Postgres Pro clusters are initialized with checksums enabled.

--locale=locale

Sets the default locale for the database cluster. If this option is not specified, the locale is inherited from the environment that initdb runs in. Locale support is described in Section 23.1.

--lc-collate=locale --lc-ctype=locale --lc-messages=locale --lc-monetary=locale --lc-numeric=locale --lc-time=locale

Like --locale, but only sets the locale in the specified category. The --lc-collate option overrides the --locale setting, regardless of whether the collation provider is specified.

--locale=locale@provider --lc-collate=locale@provider

These are deprecated variants of --locale-provider, where provider can take the icu or libc value, and locale is specified in the libc format. You can only specify a single locale provider after the @ symbol.

--no-locale

Equivalent to --locale=C.

--locale-provider={libc|icu}

This option sets the locale provider for databases created in the new cluster. It can be overridden in the CREATE DATABASE command when new databases are subsequently created.

-N --no-sync

By default, initdb will wait for all files to be written safely to disk. This option causes initdb to return without waiting, which is faster, but means that a subsequent operating system crash can leave the data directory corrupt. Generally, this option is useful for testing, but should not be used when creating a production installation.

--no-instructions

By default, initdb will write instructions for how to start the cluster at the end of its output. This option causes those instructions to be left out. This is primarily intended for use by tools that wrap initdb in platform-specific behavior, where those instructions are likely to be incorrect.

--pwfile=filename

Makes initdb read the database superuser's password from a file. The first line of the file is taken as the password.

-S --sync-only

Safely write all database files to disk and exit. This does not perform any of the normal initdb operations. Generally, this option is useful for ensuring reliable recovery after changing fsync from off to on.

--no-tune

By default, the use of pgpro_tune is enabled in initdb. Use this option to disable it.

--tune=options

Sets parameters for pgpro_tune. See their description for further information.

-T config --text-search-config=config

Sets the default text search configuration. See default_text_search_config for further information.

-U username --username=username

Selects the user name of the database superuser. This defaults to the name of the effective user running initdb. It is really not important what the superuser's name is, but one might choose to keep the customary name postgres, even if the operating system user's name is different.

-W --pwprompt

Makes initdb prompt for a password to give the database superuser. If you don't plan on using password authentication, this is not important. Otherwise you won't be able to use password authentication until you have a password set up.

-X directory --waldir=directory

This option specifies the directory where the write-ahead log should be stored.

--wal-segsize=size

Set the WAL segment size, in megabytes. This is the size of each individual file in the WAL log. The default size is 16 megabytes. The value must be a power of 2 between 1 and 1024 (megabytes). This option can only be set during initialization, and cannot be changed later.

It may be useful to adjust this size to control the granularity of WAL log shipping or archiving. Also, in databases with a high volume of WAL, the sheer number of WAL files per directory can become a performance and management problem. Increasing the WAL file size will reduce the number of WAL files.

Other, less commonly used, options are also available:

-d --debug: Print debugging output from the bootstrap backend and a few other messages of lesser interest for the general public. The bootstrap backend is the program initdb uses to create the catalog tables. This option generates a tremendous amount of extremely boring output.
--discard-caches: Run the bootstrap backend with the debug_discard_caches=1 option. This takes a very long time and is only of use for deep debugging.
-L directory: Specifies where initdb should find its input files to initialize the database cluster. This is normally not necessary. You will be told if you need to specify their location explicitly.
-n --no-clean: By default, when initdb determines that an error prevented it from completely creating the database cluster, it removes any files it might have created before discovering that it cannot finish the job. This option inhibits tidying-up and is thus useful for debugging.

Other options for testing 64-bit XIDs:

-m START_MX_ID --multixact-id=START_MX_ID: Specifies the initial multixact ID value in the decimal format for a new database instance to test database upgrades, default value is 0.
-o START_MX_OFFSET --multixact-offset=START_MX_OFFSET: Specifies the initial multixact offset value in the decimal format for a new database instance to test database upgrades, default value is 0.
-x START_XID --xid=START_XID: Specifies the initial XID value in the decimal format for a new database instance to test database upgrades, default value is 0.

Other options:

-V --version: Print the initdb version and exit.
-? --help: Show help about initdb command line arguments, and exit.

Environment

PGDATA: Specifies the directory where the database cluster is to be stored; can be overridden using the -D option.
PG_COLOR: Specifies whether to use color in diagnostic messages. Possible values are always, auto and never.
PGPRO_TUNE: Specifies whether to use pgpro_tune without modifying command-line options directly. If set to disable, this environment variable has the same effect as passing --no-tune, disabling the use of pgpro_tune. If set to any other value, and neither --tune nor --no-tune is explicitly specified on the command line, the behavior is the same as if --tune is specified with the value of PGPRO_TUNE.
TZ: Specifies the default time zone of the created database cluster. The value should be a full time zone name (see Section 8.5.3).

Notes

initdb can also be invoked via pg_ctl initdb.

initdb

Синтаксис

Описание

Параметры

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

Примечания

См. также

initdb

Synopsis

Description

Options

Environment

Notes

See Also