Skip to content

Commit 0107000

Browse files
committed
Fixes gh-551 Convert "Storing data w vinyl" article to ReST
1 parent d11c5f8 commit 0107000

35 files changed

+833
-348
lines changed

conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
extensions = [
1717
'sphinx.ext.todo',
18+
'sphinx.ext.imgmath',
1819
'sphinx.ext.ifconfig',
1920
'sphinx.ext.intersphinx',
2021
'sphinx.ext.imgconverter',
@@ -48,7 +49,7 @@
4849
'doc/1.9/book/admin.rst',
4950
'doc/1.9/book/box/box_introspection.rst',
5051
'doc/1.9/book/cookbook.rst',
51-
'doc/1.9/book/box/vinyl.rst',
52+
'doc/1.9/book/box/engines/vinyl.rst',
5253
'doc/1.9/dev_guide/box_protocol.rst',
5354
'doc/1.9/dev_guide/internals.rst',
5455
'doc/1.9/reference/configuration/cfg_*',
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/1.9/book/box/engines/index.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. _engines-chapter:
2+
3+
********************************************************************************
4+
Storage engines
5+
********************************************************************************
6+
7+
A storage engine is a set of very-low-level routines which actually store and
8+
retrieve tuple values. Tarantool offers a choice of two storage engines:
9+
10+
* memtx (the in-memory storage engine) is the default and was the first to
11+
arrive.
12+
13+
* vinyl (the on-disk storage engine) is a working key-value engine and will
14+
especially appeal to users who like to see data go directly to disk, so that
15+
recovery time might be shorter and database size might be larger.
16+
17+
On the other hand, vinyl lacks some functions and options that are available
18+
with memtx. Where that is the case, the relevant description in this manual
19+
contains a note beginning with the words "Note re storage engine".
20+
21+
Further in this section we discuss the details of storing data using
22+
the vinyl storage engine.
23+
24+
To specify that the engine should be vinyl, add the clause ``engine = 'vinyl'``
25+
when creating a space, for example:
26+
27+
.. code-block:: lua
28+
29+
space = box.schema.space.create('name', {engine='vinyl'})
30+
31+
.. include:: vinyl.rst

doc/1.9/book/box/engines/vinyl.rst

Lines changed: 799 additions & 0 deletions
Large diffs are not rendered by default.
23.6 KB
Loading
Loading
14.5 KB
Loading
14 KB
Loading
10.4 KB
Loading
10.3 KB
Loading
6.28 KB
Loading
Loading
17.3 KB
Loading
13 KB
Loading
2.69 KB
Loading
28.2 KB
Loading
7.97 KB
Loading
13.2 KB
Loading
15.4 KB
Loading
16.3 KB
Loading
34.2 KB
Loading

doc/1.9/book/box/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ This chapter contains the following sections:
1818
authentication
1919
triggers
2020
limitations
21+
engines/index

0 commit comments

Comments
 (0)