Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clearly document shutting down other instances for index operations #3974

Open
FlorianHockmann opened this issue Sep 13, 2023 · 3 comments
Open

Comments

@FlorianHockmann
Copy link
Member

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.

@porunov
Copy link
Member

porunov commented Sep 13, 2023

I also answered previously regarding this matter in the discussions here: #3195 (comment)

Users need to follow 2 requirements:

  • No other parallel management transactions are running
  • No JanusGraph ghost instances exist

If one of the above cases is false then the index won't be enabled no matter how long users await for the status change.

@FlorianHockmann
Copy link
Member Author

No other parallel management transactions are running

Yes, this is another confusing aspect in this. The docs currently talk about transactions in general which we should then also fix.

@FlorianHockmann
Copy link
Member Author

We should also document this for the ConfiguredGraphFactory when managing graphs as noted in #4440.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants