JanusGraph/janusgraph

Create JanusGraphIndex::describe method to include more information

Open

#3.126 geöffnet am 30. Juni 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (1.137 Forks)batch import
area/indexgood first issue

Repository-Metriken

Stars
 (4.985 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 3T 18h) (12 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Um dies zu implementieren, untersuche die JanusGraphIndex Schnittstelle und die JanusGraphIndexWrapper Klasse im janusgraph core Modul. Die neue Methode sollte einen String mit Indexnamen, Feldschlüsseln und deren Status (z.B. ENABLED) zurückgeben. Sieh dir die Methoden getFieldKeys() und getParametersFor() an. Die Methode kann zu JanusGraphIndexWrapper und bei Bedarf zur Schnittstelle hinzugefügt werden.
Tech Stack
java
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Java
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75