Commit 5cbcd3b9 authored by MANOLESCU Ioana's avatar MANOLESCU Ioana
Browse files

Update README.md

parent a4ea977e
......@@ -41,7 +41,7 @@ The respective installation instructions are:
## Example
The example below ingests 5 small data sources of different formats into a graph. It also shows how to query the graph and visualize the results.
#### Ingesting a small dataset:
#### Creeating a small graph
From the main folder, call the jar in the `core` folder with the following options:
```
......@@ -51,7 +51,16 @@ java -jar core/connection-lens-core-full-1.1-SNAPSHOT.jar -DRDBMSDBName=cl_myins
![image_3.png](./image_3.png)
#### Asking queries in interactive mode: on a database created/loaded as above, call the code with the following options
### Querying
A ConnectionLens query is a set of keywords; an answer is a subtree of the graph, that connects one node matching each keyword.
To ask that a node matches more than one keyword, include those keywords within quotes.
#### Command-line queries
First, we can query the graph using an interactive, command-line interface.
After having loaded the graph as explained above, call the code with the following options:
```
java -jar core/connection-lens-core-full-1.1-SNAPSHOT.jar -DRDBMSDBName=cl_myinstance -n -v -a
```
......@@ -61,25 +70,27 @@ The `query>` indicates that the shell is ready to accept queries.
![image_2.png](./image_2.png)
#### Gathering statistics about queries
Assuming a set of queries are written in a query file (one query per line), the following call:
#### Collecting statistics on a set of query (stored in a text file, one query per line)
```
java -jar core/connection-lens-core-full-1.1-SNAPSHOT.jar -DRDBMSDBName=cl_myinstance -n -qs -Q core/data/poc/2/demo.queries
```
will yield a set of statistics on each query: how long it took, how many answers were found, how long before the first answer was found etc.
#### Sample queries on the small example and the number of expected answer trees (ATs):
Quotes can be used to denote groups of keywords to consider as an *atomic*
keyword, i.e. a string between quotes will be matched *exactly* against the
graph.
#### Sample queries on the small example
- Russie - 1 AT
- Ruffin - 13 ATs
- Poutine - 1 AT
- Assemblée - 3 ATs
- Soral Toulon - 2 ATs
- Briand Halluin Tonolli - 1 AT
- Russie - 1 answer
- Ruffin - 13 answers
- Poutine - 1 answer
- Assemblée - 3 answers
- Soral Toulon - 2 answers
- Briand Halluin Tonolli - 1 answer
#### Visualization
......@@ -101,11 +112,9 @@ If you found a bug or issue with ConnectionLens please let us know. You can repo
## How to report an issue
- Create or/and login with your gitlab inria account. If you are not from Inria, please contact ioana.manolsecu@inria.fr or tayeb.merabti@inria.fr to be sponsored.
- Open a bug entry on https://gitlab.inria.fr/cedar/connectionlens/-/issues.
- Log in https://gitlab.inria.fr. If you need to create an account and do not work at Inria, please send an email to `connection-lens-admin@inria.fr` to help you establish an account.
- Do not forget to mention your OS and all important information.
- Create a new issue on https://gitlab.inria.fr/cedar/connectionlens/-/issues, giving as much information as possible (what did you succeed in doing, what is not working etc.)
## About
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment