support secondary key in get table without the need of modifying abi file #4053

taokayan · 2018-06-12T10:07:37Z

#3695
New parameter:

 --index TEXT                Index number, 1 - primary (first), 2 - secondary index (in order defined by multi_index), 3 - third index, etc.
				Number or name of index can be specified, e.g. 'secondary' or '2'.
  --key-type TEXT             The key type of --index, primary only supports (i64), all others support (i64, i128, i256, float64, float128).
				Special type 'name' indicates an account name.

Command example:

Get all the bids sorted by highbid:

./cleos get table eosio eosio namebids --key-type i64 --index 2
{
  "rows": [{
      "newname": "zoo",
      "high_bidder": "a123",
      "high_bid": 9990000,
      "last_bid_time": "1528797387500000"
    },{
      "newname": "ddd",
      "high_bidder": "a123",
      "high_bid": 120000,
      "last_bid_time": "1528797387500000"
    },{
      "newname": "abc",
      "high_bidder": "a123",
      "high_bid": 110000,
      "last_bid_time": "1528797387500000"
    },{
      "newname": "com",
      "high_bidder": "a123",
      "high_bid": 100000,
      "last_bid_time": "1528797387000000"
    }
  ],
  "more": false
}

Get all the producers which have votes equal to zero:

./cleos get table eosio eosio producers --key-type float64 --index 2 -L "0" -U "0.00001"
{
  "rows": [{
      "owner": "a123",
      "total_votes": "0.00000000000000000",
      "producer_key": "EOS8kE63z4NcZatvVWY4jxYdtLg6UEA123raMGwS6QDKwpQ69eGcP",
      "is_active": 1,
      "url": "",
      "unpaid_blocks": 0,
      "last_claim_time": 0,
      "location": 0
    }
  ],
  "more": false
}

heifner · 2018-07-02T12:56:03Z

programs/cleos/main.cpp

@@ -1735,6 +1737,8 @@ int main( int argc, char** argv ) {
   getTable->add_option( "-k,--key", table_key, localized("The name of the key to index by as defined by the abi, defaults to primary key") );
   getTable->add_option( "-L,--lower", lower, localized("JSON representation of lower bound value of key, defaults to first") );
   getTable->add_option( "-U,--upper", upper, localized("JSON representation of upper bound value value of key, defaults to last") );
+   getTable->add_option( "-t,--seckeytype", sec_key_type, localized("Secondary key type(i64,i128,i256,float64,float128)"));
+   getTable->add_option( "-p,--secindexposition", sec_index_position, localized("Secondary index position, default to 0(first secondary index)"));


Since we will support diff primary key types in the future, the abbreviated -t -p are too generic. Also too much implementation detail here. Seems odd to talk about first, second, third, etc secondary index. From the users perspective it should just be first (primary), second, third, etc.

How about:

"--index", "Index number, 1 - primary (first), 2 - secondary index (in order defined by mult_index), 3 - third index, etc." "--key-type", "The key type of --index, primary currently only supports (i64), all others support (i64, i128, i256, float64, float128)"

"-k,--key" should either be removed or made to work. Currently, it is not used for anything. However, to not break existing tools, leave it as part of the json, but mark it as deprecated.

@wanderingbort suggested also supporting "primary", "secondary", etc as args to --index so the user does not have to use literal numbers.

FortisFortuna · 2018-07-05T19:30:32Z

This is direly needed, especially for eosjs / scatter which make use of the RPC.

… is expected by multi_index.

tbfleming · 2018-07-07T01:33:38Z

This feels like a workaround for a mistake: the ABI format cleanly distinguishes among types, except for the indexes. Maybe we should revisit that.

"senary"? "denary"? Are these Portuguese words? Italian? Could we abandon using words as numbers?

heifner · 2018-07-07T02:32:48Z

Might have gotten a little carried away. I'm ok with removing the word support or limiting it to primary, secondary, third.

wanderingbort · 2018-07-09T13:31:11Z

@tbfleming I agree however, there will be some non-zero amount of time between pushing a new version of the ABI format which includes typed indices and when existing ABIs are migrated to it. Even if this gets deprecated in the next release, we will have coverage for our users until then. I do not think this is the last word on the usability of these indices.

wanderingbort · 2018-07-09T13:39:42Z

plugins/chain_plugin/include/eosio/chain_plugin/chain_plugin.hpp

+      return index;
+   }
+
+   template <typename IndexType, typename Scope, typename SecKeyType, typename ConvFn>


It looks like Scope is no longer really needed as a template parameter and a relic of the days when we had multiple intrusive indices. All of the callers use by_secondary and it is only used in a way where by_secondary is always the right choice. We should probably simplify it out.

wanderingbort · 2018-07-09T13:42:51Z

plugins/chain_plugin/include/eosio/chain_plugin/chain_plugin.hpp

