MySQL Router 8.4

Abstract

MySQL Router is part of InnoDB Cluster, and is lightweight middleware that provides transparent routing between your application and 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 additional details about how MySQL Router is part of InnoDB Cluster, see MySQL AdminAPI.

MySQL Router 8.4 is highly recommended for use with MySQL Server 8.4.

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 the MySQL Forums, where you can discuss your issues with other MySQL users.

Licensing information.  This product may include third-party software, used under license. If you are using a Commercial release of MySQL Router, see MySQL Router Commercial License Information User Manual 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 MySQL Router Community License Information User Manual for licensing information, including licensing information relating to third-party software that may be included in this Community release.

Document generated on: 2024-10-29 (revision: 80142)

Table of Contents

Preface and Legal Notices

1 General Information

1.1 Routing for MySQL InnoDB Cluster

1.2 Cluster Metadata and State

1.2.1 MySQL Router Read Replica Support

1.3 Connection Routing

1.4 Application Considerations

2 Installing MySQL Router

2.1 Installing MySQL Router on Linux

2.2 Installing MySQL Router with Docker

2.3 Installing MySQL Router on macOS

2.4 Installing MySQL Router on Windows

2.5 Installing MySQL Router from Source Code

2.6 Upgrading MySQL Router

3 Deploying MySQL Router

3.1 Bootstrapping MySQL Router

3.2 Trying out MySQL Router in a Sandbox

3.3 Basic Connection Routing

3.4 Connection Sharing and Reuse

3.5 Read/Write Splitting

3.5.1 Configuration

3.5.2 Statements

3.6 MySQL Router TLS Session Cache

3.7 MySQL Router Set Trace

4 Configuration

4.1 Configuration File Syntax

4.2 Configuration Locations

4.3 Configuration Options

4.3.1 Defining Options Using the Command Line

4.3.2 MySQL Router Command Line Programs

4.3.3 Configuration File Options

4.3.4 Configuration File Example

4.4 TLS Configuration

5 MySQL Router Application

5.1 Starting MySQL Router

5.2 Using the Logging Feature

6 MySQL Router REST API

6.1 A Simple MySQL Router REST API Guide

6.2 MySQL Router REST API Reference

A MySQL Router Frequently Asked Questions