postgresql_idx – Создание или удаление индексов в базе данных PostgreSQL
Новое в версии 2.8.
Описание
- Создание или удаление индексов в базе данных PostgreSQL.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- psycopg2
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ca_cert строка | Указывает имя файла, содержащего сертификат(ы) центра сертификации (CA). Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров. псевдонимы: ssl_rootcert | |
| cascade логическое значение |
| Автоматически удаляет объекты, зависящие от индекса, и, в свою очередь, все объекты, зависящие от этих объектов. Используется только с state=absent. Несовместимо с concurrent=yes
|
| columns список / элементы=строка | Список столбцов индекса, которые должны быть покрыты индексом. Несовместимо с state=absent. псевдонимы: column | |
| concurrent логическое значение |
| Включить или выключить режим одновременной работы (CREATE / DROP INDEX CONCURRENTLY). Обратите внимание, если concurrent=no, таблица будет заблокирована (ACCESS EXCLUSIVE) во время процесса создания. Более подробную информацию о уровнях блокировки см. на https://www.postgresql.org/docs/current/explicit-locking.html. Если процесс создания был прерван по какой-либо причине при cuncurrent=yes, индекс становится недействительным. В этом случае его следует удалить и создать заново. Несовместимо с cascade=yes. |
| cond строка | Условия индекса. Несовместимо с state=absent. | |
| db строка | Имя базы данных для подключения и где будет создан/удален индекс. псевдонимы: login_db | |
| idxname строка / обязательно | Имя индекса для создания или удаления. псевдонимы: name | |
| idxtype строка | Тип индекса (например, btree, gist, gin и т. д.). Несовместимо с state=absent. псевдонимы: type | |
| login_host строка | Хост, на котором работает база данных. | |
| login_password строка | Пароль для аутентификации. | |
| login_unix_socket строка | Путь к сокету Unix-домена для локальных подключений. | |
| login_user строка | По умолчанию: "postgres" | Имя пользователя для аутентификации. |
| port целое число | По умолчанию: 5432 | Порт базы данных для подключения. псевдонимы: login_port |
| schema строка | Имя схемы базы данных, где будет создан индекс. | |
| session_role строка | Переключение на session_role после подключения. Указанный session_role должен быть ролью, членом которой является текущий login_user. Проверка разрешений для команд SQL выполняется так, как будто session_role был тем, кто первоначально вошел в систему. | |
| ssl_mode строка |
| Определяет, будет ли и с какой приоритетностью устанавливаться защищенное SSL TCP/IP соединение с сервером. См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах. Значение по умолчанию prefer соответствует значению по умолчанию libpq. |
| state строка |
| Состояние индекса.
state=present означает, что индекс будет создан, если он не существует.
state=absent означает, что индекс будет удален, если он существует. |
| storage_params список / элементы=строка | Параметры хранения, такие как fillfactor, vacuum_cleanup_index_scale_factor и т. д. Несовместимо с state=absent. | |
| table строка / обязательно | Таблица, на которой будет создан индекс. Несовместимо с state=absent. | |
| tablespace строка | Установить табличное пространство для индекса. Несовместимо с state=absent. |
Примечания
Примечание
- Процесс создания индекса может повлиять на производительность базы данных.
- Для избежания блокировок таблиц в базах данных в рабочем режиме используйте concurrent=yes (поведение по умолчанию).
- Аутентификация по умолчанию предполагает, что вы входите или используете sudo с учетной записью
postgresна хосте. - Чтобы избежать ошибки «Ошибка проверки подлинности клиента для пользователя postgres», используйте пользователя postgres в качестве become_user.
- Этот модуль использует psycopg2, адаптер базы данных Python PostgreSQL. Вы должны убедиться, что psycopg2 установлен на хосте перед использованием этого модуля.
- Если удаленный хост является сервером PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удаленном хосте.
- Для систем на основе Ubuntu установите пакеты postgresql, libpq-dev и python-psycopg2 на удаленном хосте перед использованием этого модуля.
- Для параметра ca_cert требуется по крайней мере версия Postgres 8.4 и версия psycopg2 2.4.3.
См. также
См. также
- postgresql_table – Создание, удаление или изменение таблицы PostgreSQL
- Официальная документация по модулю postgresql_table.
- postgresql_tablespace – Добавление или удаление табличных пространств PostgreSQL на удаленных хостах
- Официальная документация по модулю postgresql_tablespace.
- Справочник по индексам PostgreSQL
- Общая информация об индексах PostgreSQL.
- Справочник по CREATE INDEX
- Полное описание документации команды CREATE INDEX.
- Справочник по ALTER INDEX
- Полное описание документации команды ALTER INDEX.
- Справочник по DROP INDEX
- Полное описание документации команды DROP INDEX.
Примеры
- name: Create btree index if not exists test_idx concurrently covering columns id and name of table products
postgresql_idx:
db: acme
table: products
columns: id,name
name: test_idx
- name: Create btree index test_idx concurrently with tablespace called ssd and storage parameter
postgresql_idx:
db: acme
table: products
columns:
- id
- name
idxname: test_idx
tablespace: ssd
storage_params:
- fillfactor=90
- name: Create gist index test_gist_idx concurrently on column geo_data of table map
postgresql_idx:
db: somedb
table: map
idxtype: gist
columns: geo_data
idxname: test_gist_idx
# Note: for the example below pg_trgm extension must be installed for gin_trgm_ops
- name: Create gin index gin0_idx not concurrently on column comment of table test
postgresql_idx:
idxname: gin0_idx
table: test
columns: comment gin_trgm_ops
concurrent: no
idxtype: gin
- name: Drop btree test_idx concurrently
postgresql_idx:
db: mydb
idxname: test_idx
state: absent
- name: Drop test_idx cascade
postgresql_idx:
db: mydb
idxname: test_idx
state: absent
cascade: yes
concurrent: no
- name: Create btree index test_idx concurrently on columns id,comment where column id > 1
postgresql_idx:
db: mydb
table: test
columns: id,comment
idxname: test_idx
cond: id > 1
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| name строка | всегда | Имя индекса. Пример: foo_idx |
| query строка | всегда | Запрос, который пытались выполнить. Пример: CREATE INDEX CONCURRENTLY foo_idx ON test_table USING BTREE (id) |
| schema строка | всегда | Схема, в которой существует индекс. Пример: public |
| state строка | всегда | Состояние индекса. Пример: present |
| storage_params список | всегда | Параметры хранения индекса. Пример: ['fillfactor=90'] |
| tablespace строка | всегда | Таблица, в которой существует индекс. Пример: ssd |
| valid логическое значение | всегда | Действительность индекса. Пример: True |
Статус
- Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Андрей Клычков (@Andersson007)
Подсказка
Если вы заметите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/postgresql_idx_module.html