hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Documentation/About

Browse Source 
Mostly rewording and some reformatting.
This commit is contained in:
Esa Korhonen
2017-01-27 14:46:43 +02:00
parent 7dc5698c90
commit d5b96ec2b6
1 changed files with 34 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
Documentation/About/About-MaxScale.md
View File

@ -1,48 +1,50 @@
# About MariaDB MaxScale # About MariaDB MaxScale
**MariaDB MaxScale** is a database proxy that allows the forwarding of
database statements to one or more database servers.
The forwarding is performed using rules that can be based on a the semantic **MariaDB MaxScale** is a database proxy that forwards database statements to
understanding of the database statements and on the roles of the various one or more database servers.
servers within the backend cluster of databases.
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.
MariaDB MaxScale is designed to provide, transparently to applications, load MariaDB MaxScale is designed to provide, transparently to applications, load
balancing and high availability functionality. In addition, it provides balancing and high availability functionality. MariaDB MaxScale has a scalable
a highly scalable and flexible architecture, with plugin components to and flexible architecture, with plugin components to support different protocols
support different protocols and routing approaches. and routing approaches.
MariaDB MaxScale makes extensive use of the asynchronous I/O capabilities of the MariaDB MaxScale makes extensive use of the asynchronous I/O capabilities of the
Linux operating system, combined with a fixed number of worker threads. Linux operating system, combined with a fixed number of worker threads. *epoll*
The epoll system is used to provide the event driven framework for the is used to provide the event driven framework for the input and output via
input and output via sockets. Similar features in Windows® could sockets.
be used in future development of MariaDB MaxScale.
Many of the services provided by MariaDB MaxScale are implemented as external Many of the services provided by MariaDB MaxScale are implemented as external
shared object modules, which are loaded at runtime. These modules shared object modules loaded at runtime. These modules support a fixed
support a fixed interface, communicating the entry points via a structure interface, communicating the entry points via a structure consisting of a set of
consisting of a set of function pointers. This structure is called the function pointers. This structure is called the "module object". Additional
"module object". Additional modules can be created to work with MariaDB MaxScale. modules can be created to work with MariaDB MaxScale.
One group of modules provides support for protocols, both for clients Commonly used module types are *protocol*, *router* and *filter*. Protocol
that communicate with MariaDB MaxScale and for backend servers. The code that modules implement the communication between clients and MariaDB MaxScale, and
routes the queries to the backend servers is also loaded as external between MariaDB MaxScale and backend servers. Routers inspect the queries from
shared objects and they are referred to as routing modules. Another clients and decide the target backend. The decisions are usually based on
group of modules work on data as it passes through MariaDB MaxScale, and they routing rules and backend server status. Filters work on data as it passes
are known as filters. through MariaDB MaxScale. Filter are often used for logging queries or modifying
server responses.
A Google Group exists for MariaDB MaxScale that can be used to discuss ideas, A Google Group exists for MariaDB MaxScale. The Group is used to discuss ideas,
issues and communicate with the MariaDB MaxScale community: issues and communicate with the MariaDB MaxScale community. Send email to
Send email to [maxscale@googlegroups.com](mailto:maxscale@googlegroups.com) [maxscale@googlegroups.com](mailto:maxscale@googlegroups.com) or use the
or use the [forum](http://groups.google.com/forum/#!forum/maxscale) interface [forum](http://groups.google.com/forum/#!forum/maxscale) interface.
Bugs can be reported in the MariaDB Jira Bugs can be reported in the MariaDB Jira
[https://jira.mariadb.org](https://mariadb.atlassian.net) [https://jira.mariadb.org](https://mariadb.atlassian.net)
## Installing MariaDB MaxScale ## Installing MariaDB MaxScale
Information about installing MariaDB MaxScale, either from a repository or by
building from source code, is included in the
[MariaDB MariaDB MaxScale Installation Guide](../Getting-Started/MariaDB-MaxScale-Installation-Guide.md).
The same guide also provides basic information on running MariaDB MaxScale. Information about installing MariaDB MaxScale, either from a repository or by
More detailed information about configuring MariaDB MaxScale is given in the building from source code, is included in the [MariaDB MaxScale Installation
Guide](../Getting-Started/MariaDB-MaxScale-Installation-Guide.md).
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](../Getting-Started/Configuration-Guide.md). [Configuration Guide](../Getting-Started/Configuration-Guide.md).