NenDB API

Check server health status

{
  "status": "healthy",
  "timestamp": "2024-01-01T00:00:00Z"
}

Get detailed server status and metrics

{
  "status": "running",
  "uptime": 3600,
  "graphs": 5,
  "nodes": 1250,
  "edges": 3400
}

Create a new graph

{
  "name": "social_network",
  "description": "Social network graph"
}

{
  "success": true,
  "graph_id": "social_network"
}

List all graphs

{
  "graphs": [
    {
      "name": "social_network",
      "nodes": 500,
      "edges": 1200,
      "created": "2024-01-01T00:00:00Z"
    }
  ]
}

Get graph information

{
  "name": "social_network",
  "nodes": 500,
  "edges": 1200,
  "properties": {
    "description": "Social network graph"
  }
}

Delete a graph and all its data

{
  "success": true,
  "message": "Graph deleted successfully"
}

Create one or more nodes

[
  {
    "id": 1,
    "label": "User",
    "properties": {
      "name": "Alice",
      "age": 30
    }
  },
  {
    "id": 2,
    "label": "User",
    "properties": {
      "name": "Bob",
      "age": 25
    }
  }
]

{
  "success": true,
  "nodes_created": 2,
  "node_ids": [
    1,
    2
  ]
}

Query nodes with filters

{
  "label": "User",
  "properties": {
    "age": {
      "$gte": 25
    }
  }
}

{
  "nodes": [
    {
      "id": 1,
      "label": "User",
      "properties": {
        "name": "Alice",
        "age": 30
      }
    },
    {
      "id": 2,
      "label": "User",
      "properties": {
        "name": "Bob",
        "age": 25
      }
    }
  ]
}

Get a specific node by ID

{
  "id": 1,
  "label": "User",
  "properties": {
    "name": "Alice",
    "age": 30
  }
}

Update node properties

{
  "properties": {
    "age": 31,
    "city": "New York"
  }
}

{
  "success": true,
  "node_updated": 1
}

Delete a node and its relationships

{
  "success": true,
  "node_deleted": 1,
  "relationships_deleted": 5
}

Create one or more edges

[
  {
    "source": 1,
    "target": 2,
    "label": "FOLLOWS",
    "properties": {
      "since": "2024-01-01"
    }
  },
  {
    "source": 2,
    "target": 3,
    "label": "FOLLOWS",
    "properties": {
      "since": "2024-01-02"
    }
  }
]

{
  "success": true,
  "edges_created": 2,
  "edge_ids": [
    1,
    2
  ]
}

Query edges with filters

{
  "label": "FOLLOWS",
  "source": 1
}

{
  "edges": [
    {
      "id": 1,
      "source": 1,
      "target": 2,
      "label": "FOLLOWS",
      "properties": {
        "since": "2024-01-01"
      }
    }
  ]
}

Get a specific edge by ID

{
  "id": 1,
  "source": 1,
  "target": 2,
  "label": "FOLLOWS",
  "properties": {
    "since": "2024-01-01"
  }
}

Update edge properties

{
  "properties": {
    "since": "2024-01-01",
    "strength": 0.8
  }
}

{
  "success": true,
  "edge_updated": 1
}

Delete an edge

{
  "success": true,
  "edge_deleted": 1
}

Breadth-first search traversal

{
  "start_node": 1,
  "max_depth": 3,
  "filters": {
    "label": "User"
  }
}

{
  "nodes": [
    1,
    2,
    3,
    4
  ],
  "edges": [
    1,
    2,
    3
  ],
  "depth_map": {
    "1": 0,
    "2": 1,
    "3": 1,
    "4": 2
  }
}

Shortest path between nodes

{
  "start_node": 1,
  "end_node": 5,
  "weight_property": "cost"
}

{
  "path": [
    1,
    2,
    4,
    5
  ],
  "total_cost": 15.5,
  "path_edges": [
    1,
    3,
    4
  ]
}

PageRank centrality algorithm

{
  "iterations": 100,
  "damping_factor": 0.85,
  "tolerance": 0.000001
}

{
  "scores": {
    "1": 0.15,
    "2": 0.12,
    "3": 0.08
  },
  "iterations": 45,
  "converged": true
}

Community detection using Louvain method

{
  "resolution": 1,
  "max_iterations": 100
}

{
  "communities": {
    "1": 0,
    "2": 0,
    "3": 1,
    "4": 1
  },
  "modularity": 0.75,
  "iterations": 15
}

Execute a graph query

{
  "query": "MATCH (u:User)-[:FOLLOWS]->(f:User) WHERE u.age > 25 RETURN u.name, f.name"
}

{
  "results": [
    [
      "Alice",
      "Bob"
    ],
    [
      "Alice",
      "Charlie"
    ]
  ],
  "execution_time": 0.045
}

Get query execution plan

{
  "query": "MATCH (u:User)-[:FOLLOWS]->(f:User) RETURN u.name, f.name"
}

{
  "plan": {
    "type": "Traversal",
    "index_used": "User.age",
    "estimated_cost": 150,
    "estimated_rows": 100
  }
}