Class: Ansible::Ruby::Modules::Postgresql_db

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

Overview

Add or remove PostgreSQL databases from a remote host.

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

#encoding ⇒ String?

Returns Encoding of the database.

Returns:

  • (String, nil) —

    Encoding of the database



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

attribute :encoding

#lc_collate ⇒ String?

Returns Collation order (LC_COLLATE) to use in the database. Must match collation order of template database unless C(template0) is used as template.

Returns:

  • (String, nil) —

    Collation order (LC_COLLATE) to use in the database. Must match collation order of template database unless C(template0) is used as template.



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

attribute :lc_collate

#lc_ctype ⇒ String?

Returns Character classification (LC_CTYPE) to use in the database (e.g. lower, upper, …) Must match LC_CTYPE of template database unless C(template0) is used as template.

Returns:

  • (String, nil) —

    Character classification (LC_CTYPE) to use in the database (e.g. lower, upper, …) Must match LC_CTYPE of template database unless C(template0) is used as template.



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

attribute :lc_ctype

#maintenance_db ⇒ String?

Returns The value specifies the initial database (which is also called as maintenance DB) that Ansible connects to.

Returns:

  • (String, nil) —

    The value specifies the initial database (which is also called as maintenance DB) that Ansible connects to.



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

attribute :maintenance_db

#name ⇒ String

Returns name of the database to add or remove.

Returns:

  • (String) —

    name of the database to add or remove



12
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_db.rb', line 12

attribute :name

#owner ⇒ Object?

Returns Name of the role to set as owner of the database.

Returns:

  • (Object, nil) —

    Name of the role to set as owner of the database



16
 
# File 'lib/ansible/ruby/modules/generated/database/postgresql/postgresql_db.rb', line 16

attribute :owner

#state ⇒ :present, ...

Returns The database state. present implies that the database should be created if necessary.rnabsent implies that the database should be removed if present.rndump requires a target definition to which the database will be backed up.rn(Added in 2.4) restore also requires a target definition from which the database will be restored.rn(Added in 2.4) The format of the backup will be detected based on the target name.rnSupported compression formats for dump and restore are: .bz2, .gz, and .xzrnSupported formats for dump and restore are: .sql and .tarrn.

Returns:

  • (:present, :absent, :dump, :restore, nil) —

    The database state. present implies that the database should be created if necessary.rnabsent implies that the database should be removed if present.rndump requires a target definition to which the database will be backed up.rn(Added in 2.4) restore also requires a target definition from which the database will be restored.rn(Added in 2.4) The format of the backup will be detected based on the target name.rnSupported compression formats for dump and restore are: .bz2, .gz, and .xzrnSupported formats for dump and restore are: .sql and .tarrn



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

attribute :state

#target ⇒ String?

Returns File to back up or restore from. Used when state is “dump” or “restore”.

Returns:

  • (String, nil) —

    File to back up or restore from. Used when state is “dump” or “restore”



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

attribute :target

#target_opts ⇒ String?

Returns Further arguments for pg_dump or pg_restore. Used when state is “dump” or “restore”.

Returns:

  • (String, nil) —

    Further arguments for pg_dump or pg_restore. Used when state is “dump” or “restore”



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

attribute :target_opts

#template ⇒ String?

Returns Template used to create the database.

Returns:

  • (String, nil) —

    Template used to create the database



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

attribute :template