You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: maxscale/maxscale-architecture/mariadb-maxscale-guide.md
+16-32Lines changed: 16 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,51 +1,35 @@
1
+
---
2
+
description: >-
3
+
Learn the fundamental concepts of MariaDB MaxScale. This guide explains its
4
+
role as a database proxy, its plugin-based architecture, and how it manages
5
+
database connections.
6
+
---
7
+
1
8
# About MariaDB MaxScale
2
9
3
10
## About MariaDB MaxScale
4
11
5
-
**MariaDB MaxScale** is a database proxy that forwards database statements to
6
-
one or more database servers.
12
+
**MariaDB MaxScale** is a database proxy that forwards database statements to one or more database servers.
7
13
8
-
The forwarding is performed using rules based on the semantic understanding of
9
-
the database statements and on the roles of the servers within the backend
10
-
cluster of databases.
14
+
The forwarding is performed using rules based on the semantic understanding of the database statements and on the roles of the servers within the backend cluster of databases.
11
15
12
-
MariaDB MaxScale is designed to provide, transparently to applications, load
13
-
balancing and high availability functionality. MariaDB MaxScale has a scalable
14
-
and flexible architecture, with plugin components to support different protocols
15
-
and routing approaches.
16
+
MariaDB MaxScale is designed to provide transparent to applications, load balancing and high availability functionality. MariaDB MaxScale has a scalable and flexible architecture, with plugin components to support different protocols and routing approaches.
16
17
17
-
MariaDB MaxScale makes extensive use of the asynchronous I/O capabilities of the
18
-
Linux operating system, combined with a fixed number of worker threads. _epoll_
19
-
is used to provide the event driven framework for the input and output via
20
-
sockets.
18
+
MariaDB MaxScale makes extensive use of the asynchronous I/O capabilities of the Linux operating system, combined with a fixed number of worker threads. _epoll_ is used to provide an event-driven framework for the input and output via sockets.
21
19
22
-
Many of the services provided by MariaDB MaxScale are implemented as external
23
-
shared object modules loaded at runtime. These modules support a fixed
24
-
interface, communicating the entry points via a structure consisting of a set of
25
-
function pointers. This structure is called the "module object". Additional
26
-
modules can be created to work with MariaDB MaxScale.
20
+
Many of the services provided by MariaDB MaxScale are implemented as external shared object modules loaded at runtime. These modules support a fixed interface, communicating the entry points via a structure consisting of a set of function pointers. This structure is called the "module object". Additional modules can be created to work with MariaDB MaxScale.
27
21
28
-
Commonly used module types are _protocol_, _router_ and _filter_. Protocol
29
-
modules implement the communication between clients and MariaDB MaxScale, and
30
-
between MariaDB MaxScale and backend servers. Routers inspect the queries from
31
-
clients and decide the target backend. The decisions are usually based on
32
-
routing rules and backend server status. Filters work on data as it passes
33
-
through MariaDB MaxScale. Filter are often used for logging queries or modifying
34
-
server responses.
22
+
Commonly used module types are _protocol_, _router,_ and _filter_. Protocol modules implement the communication between clients and MariaDB MaxScale, and between MariaDB MaxScale and backend servers. Routers inspect the queries from clients and decide the target backend. The decisions are usually based on routing rules and backend server status. Filters work on data as it passes through MariaDB MaxScale. Filters are often used for logging queries or modifying server responses.
35
23
36
-
A Google Group exists for MariaDB MaxScale. The Group is used to discuss ideas,
37
-
issues and communicate with the MariaDB MaxScale community. Send email to [[email protected]](mailto:[email protected]) or use the [forum](https://groups.google.com/forum/#!forum/maxscale) interface.
24
+
A Google Group exists for MariaDB MaxScale. The Group is used to discuss ideas, issues, and communicate with the MariaDB MaxScale community. Send an email to [[email protected]](mailto:[email protected]) or use the [forum](https://groups.google.com/forum/#!forum/maxscale) interface.
38
25
39
26
Bugs can be reported in the MariaDB Jira [jira.mariadb.org](https://jira.mariadb.org)
40
27
41
28
### Installing MariaDB MaxScale
42
29
43
-
Information about installing MariaDB MaxScale, either from a repository or by
44
-
building from source code, is included in the [MariaDB MaxScale Installation
Information about installing MariaDB MaxScale, either from a repository or by building from source code, is included in the [MariaDB MaxScale Installation Guide](../maxscale-management/installation-and-configuration/maxscale-installation-guide.md).
46
31
47
-
The same guide also provides basic information on running MariaDB MaxScale. More
48
-
detailed information about configuring MariaDB MaxScale can be found in the [Configuration Guide](../maxscale-management/deployment/maxscale-configuration-guide.md).
32
+
The same guide also provides basic information on running MariaDB MaxScale. More detailed information about configuring MariaDB MaxScale can be found in the [Configuration Guide](../maxscale-management/deployment/maxscale-configuration-guide.md).
49
33
50
34
<sub>_This page is licensed: CC BY-SA / Gnu FDL_</sub>
ReadConnRoute routes each connection to a single primary or replica node,
22
-
depending on configuration.
23
-
* MaxScale can import data from Kafka and export data into Kafka. MaxScale's
24
-
KafkaCDC router streams data from MariaDB database products to a Kafka broker.
25
-
MaxScale's KafkaImporter router streams data from Kafka to MariaDB database products.
26
-
* MaxScale provides built-in mechanisms to perform server maintenance without
27
-
disrupting applications or clients. Servers can be set to maintenance mode
28
-
using the command-line interface with MaxCtrl, a web browser with MaxGUI, or REST API.
14
+
* MaxScale performs automated failover for MariaDB replication. When the primary server fails, MaxScale promotes a replica to be the new primary and redirects the remaining replicas to it.
15
+
* MaxScale's ReadWriteSplit router performs query-based load balancing. ReadWriteSplit routes each write statement to the current primary server and load balances read statements by routing them to the replica servers.
16
+
* MaxScale's ReadConnRoute router performs connection-based load balancing. ReadConnRoute routes each connection to a single primary or replica node, depending on configuration.
17
+
* MaxScale can import data from Kafka and export data into Kafka. MaxScale's KafkaCDC router streams data from MariaDB database products to a Kafka broker. MaxScale's KafkaImporter router streams data from Kafka to MariaDB database products.
18
+
* MaxScale provides built-in mechanisms to perform server maintenance without disrupting applications or clients. Servers can be set to maintenance mode using the command-line interface with MaxCtrl, a web browser with MaxGUI, or REST API.
29
19
* MaxScale's Cache filter can improve SELECT performance by caching and reusing results.
30
-
* Security and traffic controls for database connections and queries can be implemented
31
-
with MaxScale. MaxScale's QLAfilter can be used to create an audit trail by logging
32
-
all queries. MaxScale's RegexFilter can also perform audit logging or protect
33
-
against SQL injection by matching queries against a regular expression and
34
-
performing various actions on the query, such as logging it, modifying it, or
35
-
routing it to a specific server.
20
+
* Security and traffic controls for database connections and queries can be implemented with MaxScale. MaxScale's QLAfilter can be used to create an audit trail by logging all queries. MaxScale's RegexFilter can also perform audit logging or protect against SQL injection by matching queries against a regular expression and performing various actions on the query, such as logging it, modifying it, or routing it to a specific server.
36
21
37
22
MariaDB MaxScale can be deployed in the cloud or on-premises.
38
23
39
24
## Scheduled Releases
40
25
41
-
MariaDB MaxScale follows the MariaDB Enterprise release schedule, which can be found
MariaDB MaxScale follows the MariaDB Enterprise release schedule, which can be found [here](../../release-notes/enterprise-server/enterprise-server-release-schedule.md).
43
27
44
28
## Software Releases
45
29
46
-
The supported MaxScale versions can be found from the latest
0 commit comments