PolarDB:Visualization tool

Configure the whitelist

The application whitelist is separate from the cluster whitelist and must be configured independently.

1. On the AI Applications list page, click your Application ID to open the application details page.

2. On the Whitelist tab, click Add Whitelist, Select Security Groups, or Configure to add the IP address or security group of the machine that needs access:

   • If your ECS instance is in the same Virtual Private Cloud (VPC) as the application, add the private IP address of the ECS instance or its VPC CIDR block.

   • If your ECS instance is in a different VPC, add the public IP address of the ECS instance or the security group where it is located.

   • If you are connecting from an on-premises server or another cloud provider, add its public IP address.

   

Get the endpoint

1. On the application details page, go to the Basic Information tab.

2. In the Topology section, copy the Private Endpoint.

The public endpoint is not created by default. Click Request to submit a request. The public endpoint provides only an IP address and port — if you need a domain name, bind one yourself.

Create the extension

Run the following statement using a privileged account:

CREATE EXTENSION age;

The age extension does not support manual creation. To use this feature, submit a ticket to request its creation.

Per-connection settings

For each new database connection, add ag_catalog to the search_path and load the extension using the get_cypher_keywords function:

SET search_path = ag_catalog, "$user", public;

If you use Data Management Service (DMS) to run this statement, compatibility issues may occur. Use PolarDB-Tools instead.

Permanent settings

To avoid repeating the per-connection setup on every new connection, use a privileged account to set these database parameters once:

ALTER DATABASE <dbname> SET search_path = "$user", public, ag_catalog;
ALTER DATABASE <dbname> SET session_preload_libraries TO 'age';

Grant access to regular users (optional)

Grant the USAGE permission on the ag_catalog schema:

GRANT USAGE ON SCHEMA ag_catalog TO <username>;

If the user also needs to create tables, grant the CREATE permission:

GRANT CREATE ON DATABASE <dbname> TO <username>;

Create a graph

Use the create_graph function in the ag_catalog namespace. Create a graph before using it.

Syntax:

SELECT create_graph('<graph_name>');

Example:

SELECT ag_catalog.create_graph('moviedb');

Insert data

Use a Cypher CREATE statement wrapped in a cypher() SQL function call. The following example inserts sample data into the moviedb graph:

SELECT * FROM cypher('moviedb', $$
  CREATE (matrix:Movie {title: 'The Matrix', released: 1997})
  CREATE (cloudAtlas:Movie {title: 'Cloud Atlas', released: 2012})
  CREATE (forrestGump:Movie {title: 'Forrest Gump', released: 1994})
  CREATE (keanu:Person {name: 'Keanu Reeves', born: 1964})
  CREATE (robert:Person {name: 'Robert Zemeckis', born: 1951})
  CREATE (tom:Person {name: 'Tom Hanks', born: 1956})
  CREATE (tom)-[:ACTED_IN {roles: ['Forrest']}]->(forrestGump)
  CREATE (tom)-[:ACTED_IN {roles: ['Zachry']}]->(cloudAtlas)
  CREATE (robert)-[:DIRECTED]->(forrestGump)
$$) AS (result1 agtype);

This creates six nodes — three with the Movie label and three with the Person label — and three edges: two ACTED_IN and one DIRECTED.

Access the visualization tool

First, add your public IP address to the application whitelist (see Step 2).

Then open the visualization tool using either method:

• On the AI Applications list page, click Develop Application. This opens the public endpoint in your browser.

• Enter the public IP address and port of the application directly in your browser's address bar.

Log in

On the login page, enter the following connection details:

Query data

All queries use the cypher() SQL function. Inside the function, use the Cypher MATCH keyword for pattern matching and RETURN to specify the output.

Syntax:

SELECT * FROM cypher('graph_name', $$
  MATCH <patterns>
  RETURN <variables>
$$) AS (result1 agtype);

Example — query all Person nodes in moviedb:

SELECT * FROM cypher('moviedb', $$
  MATCH (m:Person)
  RETURN m
$$) AS (result1 agtype);

After the query runs, the three Person nodes appear in the visualization area.