RIAK(1)()

NAME
riak - Distributed, decentralized data storage system

SYNOPSIS
riak [start] [stop] [restart] [reboot] [ping] [console] [attach] [chkconfig] [attach-direct] [ertspath] [escript filename] [version] [getpid] [top commands] [config commands]

DESCRIPTION
Riak is a distributed, decentralized data storage system written in Erlang.

Riak combines a decentralized key-value store, a flexible map/reduce engine, and a friendly HTTP/JSON query interface to provide a database ideally suited for web applications.

OPTIONS
The riak command controls the main server process, and accepts several subcommands for controlling and checking status of a node.

start
    Starts Riak node background process; outputs message "Node is already running!" when attempting to start an already running node.

stop
    Stops Riak node; outputs "ok" on success or warnings about the node not responding to pings when node is not responding or not running. If attached to Riak on the Erlang shell, stop like this example:

    (riak@example.com)1> q().

restart
    Stops and starts Riak node while maintaining current Erlang virtual machine; outputs "ok" on success or warnings about node not responding to pings when node is not responding or not running.

reboot
    Stops and starts Riak node while also exiting the current Erlang virtual machine; outputs "ok" on success or warnings about node not responding to pings when node is not responding or not running.

ping
    Pings Riak node as a basic test for node liveness; outputs "pong" on success or warnings about the not not responding to pings when node is not responding or not running.

console
    Start Riak as a foreground process with access to the Erlang console messages and shell; outputs "Node is already running - use 'riak attach' instead" when node is already running as a background process.

attach
    Safely attaches an Erlang console to the running Riak process which can be exited more safely.

attach-direct
    Attaches an Erlang console directly to the local riak node OS process with access to the Erlang console messages and shell. Killing this shell can kill the Riak node.

chkconfig
    Verify validity of node's generated app.config file (see config generate)

ertspath
    Ouputs the path to the Erlang Run-Time System that Riak is using.

escript
    <filename>
    Runs any Erlang scripts included in the <filename>

version
    Returns the currently running Riak version.

getpid
    Get the process id of the currently running Riak node.

top [-interval N] [-sort reductions|memory|msg_q] [-lines N]
    Output current CPU utilization, memory, and message queue sizes for the node. interval is the number of seconds between each update, and defaults to 5. sort specifies the column to sort, and defaults to reductions. lines is the number of processes to display, and defaults to 10.

config
    generate|effective|{describe VARIABLE} [-l debug]
    Commands to help manage with Riak configuration through the riak.conf file. generate builds and outputs app.*.config and vm.*.args from the riak.conf configuration, or returns an error.
    effective outputs a list of key/value settings which represent the inherited and overridden Riak node configuration values.
    describe requires a configuration setting and outputs a description of the setting, a list of valid values, the default value, the currently set value, and the internal system key representation.

AUTHORS
Riak is developed by Basho Technologies, Inc. http://basho.com