Skip to content

Commit 46999e4

Browse files
committed
Describe supported Tarantool versions with limitations
For those who interested to dig to a topic himself I recommend to start with: - search using of helper functions like utils.tarantool_supports_* in source code base - search conditions with `_TARANTOOL` in source codebase - supported Tarantool versions by tuple-keydef module [1] - supported Tarantool versions by tuple-merger module [2] - source code for compatibility layer in CRUD - "Select: support jsonpath indexes (#158)" (27d825f) - JSON paths support in Tarantool [3] - release notes 1. https://github.com/tarantool/tuple-keydef#compatibility 2. https://github.com/tarantool/tuple-merger#backward-and-forward-compatibility-guarantees 3. https://www.tarantool.io/en/doc/latest/reference/reference_lua/json_paths/ 4. https://www.tarantool.io/en/doc/latest/release/
1 parent 9a5427e commit 46999e4

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,47 @@ The `CRUD` module allows to perform CRUD operations on the cluster.
88
It also provides the `crud-storage` role for
99
[Tarantool Cartridge](https://github.com/tarantool/cartridge).
1010

11+
# Supported Tarantool versions
12+
13+
CRUD depends on Tarantool features like key_def, merger, UUID modules and JSON
14+
paths support. We do our best to provide uniform support for all supported
15+
Tarantool version with help of compatibility layer, runtime feature detection
16+
etc. but anyway some Tarantool versions has limited support in CRUD. Please
17+
consult with a list below to choose a Tarantool version compatible with CRUD
18+
module before use:
19+
20+
- 1.10: since 1.10.7-91-g9ee14eca5 with tuple-merger<sup>1</sup> and
21+
tuple-keydef<sup>2</sup> modules, without UUID keys comparison and without
22+
Jsonpath indexes
23+
- 2.2: since 2.2.0-268-gc7915eccd with key_def and merger modules, without
24+
UUID keys comparison and without Jsonpath indexes
25+
- 2.3: since 2.3.2-99-g487289ad2 with key_def and merger modules, without UUID
26+
keys comparison and without Jsonpath indexes
27+
- 2.5: since 2.5.0-275-g9be50ae74 with key_def and merger modules and without
28+
Jsonpath indexes
29+
- 2.6: since 2.6.2-99-gf92b9e21
30+
- 2.7: since 2.7.1-102-g84edc33fb
31+
- 2.8: since 2.8.0-113-gb3d4648d8
32+
33+
1. Differences from the built-in merger module - https://github.com/tarantool/tuple-merger#backward-and-forward-compatibility-guarantees
34+
2. Differences from the built-in key_def module - https://github.com/tarantool/tuple-keydef#differences-from-the-built-in-module
35+
36+
For more information see the table below that describes Tarantool's versions
37+
and features for what CRUD module depends on:
38+
39+
| Branch | merger | tuple-merger | key_def | tuple-keydef | UUID | JSON paths |
40+
|--------|----------------------------------|----------------------|--------------|----------------------|--------------|-----------------------|
41+
| 1.10 | Unsupported | 1.10.7-91-g9ee14eca5 | Unsupported | 1.10.7-85-g840c13293 | Unsupported | Unsupported |
42+
| 2.2 | 2.2.0-268-gc7915eccd | Unsupported | All versions | Unsupported | Unsupported | Unsupported |
43+
| 2.3 | 2.3.2-99-g487289ad2<sup>1</sup> | Unsupported | All version | Unsupported | Unsupported | Unsupported |
44+
| 2.5 | 2.5.0-275-g9be50ae74<sup>1</sup> | 2.5.1-150-g98ff9aae0 | All version | 2.5.1-145-geea90d7ce | All versions | Unsupported |
45+
| 2.6 | All versions | 2.6.0-193-g3dc6a76c8 | All version | 2.6.0-188-g4a12985f1 | All versions | 2.6.2-99-gf92b9e21 |
46+
| 2.7 | All versions | All versions | All version | All versions | All versions | 2.7.1-102-g84edc33fb |
47+
| 2.8 | All versions | All versions | All version | All versions | All versions | 2.8.0-113-gb3d4648d8 |
48+
49+
1. merger has been added in 2.2.0-268-gc7915eccd, but usage was blocked due to
50+
Tarantool's SEGFAULT, see https://github.com/tarantool/tarantool/issues/4954
51+
1152
## API
1253

1354
The CRUD operations should be called from router.

0 commit comments

Comments
 (0)