JanusGraph/janusgraph

updateIndex() should make error cases easier to understand

Open

#1,378 建立於 2019年1月14日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Java (1,137 fork)batch import
help wantedkind/enhancement

倉庫指標

Star
 (4,985 star)
PR 合併指標
 (平均合併 3天 18小時) (30 天內合併 12 個 PR)

描述

ManagementSystem.updateIndex() returns null if the provided SchemaAction is not applicable for the current status of the index:

if (!updateAction.isApplicableStatus(schemaVertex.getStatus()))
    return null;

Source

This is confusing and the API docs also don't mention this behaviour:

/**
 * Updates the provided index according to the given {@link SchemaAction}
 *
 * @param index
 * @param updateAction
 * @return a future that completes when the index action is done
 */
IndexJobFuture updateIndex(Index index, SchemaAction updateAction);

The method should either throw an exception in this case or at least document this behaviour in the API docs.

When a user doesn't know about this behaviour, then all they're getting is a NullPointerException by calling get() on the returned IndexJobFuture (see #1359).

貢獻者指南