Querying StarRocks Data as a Graph

Summary

In this tutorial, you will:

Start a PuppyGraph container alongside a StarRocks all-in-one container and load example data.
Connect StarRocks to PuppyGraph and define a graph schema.
Run Cypher and Gremlin queries against the StarRocks data as a graph.

Self-contained StarRocks Data

This tutorial bundles a StarRocks all-in-one container and seeds it with the TinkerPop modern graph sample data.

In real deployments, PuppyGraph queries your existing StarRocks deployments directly. See Connecting to StarRocks for the connection reference.

Prerequisites

Please ensure that docker compose is available. The installation can be verified by running:

docker compose version

See https://docs.docker.com/compose/install/ for Docker Compose installation instructions and https://www.docker.com/get-started/ for more details on Docker.

Accessing the PuppyGraph Web UI requires a browser. The schema upload and query steps also have CLI alternatives via curl and the bundled Gremlin console.

Setup

Deployment

Create a file docker-compose.yaml with the following content:

docker-compose.yaml

version: "3"
services:
  puppygraph:
    image: puppygraph/puppygraph:latest
    pull_policy: always
    container_name: puppygraph
    environment:
      - PUPPYGRAPH_USERNAME=puppygraph
      - PUPPYGRAPH_PASSWORD=puppygraph123
    networks:
      - starrocks_net
    ports:
      - "8081:8081"
      - "8182:8182"
      - "7687:7687"
  starrocks:
    image: starrocks/allin1-ubuntu:latest
    container_name: starrocks-server
    networks:
      - starrocks_net
    ports:
      - "9030:9030"
networks:
  starrocks_net:
    name: puppy-starrocks

Start the stack:

docker compose up -d

[+] Running 3/3
 ✔ Network puppy-starrocks    Created                                      0.1s
 ✔ Container starrocks-server Started                                      0.6s
 ✔ Container puppygraph       Started                                      0.7s

Data Preparation

Open a StarRocks shell as root (no password by default):

docker exec -it starrocks-server mysql -h127.0.0.1 -P9030 -uroot

Paste the following SQL into the prompt to create the database and insert data:

modern.sql

CREATE DATABASE modern;
USE modern;

CREATE TABLE software (
    id   varchar(10),
    name varchar(50),
    lang varchar(50)
);
INSERT INTO software VALUES ('v3', 'lop', 'java'), ('v5', 'ripple', 'java');

CREATE TABLE person (
    id   varchar(10),
    name varchar(50),
    age  int
);
INSERT INTO person VALUES
    ('v1', 'marko', 29),
    ('v2', 'vadas', 27),
    ('v4', 'josh',  32),
    ('v6', 'peter', 35);

CREATE TABLE created (
    id      varchar(10),
    from_id varchar(10),
    to_id   varchar(10),
    weight  double
);
INSERT INTO created VALUES
    ('e9',  'v1', 'v3', 0.4),
    ('e10', 'v4', 'v5', 1.0),
    ('e11', 'v4', 'v3', 0.4),
    ('e12', 'v6', 'v3', 0.2);

CREATE TABLE knows (
    id      varchar(10),
    from_id varchar(10),
    to_id   varchar(10),
    weight  double
);
INSERT INTO knows VALUES
    ('e7', 'v1', 'v2', 0.5),
    ('e8', 'v1', 'v4', 1.0);

The above creates four tables under the modern database.

personsoftwarecreatedknows

id	name	age
v1	marko	29
v2	vadas	27
v4	josh	32
v6	peter	35

id	name	lang
v3	lop	java
v5	ripple	java

id	from_id	to_id	weight
e9	v1	v3	0.4
e10	v4	v5	1.0
e11	v4	v3	0.4
e12	v6	v3	0.2

id	from_id	to_id	weight
e7	v1	v2	0.5
e8	v1	v4	1.0

Modeling a Graph

We model the data as the TinkerPop modern graph: two node types (person, software) and two edge types (knows, created).

First, log into the PuppyGraph Web UI at http://localhost:8081 with the credentials configured above:

Field	Value
Username	`puppygraph`
Password	`puppygraph123`

There are two ways to define the schema in PuppyGraph: build it interactively in the Schema Builder, or upload a JSON file directly. Pick whichever you prefer; both produce the same graph.

Build the graph in the Schema Builder

The Schema Builder is the visual editor in the PuppyGraph Web UI for adding catalogs, nodes, and edges step by step. It's the recommended path when you're modeling a graph for the first time or want to inspect what each click produces. For a deeper visual walkthrough of every dialog and field, see Modeling a Graph through the Schema Builder. The summary below covers what's needed to build the modern graph against this tutorial's StarRocks data.

PuppyGraph queries StarRocks through its MySQL-compatible protocol, so the catalog type below is MySQL.

Connecting to StarRocks

Click Create Catalog, then expand SQL Databases and pick MySQL 8.

Fill in the connection form (leave Password empty since root has no password by default):

Field	Value
Catalog name	`starrocks_data`
Username	`root`
Password	(empty)
JDBC Connection String	`jdbc:mysql://starrocks-server:9030/modern`

Check User Specified Driver and fill in:

Field	Value
JDBC Driver Class	`com.mysql.cj.jdbc.Driver`
JDBC Driver URL	`https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.28/mysql-connector-java-8.0.28.jar`

Click Create Catalog.

Adding nodes

Click Add Node in the toolbar. The Select Table for Node dialog opens. Expand starrocks_data then modern, pick software, then click Next.

In the Add Node wizard, click Add to ID and select id from the dropdown. The wizard moves id into ID Columns, leaving name and lang as attributes. Click Next, leave Enable Local Replication off, then click Add Node.

Repeat for person. The flow is the same: click Add Node, pick the table, click Next, assign id to ID Columns, leave replication off, click Add Node.

