Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 91 lines (66 sloc) 2.856 kb
6908df6 Konstantin Osipov Rename 'silverbox' to 'box', across the board.
kostja authored
1 TARANTOOL/BOX
9b8dd70 Yuriy Vostrikov Initial public import
delamonpansie authored
2
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
3 Tarantool is a framework for in-memory key/value storage and
6908df6 Konstantin Osipov Rename 'silverbox' to 'box', across the board.
kostja authored
4 Box is a yet another in-memory key-value database.
9b8dd70 Yuriy Vostrikov Initial public import
delamonpansie authored
5
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
6 Key features of the pair include:
9b8dd70 Yuriy Vostrikov Initial public import
delamonpansie authored
7 * log streaming replication
8 * hot standby
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
9 * a simple binary protocol, as well as emulation of memcached
10 protocol
11 * extensibility and speed
9b8dd70 Yuriy Vostrikov Initial public import
delamonpansie authored
12
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
13 Caveats:
14 * currently supported platforms are only Linux/x86 and
15 FreeBSD/x86
16 * gcc is the only supported compiler.
9b8dd70 Yuriy Vostrikov Initial public import
delamonpansie authored
17
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
18 COMPILATION AND INSTALL
cdf4270 Yuriy Vostrikov [core] update README, add instructions on how to run tarantool_silverbox
delamonpansie authored
19
e492c25 Konstantin Osipov Fix the test runner after rename of --daemonize to --background.
kostja authored
20 Tarantool is written in C and Objective C.
bfd79ec Konstantin Osipov Lua: continue extending the user guide.
kostja authored
21 To build, you will need GCC Objective C frontend
22 (gcc-objc package on most systems) or Apple CLang compiler.
e492c25 Konstantin Osipov Fix the test runner after rename of --daemonize to --background.
kostja authored
23
24 CMake is used for configuration management.
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
25 3 standard CMake build types are supported:
26 * Debug -- used by project maintainers
27 * RelWithDebugInfo -- the most common release configuration,
28 also provides debugging capabilities
29 * Release -- use only if the highest performance is required
cdf4270 Yuriy Vostrikov [core] update README, add instructions on how to run tarantool_silverbox
delamonpansie authored
30
bfd79ec Konstantin Osipov Lua: continue extending the user guide.
kostja authored
31 The only external library dependency is readline: libreadline-dev
32 is required to build the command line client.
33
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
34 Please follow these steps to compile Tarantool:
cdf4270 Yuriy Vostrikov [core] update README, add instructions on how to run tarantool_silverbox
delamonpansie authored
35
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
36 tarantool $ cmake .
37 tarantool $ make
38
f35706e Konstantin Osipov Extend README file.
kostja authored
39 To use a different release type, say, RelWithDebugInfo, use:
40
41 tarantool $ cmake . -DCMAKE_BUILD_TYPE=RelWithDebugInfo
42
bfd79ec Konstantin Osipov Lua: continue extending the user guide.
kostja authored
43 Additional build options can be set similarly:
44
45 tarantool $ cmake . -DCMAKE_BUILD_TYPE=RelWithDebugInfo -DENABLE_CLIENT=true
46
47 -- builds the command line client.
48
49 'make' creates tarantool_box executable in directory
50 mod/box and tarantool executable in client/tarantool.
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
51
52 There is no 'make install' goal, but no installation
53 is required either.
61b4da2 Konstantin Osipov Update README with a list of required Python modules.
kostja authored
54 Tarantool regression testing framework (test/test-run.py) is the
55 simplest way to setup and start the server, but it requires a few
56 additional Python modules:
57 * daemon
58 * pyyaml
59 * pexpect.
60
61 Once all pre-requisites are installed, try:
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
62
63 tarantool $ cd test && ./test-run.py --start-and-exit
64
61b4da2 Konstantin Osipov Update README with a list of required Python modules.
kostja authored
65 This will create a 'var' subdirectory in directory 'test',
9ad508e Konstantin Osipov User manual: initial commit
kostja authored
66 populate it with necessary files, and
61b4da2 Konstantin Osipov Update README with a list of required Python modules.
kostja authored
67 start the server. To connect, you could use
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
68 a simplistic command-line client:
69
70 tarantool $ ./test/tarantool
71
72 Alternatively, if a customized server configuration is required,
73 you could follow these steps:
74
6908df6 Konstantin Osipov Rename 'silverbox' to 'box', across the board.
kostja authored
75 tarantool $ emacs cfg/tarantool_box_cfg.cfg # edit the configuration
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
76 # Initialize the storage directory, path to this directory
77 # is specified in the configuration file:
6908df6 Konstantin Osipov Rename 'silverbox' to 'box', across the board.
kostja authored
78 tarantool $ mod/box/tarantool_box --config cfg/tarantool_box_cfg.cfg --init-storage
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
79 #
80 # run
6908df6 Konstantin Osipov Rename 'silverbox' to 'box', across the board.
kostja authored
81 tarantool $ mod/box/tarantool_box --config cfg/tarantool_box_cfg.cfg
82e966b Konstantin Osipov Blueprint 'cmake-based-build' initial commit.
kostja authored
82
83 Please report bugs at http://bugs.launchpad.net/tarantool.
84 We also warmly welcome your feedback in the discussion mailing
85 list, tarantool-developers@lists.launchpad.net, however, please be
86 warned: Launchpad silently deletes posts from non-subscribed
87 members, thus please be sure to have subscribed to the list prior
88 to posting.
89
90 Thank you for your interest in Tarantool!
Something went wrong with that request. Please try again.