Skip to content

Document IPROTO stream transactions properly #2922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
3 tasks done
Tracked by #2646
p7nov opened this issue Jun 6, 2022 · 1 comment
Closed
3 tasks done
Tracked by #2646

Document IPROTO stream transactions properly #2922

p7nov opened this issue Jun 6, 2022 · 1 comment
Assignees
@p7nov
Labels
iproto Related to the iproto protocol reference [location] Tarantool manual, Reference part server [area] Task relates to Tarantool's server (core) functionality

Comments

@p7nov
Copy link
Contributor

p7nov commented Jun 6, 2022 •
edited
Loading

Product: Tarantool
Since: 2.10
Audience/target: iproto devs
Root document: https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/
SME: @ locker

Details

In PR #2918 , @ locker requested a documentation improvement about IPROTO requests for stream transactions:

We have a separate entry for each IPROTO command (IPROTO_SELECT, IPROTO_REPLACE, etc) with the description of header and data fields, but not for IPROTO_BEGIN, IPROTO_COMMIT, IPROTO_ROLLBACK - those commands are clustered together in one section, but they are no worse than other commands so why would we want to treat them in a different way? If I developed a connector to Tarantool, I'd prefer all IPROTO commands and their arguments to be listed explicitly.

Definition of done

  • Add a section for IPROTO_BEGIN
  • Add a section for IPROTO_COMMIT
  • Add a section for IPROTO_ROLLBACK
@p7nov p7nov added reference [location] Tarantool manual, Reference part server [area] Task relates to Tarantool's server (core) functionality iproto Related to the iproto protocol 3sp labels Jun 6, 2022
@p7nov p7nov mentioned this issue Jun 6, 2022
Merged
@p7nov p7nov self-assigned this Jun 6, 2022
@patiencedaur patiencedaur mentioned this issue Jun 7, 2022
Open
26 tasks
p7nov added a commit that referenced this issue Jun 7, 2022
@p7nov @patiencedaur
Add iproto requests for stream transactions (#2918)
d84a9d9 
Resolves #2402 #2922

Co-authored-by: Dia Patience Daur <[email protected]>
@p7nov
Copy link
Contributor Author

p7nov commented Jun 7, 2022

Resolved in PR #2918

@p7nov p7nov closed this as completed Jun 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@p7nov p7nov

Labels
iproto Related to the iproto protocol reference [location] Tarantool manual, Reference part server [area] Task relates to Tarantool's server (core) functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@p7nov