Next.js + AWS Neptune Analytics

This is an example of a Next.js application using AWS Neptune Analytics for creating, reading, updating, and deleting graph nodes and edges with OpenCypher queries.

How to Use

Option 1: Use an existing Neptune Analytics graph.

Retrieve your existing graph ID and ensure proper AWS credentials are configured. Provide the graph ID after clicking "Deploy" to automatically set the environment variable.

Option 2: Create a new Neptune Analytics graph.

Execute create-next-app with pnpm to bootstrap the example:

1
pnpm create next-app --example https://github.com/vercel/examples/tree/main/solutions/aws-neptune-analytics

1. Create a new IAM role that includes permissions neptune-graph:ReadDataViaQuery, neptune-graph:WriteDataViaQuery and neptune-graph:DeleteDataViaQuery
2. Save the access key and secret key or configure AWS credentials (see AWS CLI configuration guide for details).
3. Create a new Neptune Analytics graph on AWS console In the Neptune Analytics Console, create a new graph with public endpoint enabled and 16 NCUs to start.
4. Save the graph ID from the Neptune Analytics console
5. Create an .env.local file and add your graph ID:

   1
   GRAPH_ID=your-graph-id-here

   Alternatively, you can set it directly in your terminal:

   1
   export GRAPH_ID=your-graph-id-here

6. Run pnpm dev to start the Next app at http://localhost:3000

Deploy it to the cloud with Vercel (Documentation).

Credentials and Environment Variables

AWS credentials (e.g. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY) and region configuration (e.g. AWS_REGION) can be used directly as environment variables for Vercel deployments.

The AWS SDK will automatically pick up these credentials from the environment:

1
const client = new NeptuneGraphClient({})

API Endpoints

The application provides a RESTful API for graph node and edge operations:

Node Operations

• GET /api/node?id={id} - Retrieve a node by ID
• POST /api/node - Create a new node
• PUT /api/node - Update an existing node
• DELETE /api/node?id={id} - Delete a node and its relationships

Edge Operations

• GET /api/edge?id={id} - Retrieve an edge by ID
• POST /api/edge - Create a new edge
• PUT /api/edge - Update an existing edge
• DELETE /api/edge?id={id} - Delete an edge

Testing

Create Node (POST)

1
curl -X POST http://localhost:3000/api/node \
2
  -d '{"id": "user-123", "name": "John Doe", "type": "user"}' \
3
  -H "Content-type: application/json"

Get Node (GET)

1
curl "http://localhost:3000/api/node?id=user-123"

Update Node (PUT)

1
curl -X PUT http://localhost:3000/api/node \
2
  -d '{"id": "user-123", "name": "John Smith", "type": "user", "active": true}' \
3
  -H "Content-type: application/json"

Delete Node (DELETE)

1
curl -X DELETE "http://localhost:3000/api/node?id=user-123"

Create Edge (POST)

1
curl -X POST http://localhost:3000/api/edge \
2
  -d '{"fromId": "user-123", "toId": "user-456", "type": "FOLLOWS"}' \
3
  -H "Content-type: application/json"

Get Edge (GET)

1
curl "http://localhost:3000/api/edge?id=follows-001"

Update Edge (PUT)

1
curl -X PUT http://localhost:3000/api/edge \
2
  -d '{"id": "follows-001", "since": "2024-01-15", "strength": "strong"}' \
3
  -H "Content-type: application/json"

Delete Edge (DELETE)

1
curl -X DELETE "http://localhost:3000/api/edge?id=follows-001"