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 6f6ae50
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,59 @@ 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 and JSON
paths support. We do our best to provide uniform support for all supported
Tarantool version with help of compatibility layer, runtime feature detection
etc. but anyway some Tarantool versions has limited support in CRUD.

- 1.10 (latest patch version)
- tuple-keydef: since 1.10.7-85-g840c13293
- tuple-merger: since 1.10.7-91-g9ee14eca5
- key_def: TODO
- merger: TODO
- JSON paths: TODO
- 2.2 (latest patch version)
- tuple-keydef: unsupported?
- tuple-merger: unsupported?
- key_def: since 2.2.2, see https://github.com/tarantool/tarantool/issues/3398
- merger: TODO
- JSON paths: TODO
- 2.3 (latest patch version)
- tuple-keydef: unsupported?
- tuple-merger: unsupported?
- key_def: TODO
- merger: 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`.
- JSON paths: TODO
- 2.5 (latest patch version)
- tuple-keydef: since 2.5.1-145-geea90d7ce
- tuple-merger: since 2.5.1-150-g98ff9aae0
- key_def: TODO
- merger: TODO
- JSON paths: TODO
- 2.6 (latest patch version)
- tuple-keydef: since 2.6.0-188-g4a12985f1
- tuple-merger: since 2.6.0-193-g3dc6a76c8
- key_def: TODO
- merger: TODO
- JSON paths: since 2.6.3
- 2.7 (latest patch version)
- tuple-keydef: all versions
- tuple-merger: all versions
- merger: TODO
- key_def: TODO
- JSON paths: since 2.7.2
- 2.8 (latest patch version)
- tuple-keydef: all versions
- tuple-merger: all versions
- merger: TODO
- key_def: TODO
- JSON paths: since 2.8.1

## API

The CRUD operations should be called from router.
Expand Down

0 comments on commit 6f6ae50

Please sign in to comment.