tarantool-crud 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11970ebf33857fa1e2258adb32da2269bf1b1df9cc996f6651694512ec7ebbcb
-  data.tar.gz: 3416899d889c8e7588c5d9d798474ffecef168571f21dc734215a3277fadb70f
+  metadata.gz: 94250daa4b601caa86d7135bc072d19acab551444b77abbbc5baf5f815392e72
+  data.tar.gz: 87548a43bb0e3cb74289bddbc67b49ad942ca644c5d0420e4c0a88e5b16f2488
 SHA512:
-  metadata.gz: cd2dda38a9f0ea4bab6c5a45f9479feae2b41cfcb0c244a426997138adcec973c6111297caee62829c0b3641a45cd5b420ce5036d763012b223ce955270422b1
-  data.tar.gz: abad29a2402e6830535dd5c0bf569962b1d4636ad35e4b665557d060ac7a6a97a025d1c9747abccce6b649f73cf8b917e01d66d8c02a35bf1d6a354b49ca32fd
+  metadata.gz: ee11036c413af3b0694382947e77d72f24a224c49cb18bf7d6d6efd18e612ffd7ddc99401ff2eb390b8db3ab913e5e7b7003ff061d56b7c4d59a5f8ba6d15d12
+  data.tar.gz: 20a4045f278bd37758357ddd19a82e9371b8efa31b0d19e684612919a436666cdcfa9fedd332920853fe6dc66bf8e9c5bf901ee5752d73090451754771d69d84

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.2.0 (unreleased)
+
+- `Client#schema(space = nil)`: `crud.schema` through the router, returned in the shape of a tarantool-schema
+  declaration (`MemoryStorage.new(crud.schema, behaves_like: :crud)` works); `Crud::SchemaError`.
+- Depends on `tarantool-client ~> 0.3`.
+
 ## 0.1.1 (2026-10-17)
 
 - Depends on `tarantool-client ~> 0.2.0`.

data/README.md

@@ -73,6 +73,21 @@ returns an Enumerator without a block. Single-row operations (`get`, `insert`, `
 call fails (missing space, empty row list, ...), crud reports it as `InsertManyError`/`ReplaceManyError`/
 `UpsertManyError` inside `errors` with no rows, rather than raising.
 
+## Schema
+
+```ruby
+crud.schema(:users)   # => { format: [{ name: :id, type: 'unsigned', is_nullable: false }, ...],
+                      #      indexes: [{ name: :primary, type: 'tree', unique: true,
+                      #                  parts: [{ field: :id, type: 'unsigned', is_nullable: false }] }, ...] }
+crud.schema           # => { users: { format: ..., indexes: ... }, ... }
+```
+
+`crud.schema` through the router, for applications without read access to `_space`. The shape is the one
+tarantool-schema declares (Symbol names, String types, indexes in id order, parts named by their field), so
+tarantool-model's in-memory storage takes it as is: `MemoryStorage.new(crud.schema, behaves_like: :crud)`.
+`exclude_null` is dropped; a part past the format is named `:"#N"` by its position. An unknown space raises
+`SchemaError`. Options: `timeout:`, `vshard_router:`, and crud's `cached:`.
+
 ## Conditions
 
 An Array of `[operator, field, value]` or a Hash:
@@ -102,7 +117,7 @@ The `mode:` option here is the crud/vshard router option (`'read'` or `'write'`
 
 `Tarantool::Crud::Error` has `message` (the crud error message), `str` (crud's `tostring` of the full error, e.g. `"InsertError: ..."`), `class_name`, `file`, `line`, and `operation_data`. Subclasses: `InsertError`,
 `ReplaceError`, `UpsertError`, `GetError`, `UpdateError`, `DeleteError`, `SelectError`, `CountError`, `MinMaxError`,
-`LenError`, `TruncateError`, `CallError`, `InsertManyError`, `ReplaceManyError`, `UpsertManyError`.
+`LenError`, `TruncateError`, `SchemaError`, `CallError`, `InsertManyError`, `ReplaceManyError`, `UpsertManyError`.
 `Tarantool::Crud::ManyError` is a separate `Tarantool::Error` subclass raised by the `*_many!` bang variants; it
 carries `result` (and `errors`), not the crud error fields. Transport and server errors from tarantool-client
 propagate unchanged.
@@ -114,11 +129,19 @@ in the message. Only a request that gets no answer within the transport timeout
 ## Development
 
 ```sh
-podman compose -f tarantool-crud/docker-compose.yml up -d --wait --build
+podman compose -f tarantool-crud/docker-compose.yml up -d --wait
 cd tarantool-crud
 INTEGRATION=1 TARANTOOL_CRUD_URI=tcp://app:secret@localhost:3311 bundle exec rspec
 ```
 
+Compose pulls `ghcr.io/starlexxx/tarantool-crud:2.11` and `:3` (Tarantool with vshard and crud from
+`docker/Dockerfile`), built by the `Images` workflow whenever `docker/` changes. If the pull is denied, log in
+with `podman login ghcr.io` and a token that has `read:packages`. To try a Dockerfile change locally:
+
+```sh
+docker build -t ghcr.io/starlexxx/tarantool-crud:3 --build-arg TARANTOOL_VERSION=3 tarantool-crud/docker
+```
+
 ## Public API
 
 `Tarantool::Crud::Client`, `Space`, `Result`, `ManyResult`, and the error classes above.

data/lib/tarantool/crud/client.rb

@@ -12,6 +12,15 @@ module Tarantool
 
       def storage_info(**options) = @call.value('storage_info', [], options)
 
+      # The format and indexes of one space, or of every space keyed by name, as crud sees them through the
+      # router: the same shape as a tarantool-schema declaration, so MemoryStorage.new(crud.schema, behaves_like: :crud)
+      # works. An unknown space raises SchemaError.
+      def schema(space = nil, **options)
+        raw = @call.value('schema', [space&.to_s], options)
+
+        space ? Schema.space(raw) : Schema.all(raw)
+      end
+
       # crud.stats takes no options and encodes an empty table as an Array.
       def stats(space = nil, timeout: nil)
         stats = @call.without_options('stats', [space&.to_s].compact, timeout).first

data/lib/tarantool/crud/defaults.rb

@@ -6,7 +6,7 @@ module Tarantool
     # narrowed to what each function accepts (crud 1.8.0); options given to a call are sent as is.
     # @api private
     class Defaults
-      READ_FUNCTIONS = %w[get select count min max len storage_info stats].freeze
+      READ_FUNCTIONS = %w[get select count min max len storage_info stats schema].freeze
 
       READ = %i[timeout request_timeout bucket_id prefer_replica balance mode vshard_router].freeze
       BORDERS = %i[timeout request_timeout fields mode vshard_router fetch_latest_metadata].freeze
@@ -27,6 +27,7 @@ module Tarantool
         'max' => BORDERS,
         'len' => READ - %i[bucket_id],
         'storage_info' => SERVICE,
+        'schema' => SERVICE,
         'stats' => %i[timeout],
         'truncate' => SERVICE,
         'insert' => TUPLE,

data/lib/tarantool/crud/errors.rb

@@ -36,6 +36,7 @@ module Tarantool
     class MinMaxError < Error; end
     class LenError < Error; end
     class TruncateError < Error; end
+    class SchemaError < Error; end
 
     # One row of a *_many call failed; operation_data holds that row.
     class CallError < Error; end
@@ -71,6 +72,7 @@ module Tarantool
         'BorderError' => MinMaxError,
         'LenError' => LenError,
         'TruncateError' => TruncateError,
+        'SchemaError' => SchemaError,
         'CallError' => CallError,
         'InsertManyError' => InsertManyError,
         'ReplaceManyError' => ReplaceManyError,

data/lib/tarantool/crud/schema.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Tarantool
+  module Crud
+    # crud.schema output in the shape tarantool-schema declares and MemoryStorage accepts: Symbol names,
+    # String types, indexes as an Array in id order, parts named by field. exclude_null is dropped.
+    # @api private
+    module Schema
+      module_function
+
+      def all(raw) = raw.to_h { |name, space| [name.to_sym, space(space)] }
+
+      def space(raw)
+        format = Array(raw['format']).map { |field| field(field) }
+        indexes = Array(raw['indexes']&.values).sort_by { |index| index['id'] }
+
+        { format:, indexes: indexes.map { |index| index(index, format) } }
+      end
+
+      def field(raw)
+        { name: raw.fetch('name').to_sym, type: raw.fetch('type', 'any'), is_nullable: raw.fetch('is_nullable', false) }
+      end
+
+      def index(raw, format)
+        { name: raw.fetch('name').to_sym, type: raw.fetch('type').downcase, unique: raw.fetch('unique'),
+          parts: Array(raw['parts']).map { |part| part(part, format) } }
+      end
+
+      def part(raw, format)
+        fieldno = raw.fetch('fieldno')
+        field = format[fieldno - 1]&.fetch(:name) || :"##{fieldno}"
+        part = { field:, type: raw.fetch('type'), is_nullable: raw.fetch('is_nullable', false) }
+        part[:path] = raw['path'] if raw['path']
+
+        part
+      end
+    end
+  end
+end

data/lib/tarantool/crud/version.rb

@@ -2,6 +2,6 @@
 
 module Tarantool
   module Crud
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/lib/tarantool/crud.rb

@@ -10,5 +10,6 @@ require_relative 'crud/many_result'
 require_relative 'crud/defaults'
 require_relative 'crud/call'
 require_relative 'crud/scan'
+require_relative 'crud/schema'
 require_relative 'crud/space'
 require_relative 'crud/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tarantool-crud
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Starlexxx
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.3'
 description: Per-space CRUD, conditions, pagination and batch operations over the
   tarantool/crud module for vshard clusters on Tarantool 2.11+ and 3.x, built on tarantool-client.
 email:
@@ -44,6 +44,7 @@ files:
 - lib/tarantool/crud/many_result.rb
 - lib/tarantool/crud/result.rb
 - lib/tarantool/crud/scan.rb
+- lib/tarantool/crud/schema.rb
 - lib/tarantool/crud/space.rb
 - lib/tarantool/crud/version.rb
 homepage: https://github.com/Starlexxx/tarantool-ruby