Skip to content
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.

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

Document tuple:info() #3840

Closed
TarantoolBot opened this issue Nov 8, 2023 · 0 comments · Fixed by #4373
Closed

Document tuple:info() #3840

TarantoolBot opened this issue Nov 8, 2023 · 0 comments · Fixed by #4373
Assignees
Labels
3.0 reference [location] Tarantool manual, Reference part

Comments

@TarantoolBot
Copy link
Collaborator

TarantoolBot commented Nov 8, 2023

Related dev. issue(s): tarantool/tarantool#6762
Related doc. issue(s): #3841

Product: Tarantool
Since: 3.0
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_tuple/
SME: @ Gumix

Details

tuple_object:info() - Get information about the tuple

Returns a table with the following fields:

  • data_size - Size of the MessagePack data in the tuple.
    This number equals to number returned by tuple_object:bsize().
  • header_size - Size of the internal tuple header.
  • field_map_size - Size of the field map.
    Field map is used to speed up access to indexed fields of the tuple.
  • waste_size - The amount of excess memory used to store the tuple
    in mempool.
  • arena - Type of the arena where the tuple is allocated.
    Possible values are: "memtx", "malloc", "runtime".
    Requested by @ Gumix in tarantool/tarantool@ab24dfb.
@andreyaksenov andreyaksenov self-assigned this Nov 9, 2023
@andreyaksenov andreyaksenov added 3.0 reference [location] Tarantool manual, Reference part labels Nov 9, 2023
@andreyaksenov andreyaksenov removed their assignment Nov 9, 2023
@p7nov p7nov self-assigned this Jul 19, 2024
@p7nov p7nov linked a pull request Jul 23, 2024 that will close this issue
p7nov added a commit that referenced this issue Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.0 reference [location] Tarantool manual, Reference part
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants