JanusGraph/janusgraph

Create JanusGraphIndex::describe method to include more information

Open

#3,126 opened on Jun 30, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (1,137 forks)batch import
area/indexgood first issue

Repository metrics

Stars
 (4,985 stars)
PR merge metrics
 (Avg merge 3d 18h) (12 merged PRs in 30d)

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

Research direction
Examine the JanusGraphIndexWrapper class and implement a describe method that iterates through field keys and retrieves their parameters to build a descriptive string.
Tech stack
java
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Java
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75