hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove references to router_options

Browse Source 
As they are deprecated, they should not be mentioned in the examples. Also
moved the router_options documentation under a Legacy Configuration
heading.
This commit is contained in:
Markus Mäkelä
2018-03-28 13:42:39 +03:00
parent 7e4665b03b
commit dd59e7181c
1 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
Documentation/Routers/ReadWriteSplit.md
View File

@ -29,7 +29,7 @@ the name is used later as a reference in a listener section.
For more details about the standard service parameters, refer to the For more details about the standard service parameters, refer to the
[Configuration Guide](../Getting-Started/Configuration-Guide.md). [Configuration Guide](../Getting-Started/Configuration-Guide.md).
## Optional parameters ## Parameters
### `max_slave_connections` ### `max_slave_connections`
@ -74,10 +74,6 @@ with embedded session variable modifications, such as:
In above-mentioned case the user-defined variable would only be updated in the In above-mentioned case the user-defined variable would only be updated in the
master where the query would be routed to due to the `INSERT` statement. master where the query would be routed to due to the `INSERT` statement.
**Note:** As of version 2.1 of MaxScale, all of the router options can also be
defined as parameters. The values defined in _router_options_ will have priority
over the parameters.
``` ```
[Splitter Service] [Splitter Service]
type=service type=service
@ -131,26 +127,6 @@ connected to is promoted as the master, the session will come out of the
read-only mode (described in detail in the read-only mode (described in detail in the
[`master_failure_mode`](#master_failure_mode) documentation). [`master_failure_mode`](#master_failure_mode) documentation).
## Router options
**`router_options`** may include multiple **readwritesplit**-specific options.
All the options are parameter-value pairs. All parameters listed in this section
must be configured as a value in `router_options`.
Multiple options can be defined as a comma-separated list of parameter-value
pairs.
```
router_options=<option>,<option>
```
For example, to set **`slave_selection_criteria`** and
**`disable_sescmd_history`**, write
```
router_options=slave_selection_criteria=LEAST_GLOBAL_CONNECTIONS,disable_sescmd_history=true
```
### `slave_selection_criteria` ### `slave_selection_criteria`
This option controls how the readwritesplit router chooses the slaves it This option controls how the readwritesplit router chooses the slaves it
@ -161,7 +137,7 @@ read queries to the slave server with the lowest amount of ongoing queries i.e.
The option syntax: The option syntax:
``` ```
router_options=slave_selection_criteria=<criteria> slave_selection_criteria=<criteria>
``` ```
Where `<criteria>` is one of the following values. Where `<criteria>` is one of the following values.
@ -205,7 +181,7 @@ unlimited number of session commands.
``` ```
# Set a limit on the session command history # Set a limit on the session command history
router_options=max_sescmd_history=1500 max_sescmd_history=1500
``` ```
When a limitation is set, it effectively creates a cap on the session's memory When a limitation is set, it effectively creates a cap on the session's memory
@ -228,7 +204,7 @@ Starting with version 2.1, the session command history is disabled by default.
``` ```
# Disable the session command history # Disable the session command history
router_options=disable_sescmd_history=true disable_sescmd_history=true
``` ```
### `master_accept_reads` ### `master_accept_reads`
@ -241,7 +217,7 @@ By default, no reads are sent to the master.
``` ```
# Use the master for reads # Use the master for reads
router_options=master_accept_reads=true master_accept_reads=true
``` ```
### `strict_multi_stmt` ### `strict_multi_stmt`
@ -262,7 +238,7 @@ query.
``` ```
# Enable strict multi-statement mode # Enable strict multi-statement mode
router_options=strict_multi_stmt=true strict_multi_stmt=true
``` ```
### `strict_sp_calls` ### `strict_sp_calls`
@ -325,6 +301,30 @@ hints when you are sure that they can cause no harm.
For a list of readwritesplit limitations, please read the For a list of readwritesplit limitations, please read the
[Limitations](../About/Limitations.md) document. [Limitations](../About/Limitations.md) document.
## Legacy Configuration
In older versions of MaxScale, routers were configured via the _router_options_
parameter. This functionality is deprecated and should not be used.
**`router_options`** may include multiple **readwritesplit**-specific options.
All the options are parameter-value pairs. All parameters listed in this section
must be configured as a value in `router_options`.
Multiple options can be defined as a comma-separated list of parameter-value
pairs.
```
router_options=<option>,<option>
```
For example, to set **`slave_selection_criteria`** and
**`disable_sescmd_history`**, write
```
router_options=slave_selection_criteria=LEAST_GLOBAL_CONNECTIONS,disable_sescmd_history=true
```
## Examples ## Examples
Examples of the readwritesplit router in use can be found in the Examples of the readwritesplit router in use can be found in the