tarantool / tarantool/doc

Document `index_object:info()` method

Open Beginner friendly
#5,714 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Since: 3.9.0
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_index/

Returns engine-specific information about an index.
Unlike index_object:stat(), which reports runtime counters, info()
is meant for static details about how an index is organized internally.
At the moment, the only engine that implements it with real content is
memcs (Enterprise Edition).

Parameters:

  • index_object – an object reference to the index.

Return value:

  • Type: table
  • Engine-specific information about the index.

Example:

tarantool> box.space.test.index.pk:info()
---
- columns:
    column1:
      layout:
        dict: false
        null_rle: false
      compression:
        type: none
    column2:
      layout:
        dict: false
        null_rle: true
      compression:
        type: none
    column3:
      layout:
        dict: true
        null_rle: false
      compression:
        type: lz4
        acceleration: 1

Also link this page from https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/create_index/#index-opts-layout
Requested by @Gumix in https://github.com/tarantool/tarantool-ee/commit/cd301f44185cd83f4a9523b115b6ec849901c6a7.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the box_index reference page and the create_index page's index-opts-layout section named in the issue. Document index_object:info() with its parameters, return value, engine-specific behavior, and example, then link the method page from the layout section. Done means both pages contain the requested documentation and link.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
74/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.