TRY ME

Try Valo for free

We want to show you something amazing.

We'll send you a link to download a fully functional Valo copy to play with.



Great! Check your email and enjoy Valo



Apologies, we seem to be having a problem processing your input, please try again

Command Line Interface

config

Allows easy access to settings for the local Valo node. For example, the following returns the port serving the HTTP API:

bin\valo config get valo.node.api-port
8889

Settings can be updated using the following syntax:

bin\valo config set valo.node.offset 1
Set 'valo.node.offset' to '1'

The CLI does not modify conf/application.conf, instead writing the new value of a setting to conf/settings.conf, which takes precendence when Valo is loading.

cluster

Provides operations using the Valo Cluster API.

The simplest operation is to return the current state of the cluster:

bin\valo cluster state
+---------+-------------+------------------+----------+-------------+
|  Name   |  Host       |  Version         |  State   |  Available  |
+---------+-------------+------------------+----------+-------------+
|  valo1  |  localhost  |  1.2.0           |  Joined  |  yes        |
+---------+-------------+------------------+----------+-------------+

It can also be used to add the local node into an existing cluster, providing the host and port of an existing node:

bin\valo cluster add -host otherhost -p 8889
+---------+-------------+------------------+-----------+-------------+
|  Name   |  Host       |  Version         |  State    |  Available  |
+---------+-------------+------------------+-----------+-------------+
|  valo1  |  otherhost  |  1.2.0           |  Joined   |  yes        |
+---------+-------------+------------------+-----------+-------------+
|  valo2  |  localhost  |  1.2.0           |  Joining  |  yes        |
+---------+-------------+------------------+-----------+-------------+

Or to remove a node from the cluster:

bin\valo cluster remove valo1
+---------+-------------+------------------+------------+-------------+
|  Name   |  Host       |  Version         |  State     |  Available  |
+---------+-------------+------------------+------------+-------------+
|  valo1  |  otherhost  |  1.2.0           |  Leaving   |  yes        |
+---------+-------------+------------------+------------+-------------+
|  valo2  |  localhost  |  1.2.0           |  Joined    |  yes        |
+---------+-------------+------------------+------------+-------------+

test

Verifies that a node is up and running by creating a stream, publishing some data and querying it back.

To test the local node:

bin\valo test
Checking cluster state
There are 1 node(s) in the cluster
Creating stream '/streams/demo/test/test'
Starting real time query 'from /streams/demo/test/test'
Publishing 5 payloads
Successfully pushed and queried 5 items

It is also possible to test a node on a different machine:

bin\valo test -h otherhost -p 8889
Checking cluster state
There are 1 node(s) in the cluster
Creating stream '/streams/demo/test/test'
Starting real time query 'from /streams/demo/test/test'
Publishing 5 payloads
Successfully pushed and queried 5 items