tarantool-ruby

Ruby gems for working with Tarantool 2.11+ and 3.x. tarantool-client is a low-level IPROTO client; tarantool-crud wraps the tarantool/crud module for sharded vshard clusters; tarantool-model adds ActiveModel-based models with validations, callbacks, and keyset pagination on top of either storage backend. tarantool-schema declares spaces and indexes idempotently on deploy. tarantool-rails wires all of them into a Rails application; tarantool-opentelemetry turns the client's events into OpenTelemetry spans.

API docs for every gem: https://starlexxx.github.io/tarantool-ruby/ (generated with YARD from master).

Ruby >= 3.2, Tarantool 2.11+ or 3.x.

gem install tarantool-client
gem install tarantool-crud   # sharded clusters via tarantool/crud
gem install tarantool-model  # ActiveModel models
gem install tarantool-schema # idempotent schema declaration
gem install tarantool-rails  # Rails integration
gem install tarantool-opentelemetry  # spans for the client's events

Or in your Gemfile:

gem 'tarantool-client'
gem 'tarantool-crud'
gem 'tarantool-model'
gem 'tarantool-schema'
gem 'tarantool-rails'
gem 'tarantool-opentelemetry'

Every error raised by these gems descends from Tarantool::Error: the client's own classes such as Tarantool::ConnectionError and Tarantool::ServerError, Tarantool::Crud::Error, Tarantool::Model::Error, Tarantool::Schema::Error, and Tarantool::Rails::Error.

bundle install
bundle exec rubocop
bundle exec rake rbs   # validates the RBS signatures in each gem's sig/ and runs the unit suites under rbs/test

Each gem's README has its own test commands and the containers it needs.

MIT — see LICENSE.