Updated Documentation/About

Mostly rewording and some reformatting.
This commit is contained in:
Esa Korhonen 2017-01-27 14:46:43 +02:00
parent 7dc5698c90
commit d5b96ec2b6

View File

@ -1,48 +1,50 @@
# 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
understanding of the database statements and on the roles of the various
servers within the backend cluster of databases.
**MariaDB MaxScale** is a database proxy that forwards database statements to
one or more database servers.
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
balancing and high availability functionality. In addition, it provides
a highly scalable and flexible architecture, with plugin components to
support different protocols and routing approaches.
balancing and high availability functionality. MariaDB MaxScale has a scalable
and flexible architecture, with plugin components to support different protocols
and routing approaches.
MariaDB MaxScale makes extensive use of the asynchronous I/O capabilities of the
Linux operating system, combined with a fixed number of worker threads.
The epoll system is used to provide the event driven framework for the
input and output via sockets. Similar features in Windows® could
be used in future development of MariaDB MaxScale.
Linux operating system, combined with a fixed number of worker threads. *epoll*
is used to provide the event driven framework for the input and output via
sockets.
Many of the services provided by MariaDB MaxScale are implemented as external
shared object modules, which are 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.
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.
One group of modules provides support for protocols, both for clients
that communicate with MariaDB MaxScale and for backend servers. The code that
routes the queries to the backend servers is also loaded as external
shared objects and they are referred to as routing modules. Another
group of modules work on data as it passes through MariaDB MaxScale, and they
are known as filters.
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. 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,
issues and communicate with the MariaDB MaxScale community:
Send email to [maxscale@googlegroups.com](mailto:maxscale@googlegroups.com)
or use the [forum](http://groups.google.com/forum/#!forum/maxscale) interface
A Google Group exists for MariaDB MaxScale. The Group is used to discuss ideas,
issues and communicate with the MariaDB MaxScale community. Send email to
[maxscale@googlegroups.com](mailto:maxscale@googlegroups.com) or use the
[forum](http://groups.google.com/forum/#!forum/maxscale) interface.
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
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.
More detailed information about configuring MariaDB MaxScale is given in the
Information about installing MariaDB MaxScale, either from a repository or by
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).