Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

efficient in-memory storage

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 cfg
Octocat-spinner-32 cmake
Octocat-spinner-32 connector
Octocat-spinner-32 core
Octocat-spinner-32 doc
Octocat-spinner-32 extra
Octocat-spinner-32 include
Octocat-spinner-32 mod
Octocat-spinner-32 scripts
Octocat-spinner-32 test
Octocat-spinner-32 third_party
Octocat-spinner-32 .gdbinit
Octocat-spinner-32 .gitignore
Octocat-spinner-32 CMakeLists.txt
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README
Octocat-spinner-32 TODO
README
TARANTOOL/BOX

Tarantool is a framework for in-memory key/value storage and
Box is a yet another in-memory key-value database.

Key features of the pair include:
 * log streaming replication
 * hot standby
 * a simple binary protocol, as well as emulation of memcached
   protocol
 * extensibility and speed

Caveats:
 * currently supported platforms are only Linux/x86 and
   FreeBSD/x86
 * gcc is the only supported compiler.

COMPILATION AND INSTALL

Tarantool uses CMake for configuration management.
3 standard CMake build types are supported:
 * Debug -- used by project maintainers
 * RelWithDebugInfo -- the most common release configuration,
 also provides debugging capabilities
 * Release -- use only if the highest performance is required

Please follow these steps to compile Tarantool:

tarantool $ cmake .
tarantool $ make

'make' will create tarantool_box executable in directory
mod/box.

There is no 'make install' goal, but no installation
is required either.
Tarantool regression testing framework (test/test-run.py) is the
simplest way to setup and start the server, but it requires a few
additional Python modules:
 * daemon
 * pyyaml
 * pexpect.

Once all pre-requisites are installed, try:

tarantool $ cd test && ./test-run.py --start-and-exit

This will create a 'var' subdirectory in directory 'test',
populate it with necessary files used by the server, and
start the server. To connect, you could use
a simplistic command-line client:

tarantool $ ./test/tarantool

Alternatively, if a customized server configuration is required,
you could follow these steps:

tarantool $ emacs cfg/tarantool_box_cfg.cfg # edit the configuration
# Initialize the storage directory, path to this directory
# is specified in the configuration file:
tarantool $ mod/box/tarantool_box --config cfg/tarantool_box_cfg.cfg --init-storage
#
# run
tarantool $ mod/box/tarantool_box --config cfg/tarantool_box_cfg.cfg

Please report bugs at http://bugs.launchpad.net/tarantool.
We also warmly welcome your feedback in the discussion mailing
list, tarantool-developers@lists.launchpad.net, however, please be
warned: Launchpad silently deletes posts from non-subscribed
members, thus please be sure to have subscribed to the list prior
to posting.

Thank you for your interest in Tarantool!
Something went wrong with that request. Please try again.