Skip to content

index.en.md

Latest commit

 

History

History
95 lines (70 loc) · 3.57 KB

index.en.md

File metadata and controls

95 lines (70 loc) · 3.57 KB
title Spring Data
hide
toc

Spring Data Tarantool is a Spring Data module that simplifies creating applications based on Spring :simple-spring:, using Tarantool as a data store.

Features

  • Implementation of CRUD methods for data model classes specific to working with the Tarantool cluster through the tarantool/crud library
  • Working with stored procedures and LUA scripts through dynamic methods
  • Ability to integrate custom repository code
  • Flexible access configuration to Tarantool
    • via spring-bean
    • via configuration files (.properties/.yaml)
  • Convenient integration with Spring infrastructure
  • Automatic implementation of the Repository interface using @EnableTarantoolRepositories, including support for custom queries

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 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*)

???+ 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*)

???+ note "Note"

Release 1.4.0 introduced an experimental version of the client for Tarantool Data Grid,
with support for CRUD operations.

Prerequisites Before Working with the Spring Data Tarantool Module

Having a Tarantool Database

To work with the module, access to a running Tarantool is required. Instructions for installing and running Tarantool can be found here: github.

???+ warning "Important"

- This module is designed to work with Tarantool versions `2.11.x` and `3.x`. Differences between versions 
  can be found in the [`official documentation`](https://www.tarantool.io/en/doc/latest/).
- Working with lower versions of Tarantool is possible but not guaranteed

???+ note "Note"

For familiarization or reviewing examples, it's convenient to use
[`docker`](https://www.tarantool.io/en/download/os-installation/docker-hub/) and/or
[`testcontainers`](https://testcontainers.com) as a runtime environment for Tarantool.

???+ note "Note"

It's also worth reviewing the 
[tarantool-java-sdk/testcontainers](../testcontainers/index.md) module, which will reduce 
the time spent using `Tarantool` with `testcontainers` in Java.

Loading the Library on the Development Machine

Include the module in your project as follows:

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>3.4.12</version>
  </dependency>
  <dependency>
    <groupId>io.tarantool</groupId>
    <artifactId>tarantool-spring-data-35</artifactId>
    <version>${tarantool-spring-data.version}</version>
  </dependency>
</dependencies>