Utility tarantoolctl¶

Command format¶

tarantoolctl COMMAND NAME [URI] [FILE] [OPTIONS..]

где:

• COMMAND is one of the following: start, stop, status, restart, logrotate, check, enter, eval, connect, cat, play, rocks.
• NAME is the name of an instance file or a module.
• FILE is the path to some file (.lua, .xlog or .snap).
• URI is the URI of some Tarantool instance.
• OPTIONS are options taken by some tarantoolctl commands.

Commands for managing Tarantool instances¶

tarantoolctl start NAME

Start a Tarantool instance (if not started; fail otherwise).

tarantoolctl stop NAME

Stop a Tarantool instance (if not stopped; fail otherwise).

tarantoolctl status NAME

Show an instance’s status (started/stopped). If pid file exists and an alive control socket exists, the return code is 0. Otherwise, the return code is not 0.

Reports typical problems to stderr (e.g. pid file exists and control socket doesn’t).

tarantoolctl restart NAME

Stop and start a Tarantool instance (if started; fail otherwise).

tarantoolctl logrotate NAME

Rotate logs of a started Tarantool instance. Works only if logging-into-file is enabled in the instance file. Pipe/syslog make no effect.

tarantoolctl check NAME

Check an instance file for syntax errors.

tarantoolctl enter NAME

Enter an instance’s interactive Lua console.

tarantoolctl eval NAME FILE

Evaluate a local Lua file on a Tarantool instance (if started; fail otherwise).

tarantoolctl connect URI

Connect to a Tarantool instance on an admin-console port. Supports both TCP/Unix sockets.

Commands for managing checkpoint files¶

tarantoolctl cat FILE.. [--space=space_no ..] [--show-system] [--from=from_lsn] [--to=to_lsn] [--replica=replica_id ..]

Print into stdout the contents of .snap/.xlog files.

tarantoolctl play URI FILE.. [--space=space_no ..] [--show-system] [--from=from_lsn] [--to=to_lsn] [--replica=replica_id ..]

Play the contents of .snap/.xlog files to another Tarantool instance.

Supported options:

• --space=space_no to filter the output by space number. May be passed more than once.
• --show-system to show the contents of system spaces.
• --from=from_lsn to show operations starting from the given lsn.
• --to=to_lsn to show operations ending with the given lsn.
• --replica=replica_id to filter the output by replica id. May be passed more than once.

Commands for managing Tarantool modules¶

tarantoolctl rocks install NAME

Install a module in the current directory.

tarantoolctl rocks remove NAME

Remove a module.

tarantoolctl rocks show NAME

Show information about an installed module.

tarantoolctl rocks search NAME

Search the repository for modules.

tarantoolctl rocks list

List all installed modules.