Skip to content

Clearly document shutting down other instances for index operations #3974

@FlorianHockmann

Description

@FlorianHockmann

This was originally discussed in #3965.

Describe the feature:
Many posts on our mailing list, SO and so on contain the recommendation to make sure that no management transaction is open when performing index operations to make sure that index operations aren't hindered by dangling open instances, but this isn't described clearly in the docs.

The indexing docs currently mention that no other transaction should be open, but only in a code listing and also only really in a comment:

graph.tx().rollback() //Never create new indexes while a transaction is active

The docs should make it more clear how important that is and also that other JanusGraph instances shouldn't be running in parallel as they could otherwise open new transactions after this has been executed.

Describe a specific use case for the feature:
Prevent users from running into a situation where an index isn't enabled only because some old management instance is still registered.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions