Skip to content

Latest commit

 

History

History

scripts

README.md

Scripts description

This is a set of example scripts to show the capabilities of the RESTAPI interface and how to interface with it.

Prepare ProxySQL

  1. Launch ProxySQL:
./proxysql -M --sqlite3-server --idle-threads -f -c $PROXYSQL_PATH/scripts/datadir/proxysql.cnf -D $PROXYSQL_PATH/scripts/datadir
  1. Configure ProxySQL:
cd $RESTAPI_EXAMPLES_DIR
./proxysql_config.sh
  1. Install requirements
cd $RESTAPI_EXAMPLES_DIR/requirements
./install_requirements.sh

Query the endpoints

  1. Flush Query Cache: curl -i -X GET http://localhost:6070/sync/flush_query_cache
  2. Change host status:
    • Assuming local ProxySQL: 
      curl -i -X POST -d '{ "hostgroup_id": "0", "hostname": "127.0.0.1", "port": 13306, "status": "OFFLINE_HARD" }' http://localhost:6070/sync/change_host_status
    • Specifying server: 
      curl -i -X POST -d '{ "admin_host": "127.0.0.1", "admin_port": "6032", "admin_user": "radmin", "admin_pass": "radmin", "hostgroup_id": "0", "hostname": "127.0.0.1", "port": 13306, "status": "OFFLINE_HARD" }' http://localhost:6070/sync/change_host_status
  3. Add or replace MySQL user:
    • Assuming local ProxySQL: 
      curl -i -X POST -d '{ "user": "sbtest1", "pass": "sbtest1" }' http://localhost:6070/sync/add_mysql_user
    • Add user and load to runtime (Assuming local instance): 
      curl -i -X POST -d '{ "user": "sbtest1", "pass": "sbtest1", "to_runtime": 1 }' http://localhost:6070/sync/add_mysql_user
    • Specifying server: 
      curl -i -X POST -d '{ "admin_host": "127.0.0.1", "admin_port": "6032", "admin_user": "radmin", "admin_pass": "radmin", "user": "sbtest1", "pass": "sbtest1" }' http://localhost:6070/sync/add_mysql_user
  4. Kill idle backend connections:
    • Assuming local ProxySQL: 
      curl -i -X POST -d '{ "timeout": 10 }' http://localhost:6070/sync/kill_idle_backend_conns
    • Specifying server: 
      curl -i -X POST -d '{ "admin_host": "127.0.0.1", "admin_port": 6032, "admin_user": "radmin", "admin_pass": "radmin", "timeout": 10 }' http://localhost:6070/sync/kill_idle_backend_conns
  5. Scrap tables from 'stats' schema:
    • Assuming local ProxySQL: 
      curl -i -X POST -d '{ "table": "stats_mysql_users" }' http://localhost:6070/sync/scrap_stats
    • Specifying server: 
      curl -i -X POST -d '{ "admin_host": "127.0.0.1", "admin_port": 6032, "admin_user": "radmin", "admin_pass": "radmin", "table": "stats_mysql_users" }' http://localhost:6070/sync/scrap_stats
    • Provoke script failure (non-existing table): 
      curl -i -X POST -d '{ "admin_host": "127.0.0.1", "admin_port": 6032, "admin_user": "radmin", "admin_pass": "radmin", "table": "stats_mysql_servers" }' http://localhost:6070/sync/scrap_stats

Scripts doc

  • All scripts allows to perform the target operations on a local or remote ProxySQL instance.
  • Notice how the unique 'GET' request is for 'QUERY CACHE' flushing, since it doesn't require any parameters.
  • Script 'stats_scrapper.py' fails when a table that isn't present in 'stats' schema is queried. This is left as an example of the behavior of a failing script and ProxySQL log output.