+      EOS_ASSERT( index == table, chain::contract_table_query_exception, "Unsupported table name: ${n}", ("n", p.table) );
+
+      uint64_t pos = 0;
+      if (p.index_position.empty() || p.index_position == "first" || p.index_position == "primary") {


This is only called when we are explicitly not talking about the primary key. However, the naming of the method and the operation would imply that there is no difference between the primary and secondary indices. (They both return 0 for the index byte).

Can we rename this such that it is obvious that this only works on the non-primary indices and let "first", "primary" etc fall through to the throw when it is misused?

…move unneeded Scope template params.

shuaiLiWang · 2018-07-20T03:17:28Z

not support search by string？

taokayan · 2018-07-20T07:31:41Z

you can use --key-type name if you want to search by name in string

shuaiLiWang · 2018-07-20T07:54:04Z

this is my struct , if i want search by name or phone，how to get it

struct chaninfo {
uint64_t channelId;
string name;
string phone;

   }
   uint64_t primary_key() const { return channelId; }

  EOSLIB_SERIALIZE(chaninfo, (channelId)(name)(phone); };

taokayan · 2018-07-20T08:48:26Z

We don't support std::string as key of any indexes. However you can find a way to encode it into 64/128/256 bit integers.

shuaiLiWang · 2018-07-23T06:13:35Z

i want to encode string into 64 bit integers by boost，but i get the error when i cleos set contract，so i change the contract，use stringstream and sprintf/sscanf ，also have the same problem，why?

FortisFortuna · 2018-07-23T08:54:40Z

Does the abi have to be updated as well in the key_names and key_types fields?
Also, are i128 and i256 forced to take hex as inputs?

This was referenced Jun 12, 2018

chain_api_plugin get_table_rows table_key is not used #3695

Closed

How to get table sorted by secondary index using cleos #2983

Closed

wanderingbort changed the base branch from master to release/1.1 June 19, 2018 15:20

wanderingbort added this to the Version 1.1 milestone Jun 27, 2018

heifner reviewed Jul 2, 2018

View reviewed changes

jgiszczak mentioned this pull request Jul 3, 2018

cleos get table --key not support #4464

Closed

heifner mentioned this pull request Jul 6, 2018

cleos get table lookup fails when specifying an account name that is entirely numerical as lower bound param #4442

Closed

heifner self-assigned this Jul 6, 2018

heifner added the Needs Revisions label Jul 6, 2018

taokayan and others added 5 commits July 6, 2018 11:33

3695 support get table by secondary key without modifying abi file

5cec89f

3695 support multiple secondary indexes

39bbd56

fix secondary index table id lookup

a272d84

Renamed table options for index and key-type

343034b

Add support for name key-type. Normalize index position to match what…

921b777

… is expected by multi_index.

heifner force-pushed the seckey branch from 2933387 to 921b777 Compare July 6, 2018 22:22

heifner removed the Needs Revisions label Jul 6, 2018

wanderingbort suggested changes Jul 9, 2018

View reviewed changes

Address peer review comments. Better index position name handling. Re…

529745c

…move unneeded Scope template params.

wanderingbort approved these changes Jul 10, 2018

View reviewed changes

wanderingbort merged commit 7e3617e into EOSIO:release/1.1 Jul 10, 2018

andriantolie mentioned this pull request Jul 10, 2018

abi_serializer is still using the old definition #4564

Merged

heifner mentioned this pull request Jul 11, 2018

cleos get table secondary key indexing #4206

Closed

jcalfee mentioned this pull request Jul 19, 2018

lower bound numeric helper EOSIO/eosjs#224

Closed

venediktov mentioned this pull request Jul 27, 2018

support sha256 in hex as secondary key when calling get_table_rows #4908

Merged

heifner mentioned this pull request Aug 4, 2018

close get table bug #5019

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support secondary key in get table without the need of modifying abi file #4053

support secondary key in get table without the need of modifying abi file #4053

taokayan commented Jun 12, 2018 •

edited by heifner

Loading

heifner Jul 2, 2018 •

edited

Loading

heifner Jul 2, 2018 •

edited

Loading

heifner Jul 2, 2018

FortisFortuna commented Jul 5, 2018 •

edited

Loading

tbfleming commented Jul 7, 2018 •

edited

Loading

heifner commented Jul 7, 2018

wanderingbort commented Jul 9, 2018

wanderingbort Jul 9, 2018

wanderingbort Jul 9, 2018

shuaiLiWang commented Jul 20, 2018

taokayan commented Jul 20, 2018

shuaiLiWang commented Jul 20, 2018

taokayan commented Jul 20, 2018 •

edited

Loading

shuaiLiWang commented Jul 23, 2018

FortisFortuna commented Jul 23, 2018 •

edited

Loading

support secondary key in get table without the need of modifying abi file #4053

support secondary key in get table without the need of modifying abi file #4053

Conversation

taokayan commented Jun 12, 2018 • edited by heifner Loading

heifner Jul 2, 2018 • edited Loading

Choose a reason for hiding this comment

heifner Jul 2, 2018 • edited Loading

Choose a reason for hiding this comment

heifner Jul 2, 2018

Choose a reason for hiding this comment

FortisFortuna commented Jul 5, 2018 • edited Loading

tbfleming commented Jul 7, 2018 • edited Loading

heifner commented Jul 7, 2018

wanderingbort commented Jul 9, 2018

wanderingbort Jul 9, 2018

Choose a reason for hiding this comment

wanderingbort Jul 9, 2018

Choose a reason for hiding this comment

shuaiLiWang commented Jul 20, 2018

taokayan commented Jul 20, 2018

shuaiLiWang commented Jul 20, 2018

taokayan commented Jul 20, 2018 • edited Loading

shuaiLiWang commented Jul 23, 2018

FortisFortuna commented Jul 23, 2018 • edited Loading

taokayan commented Jun 12, 2018 •

edited by heifner

Loading

heifner Jul 2, 2018 •

edited

Loading

heifner Jul 2, 2018 •

edited

Loading

FortisFortuna commented Jul 5, 2018 •

edited

Loading

tbfleming commented Jul 7, 2018 •

edited

Loading

taokayan commented Jul 20, 2018 •

edited

Loading

FortisFortuna commented Jul 23, 2018 •

edited

Loading