JanusGraph / JanusGraph/janusgraph
Create JanusGraphIndex::describe method to include more information
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 5.8k
- Forks
- 1.2k
- Avg merge
- 13h 53m
- Merged PRs (30d)
- 6
Description
Currently, `JanusGraphIndexWrapper::toString` simply returns the index name. We could create a new `describe` method (or any other name) so that user could more easily retrieve information about that index. For example, we could include the status of each field key. Currently, it is a bit cumbersome to retrieve such information (see below):
```
gremlin> mgmt.getGraphIndex("mixed_demo")
==>mixed_demo
gremlin> mgmt.getGraphIndex("mixed_demo").getFieldKeys()
==>name
==>update_time
gremlin> mgmt.getGraphIndex("mixed_demo").getParametersFor(mgmt.getPropertyKey("name"))
==>mapping->STRING
==>mapped-name->name
==>status->ENABLED
```
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at JanusGraphIndexWrapper::toString and inspect the management calls shown in the issue: getGraphIndex, getFieldKeys, and getParametersFor. Determine the intended describe method name and output, including each field key's status; completion should make the index details easier to retrieve than the current name-only string.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- databases
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100