visual/ GraphStudio Guide
Last Updated: October 20, 2018Mastering TigerGraph's intuitive browser-based design and exploration tool.
GraphStudio Guide
GraphStudio is the primary visual interface for developing graph applications. It allows you to perform almost all GSQL tasks without writing code.
1. The Development Lifecycle
GraphStudio is organized around a logical workflow:
- Design Schema: Create vertex and edge types by dragging and dropping. Define attributes and primary IDs visually.
- Map Data to Schema: Upload CSV files and map columns to your schema using a graphical mapping tool.
- Load Data: Monitor real-time loading statistics as data flows into the engine.
- Explore Graph: Search for specific vertices, expand neighbors, find shortest paths, and run existing GSQL queries.
- Write Queries: A full GSQL IDE with syntax highlighting and real-time validation.
2. Visual Query Builder
The Visual Query Builder (VQB) allows you to build complex multi-hop queries by drawing patterns.
- Pattern Matching: Draw the relationships you want to find.
- Filters: Add conditions to vertices or edges (e.g.,
age > 21). - Aggregation: Perform counts and sums visually.
3. Availability
- Cloud: Accessible via the "Tools" menu in the Cloud Portal.
- On-Premises: Defaults to port
14240.- Check status:
gadmin status gui - Start service:
gadmin start gui
- Check status:
[!NOTE] Session Timeout: GraphStudio sessions last for 1 week by default. You can change this using
gadmin config set GUI.ClientIdleTimeSec.
[!WARNING] Limitations: GraphStudio does not support fixed binary types or composite keys in the visual designer. Use the GSQL shell for these advanced features.
TigerGraph Book
v1.0 Curated