Adding edges

Click Add Edge in the toolbar, pick created from the catalog tree, then click Next.

In the Add Edge wizard, set:

Field	Value
From Node	`person`
To Node	`software`
FROM `Select Column`	`from_id`
TO `Select Column`	`to_id`

Click Add to ID and select id to set the edge identifier. Click Next, leave Enable Local Replication off, then click Add Edge.

Repeat for knows with both From Node and To Node set to person. The other settings are identical to created.

Upload a schema file

If you've already built the graph in the Schema Builder above, you can skip this section. The resulting schema is the same.

This method writes the full schema to a JSON file and uploads it directly. It's useful when you already have a schema for an environment and want to recreate it elsewhere (e.g. for CI, scripted setup, or copy-pasting between PuppyGraph instances).

Create a file schema.json with the following content. PuppyGraph queries StarRocks through its MySQL-compatible protocol, so the catalog type is mysql and the JDBC URI uses the jdbc:mysql://... scheme.

schema.json

{
  "catalog": [
    {
      "name": "starrocks_data",
      "type": "mysql",
      "jdbc": {
        "username": "root",
        "password": "",
        "jdbcUri": "jdbc:mysql://starrocks-server:9030/modern",
        "driverClass": "com.mysql.cj.jdbc.Driver",
        "driverUrl": "https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.28/mysql-connector-java-8.0.28.jar"
      }
    }
  ],
  "node": [
    {
      "label": "software",
      "dataSourceGroup": {
        "externalDataSource": {
          "enabled": true,
          "catalog": "starrocks_data",
          "schema": "modern",
          "table": "software",
          "mappedField": [
            { "sourceFieldName": "id",   "targetFieldName": "id"   },
            { "sourceFieldName": "name", "targetFieldName": "name" },
            { "sourceFieldName": "lang", "targetFieldName": "lang" }
          ]
        }
      },
      "id":        [{ "name": "id",   "type": "STRING" }],
      "attribute": [
        { "name": "name", "type": "STRING" },
        { "name": "lang", "type": "STRING" }
      ]
    },
    {
      "label": "person",
      "dataSourceGroup": {
        "externalDataSource": {
          "enabled": true,
          "catalog": "starrocks_data",
          "schema": "modern",
          "table": "person",
          "mappedField": [
            { "sourceFieldName": "id",   "targetFieldName": "id"   },
            { "sourceFieldName": "name", "targetFieldName": "name" },
            { "sourceFieldName": "age",  "targetFieldName": "age"  }
          ]
        }
      },
      "id":        [{ "name": "id",   "type": "STRING" }],
      "attribute": [
        { "name": "name", "type": "STRING" },
        { "name": "age",  "type": "INT"    }
      ]
    }
  ],
  "edge": [
    {
      "label":         "created",
      "fromNodeLabel": "person",
      "toNodeLabel":   "software",
      "dataSourceGroup": {
        "externalDataSource": {
          "enabled": true,
          "catalog": "starrocks_data",
          "schema": "modern",
          "table": "created",
          "mappedField": [
            { "sourceFieldName": "id",      "targetFieldName": "id"      },
            { "sourceFieldName": "from_id", "targetFieldName": "from_id" },
            { "sourceFieldName": "to_id",   "targetFieldName": "to_id"   },
            { "sourceFieldName": "weight",  "targetFieldName": "weight"  }
          ]
        }
      },
      "id":        [{ "name": "id",      "type": "STRING" }],
      "fromKey":   [{ "name": "from_id", "type": "STRING" }],
      "toKey":     [{ "name": "to_id",   "type": "STRING" }],
      "attribute": [
        { "name": "from_id", "type": "STRING" },
        { "name": "to_id",   "type": "STRING" },
        { "name": "weight",  "type": "DOUBLE" }
      ]
    },
    {
      "label":         "knows",
      "fromNodeLabel": "person",
      "toNodeLabel":   "person",
      "dataSourceGroup": {
        "externalDataSource": {
          "enabled": true,
          "catalog": "starrocks_data",
          "schema": "modern",
          "table": "knows",
          "mappedField": [
            { "sourceFieldName": "id",      "targetFieldName": "id"      },
            { "sourceFieldName": "from_id", "targetFieldName": "from_id" },
            { "sourceFieldName": "to_id",   "targetFieldName": "to_id"   },
            { "sourceFieldName": "weight",  "targetFieldName": "weight"  }
          ]
        }
      },
      "id":        [{ "name": "id",      "type": "STRING" }],
      "fromKey":   [{ "name": "from_id", "type": "STRING" }],
      "toKey":     [{ "name": "to_id",   "type": "STRING" }],
      "attribute": [
        { "name": "from_id", "type": "STRING" },
        { "name": "to_id",   "type": "STRING" },
        { "name": "weight",  "type": "DOUBLE" }
      ]
    }
  ]
}

In the Web UI, click Graph in the sidebar, then Upload Schema, and select schema.json.

Upload via CLI

You can also POST the schema directly:

curl -X POST -H "content-type: application/json" \
  --data-binary @./schema.json \
  --user "puppygraph:puppygraph123" \
  http://localhost:8081/schema

Querying the Graph

In the PuppyGraph Web UI, click Query in the sidebar. You can run graph queries in either Cypher or Gremlin.

The following query answers "What software was created by people that marko knows?"

CypherGremlin

MATCH path = (p:person)-[:knows]->()-[:created]->()
WHERE p.name = 'marko'
RETURN path;

g.V().hasLabel('person').has('name', 'marko')
  .out('knows').out('created').path()

There are two paths in the result: marko knows josh, who created lop and ripple.

Cleanup

Shut down and remove the containers:

docker compose down