community.general.vertica_schema module – Adds or removes Vertica database schema and roles
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.vertica_schema
.
Synopsis
Adds or removes Vertica database schema and, optionally, roles with schema access privileges.
A schema will not be removed until all the objects have been dropped.
In such a situation, if the module tries to remove the schema it will fail and only remove roles created for the schema if they have no dependencies.
Aliases: database.vertica.vertica_schema
Requirements
The below requirements are needed on the host that executes this module.
unixODBC
pyodbc
Parameters
Parameter |
Comments |
---|---|
Name of the Vertica cluster. Default: |
|
Comma separated list of roles to create and grant usage and create access to the schema. |
|
Name of the Vertica database. |
|
The password used to authenticate with. |
|
The username used to authenticate with. Default: |
|
Name of the user to set as owner of the schema. |
|
Vertica cluster port to connect to. Default: |
|
Name of the schema to add or remove. |
|
Whether to create Choices:
|
|
Comma separated list of roles to create and grant usage access to the schema. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
The default authentication assumes that you are either logging in as or sudo’ing to the
dbadmin
account on the host.This module uses
pyodbc
, a Python ODBC database adapter. You must ensure thatunixODBC
andpyodbc
is installed on the host and properly configured.Configuring
unixODBC
for Vertica requiresDriver = /opt/vertica/lib64/libverticaodbc.so
to be added to theVertica
section of either/etc/odbcinst.ini
or$HOME/.odbcinst.ini
and bothErrorMessagesPath = /opt/vertica/lib64
andDriverManagerEncoding = UTF-16
to be added to theDriver
section of either/etc/vertica.ini
or$HOME/.vertica.ini
.
Examples
- name: Creating a new vertica schema
community.general.vertica_schema: name=schema_name db=db_name state=present
- name: Creating a new schema with specific schema owner
community.general.vertica_schema: name=schema_name owner=dbowner db=db_name state=present
- name: Creating a new schema with roles
community.general.vertica_schema:
name=schema_name
create_roles=schema_name_all
usage_roles=schema_name_ro,schema_name_rw
db=db_name
state=present