Resource Type: proxy_mysql_query_rule

Defined in:

lib/puppet/type/proxy_mysql_query_rule.rb

Providers:

proxysql

Overview

Manage a ProxySQL mysql_query_rules entry.

Properties

• active

  Is the rule active or not.

  Supported values:

  • %r{[01]}
• apply

  Used to chain rules.

  Supported values:

  • %r{[01]}
• cache_ttl

  The amount of miliseconds to cache the result of this query.

  Supported values:

  • %r{\d+}
• client_addr

  Match traffic from a certain address.

  Supported values:

  • %r{\w+}
• comment

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

  Supported values:

  • %r{[\w+]}
• delay

  number of milliseconds to delay the execution of the query.

  Supported values:

  • %r{\d+}
• destination_hostgroup

  The hostgroup to send this query to.

  Supported values:

  • %r{\d+}
• digest

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

  Supported values:

  • %r{\w+}
• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• error_msg

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

  Supported values:

  • %r{\w+}
• flag_in

  Used to chain rules. This is the id of the previous rule to apply

  Supported values:

  • %r{\d+}
• flag_out

  Used to chain rules. This is the id of the next rule to apply

  Supported values:

  • %r{\d+}
• log

  query will be logged.

  Supported values:

  • %r{[01]}
• match_digest

  regular expression that matches the query digest

  Supported values:

  • %r{\w+}
• match_pattern

  regular expression that matches the query text

  Supported values:

  • %r{\w+}
• mirror_flag_out

  see github.com/sysown/proxysql/blob/master/doc/mirroring.md

  Supported values:

  • %r{\d+}
• mirror_hostgroup

  see github.com/sysown/proxysql/blob/master/doc/mirroring.md.

  Supported values:

  • %r{\d+}
• negate_match_pattern

  if this is set to 1, only queries not matching the query text will be considered as a match. This acts as a NOT operator in front of the regular expression matching against match_pattern or match_digest.

  Supported values:

  • %r{[01]}
• proxy_addr

  Match incoming traffic on a specific local address.

  Supported values:

  • %r{\w+}
• proxy_port

  Match incoming traffic on a specific local port.

  Supported values:

  • %r{\d+}
• reconnect

  feature currently not in use.

  Supported values:

  • %r{[01]}
• replace_pattern

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

  Supported values:

  • %r{\w+}
• retries

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

  Supported values:

  • %r{\d+}
• rule_id

  The id of the query rule.

  Supported values:

  • %r{\d+}
• schemaname

  Schema to apply this rule to.

  Supported values:

  • %r{\w+}
• timeout

  The maximum amount of miliseconds in which the matched or rewritten query should be executed.

  Supported values:

  • %r{\d+}
• username

  Username to apply this rule to.

  Supported values:

  • %r{\w+}

Parameters

• load_to_runtime (defaults to: true)

  Load this entry to the active runtime.

  Supported values:

  • true
  • false
• name (namevar)

  query rule name

• provider

  The specific backend to use for this ‘proxy_mysql_query_rule` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• save_to_disk (defaults to: true)

  Perist this entry to the disk.

  Supported values:

  • true
  • false