Accessing the PuppyGraph Web UI requires a browser. However, the tutorial offers alternative instructions for those who wish to exclusively use the CLI.
[+] Running 3/3
✔ Network puppy-mysql Created 0.1s
✔ Container mysql-server Started 3.7s
✔ Container puppygraph Started 3.7s
Data Preparation
This tutorial is designed to be comprehensive and standalone, so it includes steps to populate data in MySQL. In practical scenarios, PuppyGraph can query data directly from your existing MySQL databases.
dockerexec-itmysql-servermysql-uroot-p
It will show a password prompt:
Enter password:
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 8
Server version: 8.0.33 MySQL Community Server - GPL
Copyright (c) 2000, 2023, Oracle and/or its affiliates.
Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
mysql>
createschemamodern;createtablemodern.person (id text, nametext, age integer);insert into modern.person values ('v1', 'marko', 29), ('v2', 'vadas', 27), ('v4', 'josh', 32), ('v6', 'peter', 35);createtablemodern.software (id text, nametext, lang text);insert into modern.software values ('v3', 'lop', 'java'), ('v5', 'ripple', 'java');createtablemodern.created (id text, from_id text, to_id text, weightdouble precision);insert into modern.created values ('e9', 'v1', 'v3', 0.4), ('e10', 'v4', 'v5', 1.0), ('e11', 'v4', 'v3', 0.4), ('e12', 'v6', 'v3', 0.2);createtablemodern.knows (id text, from_id text, to_id text, weightdouble precision);insert into modern.knows values ('e7', 'v1', 'v2', 0.5), ('e8', 'v1', 'v4', 1.0);
The above SQL creates the following tables:
Modeling a Graph
We then define a graph on top of the data tables we just created. Actually, this is the "Modern" graph defined by Apache Tinkerpop.
A schema instructs PuppyGraph on mapping data from the MySQL into a graph. PuppyGraph offers various methods for schema creation. For this tutorial, we've already prepared a schema to help save time.
The response shows that graph schema has been uploaded successfully:
{"Status":"OK","Message":"Schema uploaded and gremlin server restarted"}
Querying the Graph
In this tutorial, we will use the Gremlin and Cypher query languages to interact with the Graph. Gremlin, developed by Apache TinkerPop, and Cypher, designed by Neo4j, are both powerful graph query languages. Prior knowledge of either Gremlin or Cypher is not necessary to follow this tutorial. To learn more about Gremlin, visit https://tinkerpop.apache.org/gremlin.html. For information on Cypher, you can check out https://neo4j.com/product/cypher-graph-query-language/.
Queries are entered on the left side, and the right side displays the graph visualization.
The first query retrieves the property of the person named "marko".
g.V().has("name", "marko").valueMap()
The output is plain text like the following:
Rows: 1
age 29
name marko
Now let's also leverage the visualization. The next query gets all the software created by people known to "marko".
[PuppyGraph]> console
____ ____ _
| _ \ _ _ _ __ _ __ _ _ / ___| _ __ __ _ _ __ | |__
| |_) | | | | | | '_ \ | '_ \ | | | | | | _ | '__| / _` | | '_ \ | '_ \
| __/ | |_| | | |_) | | |_) | | |_| | | |_| | | | | (_| | | |_) | | | | |
|_| \__,_| | .__/ | .__/ \__, | \____| |_| \__,_| | .__/ |_| |_|
|_| |_| |___/ |_|
Welcome to PuppyGraph!
version: 0.11
To Learn more about the graph schema:
- Use graph.show() to list all the vertex and edge labels.
- Use graph.show('$FOO') to list all the vertex and edge labels related to $FOO.
- Use graph.describe('$BAR') to list all the attributes of the label $BAR.
See https://tinkerpop.apache.org/gremlin.html to learn more about the Gremlin query language.
Here are some example queries for exploring the graph:
- Use g.V() to list all the vertices.
- Use g.E() to list all the edges.
- Use g.V().count() to get the total number of vertices.
- Use g.E().count() to get the total number of edges.
- Use g.V('$ID').out() to find out vertices that are reachable in 1-hop from the vertex $ID. For example, g.V('person:::v1').out() will find out 1-hop reachable vertices from 'person:::v1'.
- Use g.V('$ID').out().out() similarly to find out 2-hop reachable vertices from the vertex $ID.
puppy-gremlin>
Create a file docker-compose.yaml with the following content:
Warning: Ensure to modify your password environment variables, particularly when your machine is publicly accessible.
Then run the following command to start Mysql and PuppyGraph:
Run the following command to start a MySQL shell to access the database using root:
Input the root password (default root password: mysql123) of mysql-server to access the MySQL client shell.
Then execute the following SQL statements in the shell to create tables and insert data.
id
name
age
id
name
lang
id
from_id
to_id
weight
id
from_id
to_id
weight
Create a PuppyGraph schema file schema.json with the following content:
Replace the password by your modified root password (default root password: mysql123).
Log into PuppyGraph Web UI at http://localhost:8081 with username and password of PuppyGraph.(default username: puppygraph, default password: puppygraph123)
Upload the schema by choosing the file schema.json in the Upload Graph Schema JSON block and clicking on Upload.
Alternatively, run the following command to upload the schema file:
Click on the Query panel the left side. The Gremlin Query tab offers an interactive environment for querying the graph using Gremlin.
Copy the following query, paste it in the query input, and click on the run button.
Copy the following query, paste it in the query input, and click on the run button.
Execute the following command to access the PuppyGraph CLI.
Access the PuppyGraph Gremlin Console through the console command.
Run the following queries in the console to query the Graph.
Exit Gremlin console by :x and then access Cypher console by cypher-console.
Make sure to initiate Cypher queries using the prefix :>.
Exit Cypher console and the CLI by :x and then exit command.
Run the following command to shut down and remove the services: