Class: Ansible::Ruby::Modules::Vertica_schema

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#cluster ⇒ String?

Returns Name of the Vertica cluster.

Returns:

  • (String, nil) —

    Name of the Vertica cluster.



38
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 38

attribute :cluster

#create_roles ⇒ String?

Returns Comma separated list of roles to create and grant usage and create access to the schema.

Returns:

  • (String, nil) —

    Comma separated list of roles to create and grant usage and create access to the schema.



22
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 22

attribute :create_roles

#db ⇒ String?

Returns Name of the Vertica database.

Returns:

  • (String, nil) —

    Name of the Vertica database.



34
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 34

attribute :db

#login_password ⇒ Object?

Returns The password used to authenticate with.

Returns:

  • (Object, nil) —

    The password used to authenticate with.



50
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 50

attribute :login_password

#login_user ⇒ String?

Returns The username used to authenticate with.

Returns:

  • (String, nil) —

    The username used to authenticate with.



46
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 46

attribute :login_user

#name ⇒ String

Returns Name of the schema to add or remove.

Returns:

  • (String) —

    Name of the schema to add or remove.



14
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 14

attribute :name

#owner ⇒ String?

Returns Name of the user to set as owner of the schema.

Returns:

  • (String, nil) —

    Name of the user to set as owner of the schema.



26
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 26

attribute :owner

#port ⇒ Integer?

Returns Vertica cluster port to connect to.

Returns:

  • (Integer, nil) —

    Vertica cluster port to connect to.



42
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 42

attribute :port

#state ⇒ :present, ...

Returns Whether to create C(present), or drop C(absent) a schema.

Returns:

  • (:present, :absent, nil) —

    Whether to create C(present), or drop C(absent) a schema.



30
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 30

attribute :state

#usage_roles ⇒ Array<String>, ...

Returns Comma separated list of roles to create and grant usage access to the schema.

Returns:

  • (Array<String>, String, nil) —

    Comma separated list of roles to create and grant usage access to the schema.



18
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_schema.rb', line 18

attribute :usage_roles