JanusGraph/janusgraph

Add SETTINGS parameter for index keys

Open

#1,104 opened on Jun 8, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Java (1,137 forks)batch import
help wantedindex/elasticsearchkind/enhancement

Repository metrics

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

Description

I think it would be very useful to add SETTINGS parameter for index creation. With this option we could create more useful indexes like sorted index (https://www.elastic.co/blog/index-sorting-elasticsearch-6-0).

I imagine the creation process of sorted index could be like this (just a suggestion, I am not sure of it):

mgmt.buildIndex('borderIndex', Vertex.class).addKey(name, Settings.SORTED.asParameter())
.buildMixedIndex("search")

Related discussion: https://groups.google.com/forum/#!searchin/janusgraph-users/elasticsearch$206%7Csort:date/janusgraph-users/dtBxqdR2qr0/ieXJdWaVAAAJ

Contributor guide

Research direction
Investigate how to extend the index management API to accept a Settings parameter, particularly for sorted indexes in Elasticsearch. Look at the existing buildIndex and addKey methods. Consider how to pass sorting configuration through the Settings parameter. Review the JanusGraph documentation and Elasticsearch integration.
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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaJanusGraphElasticsearch
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30