Commit Graph

206 Commits

Author SHA1 Message Date
6295732bee MXS-2310: Document and install cdc_one_schema.py
Added documentation for the script and installed it as a part of the
default package.
2019-02-04 11:15:38 +02:00
6ab3985164 Auto-generate ToC
The KB supports the [TOC] tag that auto-generates the table of contents.
2019-01-31 14:23:27 +02:00
260ce9b8b8 MXS-2300: Add session command pruning
This commit adds a new parameter that, when enabled, prunes the session
command history to a known length. This makes it possible to keep a
client-side pooled connection open indefinitely at the cost of making
reconnections theoretically unsafe. In practice the maximum history length
can be set to a value that encompasses a single session using the pooled
connection with no risk to session state integrity. The default history
length of 50 commands is quite likely to be adequate for the majority of
use-cases.
2019-01-31 14:23:26 +02:00
7f978f275f MXS-2223 Log a message when a slave is discriminated due to replication lag
Both the replication lag and the message printing state are saved in SERVER,
although the values are mostly used by readwritesplit. A log message is printed
both when a server goes over the limit and when it comes back below.
Because of concurrency issues, a message may be printed multiple times before
different threads detect the new message state.

Documentation updated to explain the change.
2019-01-21 13:02:18 +02:00
88f234fdcd MXS-2214: Fix object names in documentation
The object names now always use a valid and supported form.
2019-01-03 09:37:59 +02:00
1a78f2ffbb Merge branch '2.2' into 2.3 2018-12-04 11:23:31 +02:00
cb878f18b7 Update max_slave_connections documentation
Corrected the default value and added a more detailed explanation of what
the parameter does and how it affects client connections.
2018-11-29 08:47:11 +02:00
ff22624d3c Add table of contents to router documentation
The TOC was added only to the long documentation files to make them easier
to navigate. Also modified the headings for Avro and Binlog routers and did
some minor cleanup.
2018-11-26 10:32:08 +02:00
dcf53da209 Enable connection_keepalive by default
Enabling the feature by default prevents the master connection from dying
during times when there are very little or no writes. Having a modest ping
interval of 300 seconds serves to minimize the amount of extra work that
both MaxScale and the server have to do while still keeping the
connections in good shape.
2018-11-26 09:42:11 +02:00
a883a4f3e0 Fix password documentation
The old parameter was used in some examples and no note about its removal
was in the parameter.
2018-11-06 15:09:14 +02:00
4341c2b6e2 MXS-2142: Set causal_reads_timeout default to 10
The causal_reads_timeout default value is too long when considering the
behavioral changes that MXS-2141 introduced. With a 10 second default
value, a result is returned to the client in a reasonable amount of time.
2018-11-06 15:09:14 +02:00
e56372b153 MXS-2141: Retry query on master if it times out on slave
With causal_reads enabled, the query would return with an error if the
slave was not able to catch up to the master fast enough. By automatically
retrying the query on the master, we're guaranteed that a valid result is
always returned to the client.
2018-11-06 15:09:14 +02:00
8d60bd04d2 MXS-2090 Update documentation 2018-10-19 08:03:11 +03:00
a2ef874fe6 Fix max_sescmd_history documentation
The session commands are now always stored but they are stored as
references. Also clarified that the feature was disabled in older
versions.
2018-10-16 10:59:14 +03:00
9c52ba5c07 Update release notes and documentation for the Throttle Filter
and Adaptive Routing
2018-10-05 13:52:42 +03:00
59d45aabb4 MXS-1980 Update documentation
And release note and change log.
2018-10-05 12:16:18 +03:00
3d06b5129d MXS-1980 Extend test program
Now the test program will

1) Write to each node in a Galera cluster and verify that the data
   ends up in the slave.
2) At the end of 1) execute STOP SLAVE and START SLAVE to check that
   replication can be stopped and started again (won't work unless
   each node has the same server_id and value for @@log_bin_basename).
3) Block the node BLR is replicating from and expect it to connect
   to the next configured master and that replication continues to
   work. Do that for all nodes.
4) Stop MaxScale and restart it and expect 3) to work. That checks
   that BLR saves all necessary information in master.ini and is
   capable of reading it.
