Skip to content

doc: improve documetation #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nickkkccc wants to merge 3 commits into
base: master
Choose a base branch
from
Open

doc: improve documetation #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e8c793
chore(spring-data-40): bump version
nickkkccc May 18, 2026
4a9e4bd
doc: refactor for release 1.7.0
nickkkccc May 18, 2026
9d2f468
chore: bump spring-data-35 version
nickkkccc May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions documentation/doc-src/pages/spring-data/index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ using [Tarantool](https://www.tarantool.io) as a data store.

- Implementation of CRUD methods for data model classes specific to working with the Tarantool cluster
through the [tarantool/crud](https://github.com/tarantool/crud) library
- Working with stored procedures and LUA scripts through dynamic methods
- Working with stored procedures and Lua scripts through dynamic methods
- Ability to integrate custom repository code
- Flexible access configuration to Tarantool
- via spring-bean
Expand All @@ -23,25 +23,26 @@ using [Tarantool](https://www.tarantool.io) as a data store.

## Project Status

| tarantool-java-sdk Version | tarantool-spring-data Version | Spring Boot Version |
|:-------------------------:|:----------------------------:|:-------------------------------------------------:|
| 1.5.x | 1.5.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.8 |
| tarantool-java-sdk Version | tarantool-spring-data Version | Spring Boot Version |
|:--------------------------:|:-----------------------------:|:----------------------------------------------------------:|
| 1.5.x/1.6.x | 1.5.x/1.6.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.11 |
Copy link
Copy Markdown
Contributor

@dkasimovskiy dkasimovskiy May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| 1.5.x/1.6.x | 1.5.x/1.6.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.11 |
| 1.5.x/1.6.x | 1.5.x/1.6.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.8 |

| 1.7.x | 1.7.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.11 / 4.0.5 |

### Tarantool Version and Supported Client Modules

| Tarantool Version | CRUD API (cluster) | BOX API (single instance) |
|:----------------:|:------------------:|:------------------------:|
| 2.11.x | Yes | Yes (limited*) |
| 3.x | Yes | Yes (limited*) |
|:-----------------:|:------------------:|:-------------------------:|
| 2.11.x | Yes | Yes (limited*) |
| 3.x | Yes | Yes (limited*) |

???+ note "Note"

Only the configuration and retrieval of the spring bean `TarantoolBoxClient` is supported.

| Tarantool Data Grid Version | Repository API |
|:--------------------------:|:----------------:|
| 1.x | Yes (limited*) |
| 2.x | Yes (limited*) |
| Tarantool Data Grid Version | Repository API |
|:---------------------------:|:--------------:|
| 1.x | Yes (limited*) |
| 2.x | Yes (limited*) |

???+ note "Note"

Expand Down Expand Up @@ -84,11 +85,11 @@ Include the module in your project as follows:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<version>3.4.12</version>
<version>4.0.5</version>
</dependency>
<dependency>
<groupId>io.tarantool</groupId>
<artifactId>tarantool-spring-data-35</artifactId>
<artifactId>tarantool-spring-data-40</artifactId>
<version>${tarantool-spring-data.version}</version>
</dependency>
</dependencies>
Expand Down
13 changes: 7 additions & 6 deletions documentation/doc-src/pages/spring-data/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ hide:

- Реализация CRUD методов для классов моделей данных, специфичных для работы с кластером Tarantool
через библиотеку [tarantool/crud](https://github.com/tarantool/crud)
- Работа с хранимыми процедурами и скриптами LUA через динамические методы
- Работа с хранимыми процедурами и скриптами Lua через динамические методы
- Возможность интеграции пользовательского кода репозитория
- Возможности гибкой настройки доступа к Tarantool
- через spring-bean
Expand All @@ -23,9 +23,10 @@ hide:

## Статус проекта

| Версия tarantool-java-sdk | Версия tarantool-spring-data | Версия Spring Boot |
|:-------------------------:|:----------------------------:|:-------------------------------------------------:|
| 1.5.x | 1.5.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.8 |
| Версия tarantool-java-sdk | Версия tarantool-spring-data | Версия Spring Boot |
|:-------------------------:|:----------------------------:|:----------------------------------------------------------:|
| 1.5.x/1.6.x | 1.5.x/1.6.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.11 |
Copy link
Copy Markdown
Contributor

@dkasimovskiy dkasimovskiy May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| 1.5.x/1.6.x | 1.5.x/1.6.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.11 |
| 1.5.x/1.6.x | 1.5.x/1.6.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.8 |

| 1.7.x | 1.7.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.11 / 4.0.5 |

### Версия Tarantool и поддерживаемые модули-клиенты

Expand Down Expand Up @@ -84,11 +85,11 @@ Tarantool можно найти
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<version>3.5.8</version>
<version>4.0.5</version>
</dependency>
<dependency>
<groupId>io.tarantool</groupId>
<artifactId>tarantool-spring-data-35</artifactId>
<artifactId>tarantool-spring-data-40</artifactId>
<version>${tarantool-spring-data.version}</version>
</dependency>
</dependencies>
Expand Down
2 changes: 1 addition & 1 deletion documentation/doc-src/pages/spring-data/query-lua.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Stored Procedures
---

## Working with Stored Procedures and LUA Scripts
## Working with Stored Procedures and Lua Scripts

To work with LUA or stored procedures through `Repository`, declare a custom method (
the name is chosen at your discretion) and add the `@Query` annotation, selecting the
Expand Down
2 changes: 1 addition & 1 deletion documentation/doc-src/pages/spring-data/query-lua.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Хранимые процедуры
---

## Работа с хранимыми процедурами и LUA скриптами
## Работа с хранимыми процедурами и Lua скриптами

Для работы с LUA или хранимыми процедурами через `Repository` объявите пользовательский метод (
название задается по своему усмотрению) и добавьте аннотацию `@Query`, выбрав в параметрах
Expand Down
2 changes: 1 addition & 1 deletion documentation/doc-src/pages/testcontainers/index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Supported usage scenarios:
Tarantool version:

- [x] 3.x
- [ ] 2.11.x
- [x] 2.11.x

=== "TDB Cluster"

Expand Down
2 changes: 1 addition & 1 deletion documentation/doc-src/pages/testcontainers/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ hide:
Версия `Tarantool`:

- [x] 3.x
- [ ] 2.11.x
- [x] 2.11.x

=== "Кластер TDB"

Expand Down
17 changes: 9 additions & 8 deletions tarantool-spring-data/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,15 @@ data storage.

## Project Status

| tarantool-java-sdk Version | tarantool-spring-data Version | Spring Boot Version |
|:--------------------------:|:-----------------------------:|:-------------------------------------------------:|
| 1.0.0 | 1.0.0 | 2.7.18 |
| 1.1.x | 1.1.x | 2.7.18 / 3.1.10 / 3.2.4 |
| 1.2.x | 1.2.x | 2.7.18 / 3.1.10 / 3.2.4 |
| 1.3.x | 1.3.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.11 / 3.4.5 |
| 1.4.x | 1.4.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.10 |
| 1.5.x | 1.5.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.8 |
| tarantool-java-sdk Version | tarantool-spring-data Version | Spring Boot Version |
|:--------------------------:|:-----------------------------:|:---------------------------------------------------------:|
| 1.0.0 | 1.0.0 | 2.7.18 |
| 1.1.x | 1.1.x | 2.7.18 / 3.1.10 / 3.2.4 |
| 1.2.x | 1.2.x | 2.7.18 / 3.1.10 / 3.2.4 |
| 1.3.x | 1.3.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.11 / 3.4.5 |
| 1.4.x | 1.4.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.10 |
| 1.5.x/1.6.x | 1.5.x/1.6.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.8 |
| 1.7.x | 1.7.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.8 / 4.0.5 |
Copy link
Copy Markdown
Contributor

@dkasimovskiy dkasimovskiy May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| 1.7.x | 1.7.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.8 / 4.0.5 |
| 1.7.x | 1.7.x | 2.7.18 / 3.1.10 / 3.2.4 / 3.3.13 / 3.4.13 / 3.5.11 / 4.0.5 |


### Tarantool Version and Supported Client Modules

Expand Down
2 changes: 1 addition & 1 deletion tarantool-spring-data/tarantool-spring-data-35/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<spring.boot.version>3.5.10</spring.boot.version>
<spring.boot.version>3.5.11</spring.boot.version>
<shared.dir>${project.parent.parent.basedir}/tarantool-shared-resources/</shared.dir>
<license.header.file>${project.parent.parent.basedir}/LICENSE_HEADER.txt</license.header.file>
</properties>
Expand Down
2 changes: 1 addition & 1 deletion tarantool-spring-data/tarantool-spring-data-40/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<properties>
<!-- Recommended Java version is 25, minimal version is 17 -->
<maven.compiler.release>17</maven.compiler.release>
<spring.boot.version>4.0.4</spring.boot.version>
<spring.boot.version>4.0.5</spring.boot.version>
<shared.dir>${project.parent.parent.basedir}/tarantool-shared-resources/</shared.dir>
<license.header.file>${project.parent.parent.basedir}/LICENSE_HEADER.txt</license.header.file>
<!-- Spring Framework 7.x uses JUnit 6 -->
Expand Down