JanusGraph/janusgraph

Create JanusGraphIndex::describe method to include more information

Open

#3 126 ouverte le 30 juin 2022

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Java (1 137 forks)batch import
area/indexgood first issue

Métriques du dépôt

Stars
 (4 985 stars)
Métriques de merge PR
 (Merge moyen 3j 18h) (12 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Pour implémenter cela, examinez l'interface JanusGraphIndex et la classe JanusGraphIndexWrapper dans le module janusgraph core. La nouvelle méthode doit renvoyer une chaîne contenant le nom de l'index, les clés de champ et leur statut (par exemple, ENABLED). Consultez les méthodes getFieldKeys() et getParametersFor(). La méthode peut être ajoutée à JanusGraphIndexWrapper et à l'interface si nécessaire.
Stack technique
java
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Java
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75