Spec-Zone.ru › Ansible 2.10

community.postgresql.postgresql_idx – Создание или удаление индексов в базе данных PostgreSQL

Примечание

Этот плагин входит в коллекцию community.postgresql (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.postgresql.

Для использования в playbook, укажите: community.postgresql.postgresql_idx.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Создание или удаление индексов в базе данных 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.
Если процесс создания был прерван по какой-либо причине при concurrent=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
строка
    Варианты:
  • allow
  • disable
  • prefer ←
  • require
  • verify-ca
  • verify-full
Определяет, будет ли и с какой приоритетностью устанавливаться безопасное SSL TCP/IP-соединение с сервером.
См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах.
Значение по умолчанию prefer соответствует значению по умолчанию libpq.
state
строка
    Варианты:
  • absent
  • present ←
Состояние индекса.
present подразумевает, что индекс будет создан, если он не существует.
absent подразумевает, что индекс будет удален, если он существует.
storage_params
список / элементы=строка
Параметры хранения, такие как fillfactor, vacuum_cleanup_index_scale_factor и т. д.
Взаимоисключающее с state=absent.
table
строка
Таблица, для которой нужно создать индекс.
Взаимоисключающее с state=absent.
tablespace
строка
Установите табличное пространство для индекса.
Взаимоисключающее с state=absent.
trust_input
булево
добавлено в 0.2.0 из community.postgresql
    Варианты:
  • нет
  • да ←
Если no, проверьте, являются ли значения параметров idxname, session_role, schema, table, columns, tablespace, storage_params, cond потенциально опасными.
Использование no имеет смысл только тогда, когда возможны SQL-инъекции через параметры.
unique
булево
добавлено в 0.2.0 из community.postgresql
    Варианты:
  • нет ←
  • да
Включить уникальный индекс.
В настоящее время уникальные индексы поддерживаются только для btree.

Примечания

Примечание

  • Процесс создания индекса может повлиять на производительность базы данных.
  • Чтобы избежать блокировок таблиц в базах данных в режиме реального времени, используйте concurrent=yes (поведение по умолчанию).
  • Аутентификация по умолчанию предполагает, что вы входите в систему как или подключаетесь с правами пользователя postgres на хосте.
  • Чтобы избежать ошибки «Ошибка проверки подлинности клиента для пользователя postgres», используйте пользователя postgres в качестве become_user.
  • Этот модуль использует psycopg2, адаптер базы данных PostgreSQL для Python. Необходимо убедиться, что psycopg2 установлен на хосте перед использованием этого модуля.
  • Если удалённый хост — это сервер PostgreSQL (который является значением по умолчанию), PostgreSQL также должен быть установлен на удалённом хосте.
  • Для систем на основе Ubuntu необходимо установить пакеты postgresql, libpq-dev и python-psycopg2 на удалённом хосте перед использованием этого модуля.
  • Параметр ca_cert требует как минимум версию Postgres 8.4 и psycopg2 версию 2.4.3.

См. также

См. также

community.postgresql.postgresql_table

Официальная документация модуля community.postgresql.postgresql_table.

community.postgresql.postgresql_tablespace

Официальная документация модуля community.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
  community.postgresql.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
  community.postgresql.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
  community.postgresql.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
  community.postgresql.postgresql_idx:
    idxname: gin0_idx
    table: test
    columns: comment gin_trgm_ops
    concurrent: no
    idxtype: gin

- name: Drop btree test_idx concurrently
  community.postgresql.postgresql_idx:
    db: mydb
    idxname: test_idx
    state: absent

- name: Drop test_idx cascade
  community.postgresql.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
  community.postgresql.postgresql_idx:
    db: mydb
    table: test
    columns: id,comment
    idxname: test_idx
    cond: id > 1

- name: Create unique btree index if not exists test_unique_idx on column name of table products
  community.postgresql.postgresql_idx:
    db: acme
    table: products
    columns: name
    name: test_unique_idx
    unique: yes
    concurrent: no

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
name
string
всегда
Имя индекса.

Пример:
foo_idx
query
string
всегда
Запрос, который пытались выполнить.

Пример:
CREATE INDEX CONCURRENTLY foo_idx ON test_table USING BTREE (id)
schema
string
всегда
Схема, в которой существует индекс.

Пример:
public
state
string
всегда
Состояние индекса.

Пример:
present
storage_params
list / elements=string
всегда
Параметры хранения индекса.

Пример:
['fillfactor=90']
tablespace
string
всегда
Файловая система, в которой существует индекс.

Пример:
ssd
valid
boolean
всегда
Действительность индекса.

Пример:
True


Авторы

  • Андрей Клычков (@Andersson007)
  • Томас О’Донелл (@andytom)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/postgresql/postgresql_idx_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API