Class: Ansible::Ruby::Modules::Proxysql_mysql_users

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb

Overview

The M(proxysql_mysql_users) module adds or removes mysql users using the proxysql admin interface.

Instance Method Summary

• #active ⇒ Object^?

  A user with I(active) set to C(False) will be tracked in the database, but will be never loaded in the in-memory data structures.

• #backend ⇒ Boolean^?

  If I(backend) is set to C(True), this (username, password) pair is used for authenticating to the ProxySQL instance.

• #default_hostgroup ⇒ Object^?

  If there is no matching rule for the queries sent by this user, the traffic it generates is sent to the specified hostgroup.

• #default_schema ⇒ Object^?

  The schema to which the connection should change to by default.

• #fast_forward ⇒ Object^?

  If I(fast_forward) is set to C(True), I(fast_forward) will bypass the query processing layer (rewriting, caching) and pass through the query directly as is to the backend server.

• #frontend ⇒ Boolean^?

  If I(frontend) is set to C(True), this (username, password) pair is used for authenticating to the mysqld servers against any hostgroup.

• #max_connections ⇒ Object^?

  The maximum number of connections ProxySQL will open to the backend for this user.

• #password ⇒ Object^?

  Password of the user connecting to the mysqld or ProxySQL instance.

• #state ⇒ :present, ...

  When C(present) - adds the user, when C(absent) - removes the user.

• #transaction_persistent ⇒ Object^?

  If this is set for the user with which the MySQL client is connecting to ProxySQL (thus a “frontend” user), transactions started within a hostgroup will remain within that hostgroup regardless of any other rules.

• #use_ssl ⇒ Object^?

  If I(use_ssl) is set to C(True), connections by this user will be made using SSL connections.

• #username ⇒ String

  Name of the user connecting to the mysqld or ProxySQL instance.

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

#active ⇒ Object^?

Returns A user with I(active) set to C(False) will be tracked in the database, but will be never loaded in the in-memory data structures. If omitted the proxysql database default for I(active) is C(True).

Returns:

• (Object, nil) —

  A user with I(active) set to C(False) will be tracked in the database, but will be never loaded in the in-memory data structures. If omitted the proxysql database default for I(active) is C(True).

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 19

attribute :active

#backend ⇒ Boolean^?

Returns If I(backend) is set to C(True), this (username, password) pair is used for authenticating to the ProxySQL instance.

Returns:

• (Boolean, nil) —

  If I(backend) is set to C(True), this (username, password) pair is used for authenticating to the ProxySQL instance.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 37

attribute :backend

#default_hostgroup ⇒ Object^?

Returns If there is no matching rule for the queries sent by this user, the traffic it generates is sent to the specified hostgroup. If omitted the proxysql database default for I(use_ssl) is 0.

Returns:

• (Object, nil) —

  If there is no matching rule for the queries sent by this user, the traffic it generates is sent to the specified hostgroup. If omitted the proxysql database default for I(use_ssl) is 0.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 25

attribute :default_hostgroup

#default_schema ⇒ Object^?

Returns The schema to which the connection should change to by default.

Returns:

• (Object, nil) —

  The schema to which the connection should change to by default.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 28

attribute :default_schema

#fast_forward ⇒ Object^?

Returns If I(fast_forward) is set to C(True), I(fast_forward) will bypass the query processing layer (rewriting, caching) and pass through the query directly as is to the backend server. If omitted the proxysql database default for I(fast_forward) is C(False).

Returns:

• (Object, nil) —

  If I(fast_forward) is set to C(True), I(fast_forward) will bypass the query processing layer (rewriting, caching) and pass through the query directly as is to the backend server. If omitted the proxysql database default for I(fast_forward) is C(False).

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 34

attribute :fast_forward

#frontend ⇒ Boolean^?

Returns If I(frontend) is set to C(True), this (username, password) pair is used for authenticating to the mysqld servers against any hostgroup.

Returns:

• (Boolean, nil) —

  If I(frontend) is set to C(True), this (username, password) pair is used for authenticating to the mysqld servers against any hostgroup.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 41

attribute :frontend

#max_connections ⇒ Object^?

Returns The maximum number of connections ProxySQL will open to the backend for this user. If omitted the proxysql database default for I(max_connections) is 10000.

Returns:

• (Object, nil) —

  The maximum number of connections ProxySQL will open to the backend for this user. If omitted the proxysql database default for I(max_connections) is 10000.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 45

attribute :max_connections

#password ⇒ Object^?

Returns Password of the user connecting to the mysqld or ProxySQL instance.

Returns:

• (Object, nil) —

  Password of the user connecting to the mysqld or ProxySQL instance.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 16

attribute :password

#state ⇒ :present, ...

Returns When C(present) - adds the user, when C(absent) - removes the user.

Returns:

• (:present, :absent, nil) —

  When C(present) - adds the user, when C(absent) - removes the user.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 48

attribute :state

#transaction_persistent ⇒ Object^?

Returns If this is set for the user with which the MySQL client is connecting to ProxySQL (thus a “frontend” user), transactions started within a hostgroup will remain within that hostgroup regardless of any other rules. If omitted the proxysql database default for I(transaction_persistent) is C(False).

Returns:

• (Object, nil) —

  If this is set for the user with which the MySQL client is connecting to ProxySQL (thus a “frontend” user), transactions started within a hostgroup will remain within that hostgroup regardless of any other rules. If omitted the proxysql database default for I(transaction_persistent) is C(False).

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 31

attribute :transaction_persistent

#use_ssl ⇒ Object^?

Returns If I(use_ssl) is set to C(True), connections by this user will be made using SSL connections. If omitted the proxysql database default for I(use_ssl) is C(False).

Returns:

• (Object, nil) —

  If I(use_ssl) is set to C(True), connections by this user will be made using SSL connections. If omitted the proxysql database default for I(use_ssl) is C(False).

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 22

attribute :use_ssl

#username ⇒ String

Returns Name of the user connecting to the mysqld or ProxySQL instance.

Returns:

• (String) —

  Name of the user connecting to the mysqld or ProxySQL instance.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_mysql_users.rb', line 12

attribute :username