Skip to content
logo
Percona ProxySQL Admin tool
Percona Scheduler Admin statements
Initializing search
    percona/proxysql-admin-tool-doc
    percona/proxysql-admin-tool-doc
    • Home
      • 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 Percona Scheduler admin 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 Percona Scheduler Admin tool
      • Percona Scheduler Admin configuration
      • Percona Scheduler Admin statements
        • Statement reference
      • Percona Scheduler Admin options
      • Known issues in Percona Scheduler Admin
      • Release notes index
      • 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)
    • Statement reference

    Percona Scheduler Admin statements¶

    Statement reference¶

    The standard percona-scheduler-admin statement includes percona-scheduler-admin --config-file=<configuration file name and extension>. A Percona Scheduler Admin example statement has the following syntax:

    percona-scheduler-admin --config-file=config.toml [option] [option]
    

    If you do not include the configuration file in the command, the result is an error and nothing happens.

    $ percona-scheduler-admin --debug
    ERROR : The --config-file option is required but is missing from the command.
    

    The options determine what the statement does. The percona-scheduler-admin statement must include at least one option. A command without an option returns an error and nothing happens.

    For most options, two hyphens (--) precede an option name. The disable and the enable option can be selected with one hyphen (-) and the appropriate abbreviation.

    For example, the following commands return the same result:

    $ percona-scheduler-admin --config-file=config.toml -e
    
    $ percona-scheduler-admin --config-file=config.toml --enable
    

    You can combine some options with other, optional options to modify the statement’s behavior. Multiple options are separated by a space. You can combine the options in any order.

    An example of combining options in one statement:

    $ percona-scheduler-admin --config-file=config.toml --write-node=127.0.0.1:4130 --update-cluster
    

    For some options, they must be combined with a required option to return a result.

    An example of an option combined with a required option:

    $ percona-scheduler-admin --config-file=config.toml --force -e
    

    If you do not combine the option with the required option, the statement does not run and returns an error.

    $ percona-scheduler-admin --config-file=tests/testsuite.toml  --update-write-weight="127.0.0.1:33,112"
    
    Expected output
    ERROR : --update-write-weight requires --update-cluster.
    

    Specific options, such as -–write-node or –-server, require a value.

    $> percona-scheduler-admin --config-file=config.toml --server=192.168.56.32:3306
    

    For the available options, see Percona Scheduler Admin options

    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-02-14
    Back to top
    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.