This section is under active development, see pkg/api directory.
The goal of Capillaries API is to allow system integrators to create solutions that can start runs and watch their execution progress. As of this writing, all API calls can be executed either via the Toolbelt command or via Capillaries UI using Webapi. Some examples are below.
Drop keyspace:
go run capitoolbelt.go drop_keyspace -keyspace=<keyspace_name>
Get workflow status from workflow tables:
go run capitoolbelt.go get_run_history -keyspace=<keyspace_name>
go run capitoolbelt.go get_node_history -keyspace=<keyspace_name> -run_ids=<comma_separated_list_of_run_ids>
go run capitoolbelt.go get_batch_history -keyspace=<keyspace_name> -run_ids=<comma_separated_list_of_run_ids> -nodes=<comma_separated_list_of_node_names>
Initiate/terminate workflow - start/stop a run:
go run capitoolbelt.go start_run -script_file=<script_file> -params_file=<script_params_file> -keyspace=<keyspace_name> -start_nodes=<comma_separated_list_of_nodes_to start>
go run capitoolbelt.go stop_run -keyspace=<keyspace_name> -run_id=<run_id>
Most of these commands are used in integration tests.