Exploring GraphStudio, a UI for TigerGraph
By: Jon Herke
Tags: NoSQL, Graphdb, Gsql, Database, Analytics

Getting Started with GraphStudio

1. Login Page

When you hit “open solutions” you will see a screen like the one below.

The first step will be to login to your provisioned instance. By default, the username is “tigergraph” and the password is the one you choose when provisioning the instance.

Login Page

Side Note: before we can Explore and Query the data, we need to first do the following (which we will cover in steps 2,3,4)

2. Publish Schema Design

Click on the “Design Schema” tab.

This is your Schema Design Studio. Think of it as your data modeling space.

Design Schema Tab

One thing that is important when designing the database (aka building the schema) is thinking about how you should structure the data, how is it going to be accessed, are there certain types of algorithms that you will need to account for?

For more information on schema modeling checkout this helpful video.

For the purpose of this tutorial, you will just need to hit the “publish” button which will activate your current design.

Or, if you want to get fancy, try adding a few more vertices or edges.

Done? Let’s move on.

3. Data Mapping

Click on the “Map Data to Graph” tab.

Now that we have the data model published, we can create a data mapping of how the data should be inserted into the graph.

For this example, you see that we have two files, a “friendship.csv” file pointing to the edge “friendship” & a “person.csv” file that points to the “person” vertex.

If you want to explore, click around on edges, files, icons, and vertices… Just be careful of the “delete” button.

Data Mapping Tab

Now double click on one of the edges.

Focus your eyes on the right (of the image above), you will notice how the data or the current file is mapped.

The neat part about these starter kits is that all of the data is pre-mapped. All you need to do is “Publish” the data mapping.

If you have chosen a blank demo. No worries. Just add your data file and then “map data” to Vertex or Edge (reference the icon tools above)

This is the most basic way to load static data. There are many other ways including (but not limited to) kafka streaming, S3, spark, & REST endpoints.

4. Data Loading

Click on the “Load Data” tab.

At this stage we have the schema built and data file mapped. Looking on the right you will notice that there is no data in the graph. That is because we will need to choose 1 or all of the files to initiate the data loading procedure.

Simply click the “play” button to load all the files. It’s that simple.

Data Loading Tab

5. Data Exploration

Click on the “Explore Graph” tab.

Finally, we made it to the fun stuff!

What you’re seeing below is one of the most powerful graph exploration tools. It allows you to access your data and crawl your data without writing a single line of code. This is the page where you can have the MOST fun.

My recommendation is to just start clicking around:

Pick Random Vertices.

Try Expanding Vertices.

Try Expanding Only Certain Edges

Data Exploration Tab

6. Query Building

Click on the “Write Queries” tab.

As much fun as you had above.. this is where the MAGIC happens. Yes, MAGIC in all CAPS! Haha.

Why is it MAGIC? Because GSQL is a turning complete language meaning you can do absolutely anything with it.

But wait there is more.. (always wanted to say that after watching all the commercials)

My favorite feature is every query you build… The query gets automagically exposed as a REST service.

How cool!

Ok, maybe I’m the only one that finds this truly marvelous. But never the less it’s super convenient because after you write something it immediately becomes functional.

Query Building

Let’s test this out (reference image above for places you should click):

Click on the “ hello ” query — This query is designed for the user to put a name into the parameter and the logic is to find all the people that that user is friends with.

” query — This query is designed for the user to put a name into the parameter and the logic is to find all the people that that user is friends with. Click the “ Install ” button

” button Click the “Run” button

Now it’s ready for a parameter. You can try “Tom”.

What do you see? Do you see the connections? Awesome Right? You just literally passed a parameter to the REST endpoint to get these results.

Click “View JSON” — Now you will see the JSON that TigerGraph returns.