Class: Ansible::Ruby::Modules::Postgresql_lang

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

Overview

Adds, removes or changes procedural languages with a PostgreSQL database. This module allows you to add a language, remote a language or change the trust relationship with a PostgreSQL database. The module can be used on the machine where executed or on a remote host. When removing a language from a database, it is possible that dependencies prevent the database from being removed. In that case, you can specify casade to automatically drop objects that depend on the language (such as functions in the language). In case the language can’t be deleted because it is required by the database system, you can specify fail_on_drop=no to ignore the error. Be carefull when marking a language as trusted since this could be a potential security breach. Untrusted languages allow only users with the PostgreSQL superuser privilege to use this language to create new functions.

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

#cascade ⇒ :yes, ...

Returns when dropping a language, also delete object that depend on this language.,only used when C(state=absent).

Returns:

  • (:yes, :no, nil) —

    when dropping a language, also delete object that depend on this language.,only used when C(state=absent).



35
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 35

attribute :cascade

#db ⇒ String?

Returns name of database where the language will be added, removed or changed.

Returns:

  • (String, nil) —

    name of database where the language will be added, removed or changed



23
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 23

attribute :db

#fail_on_drop ⇒ :yes, ...

Returns if C(yes), fail when removing a language. Otherwise just log and continue,in some cases, it is not possible to remove a language (used by the db-system). When dependencies block the removal, consider using C(cascade).

Returns:

  • (:yes, :no, nil) —

    if C(yes), fail when removing a language. Otherwise just log and continue,in some cases, it is not possible to remove a language (used by the db-system). When dependencies block the removal, consider using C(cascade).



31
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 31

attribute :fail_on_drop

#force_trust ⇒ :yes, ...

Returns marks the language as trusted, even if it’s marked as untrusted in pg_pltemplate.,use with care!.

Returns:

  • (:yes, :no, nil) —

    marks the language as trusted, even if it’s marked as untrusted in pg_pltemplate.,use with care!



27
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 27

attribute :force_trust

#lang ⇒ String

Returns name of the procedural language to add, remove or change.

Returns:

  • (String) —

    name of the procedural language to add, remove or change



15
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 15

attribute :lang

#login_host ⇒ String?

Returns Host running PostgreSQL where you want to execute the actions.

Returns:

  • (String, nil) —

    Host running PostgreSQL where you want to execute the actions.



50
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 50

attribute :login_host

#login_password ⇒ Object?

Returns Password used to authenticate with PostgreSQL (must match C(login_user)).

Returns:

  • (Object, nil) —

    Password used to authenticate with PostgreSQL (must match C(login_user))



47
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 47

attribute :login_password

#login_user ⇒ String?

Returns User used to authenticate with PostgreSQL.

Returns:

  • (String, nil) —

    User used to authenticate with PostgreSQL



43
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 43

attribute :login_user

#port ⇒ Integer?

Returns Database port to connect to.

Returns:

  • (Integer, nil) —

    Database port to connect to.



39
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 39

attribute :port

#state ⇒ :present, ...

Returns The state of the language for the selected database.

Returns:

  • (:present, :absent, nil) —

    The state of the language for the selected database



54
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 54

attribute :state

#trust ⇒ :yes, ...

Returns make this language trusted for the selected db.

Returns:

  • (:yes, :no, nil) —

    make this language trusted for the selected db



19
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_lang.rb', line 19

attribute :trust