Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
etrange02 committed Feb 19, 2024
1 parent 35dea08 commit e1dfe8a
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
Ivet
Summary
=======

Ivet is command line tool to generate a schema for a janusgraph database and apply this schema. It has been inspired from Doctrine behaviour.
Ivet is a command line tool created to generate a schema for a janusgraph database and apply this schema. It has been inspired from Doctrine behaviour.
The **generate** command creates a json file containing commands to execute. The file can be manually modified if you find migration is not complete or does not cover all you deserves.
To keep trace of all applied migrations, migration names are saved into janusgraph server when **upgrade** is called.
You can check at any moment the **list** of migrations both applied and not.

Available commands:
A **test** command is used to populate database either for personnal tests or unit tests. Do not use it in your production environment.

Available commands
=======
* **generate**
* **dir*** Dlls to analyze
* **output*** Directory where to put migration file
Expand All @@ -20,3 +26,7 @@ Available commands:
* test* _Must not be used in Prod. This command is only used to apply a schema to a Janusgraph server_
* **ip** _localhost_
* **port** _8182_

Docker image
=======
https://hub.docker.com/r/dlecoconnier/ivet

0 comments on commit e1dfe8a

Please sign in to comment.