Skip to content
This repository was archived by the owner on Aug 2, 2022. It is now read-only.

[docs] Update cleos get kv_table reference - #9618

Merged
lparisc merged 5 commits into
developfrom
docs/devrel-947
Oct 30, 2020
Merged

lparisc merged 5 commits into
developfrom
docs/devrel-947

Conversation

@lparisc

@lparisc lparisc commented Oct 29, 2020

Copy link
Copy Markdown
Contributor

Change Description

Resolves DEVREL-947

Change Type

Select ONE

  • Documentation
  • Stability bug fix
  • Other
  • Other - special case

Consensus Changes

  • Consensus Changes

API Changes

  • API Changes

Documentation Additions

  • Documentation Additions


Range query to return all rows (in reverse order) starting from eosio name key `bobg` (exclusive) from kv_table named `kvtable` owned by `contr_acct` account using kv_table index `primarykey`:
```sh
cleos get kv_table --encode-type name -L bobg contr_acct kvtable primarykey -b -r

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.

missing -U bobj

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Is it really required if -r is specified? I wanted to highlight an example where -U is not specified, in which case the reverse iterator will start from the last row. Is this correct? I should correct the description to read "start from the last row until eosio name key `bobg` (exclusive)", though.


Range query to return all rows until eosio name key `bobe` (exclusive) from kv_table named `kvtable` owned by `contr_acct` account using kv_table index `primarykey`:
```sh
cleos get kv_table --encode-type name -U bobe contr_acct kvtable primarykey -b

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.

missing -L boba

@lparisc lparisc Oct 29, 2020 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Same as above, but an example where -L is not specified. Does the forward iterator start from the first row if -L is not specified?

}
```

Range query to return all rows (in reverse order) until eosio name key `bobe` (inclusive) from kv_table named `kvtable` owned by `contr_acct` account using kv_table index `primarykey`:

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.

from eosio name key 'bobe' (inclusive)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Will correct this and other instances where applicable.

}
```

Range query to return all rows (in reverse order, limit results to 2 rows) until eosio name key `bobe` (inclusive) from kv_table named `kvtable` owned by `contr_acct` account using kv_table index `primarykey`:

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.

'from' instead of 'until'

@johndebord johndebord 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.

LGTM

@lparisc
lparisc merged commit 277c352 into develop Oct 30, 2020
@lparisc
lparisc deleted the docs/devrel-947 branch October 30, 2020 17:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants