The Ultimate Guide to High Availability with MariaDB
This is a read-only copy of the MariaDB Knowledgebase generated on 2024-12-26. For the latest, interactive version please visit https://mariadb.com/kb/.

MaxScale 2.3 Contents

Contents

About MariaDB MaxScale

Getting Started

Upgrading MariaDB MaxScale

Reference

Tutorials

The main tutorial for MariaDB MaxScale consist of setting up MariaDB MaxScale for the environment you are using with either a connection-based or a read/write-based configuration.

These tutorials are for specific use cases and module combinations.

Here are tutorials on monitoring and managing MariaDB MaxScale in cluster environments.

Routers

The routing module is the core of a MariaDB MaxScale service. The router documentation contains all module specific configuration options and detailed explanations of their use.

There are also two diagnostic routing modules. The CLI is for MaxAdmin and the Debug CLI client for Telnet.

Filters

Here are detailed documents about the filters MariaDB MaxScale offers. They contain configuration guides and example use cases. Before reading these, you should have read the filter tutorial so that you know how they work and how to configure them.

Monitors

Common options for all monitor modules.

Module specific documentation.

Legacy monitors that have been deprecated.

Protocols

Documentation for MaxScale protocol modules.

The MaxScale CDC Connector provides a C++ API for consuming data from a CDC system.

Authenticators

A short description of the authentication module type can be found in the Authentication Modules document.

Utilities

Design Documents

Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.