From 89cae0e35b87b58ba0ad0a2bffe912c37f8f4cd1 Mon Sep 17 00:00:00 2001 From: Markus Makela Date: Fri, 24 Apr 2015 06:19:50 +0300 Subject: [PATCH] Added README.md and updated schemarouter documentation. --- .../routers/schemarouter/SchemaRouter.md | 2 +- README.md | 37 +++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/Documentation/routers/schemarouter/SchemaRouter.md b/Documentation/routers/schemarouter/SchemaRouter.md index 7823bd817..d1de66b2b 100644 --- a/Documentation/routers/schemarouter/SchemaRouter.md +++ b/Documentation/routers/schemarouter/SchemaRouter.md @@ -47,7 +47,7 @@ The schemarouter supports the following router options: |option |parameter |description| --------------------------------------------- |max_sescmd_hitory | |Set a limit on the number of session modifying commands a session can execute. This sets an effective cap on the memory consupmtion of the session.| - +|disable_sescmd_history||Disable the session command history. This will prevent growing memory consumption of a long-running session and allows pooled connections to MaxScale to be used. The drawback of this is the fact that if a server goes down, the session state will not be consistent anymore.| ## Limitations The schemarouter router currently has some limitations due to the nature of the sharding implementation and the way the session variables are detected and routed. Here is a list of the current limitations. diff --git a/README.md b/README.md new file mode 100644 index 000000000..263134569 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# MaxScale by MariaDB Corporation + +The MariaDB Corporation MaxScale is an intelligent proxy that allows forwarding of +database statements to one or more database servers using complex rules, +a semantic understanding of the database statements and the roles of +the various servers within the backend cluster of databases. + +MaxScale is designed to provide load balancing and high availability +functionality transparently to the applications. In addition it provides +a highly scalable and flexible architecture, with plugin components to +support different protocols and routing decisions. + +MaxScale is implemented in C and makes extensive use of the +asynchronous I/O capabilities of the Linux operating system. The epoll +system is used to provide the event driven framework for the input and +output via sockets. + +The protocols are implemented as external shared object modules which +can be loaded at runtime. These modules support a fixed interface, +communicating the entries points via a structure consisting of a set of +function pointers. This structure is called the "module object". + +The code that routes the queries to the database servers is also loaded +as external shared objects and are referred to as routing modules. + +An Google Group exists for MaxScale that can be used to discuss ideas, +issues and communicate with the MaxScale community. + Send email to maxscale@googlegroups.com + or use the [forum](http://groups.google.com/forum/#!forum/maxscale) interface + +Bugs can be reported in the MariaDB Corporation bugs database + [https://mariadb.atlassian.net](https://mariadb.atlassian.net) under project MXS. + +# Documentation + +For information about installing and using MaxScale, please refer to the +[documentation](Documentation/Documentation-Contents.md).