initdb
initdb — создать кластер баз данных Postgres Pro
Синтаксис
initdb [параметр...] [ --pgdata | -D ]каталог
Описание
Команда initdb создаёт новый кластер баз данных Postgres Pro. Кластер — это коллекция баз данных под управлением единого экземпляра сервера.
Инициализация кластера базы данных заключается в создании каталогов для хранения данных, формировании общих системных таблиц (относящихся ко всему кластеру, а не к какой-либо базе) и создании баз данных template1 и postgres. Впоследствии все новые базы создаются на основе шаблона template1 (все дополнения, установленные в template1 автоматически копируются в каждую новую базу данных). База postgres используется пользователями, утилитами и сторонними приложениями по умолчанию.
При попытке создать каталог для хранения данных initdb может столкнуться с нехваткой прав доступа, если этот каталог принадлежит суперпользователю root. В таком случае необходимо назначить пользователя базы данных владельцем этого каталога при помощи chown. Затем выполнить su для смены пользователя и дальнейшего выполнения initdb.
Команда initdb должна выполняться от имени пользователя, под которым будет запускаться сервер, так как ему необходим полный доступ к файлам и каталогам, создаваемым initdb. Сервер не может запускаться от имени суперпользователя, поэтому выполнение команды initdb от его лица будет отклонено.
Из соображений безопасности новый кластер, созданный программой initdb, будет доступен только для владельца кластера. Ключ --allow-group-access позволяет разрешить чтение файлов в кластере всем пользователям, входящим в группу владельца кластера. Это полезно для выполнения резервного копирования от имени непривилегированного пользователя.
initdb инициализирует локали и кодировки баз данных кластера, которые будут использоваться по умолчанию. Кодировка, порядок сортировки (LC_COLLATE), классы наборов символов (LC_CTYPE, например, заглавные, строчные буквы, цифры) могут устанавливаться раздельно при создании новой базы данных. initdb определяет параметры локали для шаблона template1, которые будут применяться по умолчанию для новых баз.
Чтобы изменить порядок сортировки по умолчанию или классы наборов символов, используются параметры --lc-collate и --lc-ctype. Порядок сортировки, отличающийся от C или POSIX, оказывает влияние на производительность. Поэтому необходимо тщательно выбирать необходимую и достаточную локаль при выполнении initdb.
Другие категории локали можно изменить и после старта сервера. Также можно использовать параметр --locale, чтобы задать локаль для всех категорий одновременно, включая порядок сортировки и классы наборов символов. Значения локалей сервера (lc_*) можно вывести командой SHOW ALL. Узнать об этом больше можно в Разделе 23.1.
Для изменения кодировки по умолчанию используется параметр --encoding. Узнать об этом больше можно в Разделе 23.3.
Параметры
-Aauthmethod--auth=authmethodПараметр определяет метод аутентификации по умолчанию для локальных пользователей, используемый в файле
pg_hba.conf(строкиhostиlocal). Программа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=кодировкаУстанавливает кодировку шаблона и новых баз данных по умолчанию, если не указать иное при их создании. По умолчанию устанавливается исходя из указанной локали, и далее, если не удалось определить, выбирается
SQL_ASCII. Кодировки, поддерживаемые сервером Postgres Pro, описаны в Подразделе 23.3.1.-g--allow-group-accessПозволяет пользователям, входящим в группу владельца кластера, читать все файлы кластера, создаваемые программой
initdb. В Windows этот ключ не работает, так как там не поддерживаются разрешения для группы в стиле POSIX.-k--data-checksumsПрименять контрольные суммы на страницах данных для выявления сбоев при вводе-выводе, которые иначе останутся незамеченными. Расчёт контрольных сумм может повлечь заметное снижение производительности. Когда контрольные суммы включены, они рассчитываются для всех объектов и во всех базах данных. Все ошибки контрольных сумм будут видны в представлении
pg_stat_database.По умолчанию кластеры Postgres Pro инициализируются с включёнными контрольными суммами. Чтобы изменить это поведение, добавьте параметр
--no-data-checksums.--no-data-checksumsОтключить контрольные суммы в страницах данных.
По умолчанию кластеры Postgres Pro инициализируются с включёнными контрольными суммами.
--locale=локаль[@provider]Устанавливает локаль кластера по умолчанию. Если флаг не указан, локаль устанавливается согласно окружению, в котором исполняется команда
initdb. Поддерживаемые локали описаны в Разделе 23.1.Кроме того, вы можете задать провайдер основного правила сортировки после символа
@. Допустимые варианты этого указания:icuиlibc. За подробностями обратитесь к Подразделу 23.2.2.--lc-collate=локаль[@provider]--lc-ctype=локаль--lc-messages=локаль--lc-monetary=локаль--lc-numeric=локаль--lc-time=локальАналогично
--localeустанавливает необходимую локаль, но в заданной категории.--no-localeАналогично флагу
--locale=C.-N--no-syncПо умолчанию
initdbждёт, пока все файлы не будут надёжно записаны на диск. С данным параметромinitdbзавершается быстрее, без ожидания, но в случае неожиданного сбоя операционной системы каталог данных может оказаться испорченным. Этот параметр может быть полезен при тестировании; в производственной среде применять его не следует.--pwfile=имя_файлаПринуждает
initdbчитать пароль суперпользователя базы данных из файла, первая строка которого используется в качестве пароля.-S--sync-onlyБезопасно записывает все файлы базы на диск и останавливается. Другие операции initdb при этом не выполняются.
--no-tuneПо умолчанию использование утилиты pgpro_tune в
initdbвключено. Чтобы её отключить, используйте этот параметр.--tune=optionsУстанавливает параметры для 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, используемое для создания каталога таблиц. С этим параметром выдаётся очень много крайне скучных сообщений.-LкаталогУказывает
initdb, где необходимо искать входные файлы для развёртывания кластера. Обычно это не требуется. Приложение само запросит эти данные, если будет необходимо.-n--no-cleanПо умолчанию, при выявлении ошибки на этапе развёртывания кластера,
initdbудаляет все файлы, которые к тому моменту были созданы. Параметр предотвращает очистку файлов для целей отладки.
Другие параметры для тестирования 64-битных идентификаторов транзакций:
-mSTART_MX_ID--multixact-id=START_MX_IDЗадаёт для нового экземпляра БД начальный идентификатор мультитранзакций в десятичном виде для тестирования обновлений БД, значение по умолчанию —
0.-oSTART_MX_OFFSET--multixact-offset=START_MX_OFFSETЗадаёт для нового экземпляра БД начальное смещение мультитранзакций в десятичном виде для тестирования обновлений БД, значение по умолчанию —
0.-xSTART_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.
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 template1 and postgres databases. When you later create a new database, everything in the template1 database is copied. (Therefore, anything installed in template1 is automatically copied into each database created later.) The postgres database is a default database meant for use by users, utilities and third party applications.
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. The character set encoding, collation order (LC_COLLATE) and character set classes (LC_CTYPE, e.g., upper, lower, digit) can be set separately for a database when it is created. initdb determines those settings for the template1 database, which will serve as the default for all other databases.
To alter the default collation order or character set classes, use the --lc-collate and --lc-ctype options. Collation orders other than C or POSIX also have a performance penalty. For these reasons it is important to choose the right locale when running initdb.
The remaining locale categories can be changed later when the server is started. You can also use --locale to set the default for all locale categories, including collation order and character set classes. All server locale values (lc_*) can be displayed via SHOW ALL. More details 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
-Aauthmethod--auth=authmethodThis option specifies the default authentication method for local users used in
pg_hba.conf(hostandlocallines).initdbwill prepopulatepg_hba.confentries using the specified authentication method for non-replication as well as replication connections.Do not use
trustunless you trust all local users on your system.trustis the default for ease of installation.--auth-host=authmethodThis option specifies the authentication method for local users via TCP/IP connections used in
pg_hba.conf(hostlines).--auth-local=authmethodThis option specifies the authentication method for local users via Unix-domain socket connections used in
pg_hba.conf(locallines).-Ddirectory--pgdata=directoryThis 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 thePGDATAenvironment variable, which can be convenient since the database server (postgres) can find the database directory later by the same variable.-Eencoding--encoding=encodingSelects the encoding of the template database. This will also be the default encoding of any database you create later, unless you override it there. The default is derived from the locale, or
SQL_ASCIIif that does not work. The character sets supported by the Postgres Pro server are described in Section 23.3.1.-g--allow-group-accessAllows 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.-k--data-checksumsUse 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_databaseview.By default, Postgres Pro clusters are initialized with checksums enabled. To change this behavior, provide the
--no-data-checksumsoption.--no-data-checksumsDisable checksums on data pages.
By default, Postgres Pro clusters are initialized with checksums enabled.
--locale=locale[@provider]Sets the default locale for the database cluster. If this option is not specified, the locale is inherited from the environment that
initdbruns in. Locale support is described in Section 23.1.Optionally, you can specify the provider of the default collation after the
@symbol. Supported values areicuandlibc. For details, see Section 23.2.2.--lc-collate=locale[@provider]--lc-ctype=locale--lc-messages=locale--lc-monetary=locale--lc-numeric=locale--lc-time=localeLike
--locale, but only sets the locale in the specified category.--no-localeEquivalent to
--locale=C.-N--no-syncBy default,
initdbwill wait for all files to be written safely to disk. This option causesinitdbto 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.--pwfile=filenameMakes
initdbread the database superuser's password from a file. The first line of the file is taken as the password.-S--sync-onlySafely write all database files to disk and exit. This does not perform any of the normal initdb operations.
--no-tuneBy default, the use of pgpro_tune is enabled in
initdb. Use this option to disable it.--tune=optionsSets parameters for pgpro_tune. See their description for further information.
-Tconfig--text-search-config=configSets the default text search configuration. See default_text_search_config for further information.
-Uusername--username=usernameSelects 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--pwpromptMakes
initdbprompt 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.-Xdirectory--waldir=directoryThis option specifies the directory where the write-ahead log should be stored.
--wal-segsize=sizeSet 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--debugPrint debugging output from the bootstrap backend and a few other messages of lesser interest for the general public. The bootstrap backend is the program
initdbuses to create the catalog tables. This option generates a tremendous amount of extremely boring output.-LdirectorySpecifies where
initdbshould 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-cleanBy default, when
initdbdetermines 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:
-mSTART_MX_ID--multixact-id=START_MX_IDSpecifies the initial multixact ID value in the decimal format for a new database instance to test database upgrades, default value is
0.-oSTART_MX_OFFSET--multixact-offset=START_MX_OFFSETSpecifies the initial multixact offset value in the decimal format for a new database instance to test database upgrades, default value is
0.-xSTART_XID--xid=START_XIDSpecifies the initial XID value in the decimal format for a new database instance to test database upgrades, default value is
0.
Other options:
-V--versionPrint the initdb version and exit.
-?--helpShow help about initdb command line arguments, and exit.
Environment
PGDATASpecifies the directory where the database cluster is to be stored; can be overridden using the
-Doption.PG_COLORSpecifies whether to use color in diagnostic messages. Possible values are
always,autoandnever.PGPRO_TUNESpecifies 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--tunenor--no-tuneis explicitly specified on the command line, the behavior is the same as if--tuneis specified with the value ofPGPRO_TUNE.TZSpecifies 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.