MySQL Router 2.0

Abstract

MySQL Router is lightweight middleware that provides transparent routing between your application and any back-end MySQL Servers. It can be used for a wide variety of use cases, such as providing high availability and scalability by effectively routing database traffic to appropriate back-end MySQL Servers. The pluggable architecture also enables developers to extend MySQL Router for custom use cases.

For notes detailing the changes in each release, see the MySQL Router Release Notes.

If you have not yet installed MySQL Router, download it from the download site.

For help with using MySQL, please visit either the MySQL Forums or MySQL Mailing Lists, where you can discuss your issues with other MySQL users.

For additional documentation on MySQL products, including translations of the documentation into other languages, and downloadable versions in variety of formats, including HTML and PDF formats, see the MySQL Documentation Library.

Licensing information.  This product may include third-party software, used under license. If you are using a Commercial release of MySQL Router, see this document for licensing information, including licensing information relating to third-party software that may be included in this Commercial release. If you are using a Community release of MySQL Router, see this document for licensing information, including licensing information relating to third-party software that may be included in this Community release.

Document generated on: 2017-08-11 (revision: 53379)


Table of Contents

Preface and Legal Notices
1 General Information
1.1 Supported Features
1.1.1 Connection Routing
1.1.2 Fabric Integration
1.1.3 MySQL Harness: Plugin Capabilities and More
1.2 Architecture
1.3 Using MySQL Router
1.3.1 Deploying MySQL Router
1.3.2 Developing Applications to Use MySQL Router
2 Installation
2.1 Installing MySQL Router on Linux
2.2 Installing MySQL Router on macOS
2.3 Installing MySQL Router on Windows
2.4 Installing MySQL Router from Source Code
2.4.1 Prerequisites
2.4.2 Compiling the Source Code
2.4.3 Installing from Source Code
2.4.4 Testing the Installation
2.5 Postinstallation Testing
3 Configuration
3.1 Configuration File Syntax
3.2 Configuration File Locations
3.3 Configuration File Setup
3.3.1 General
3.3.2 Connection Routing (Standalone)
3.3.3 Logging
3.3.4 Configuration File Example
4 MySQL Router Application
4.1 User Options
4.2 Starting the Router
4.3 Using the Logging Feature
5 Plugins
5.1 Connection Routing Plugin
5.2 Fabric Cache Plugin
6 Use Cases and Examples
A MySQL Router Frequently Asked Questions
B MySQL Router Unit Tests