MaxScale 23.02 Contents
Contents
About MariaDB MaxScale
Getting Started
- MariaDB MaxScale Installation Guide
- Building MariaDB MaxScale from Source Code
- Configuration Guide
- MaxGUI
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.
- 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.
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
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
- 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
Monitors
Common options for all monitor modules.
Module specific documentation.
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.
