Java driver for Tarantool Cartridge for Tarantool versions 1.10+ based on the asynchronous Netty framework and official MessagePack serializer. Provides CRUD APIs for seamlessly working with standalone Tarantool servers and clusters managed by Tarantool Cartridge with sharding via vshard.
Example of single instance Tarantool application and java app connected using cartridge-java.
The easiest way to start experimenting with cartridge-java and single instance tarantool app is to use single instance test. You can set breakpoints and run it in debug mode. Testcontainers will start single instance tarantool application for you. So you will be able to manipulate data in Tarantool in real life through java expressions or Tarantool console.
If you want to start tarantool application manually all you need is to run this file in tarantool
tarantool src/test/resources/single-instance.luaExample of TarantoolClient set up
Example of client API usage
You can read more about Cartridge applications in its documentation. Also look at available Cartridge application examples.
If you use this code in another project don't forget to add cartridge-driver dependency:
<dependency>
<groupId>io.tarantool</groupId>
<artifactId>cartridge-driver</artifactId>
<version>0.10.1</version>
</dependency>- Cluster client
Connecting to Tarantool nodes.
The client can connect to storages and obtain data from spaces directly by space interface via native iproto binary protocol.
It may call lua storing procedures or eval lua code on nodes. - Proxy methods
Connecting to routers with crud library. It proxies space interface's methods to crud methods. - Retrying
Retrying transient cluster failures. - TarantoolTuple usage
Creating and operating with TarantoolTuple entity. - Custom sharding function
Determining bucket id on java side. - Thread control
Specifying custom numbers of netty work threads.
The Java Docs are available at Github pages.
If you have any questions about working with Tarantool, check out the site tarantool.io.
Feel free to ask questions about Tarantool and usage of this driver on Stack Overflow with tag tarantool or join our community support chats in Telegram: English and Russian.
Java 1.8 or higher is required for building and using this driver.
- Docker accessible to the current user is required for running integration tests.
- Set up the right user for running Tarantool with in the container:
export TARANTOOL_SERVER_USER=<current user>
export TARANTOOL_SERVER_GROUP=<current group>Substitute the user and group in these commands with the user and group under which the tests will run.
3. Use ./mvnw verify to run unit tests and ./mvnw test -Pintegration to run integration tests.
4. Use ./mvnw install for installing the artifact locally.
Contributions to this project are always welcome and highly encouraged. See conventions for tests