Class: Ansible::Ruby::Modules::Proxysql_query_rules

Inherits:

Base

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

Defined in:

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

Overview

The M(proxysql_query_rules) module modifies query rules using the proxysql admin interface.

Instance Method Summary

• #active ⇒ Integer^?

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

• #apply ⇒ Object^?

  Used in combination with I(flagIN) and I(flagOUT) to create chains of rules.

• #cache_ttl ⇒ Object^?

  The number of milliseconds for which to cache the result of the query.

• #client_addr ⇒ Object^?

  Match traffic from a specific source.

• #comment ⇒ Object^?

  Free form text field, usable for a descriptive comment of the query rule.

• #delay ⇒ Object^?

  Number of milliseconds to delay the execution of the query.

• #destination_hostgroup ⇒ Integer^?

  Route matched queries to this hostgroup.

• #digest ⇒ Object^?

  Match queries with a specific digest, as returned by stats_mysql_query_digest.digest.

• #error_msg ⇒ Object^?

  Query will be blocked, and the specified error_msg will be returned to the client.

• #flagIN ⇒ Object^?

  Used in combination with I(flagOUT) and I(apply) to create chains of rules.

• #flagOUT ⇒ Object^?

  Used in combination with I(flagIN) and apply to create chains of rules.

• #force_delete ⇒ Boolean^?

  By default we avoid deleting more than one schedule in a single batch, however if you need this behaviour and you’re not concerned about the schedules deleted, you can set I(force_delete) to C(True).

• #log ⇒ Object^?

  Query will be logged.

• #match_digest ⇒ Object^?

  Regular expression that matches the query digest.

• #match_pattern ⇒ String^?

  Regular expression that matches the query text.

• #mirror_flagOUT ⇒ Object^?

  Enables query mirroring.

• #mirror_hostgroup ⇒ Object^?

  Enables query mirroring.

• #negate_match_pattern ⇒ Object^?

  If I(negate_match_pattern) is set to C(True), only queries not matching the query text will be considered as a match.

• #proxy_addr ⇒ Object^?

  Match incoming traffic on a specific local IP.

• #proxy_port ⇒ Object^?

  Match incoming traffic on a specific local port.

• #replace_pattern ⇒ Object^?

  This is the pattern with which to replace the matched pattern.

• #retries ⇒ Integer^?

  The maximum number of times a query needs to be re-executed in case of detected failure during the execution of the query.

• #rule_id ⇒ Object^?

  The unique id of the rule.

• #schemaname ⇒ Object^?

  Filtering criteria matching schemaname.

• #state ⇒ :present, ...

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

• #timeout ⇒ Object^?

  The maximum timeout in milliseconds with which the matched or rewritten query should be executed.

• #username ⇒ String^?

  Filtering criteria matching username.

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

#active ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 15

attribute :active

#apply ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 86

attribute :apply

#cache_ttl ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 61

attribute :cache_ttl

#client_addr ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 29

attribute :client_addr

#comment ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 89

attribute :comment

#delay ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 71

attribute :delay

#destination_hostgroup ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 57

attribute :destination_hostgroup

#digest ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 38

attribute :digest

#error_msg ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 80

attribute :error_msg

#flagIN ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 26

attribute :flagIN

#flagOUT ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 51

attribute :flagOUT

#force_delete ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 96

attribute :force_delete

#log ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 83

attribute :log

#match_digest ⇒ Object^?

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

attribute :match_digest

#match_pattern ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 44

attribute :match_pattern

#mirror_flagOUT ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 74

attribute :mirror_flagOUT

#mirror_hostgroup ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 77

attribute :mirror_hostgroup

#negate_match_pattern ⇒ Object^?

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

attribute :negate_match_pattern

#proxy_addr ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 32

attribute :proxy_addr

#proxy_port ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 35

attribute :proxy_port

#replace_pattern ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 54

attribute :replace_pattern

#retries ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 67

attribute :retries

#rule_id ⇒ Object^?

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

attribute :rule_id

#schemaname ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 23

attribute :schemaname

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 92

attribute :state

#timeout ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_query_rules.rb', line 64

attribute :timeout

#username ⇒ String^?

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

attribute :username