MaxScale 24.02 Contents

About MariaDB MaxScale

• About MariaDB MaxScale

• Changelog

• Limitations

Getting Started

• MariaDB MaxScale Installation Guide

• Building MariaDB MaxScale from Source Code

• Configuration Guide

• MaxGUI

Upgrading MariaDB MaxScale

• Upgrading MaxScale

Reference

• MaxCtrl - Command Line Admin Interface

• MaxScale REST API

• Module Commands

• Routing Hints

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.

• MariaDB MaxScale Tutorial

These tutorials are for specific use cases and module combinations.

• Administration Tutorial

• Avro Router Tutorial

• Connection Routing Tutorial

• Filter Tutorial

• MariaDB Monitor Failover Tutorial

• Read Write Splitting Tutorial

• Simple Schema Sharding Tutorial

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

• REST API Tutorial

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.

• Avrorouter

• Binlogrouter

• Cat

• KafkaCDC

• KafkaImporter

• MirrorRouter

• Read Connection Router

• Read Write Split

• Schemarouter

• SmartRouter

The following routers are only available in MaxScale Enterprise.

• Diff

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.

• Binlog Filter

• Cache

• Comment Filter

• Consistent Critical Read Filter

• Hint Filter

• LDIFilter

• Luafilter

• Masking Filter

• Maxrows Filter

• Named Server Filter

• Query Log All

• Regex Filter

• Rewrite Filter

• Tee Filter

• Throttle Filter

• Top N Filter

• Transaction Performance Monitoring Filter

The following filters are only available in MaxScale Enterprise.

• Wcar

Monitors

Common options for all monitor modules.

• Monitor Common

Module specific documentation.

• Galera Monitor

• MariaDB Monitor

Protocols

Documentation for MaxScale protocol modules.

• MariaDB

• Change Data Capture (CDC) Protocol

• Change Data Capture (CDC) Users

• NoSQL

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

• CDC Connector

Authenticators

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

• MariaDB/MySQL Authenticator

• GSSAPI Authenticator

• PAM Authenticator

• Ed25519 Authenticator

_{This page is licensed: CC BY-SA / Gnu FDL}