Skip to content

docs: fill gaps in spring-data getting started - #134

Merged
bitgorbovsky merged 1 commit into
tarantool:masterfrom
NorthArea:northarea/spring-data-prerequisites
Oct 22, 2026
Merged

bitgorbovsky merged 1 commit into
tarantool:masterfrom
NorthArea:northarea/spring-data-prerequisites

Conversation

@NorthArea

Copy link
Copy Markdown
Collaborator

Users of tarantool-spring-data hit the same questions when they start: why Repository calls fail with Procedure 'crud.select' is not defined on a plain tarantool/tarantool image, why the configuration example with auth-type: pap_sha256 fails to log in, how to delete many keys or select by IN, and which tarantool-spring-data-* module to take for their Spring Boot version. This PR answers them in the documentation.

  • Spring Data overview: a warning that Repository needs a cluster with crud and vshard, with three ways to get one (TDB image, the testcontainers module, tarantool-shared-resources/vshard_cluster).
  • Configuration: the auth-type footnote explains that it must match security.auth_type of the cluster, that chap-sha1 is the default on both sides, and that pap-sha256 needs Enterprise Edition and TLS.
  • New page "Limitations and workarounds" (client section, RU/EN): crud has no batch delete and no IN; examples of parallel requests instead (compiled against the current tarantool-client); derived-method keywords that are not supported and the exceptions they raise (checked in TarantoolQueryCreator of all seven modules). derived-methods links to it.
  • Compatibility: a table that maps Spring Boot minor lines to modules and says which versions are tested.
  • testcontainers/pom.xml: the module description was copied from the connector.

Relative links in the changed pages were checked; mkdocs build was not run locally (the docs workflow runs on master only).

I haven't forgotten about:

  • Tests — documentation only
  • Changelog
  • Documentation
  • JavaDoc was written — no Java changes
  • Commit messages comply with the guideline
  • Cleanup the code for review. See checklist

Related issues:
See also #133

- Warn that the Repository layer needs a cluster with crud and
  vshard: a plain tarantool image fails with "Procedure 'crud.select'
  is not defined". List three ways to get such a cluster.
- Explain auth-type in the configuration example: it must match
  security.auth_type of the cluster, chap-sha1 is the default on both
  sides, pap-sha256 needs Enterprise Edition and TLS.
- Add the "Limitations and workarounds" page: crud has no batch
  delete and no IN condition; show parallel requests instead and list
  derived-method keywords that are not supported (In, NotIn, Like
  fail with "Unsupported type", And/Or with
  UnsupportedOperationException).
- Map Spring Boot minor lines to tarantool-spring-data-* modules and
  say which versions are tested.
@NorthArea
NorthArea force-pushed the northarea/spring-data-prerequisites branch from d98dfa6 to 55dc7b9 Compare October 22, 2026 13:08
@bitgorbovsky
bitgorbovsky self-requested a review October 22, 2026 13:47

@bitgorbovsky bitgorbovsky left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

В целом с моей стороны ок, но я бы передал слово @nickkkccc

@bitgorbovsky
bitgorbovsky merged commit 00205cd into tarantool:master Oct 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants