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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Postgresql_db

Defined in:

lib/ansible/ruby/modules/generated/core/database/postgresql/postgresql_db.rb

Overview

Add or remove PostgreSQL databases from a remote host.

Instance Method Summary

• #encoding ⇒ String^?

  Encoding of the database.

• #lc_collate ⇒ String^?

  Collation order (LC_COLLATE) to use in the database.

• #lc_ctype ⇒ String^?

  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.

• #login_host ⇒ String^?

  Host running the database.

• #login_password ⇒ Object^?

  The password used to authenticate with.

• #login_unix_socket ⇒ Object^?

  Path to a Unix domain socket for local connections.

• #login_user ⇒ Object^?

  The username used to authenticate with.

• #name ⇒ String

  Name of the database to add or remove.

• #owner ⇒ Object^?

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

• #port ⇒ Integer^?

  Database port to connect to.

• #state ⇒ :present, ...

  The database state.

• #template ⇒ String^?

  Template used to create the database.

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #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

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

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.

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

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.

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

attribute :lc_ctype

#login_host ⇒ String^?

Returns Host running the database.

Returns:

• (String, nil) —

  Host running the database

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

attribute :login_host

#login_password ⇒ Object^?

Returns The password used to authenticate with.

Returns:

• (Object, nil) —

  The password used to authenticate with

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

attribute :login_password

#login_unix_socket ⇒ Object^?

Returns Path to a Unix domain socket for local connections.

Returns:

• (Object, nil) —

  Path to a Unix domain socket for local connections

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

attribute :login_unix_socket

#login_user ⇒ Object^?

Returns The username used to authenticate with.

Returns:

• (Object, nil) —

  The username used to authenticate with

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

attribute :login_user

#name ⇒ String

Returns name of the database to add or remove.

Returns:

• (String) —

  name of the database to add or remove

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

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

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

attribute :owner

#port ⇒ Integer^?

Returns Database port to connect to.

Returns:

• (Integer, nil) —

  Database port to connect to.

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

attribute :port

#state ⇒ :present, ...

Returns The database state.

Returns:

• (:present, :absent, nil) —

  The database state

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

attribute :state

#template ⇒ String^?

Returns Template used to create the database.

Returns:

• (String, nil) —

  Template used to create the database

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

attribute :template