Python SDK Reference¶
The Interactive Python SDK allows users to seamlessly connect to Interactive or Insight(Groot) and harness their powerful features for graph management, stored procedure management, and query execution.
Documentation for Service APIs¶
The Service APIs in interactive SDK are divided into five categories.
GraphManagementApi
ProcedureManagementApi
JobManagementApi
ServiceManagementApi
QueryServiceApi
VertexApi
EdgeApi
All URIs are relative to ${INTERACTIVE_ADMIN_ENDPOINT}
Class |
Method |
HTTP request |
Description |
Interactive Support |
Insight Support |
---|---|---|---|---|---|
GraphManagementApi |
POST /v1/graph/{graph_id}/dataloading |
[x] |
[ ] |
||
GraphManagementApi |
POST /v1/graph |
[x] |
[x] |
||
GraphManagementApi |
DELETE /v1/graph/{graph_id} |
[x] |
[x] |
||
GraphManagementApi |
GET /v1/graph/{graph_id} |
[x] |
[ ] |
||
GraphManagementApi |
GET /v1/graph/{graph_id}/schema |
[x] |
[x] |
||
GraphManagementApi |
POST /v1/graph/{graph_id}/schema/vertex |
[ ] |
[x] |
||
GraphManagementApi |
PUT /v1/graph/{graph_id}/schema/vertex |
[ ] |
[x] |
||
GraphManagementApi |
Delete /v1/graph/{graph_id}/schema/vertex |
[ ] |
[x] |
||
GraphManagementApi |
POST /v1/graph/{graph_id}/schema/edge |
[ ] |
[x] |
||
GraphManagementApi |
PUT /v1/graph/{graph_id}/schema/edge |
[ ] |
[x] |
||
GraphManagementApi |
Delete /v1/graph/{graph_id}/schema/edge |
[ ] |
[x] |
||
GraphManagementApi |
GET /v1/graph |
[x] |
[ ] |
||
GraphManagementApi |
GET /v1/graph/{graph_id}/statistics |
[x] |
[ ] |
||
GraphManagementApi |
GET /v1/graph/{graph_id}/snapshot/{snapshot_id}/status |
[ ] |
[x] |
||
JobManagementApi |
DELETE /v1/job/{job_id} |
[x] |
[ ] |
||
JobManagementApi |
GET /v1/job/{job_id} |
[x] |
[ ] |
||
JobManagementApi |
GET /v1/job |
[x] |
[ ] |
||
ProcedureManagementApi |
POST /v1/graph/{graph_id}/procedure |
[x] |
[ ] |
||
ProcedureManagementApi |
DELETE /v1/graph/{graph_id}/procedure/{procedure_id} |
[x] |
[ ] |
||
ProcedureManagementApi |
GET /v1/graph/{graph_id}/procedure/{procedure_id} |
[x] |
[ ] |
||
ProcedureManagementApi |
GET /v1/graph/{graph_id}/procedure |
[x] |
[ ] |
||
ProcedureManagementApi |
PUT /v1/graph/{graph_id}/procedure/{procedure_id} |
[x] |
[ ] |
||
ServiceManagementApi |
GET /v1/service/status |
[x] |
[x] |
||
ServiceManagementApi |
POST /v1/service/restart |
[x] |
[ ] |
||
ServiceManagementApi |
POST /v1/service/start |
[x] |
[ ] |
||
ServiceManagementApi |
POST /v1/service/stop |
[x] |
[ ] |
||
QueryServiceApi |
POST /v1/graph/{graph_id}/query |
[x] |
[ ] |
||
QueryServiceApi |
POST /v1/graph/current/query |
[x] |
[ ] |
||
VertexApi |
POST /v1/graph/{graph_id}/vertex |
Add vertex to the graph |
[x] |
[x] |
|
VertexApi |
GET /v1/graph/{graph_id}/vertex |
Get the vertex’s properties with vertex primary key. |
[x] |
[ ] |
|
VertexApi |
PUT /v1/graph/{graph_id}/vertex |
Update vertex’s property |
[x] |
[x] |
|
VertexApi |
DELETE /v1/graph/{graph_id}/vertex |
Delete vertex from the graph |
[ ] |
[x] |
|
EdgeApi |
POST /v1/graph/{graph_id}/edge |
Add edge to the graph |
[x] |
[x] |
|
EdgeApi |
GET /v1/graph/{graph_id}/edge |
Get the edge’s properties with src and dst vertex primary keys. |
[x] |
[ ] |
|
EdgeApi |
PUT /v1/graph/{graph_id}/edge |
Update edge’s property |
[x] |
[x] |
|
EdgeApi |
DELETE /v1/graph/{graph_id}/edge |
Delete the edge from the graph |
[ ] |
[x] |