Skip to content
logo
Percona ProxySQL admin tools
Home
Initializing search
    percona/proxysql-admin-tool-doc
    percona/proxysql-admin-tool-doc
    • Home
      • Release notes index
      • ProxySQL 2.5.5 and ProxySQL admin tools (2023-08-23)
      • ProxySQL 2.5.4 and ProxySQL admin tools (2023-07-24)
      • ProxySQL 2.5.3 and ProxySQL admin tools (2023-07-06)
      • ProxySQL 2.5.2 and ProxySQL admin tools (2023-06-26)
      • ProxySQL 2.5.1 and ProxySQL admin tools (2023-04-17)
      • ProxySQL 2.4.8 and ProxySQL admin tools (2023-03-15)
      • ProxySQL 2.4.7 and ProxySQL admin tools (2023-02-14)
      • ProxySQL 2.4.4-1.2 and ProxySQL admin tools (2022-11-08)
      • ProxySQL 2.4.4 and ProxySQL admin tools (2022-10-04)
      • ProxySQL 2.4.3 and ProxySQL admin tools (2022-08-31)
      • ProxySQL 2.4.2 and proxysql admin tools (2022-08-10)
      • ProxySQL 2.3.2-1.2, proxysql-admin, and percona-scheduler-admin (2022-06-15)
      • ProxySQL 2.3.2 and proxysql-admin (2021-11-03)
      • ProxySQL 2.2.0 and proxysql-admin (2021-08-10)
      • ProxySQL 2.1.1 and proxysql-admin (2021-07-09)
      • ProxySQL 2.0.18 and proxysql-admin (2021-04-19)
      • ProxySQL 2.0.17 and proxysql-admin (2021-04-06)
      • ProxySQL 2.0.15 and proxysql-admin (2020-11-17)
      • ProxySQL 2.0.14 and proxysql-admin (2020-09-24)
      • ProxySQL 2.0.13 and proxysql-admin (2020-08-05)
      • ProxySQL 2.0.12 and proxysql-admin (2020-06-11)
      • ProxySQL 2.0.7 and proxysql-admin (2019-10-23)
      • ProxySQL 2.0.6 and proxysql-admin (2019-08-21)
      • ProxySQL 2.0.5 and proxysql-admin (2019-11-23)
      • ProxySQL 2.0.4 and proxysql-admin (2019-05-28)
      • ProxySQL 2.0.3 and proxysql-admin (2019-05-07)
      • ProxySQL 1.4.16 and proxysql-admin (2020-02-11)
      • ProxySQL 1.4.12 and proxysql-admin (2018-11-13)
      • ProxySQL 1.4.8 and proxysql-admin (2018-05-22)
      • ProxySQL 1.4.7 and proxysql-admin (2018-04-16)
      • ProxySQL 1.4.6 and proxysql-admin (2018-03-12)
      • ProxySQL 1.4.5 and proxysql-admin (2018-02-15)
      • ProxySQL 1.4.4 and proxysql-admin (2018-01-18)
      • Use ProxySQL 1.x.x with ProxySQL Admin
      • Install ProxySQL 1.x.x
      • Install ProxySQL 1.X from a binary tarball
      • Configure ProxySQL 1.x.x
        • Download locations for ProxySQL 2.x.x and ProxySQL admin utilities
        • Install ProxySQL 2.x.x and the admin utilities
        • Install ProxySQL 2.x.x binary tarball
        • Build the pxc_scheduler_handler tool
        • Start and stop ProxySQL
        • Upgrade ProxySQL
        • Uninstall ProxySQL 2.x.x
          • ProxySQL Admin tool changes
          • ProxySQL 2.x and proxysql-admin utility
          • The proxysql-admin functions
          • ProxySQL 2.x.x and pxc_scheduler_handler tool
          • pxc-scheduler-handler configuration
          • pxc_scheduler_handler statements
          • pxc-scheduler-handler options
          • Known issues in pxc_scheduler_handler
      • Trademark policy
      • Copyright and licensing information

    ProxySQL, proxysql-admin, and percona-scheduler-admin documentation¶

    This documentation is for the latest release: Percona ProxySQL admin tools 2.5.5 (Release notes).

    ProxySQL is a tool that performs like a proxy between Percona XtraDB Cluster and your client application. ProxySQL manages a connection pool, which caches your connections and keeps the connections open for future requests. ProxySQL is designed to run continuously without being restarted.

    Without a connection pool, each SQL request opens a connections to the remote node. When the SQL request is complete, the connection is closed. A new one is opened on the next SQL request.

    ProxySQL maintains the connection pool. The pool allows a certain number of connections to remain open. A connection is reused or closed if not reused within a specific time. You connect to the proxy and the tool forwards your requests to the cluster.

    ProxySQL runs as a daemon watched by a monitoring process which can restart ProxySQL in case of an unexpected exit to minimize downtime. The daemon accepts incoming traffic from MySQL clients and forwards the traffic to backend MySQL servers.

    The configuration options include runtime parameters, server grouping, and traffic-related parameters. Many of the settings can be done at runtime using queries that are similar to SQL statements.

    The ProxySQL documentation provides information on installing and running ProxySQL and the ProxySQL admin tools.

    ProxySQL is available from the Percona software repositories with the following:

    • ProxySQL 1.x.x downloads include:

      • ProxySQL Admin 1.x.x does not natively support Percona XtraDB Cluster and requires custom Bash scripts to track the status of a Percona XtraDB Cluster.
    • ProxySQL 2.x.x downloads include:

      • ProxySQL Admin (proxysql-admin) simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL.

      • pxc_scheduler_handler can automatically perform a failover due to node failures, service degradation, or maintenance. This utility is available from ProxySQL 2.3.2-1.2 and higher.

    Contact us

    For free technical help, visit the Percona Community Forum.

    To report bugs or submit feature requests, open a JIRA ticket.

    For paid support and managed or consulting services , contact Percona Sales.


    Last update: 2023-08-23
    Percona LLC and/or its affiliates, © 2023
    Made with Material for MkDocs

    Cookie consent

    We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better. Read more about Percona Cookie Policy.