Skip to content

Commit

Permalink
Describe supported Tarantool versions with limitations
Browse files Browse the repository at this point in the history
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]

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/
  • Loading branch information
ligurio committed Sep 3, 2021
1 parent 9a5427e commit 8404b49
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,38 @@ The `CRUD` module allows to perform CRUD operations on the cluster.
It also provides the `crud-storage` role for
[Tarantool Cartridge](https://github.com/tarantool/cartridge).

# Supported Tarantool versions

CRUD depends on Tarantool features like key_def, merger, UUID modules etc.
Due to this some Tarantool versions has limited support in CRUD.

- 1.10 (latest patch version)
- since 1.10.7-85-g840c13293, where tuple-keydef module became builtin.
- since 1.10.7-91-g9ee14eca5, where tuple-merger module became builtin.
- 2.2 (latest patch version)
- since 2.2.2, where key_def has been introduced, see
https://github.com/tarantool/tarantool/issues/3398
- 2.3 (latest patch version)
- since 2.3.3 due to Tarantool's SEGFAULT, see
https://github.com/tarantool/tarantool/issues/4954. For Tarantool versions
higher 2.x and lower 2.3.3 CRUD uses another implementation of select
module, see `crud/select/compat/select_old.lua`.
- 2.5 (latest patch version)
- since 2.5.1-145-geea90d7ce, where tuple-keydef module became builtin.
- since 2.5.1-150-g98ff9aae0, where tuple-merger module became builtin.
- 2.6 (latest patch version)
- since 2.6.0-188-g4a12985f1, where tuple-keydef module became builtin.
- since 2.6.0-193-g3dc6a76c8, where tuple-merger module became builtin.
- since 2.6.3, where jsonpath indexes support for queries has been added
- 2.7 (latest patch version)
- since 2.7.2, where jsonpath indexes support for queries has been added
- merger: all versions
- key_def: all versions
- 2.8 (latest patch version)
- since 2.8.1, where jsonpath indexes support for queries has been added
- merger: all versions
- key_def: all versions

## API

The CRUD operations should be called from router.
Expand Down

0 comments on commit 8404b49

Please sign in to comment.