Spec-Zone.ru › Ansible

Модуль community.postgresql.postgresql_sequence – Создание, удаление или изменение последовательности PostgreSQL

Примечание

Этот модуль входит в коллекцию community.postgresql (версия 3.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.postgresql. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в книге задач укажите: community.postgresql.postgresql_sequence.

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

Описание

  • Позволяет создавать, удалять или изменять определение генератора последовательности.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • psycopg2 >= 2.5.1

Параметры

Параметр

Комментарии

ca_cert

псевдонимы: ssl_rootcert

строка

Указывает имя файла, содержащего сертификат(ы) центра сертификации (CA) SSL.

Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров.

cache

целое число

Параметр cache определяет, сколько номеров последовательности предварительно выделено и сохранено в памяти для более быстрого доступа. Минимальное значение — 1 (может быть сгенерировано только одно значение за раз, т. е. кеш не используется), и это значение также является значением по умолчанию.

cascade

логическое значение

Автоматически удаляет объекты, зависящие от последовательности, и, в свою очередь, все объекты, которые зависят от этих объектов.

Игнорируется, если state=present.

Используется только при state=absent.

Варианты:

  • false ← (по умолчанию)
  • true

connect_params

словарь

добавлено в community.postgresql 2.3.0

Любые дополнительные параметры, которые необходимо передать в libpg.

Эти параметры имеют приоритет.

Значение по умолчанию: {}

cycle

логическое значение

Опция cycle позволяет последовательности циклически повторяться, когда maxvalue или minvalue достигнуты возрастающей или убывающей последовательностью соответственно. Если предел достигнут, следующее сгенерированное число будет minvalue или maxvalue соответственно.

Если false (БЕЗ ЦИКЛА) указано, любые вызовы nextval после того, как последовательность достигла максимального значения, вернут ошибку. False (БЕЗ ЦИКЛА) — значение по умолчанию.

Варианты:

  • false ← (по умолчанию)
  • true

data_type

строка

Указывает тип данных последовательности. Допустимые типы — bigint, integer и smallint. bigint — значение по умолчанию. Тип данных определяет значения по умолчанию для минимального и максимального значений последовательности. Для получения дополнительной информации см. документацию https://www.postgresql.org/docs/current/sql-createsequence.html.

Поддерживается с PostgreSQL 10.

Варианты:

  • "bigint"
  • "integer"
  • "smallint"

db

псевдонимы: database, login_db

строка

Имя базы данных для подключения и выполнения запросов.

Значение по умолчанию: ""

increment

целое число

Параметр increment определяет, какое значение добавляется к текущему значению последовательности для создания нового значения.

Положительное значение создает возрастающую последовательность, отрицательное — убывающую. Значение по умолчанию — 1.

login_host

псевдонимы: host

строка

Хост, на котором работает база данных.

Если возникают проблемы с подключением при использовании localhost, попробуйте использовать 127.0.0.1 вместо этого.

Значение по умолчанию: ""

login_password

строка

Пароль, который этот модуль должен использовать для установления сеанса PostgreSQL.

Значение по умолчанию: ""

login_unix_socket

псевдонимы: unix_socket

строка

Путь к сокету доменной Unix для локальных подключений.

Значение по умолчанию: ""

login_user

псевдонимы: login

строка

Имя пользователя, которое этот модуль должен использовать для установления сеанса PostgreSQL.

Значение по умолчанию: "postgres"

maxvalue

псевдонимы: max

целое число

Maxvalue определяет максимальное значение для последовательности. По умолчанию для возрастающей последовательности — максимальное значение типа данных. По умолчанию для убывающей последовательности — -1.

minvalue

псевдонимы: min

целое число

Minvalue определяет минимальное значение, которое может сгенерировать последовательность. По умолчанию для возрастающей последовательности — 1. По умолчанию для убывающей последовательности — минимальное значение типа данных.

newschema

строка

Новая схема для последовательности. Будет использоваться для перемещения последовательности в другую схему.

Работает только для существующих последовательностей.

owner

строка

Устанавливает владельца для последовательности.

порт

псевдонимы: login_port

целое число

Порт базы данных для подключения.

По умолчанию: 5432

rename_to

строка

Новое имя для последовательности.

Работает только для существующих последовательностей.

схема

строка

Схема последовательности. Используется для создания и перемещения последовательности в заданную схему.

По умолчанию: "public"

последовательность

псевдонимы: имя

строка / обязательно

Имя последовательности.

session_role

строка

Переключение на session_role после подключения. Указанная session_role должна быть ролью, членом которой является текущий login_user.

Проверка разрешений для SQL-команд выполняется так, как будто session_role был первоначальным пользователем, который вошел в систему.

ssl_cert

путь

добавлено в community.postgresql 2.4.0

Указывает имя файла SSL-сертификата клиента.

ssl_key

путь

добавлено в community.postgresql 2.4.0

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

ssl_mode

строка

Определяет, будет ли и с каким приоритетом устанавливаться защищенное SSL TCP/IP-соединение с сервером.

См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах.

Значение по умолчанию prefer соответствует значению по умолчанию libpq.

Варианты:

  • "allow"
  • "disable"
  • "prefer" ← (по умолчанию)
  • "require"
  • "verify-ca"
  • "verify-full"

start

целое число

Параметр start позволяет начать последовательность с любого значения. Значение по умолчанию — minvalue для возрастающих последовательностей и maxvalue для убывающих.

состояние

строка

Состояние последовательности.

Если состояние=отсутствует, другие параметры будут проигнорированы, кроме имя и схема.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

trust_input

булево

добавлено в community.postgresql 0.2.0

Если false, проверяется, являются ли значения параметров последовательность, схема, rename_to, владелец, newschema, session_role потенциально опасными.

Использование false имеет смысл только в том случае, если возможны SQL-инъекции через параметры.

Варианты:

  • false
  • true ← (по умолчанию)

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Позволяет работать в режиме проверки и возвращать прогноз изменения состояния без изменения целевого объекта.

Примечания

Примечание

  • Если вы не передаете параметр db, последовательность будет создана в базе данных с именем postgres.
  • По умолчанию предполагается, что вы вошли в систему или используете sudo с учетной записью postgres на хосте.
  • Чтобы избежать ошибки «Ошибка проверки подлинности клиента для пользователя postgres», используйте пользователя postgres в качестве become_user.
  • Этот модуль использует psycopg, адаптер базы данных Python PostgreSQL. Вы должны убедиться, что psycopg2 >= 2.5.1 или psycopg3 >= 3.1.8 установлены на хосте перед использованием этого модуля.
  • Если удаленный хост — это сервер PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удаленном хосте.
  • Для систем на базе Ubuntu установите пакеты postgresql, libpq-dev, и python3-psycopg2 на удаленном хосте перед использованием этого модуля.

См. также

См. также

community.postgresql.postgresql_table

Создание, удаление или изменение таблицы PostgreSQL.

community.postgresql.postgresql_owner

Изменение владельца объекта базы данных PostgreSQL.

community.postgresql.postgresql_privs

Предоставление или отмена прав доступа к объектам базы данных PostgreSQL.

community.postgresql.postgresql_tablespace

Добавление или удаление табличных пространств PostgreSQL на удаленных хостах.

Ссылка CREATE SEQUENCE

Полное руководство по команде CREATE SEQUENCE.

Ссылка ALTER SEQUENCE

Полное руководство по команде ALTER SEQUENCE.

Ссылка DROP SEQUENCE

Полное руководство по команде DROP SEQUENCE.

Примеры

- name: Create an ascending bigint sequence called foobar in the default
        database
  community.postgresql.postgresql_sequence:
    name: foobar

- name: Create an ascending integer sequence called foobar, starting at 101
  community.postgresql.postgresql_sequence:
    name: foobar
    data_type: integer
    start: 101

- name: Create an descending sequence called foobar, starting at 101 and
        preallocated 10 sequence numbers in cache
  community.postgresql.postgresql_sequence:
    name: foobar
    increment: -1
    cache: 10
    start: 101

- name: Create an ascending sequence called foobar, which cycle between 1 to 10
  community.postgresql.postgresql_sequence:
    name: foobar
    cycle: true
    min: 1
    max: 10

- name: Create an ascending bigint sequence called foobar in the default
        database with owner foobar
  community.postgresql.postgresql_sequence:
    name: foobar
    owner: foobar

- name: Rename an existing sequence named foo to bar
  community.postgresql.postgresql_sequence:
    name: foo
    rename_to: bar

- name: Change the schema of an existing sequence to foobar
  community.postgresql.postgresql_sequence:
    name: foobar
    newschema: foobar

- name: Change the owner of an existing sequence to foobar
  community.postgresql.postgresql_sequence:
    name: foobar
    owner: foobar

- name: Drop a sequence called foobar
  community.postgresql.postgresql_sequence:
    name: foobar
    state: absent

- name: Drop a sequence called foobar with cascade
  community.postgresql.postgresql_sequence:
    name: foobar
    cascade: true
    state: absent

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

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

Ключ

Описание

cycle

boolean

Показывает, циклическая ли последовательность или нет.

Возвращается: success

Пример: false

data_type

string

Показывает текущий тип данных последовательности.

Возвращается: success

Пример: "bigint"

increment

integer

Значение инкремента последовательности. Положительное значение создаст возрастающую последовательность, отрицательное — убывающую.

Возвращается: success

Пример: -1

maxvalue

integer

Значение maxvalue последовательности.

Возвращается: success

Пример: 9223372036854775807

minvalue

integer

Значение minvalue последовательности.

Возвращается: success

Пример: 1

newname

string

Показывает новое имя последовательности после переименования.

Возвращается: success

Пример: "barfoo"

newschema

string

Показывает новую схему последовательности после изменения схемы.

Возвращается: success

Пример: "foobar"

owner

string

Показывает текущего владельца последовательности после успешного выполнения задачи.

Возвращается: success

Пример: "postgres"

queries

string

Список запросов, которые пытались выполнить.

Возвращается: success

Пример: "['CREATE SEQUENCE \"foo\"']"

schema

string

Имя схемы последовательности.

Возвращается: success

Пример: "foo"

sequence

string

Имя последовательности.

Возвращается: success

Пример: "foobar"

start

integer

Значение start последовательности.

Возвращается: success

Пример: 12

state

string

Состояние последовательности в конце выполнения.

Возвращается: success

Пример: "present"

Авторы

  • Tobias Birkefeld (@tcraxs)
  • Thomas O’Donnell (@andytom)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (Исходный код)
  • Сообщить о проблеме
  • Связь

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

Spec-Zone.ru

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