Skip to content
Snippets Groups Projects
user avatar
Alexander Turenko authored
This commit aims several goals.

First, we're going to recommend `tt` as a tool to run and manage
tarantool instances. The tool is going to replace `tarantoolctl` and it
seems valuable to sync recipes across different parts of the
documentation (including this help message).

Second, the action options and modifier options are separated now. At
least one action option should be specified. I hope, it is more obvious
from the help message now.

Third, single line descriptions are replaced with a bit more extended
ones to give a user basic context to understand an influence of an
option.

Updated the man page accordingly: synchronized the options, removed
`tarantoolctl`.

Part of #8862

NO_TEST=the help message is not an API for a developer
NO_CHANGELOG=nothing new here, just better wording here and there

@TarantoolBot document
Title: Update CLI options documentation

https://www.tarantool.io/en/doc/latest/reference/configuration/#command-options
seems to need an update. See the linked commit for details and updated
`tarantool --help` message.
d5c874e1
History

Tarantool

Actions Status Code Coverage OSS Fuzz Telegram GitHub Discussions Stack Overflow

Tarantool is an in-memory computing platform consisting of a database and an application server.

It is distributed under BSD 2-Clause terms.

Key features of the application server:

Key features of the database:

  • MessagePack data format and MessagePack based client-server protocol.
  • Two data engines: 100% in-memory with complete WAL-based persistence and an own implementation of LSM-tree, to use with large data sets.
  • Multiple index types: HASH, TREE, RTREE, BITSET.
  • Document oriented JSON path indexes.
  • Asynchronous master-master replication.
  • Synchronous quorum-based replication.
  • RAFT-based automatic leader election for the single-leader configuration.
  • Authentication and access control.
  • ANSI SQL, including views, joins, referential and check constraints.
  • Connectors for many programming languages.
  • The database is a C extension of the application server and can be turned off.

Supported platforms are Linux (x86_64, aarch64), Mac OS X (x86_64, M1), FreeBSD (x86_64).

Tarantool is ideal for data-enriched components of scalable Web architecture: queue servers, caches, stateful Web applications.

To download and install Tarantool as a binary package for your OS or using Docker, please see the download instructions.

To build Tarantool from source, see detailed instructions in the Tarantool documentation.

To find modules, connectors and tools for Tarantool, check out our Awesome Tarantool list.

Please report bugs to our issue tracker. We also warmly welcome your feedback on the discussions page and questions on Stack Overflow.

We accept contributions via pull requests. Check out our contributing guide.

Thank you for your interest in Tarantool!