2.3.3 evqlctl

evqlctl is a client command line utility for performing administrative operations on an EventQL server or cluster. You can use it to check and change a clusters configuration and current status, to add and remove servers and more.

Most of the evqlctl commands are only applicable when running an EventQL cluster and speak directly to the coordination service (e.g. Zookeeper) rather than the EventQL server.

$ evqlctl --help

Usage: $ evqlctl [OPTIONS] <command> [<args>]

   -c, --config <file>       Load config from file
   -C name=value             Define a config value on the command line
   -?, --help <topic>        Display a command's help text and exit
   -v, --version             Display the version of this binary and exit

Supported Commands:


Create a new cluster.

  Usage: evqlctl cluster-create [OPTIONS]


Add a server to an existing cluster.

  Usage: evqlctl cluster-add-server [OPTIONS]
    --server_name            The name of the server to add.


Remove an existing server from an existing cluster.

  Usage: evqlctl cluster-remove-server [OPTIONS]
    --server_name            The name of the server to remove.
    --soft                   Enable the soft-leave operation.
    --hard                   Enable the hard-leave operation.


Display the current cluster status.

  Usage: evqlctl cluster-status [OPTIONS]


List the servers of the current cluster.

Usage:: evqlctl cluster-list


Create a new database.

  Usage: evqlctl database-create [OPTIONS]
    --database               The name of the database to create.


Split a partition

  Usage: evqlctl table-split [OPTIONS]
    --database               The name of the database.
    --cluster_name           The name of the cluster.
    --table_name             The name of the table to split.
    --partition_id           The id of the partition to split.


Set table config parameters

  Usage: evqlctl table-config-set [OPTIONS]
    --database               The name of the database to modify.
    --table_name             The name of the table to modify.
    --param                  The parameter to set
    --value                  The value to set the parameter to