community.proxysql.proxysql_query_rules module – Modifies query rules using the proxysql admin interface
Note
This module is part of the community.proxysql collection (version 1.6.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.proxysql.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.proxysql.proxysql_query_rules.
Synopsis
The community.proxysql.proxysql_query_rules module modifies query rules using the proxysql admin interface.
Requirements
The below requirements are needed on the host that executes this module.
PyMySQL
mysqlclient
Parameters
Parameter |
Comments |
|---|---|
A rule with active set to Choices:
|
|
Used in combination with flagIN and flagOUT to create chains of rules. Setting apply to True signifies the last rule to be applied. Choices:
|
|
Controls if resultset without rows will be cached or not. Choices:
|
|
The number of milliseconds for which to cache the result of the query. Note in ProxySQL 1.1 cache_ttl was in seconds. |
|
Match traffic from a specific source. |
|
Free form text field, usable for a descriptive comment of the query rule. |
|
Specify a config file from which login_user and login_password are to be read. Default: |
|
Number of milliseconds to delay the execution of the query. This is essentially a throttling mechanism and QoS, and allows a way to give priority to queries over others. This value is added to the mysql-default_query_delay global variable that applies to all queries. |
|
Route matched queries to this hostgroup. This happens unless there is a started transaction and the logged in user has transaction_persistent set to |
|
Match queries with a specific digest, as returned by stats_mysql_query_digest.digest. |
|
Query will be blocked, and the specified error_msg will be returned to the client. |
|
Used in combination with flagOUT and apply to create chains of rules. |
|
Used in combination with flagIN and apply to create chains of rules. When set, flagOUT signifies the flagIN to be used in the next chain of rules. |
|
By default we avoid deleting more than one schedule in a single batch, however if you need this behaviour and you are not concerned about the schedules deleted, you can set force_delete to Choices:
|
|
Dynamically load config to runtime memory. Choices:
|
|
Query will be logged. Choices:
|
|
The host used to connect to ProxySQL admin interface. Default: |
|
The password used to authenticate to ProxySQL admin interface. |
|
The port used to connect to ProxySQL admin interface. Default: |
|
The socket used to connect to ProxySQL admin interface. |
|
The username used to authenticate to ProxySQL admin interface. |
|
Regular expression that matches the query digest. The dialect of regular expressions used is that of re2 - https://github.com/google/re2. |
|
Regular expression that matches the query text. The dialect of regular expressions used is that of re2 - https://github.com/google/re2. |
|
Enables query mirroring. If set mirror_flagOUT can be used to evaluates the mirrored query against the specified chain of rules. |
|
Enables query mirroring. If set mirror_hostgroup can be used to mirror queries to the same or different hostgroup. |
|
If If If By default, does not change multiplexing policies. Choices:
|
|
If negate_match_pattern is set to Choices:
|
|
When is set, its value will become the flagIN value for the next queries. |
|
The specified message will be returned for a query that uses the defined rule. |
|
Match incoming traffic on a specific local IP. |
|
Match incoming traffic on a specific local port. |
|
Comma separated list of options to modify the behavior of the RE engine. With |
|
This is the pattern with which to replace the matched pattern. Note that this is optional, and when omitted, the query processor will only cache, route, or set other parameters without rewriting. |
|
The maximum number of times a query needs to be re-executed in case of detected failure during the execution of the query. If retries is not specified, the global variable mysql-query_retries_on_failure applies. |
|
The unique id of the rule. Rules are processed in rule_id order. |
|
Save config to sqlite db on disk to persist the configuration. Choices:
|
|
Filtering criteria matching schemaname. If schemaname is non-NULL, a query will match only if the connection uses schemaname as its default schema. |
|
When Choices:
|
|
The maximum timeout in milliseconds with which the matched or rewritten query should be executed. If a query run for longer than the specific threshold, the query is automatically killed. If timeout is not specified, the global variable mysql-default_query_timeout applies. |
|
Filtering criteria matching username. If username is non-NULL, a query will match only if the connection is made with the correct username. |
Notes
Note
Supports
check_mode.
Examples
---
# This example adds a rule to redirect queries from a specific user to another
# hostgroup, it saves the mysql query rule config to disk, but avoids loading
# the mysql query config config to runtime (this might be because several
# rules are being added and the user wants to push the config to runtime in a
# single batch using the community.general.proxysql_manage_config module). It
# uses supplied credentials to connect to the proxysql admin interface.
- name: Add a rule
community.proxysql.proxysql_query_rules:
login_user: admin
login_password: admin
username: 'guest_ro'
match_pattern: "^SELECT.*"
destination_hostgroup: 1
active: 1
retries: 3
state: present
load_to_runtime: false
# This example demonstrates the situation, if your application tries to set a
# variable that will disable multiplexing, and you think it can be filtered out,
# you can create a filter that returns OK without executing the request.
- name: Add a filter rule
community.proxysql.proxysql_query_rules:
login_user: admin
login_password: admin
match_digest: '^SET @@wait_timeout = ?'
active: 1
OK_msg: 'The wait_timeout variable is ignored'
# This example adds a caching rule for a query that matches the digest.
# The query digest can be obtained from the `stats_mysql_query_digest`
# table. `cache_ttl` is specified in milliseconds. Empty responses are
# not cached.
- name: Add a cache rule
community.proxysql.proxysql_query_rules:
login_user: admin
login_password: admin
rule_id: 1
digest: 0xECA450EA500A9A55
cache_ttl: 30000
cache_empty_result: false
destination_hostgroup: 1
active: true
state: present
save_to_disk: true
load_to_runtime: true
# This example demonstrates how to prevent disabling multiplexing for
# situations where a request contains @.
- name: Add a rule with multiplex
community.proxysql.proxysql_query_rules:
login_user: admin
login_password: admin
rule_id: 1
active: 1
match_digest: '^SELECT @@max_allowed_packet'
multiplex: 2
# This example demonstrates how to use next_query_flagIN argument. It allows
# ProxySQL query rules to be chained. The examples shows how you can have SELECTS
# immediately follow INSERT/UPDATE/DELETE statements to query the primary hostgroup
# and avoid replication lag
- name: Add insert query rule
proxysql_query_rules:
match_digest: "^INSERT"
destination_hostgroup: 1,
next_query_flagIN: 1
- name: Add update query rule
proxysql_query_rules:
match_digest: "^UPDATE"
destination_hostgroup: 1,
next_query_flagIN: 1
- name: Add delete query rules
proxysql_query_rules:
match_digest: "^DELETE"
destination_hostgroup: 1,
next_query_flagIN: 1
- name: Add insert query rules
proxysql_query_rules:
match_digest: ".*"
destination_hostgroup: 1,
next_query_flagIN: 1
comment: Match every queries after an INSERT/UPDATE/DELETE query
# This example removes all rules that use the username 'guest_ro', saves the
# mysql query rule config to disk, and dynamically loads the mysql query rule
# config to runtime. It uses credentials in a supplied config file to connect
# to the proxysql admin interface.
- name: Remove rules
community.proxysql.proxysql_query_rules:
config_file: '~/proxysql.cnf'
username: 'guest_ro'
state: absent
force_delete: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The mysql user modified or removed from proxysql. Returned: On create/update will return the newly modified rule, in all other cases will return a list of rules that match the supplied criteria. Sample: |