2018-10-05 12:16:18 +03:00
0ff72c5d5e Change table sharding to table family sharding 2018-10-04 15:17:54 +03:00
4a01410742 Update schema router documentation 2018-10-04 13:01:40 +03:00
10a8f1d48c Reformat SchemaRouter.md
No content changes.
2018-10-03 14:59:48 +03:00
d5dbad19bb Update readwritesplit documentation
Fixed a few typos, added the 10.2 relese where last_gtid tracking was
enabled, changed wording.
2018-10-03 08:41:44 +03:00
0e5d827f7a Merge branch '2.2' into develop 2018-09-08 18:58:57 +03:00
a0ea37b2c5 MXS-2011 Fix documentation and comments
Fix documentation and comment based upon review comments.
2018-09-04 15:54:21 +03:00
b835befe0f MXS-2011 Add documentation 2018-09-04 15:54:21 +03:00
d7dd636c9a Add table filtering to avrorouter
The filtering is implemented with PCRE2 regular expressions and as such is
not the most user-friendly interface.
2018-09-04 10:50:31 +03:00
8b39373577 MXS-1929: Document readwritesplit runtime changes
Added a note about the new behavior in 2.3.
2018-08-13 10:28:01 +03:00
437a0b92d2 Update ReadWriteSplit documentation
router_options are removed and thus do not need to be explained.
2018-07-17 11:52:21 +03:00
391618d53b MXS-1549: Add documentation for optimistic_trx
Added parameter documentation and explained the limitations it has.
2018-07-02 13:29:18 +03:00
8094c67ac2 Merge branch '2.2' into develop 2018-06-13 00:25:56 +03:00
f5f454a29b MXS-1884 Clarify what a list means 2018-06-12 17:29:00 +03:00
f87fc45511 MXS-1884 Wrap lines of readconnroute documentation
No other changes.
2018-06-12 17:29:00 +03:00
2ed631ab63 Merge branch '2.2' into develop 2018-06-01 13:46:03 +03:00
d77a9a3040 MXS-1889 Handle master used as slave
Up until 2.1.12, if it in the configuration file said
'router_options=slave', the master was used if there were no
slaves at session creation time.

That broke in 2.1.13 as a side-effect of MXS-1516 that checks
at routing time whether the server initially selected as master
still is the master.

Now the required server status is stored separately for each
session, so that if the master was chosen, even though we have
'router_options=slave', we can turn on the SERVER_MASTER bit.

That allows us to handle the case correctly in connection_is_valid().
2018-06-01 11:00:13 +03:00
3dd84e170f MXS-1778: Document causal_reads parameter
Documented and explained the feature and how it works.
2018-05-22 17:46:26 +03:00
0d92b0bc8f Merge branch '2.2' into develop 2018-05-22 16:18:36 +03:00
e7fd8ac6cb Document stopping procedure for avrorouter
The safest way to stop the avrorouter is to stop replication and wait for
the conversion to halt. This was not previously documented and needs to be
mentioned in the router documentation.
2018-05-22 15:44:55 +03:00
2e8c19f6be Merge branch '2.2' into develop 2018-05-21 10:06:20 +03:00
bdde3c44d9 Document slave_selection_criteria and weightby interaction
Documented how the slave_selection_criteria and server weights work.
2018-05-21 09:50:43 +03:00
96af90628f Add notes about experimental modules
Added a note to the documentation of experimental modules that explains
that the modules are distributed in a different package.
2018-04-27 12:31:53 +03:00
84ec46d6f0 MXS-1752: Warn that module is not GA
The module is not GA quality software so a warning should be given in the
documentation.
2018-04-27 12:31:52 +03:00
2cfa66ff7d MXS-1752: Clarify router behavior
Amended the documentation to specify the exact behavior of the router when
non-resultset results are returned.
2018-04-27 12:31:52 +03:00
6cd75cc31c MXS-1752: Add cat documentation
Added documentation for the `cat` router.
2018-04-27 12:31:49 +03:00
092532745d MXS-1507: Add transaction size limit
Added the `transaction_replay_max_size` parameter that controls the
maximum size of a transaction that can be replayed. If the limit is
exceeded, the stored statements are released thus preventing the
transaction from being replayed.

This limitation prevents accidental misuse of the transaction replaying
system when autocommit is disabled. It also allows the user to control the
amount of memory that MaxScale will use.
2018-04-26 13:44:26 +03:00
cb5917b346 MXS-1507: Clarify transaction replay limitations
Only transactions that return identical results can be replayed.
2018-04-26 13:44:26 +03:00
2848f96945 MXS-1507: Make transaction replay configurable
The transaction retrying behavior is now configurable and documented. The
`transaction_replay` parameter implicitly enables the required
functionality in the router that it needs.
2018-04-26 13:44:25 +03:00
23bc8b6db6 MXS-1506: Document delayed_retry
Document the parameters and how they interact with `master_reconnection`.
2018-04-10 15:31:51 +03:00
ce853d3f7f MXS-1503: Enable limited session command history
Enabling the session command history but limiting it to a history of 50
commands allows reconnections for sessions that don't change the state too
often.

As pooled connections will exceed this limit quite fast, they are not able
to reconnect to servers once connections are lost. To solve this problem,
the session command history needs a compaction process that removes
redundant history.
2018-04-03 13:30:53 +03:00
dd59e7181c Remove references to router_options
As they are deprecated, they should not be mentioned in the examples. Also
moved the router_options documentation under a Legacy Configuration
heading.
2018-04-03 13:30:53 +03:00
481db8acbc MXS-359: Rename parameter to master_reconnection
Changing the parameter name to `master_reconnection` allows similar
reconnection functionality to be combined under one parameter.
2018-04-03 13:30:51 +03:00
33e448fc78 MXS-359: Document interaction of master_failure_mode and allow_master_change
Added a paragraph that describes the expected behavior of the router when
both `master_failure_mode` and `allow_master_change` are enabled.
2018-03-14 14:34:49 +02:00