MariaDB MaxScale 23.08
MariaDB MaxScale 23.08 added the LDI filter for bulk data loading, Kafka improvements, and further MaxGUI enhancements.
About MariaDB MaxScale
MariaDB MaxScale is a database proxy that forwards database statements to one or more database servers.
Every change in each 23.08 point release, in the release notes.
This document lists known issues and limitations in MariaDB MaxScale and its plugins.
Getting Started
We recommend to install MaxScale on a separate server, to ensure that there can be no competition of resources between MaxScale and a MariaDB Server that it manages.
MariaDB MaxScale can be built on any system that meets the requirements.
This document describes how to configure MariaDB MaxScale and presents some possible usage scenarios.
MaxGUI is a browser-based interface for MaxScale REST-API and query execution.
Upgrading MariaDB MaxScale
For more information about what has changed, please refer to the ChangeLog and to the release notes.
Reference
MaxCtrl is a command line administrative client for MaxScale which uses the MaxScale REST API for communication.
Version 1 of the MaxScale REST API: resources, endpoints, and response formats.
Introduced in MaxScale 2.1, the module commands are special, module-specific commands.
Routing individual queries with hints. The syntax itself is documented with the Hintfilter.
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.
This document is designed as a quick introduction to setting up MariaDB MaxScale.
These tutorials are for specific use cases and module combinations.
The purpose of this tutorial is to introduce the MariaDB MaxScale Administrator to a few of the common administration tasks.
This tutorial is a short introduction to the Avrorouter, how to set it up and how it interacts with the binlogrouter.
The goal of this tutorial is to configure a system that has two ports available, one for write connections and another for read connections.
The filter mechanism in MariaDB MaxScale is a means by which processing can be inserted into the flow of requests and responses between the client connection to MariaDBā¦
The MariaDB Monitor is not only capable of monitoring the state of a MariaDB primary-replica cluster but is also capable of performing failover and switchover.
The goal of this tutorial is to configure a system that appears to the client as a single database.
Sharding is the method of splitting a single logical database server into separate physical databases.
Here are tutorials on monitoring and managing MariaDB MaxScale in cluster environments.
This tutorial is a quick overview of what the MaxScale REST API offers, how it can be used to inspect the state of MaxScale and how to use it to modify the runtimeā¦
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.
The avrorouter is a MariaDB 10.0 binary log to Avro file converter.
The binlogrouter is a router that acts as a replication proxy for MariaDB primary-replica replication.
The cat router is a special router that concatenates result sets.
The KafkaCDC module reads data changes in MariaDB via replication and converts them into JSON objects that are then streamed to a Kafka broker.
The KafkaImporter module reads messages from Kafka and streams them into a MariaDB server.
The mirror router is designed for data consistency and database behavior verification during system upgrades.
This document provides an overview of the readconnroute router module and its intended use case scenarios.
This document provides a short overview of the readwritesplit router module and its intended use case scenarios.
The SchemaRouter provides an easy and manageable sharding solution by building a single logical database server from multiple separate ones.
SmartRouter is the query router of the SmartQuery framework.
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.
This filter was introduced in MariaDB MaxScale 2.3.0.
This filter was introduced in MariaDB MaxScale 2.1.
With the comment filter it is possible to define comments that are injected before the actual statements.
This filter was introduced in MariaDB MaxScale 2.1.
This filter adds routing hints to a service.
The ldi (LOAD DATA INFILE) filter was introduced in MaxScale 23.08.0 and it extends the MariaDB LOAD DATA INFILE syntax to support loading data from any object storageā¦
This filter was introduced in MariaDB MaxScale 2.1.
This filter was introduced in MariaDB MaxScale 2.1.
The namedserverfilter is a MariaDB MaxScale filter module able to route queries to servers based on regular expression (regex) matches.
The Query Log All (QLA) filter logs query content.
The Regex filter is a filter module for MariaDB MaxScale that is able to rewrite query content using regular expression matches and text substitution.
The rewrite filter allows modification of sql queries on the fly.
The tee filter is a "plumbing" fitting in the MariaDB MaxScale filter toolkit.
This filter was added in MariaDB MaxScale 2.3
The top filter is a filter module for MariaDB MaxScale that monitors every SQL statement that passes through the filter.
Monitors
Common options for all monitor modules.
The settings supported by every monitor module.
Module specific documentation.
The Galera Monitor is a monitoring module for MaxScale that monitors a Galera cluster.
MariaDB Monitor monitors a Primary-Replica replication cluster.
Protocols
Documentation for MaxScale protocol modules.
The mariadbprotocol module implements the MariaDB client-server protocol.
CDC is a new protocol that allows compatible clients to authenticate and register for Change Data Capture events.
Change Data Capture (CDC) is a new MaxScale protocol that allows compatible clients to authenticate and register for Change Data Capture events.
The nosqlprotocol module allows a MariaDB server or cluster to be used as the backend of an application using a MongoDBĀ® client library.
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 the Authentication Modules document.
The MariaDBAuth-module implements the client and backend authentication for the server plugin mysqlnativepassword.
GSSAPI is an authentication protocol that is commonly implemented with Kerberos on Unix or Active Directory on Windows.
Pluggable authentication module (PAM) is a general purpose authentication API.
Ed25519 is a highly secure authentication method based on public key cryptography.
This page is licensed: CC BY-SA / Gnu FDL
Last updated
Was this helpful?