feat(interactive): Add Create/Update/Get APIs for vertex/edge in Interactive #4025

yqylh · 2024-07-10T03:27:13Z

What do these changes do?

This PR primarily support six interfaces for creating, updating, and retrieving vertices and edges. The Delete operation is not included as the underlying Graph DB does not yet support it.

The interfaces for vertices are as follows:

Method: GET (retrieve) / POST (create) / PUT (update)
EndPoint: /v1/graph/{graph_id}/vertex

The interfaces for edges are as follows:

Method: GET (retrieve) / POST (create) / PUT (update)
EndPoint: /v1/graph/{graph_id}/edge

CreateVertex

This API interface enables the creation of any number of vertices within an existing graph, along with the addition of any number of edges. The two vertices connected by these edges must either already exist within the graph or be newly created vertices.

For a single vertex and any number of edges, a single_vertex_insert_transaction is triggered, which supports inserting a single vertex and multiple edges.
For multiple vertices and any number of edges, an insert_transaction is triggered, which allows for unrestricted insertion of vertices and edges.

Http Request

Method：POST
EndPoint：/v1/graph/{graph_id}/vertex
Content-type: application/json
Body：

{
    "vertex_request":[
        {
            "label": "person",
            "primary_key_value": 2,
            "properties": [
                {
                    "name": "name",
                    "value": "John Doe"
                },
                {
                    "name": "age",
                    "value": 25
                }
            ]
        },
        {
            "label": "software",
            "primary_key_value": 3,
            "properties": [
                {
                    "name": "name",
                    "value": "Graph Database"
                },
                {
                    "name": "lang",
                    "value": "Java"
                }
            ]
        },
        {
            "label": "software",
            "primary_key_value": 4,
            "properties": [
                {
                    "name": "name",
                    "value": "Graph Database"
                },
                {
                    "name": "lang",
                    "value": "C++"
                }
            ]
        }
    ],
    "edge_request":[
        {
            "src_label": "person",
            "dst_label": "software",
            "edge_label": "created",
            "src_primary_key_value": 2,
            "dst_primary_key_value": 3,
            "properties": [
                {
                    "name": "weight",
                    "value": 0.3
                }
            ]
        },
        {
            "src_label": "person",
            "dst_label": "software",
            "edge_label": "created",
            "src_primary_key_value": 2,
            "dst_primary_key_value": 4,
            "properties": [
                {
                    "name": "weight",
                    "value": 0.5
                }
            ]
        }
    ]
}

CreateEdge

This API interface allows the creation of any number of edges within an existing graph. The two vertices connected by these edges must already exist within the graph.

For a single edge, a single_edge_insert_transaction is triggered, which supports the insertion of a single edge.
For multiple edges, an insert_transaction is triggered, which supports the insertion of an unlimited number of edges.

Http Request

Method：POST
EndPoint：/v1/graph/{graph_id}/edge
Content-type: application/json
Body：

{
    "graph_id": "example_graph",
    "edge_request":[
        {
            "src_label": "person",
            "dst_label": "software",
            "edge_label": "created",
            "src_primary_key_value": 2,
            "dst_primary_key_value": 3,
            "properties": [
                {
                    "name": "weight",
                    "value": 0.3
                }
            ]
        },
        {
            "src_label": "person",
            "dst_label": "software",
            "edge_label": "created",
            "src_primary_key_value": 2,
            "dst_primary_key_value": 4,
            "properties": [
                {
                    "name": "weight",
                    "value": 0.5
                }
            ]
        }
    ]
}

GetVertex（GraphManagement Category）

The function of this API interface is to get the properties of a Vertex in an existing graph.

Http Request

Method：GET
EndPoint：/v1/graph/{graph_id}/vertex
parameters：

{
    "label":"person",
    "primary_key_value":"1"
}

Expected Response

Format：application/json
Body：

Successfully found vertex

{
    "label": "person",
    "values": [
        {
            "name": "name",
            "value": "John Doe"
        },
        {
            "name": "age",
            "value": 25
        }
    ]
}

GetEdge（GraphManagement Category）

The function of this API interface is to get information about the properties of an Edge in an existing graph.

Http Request

Method：GET
EndPoint：/v1/graph/{graph_id}/edge
parameters：

{
    "src_label": "person",
    "dst_label": "software",
    "edge_label": "created",
    "src_primary_key_value": 2,
    "dst_primary_key_value": 3
}

Expected Response

Format：application/json
Body：Successfully get edge

{
    "src_label": "person",
    "dst_label": "software",
    "edge_label": "created",
    "src_primary_key_value": 2,
    "dst_primary_key_value": 3,
    "properties": [
        {
            "name": "weight",
            "value": 0.5
        }
    ]
}

UpdateVertex（GraphManagement Category）

The function of this API interface is to modify the properties of a Vertex in an existing graph.

Http Request

Method：PUT
EndPoint：/v1/graph/{graph_id}/vertex
Content-type: application/json
Body：

{
    "label": "person",
    "primary_key_value": 2,
    "properties": [
        {
            "name": "name",
            "value": "John Doe"
        },
        {
            "name": "age",
            "value": 25
        }
    ]
}

UpdateEdge（GraphManagement Category）

The function of this API interface is to modify the properties of the Edge in an existing graph.

Http Request

Method：PUT
EndPoint：/v1/graph/{graph_id}/edge
Content-type: application/json
Body：

{
    "src_label": "person",
    "dst_label": "software",
    "edge_label": "created",
    "src_primary_key_value": 2,
    "dst_primary_key_value": 3,
    "properties": [
        {
            "name": "weight",
            "value": 0.3
        }
    ]
}

Limitations:

Due to the significant cost of partitioning, queries on graph_id can only be performed on the currently running graph.
Although the system now supports edges with multiple attributes, the related transactions only support the creation, update, and retrieval of edges with a single attribute. Therefore, operations on multi-attribute edges are not supported at this time.
For edges/vertices of the same type, only 20% of the size N allocated at import time is reserved. If the initial graph is very small, only one or two edges/vertices can be inserted. This aspect will need to be adjusted in the future.
These interfaces have been designed to closely align with the SDK requirements. However, adjustments are needed within the SDK to support batch insertion of multiple vertices and edges.

zhanglei1949 · 2024-07-10T05:45:17Z

Nice work! Could you please add an end-to-end test case covering the creation, updating, and retrieval of vertices and edges? Perhaps including a test scenario within flex/interactive/sdk/python/test and flex/interactive/sdk/java/src/test/.

You may use the ldbc sf0.1 as the dataset.

flex/engines/graph_db/database/manager.cc

flex/engines/graph_db/database/manager.h

flex/engines/http_server/actor/executor.act.cc

zhanglei1949 · 2024-07-23T07:48:55Z

flex/engines/http_server/handler/hqps_http_handler.cc

@@ -168,6 +169,84 @@ seastar::future<std::unique_ptr<seastar::httpd::reply>> hqps_ic_handler::handle(
 auto dst_executor = executor_idx_;
 executor_idx_ = (executor_idx_ + 1) % shard_concurrency_;
 // TODO(zhanglei): choose read or write based on the request, after the
+ auto& method = req->_method;


Maybe we need a new handler to handle vertex/edge CRUD request? @luoxiaojian

zhanglei1949 · 2024-07-23T07:50:01Z

flex/engines/http_server/types.h

@@ -59,6 +59,8 @@ using admin_query_result = payload<gs::Result<seastar::sstring>>;
 // url_path, query_param
 using graph_management_param =
 payload<std::pair<seastar::sstring, seastar::sstring>>;
+using graph_management_query_param =


Why do we need a map?

Because the get request is for a map, not a json.

flex/interactive/sdk/examples/python/vertex_edge_example.py

…and retrieving vertices and edges. The Delete operation is not included as the underlying Graph DB does not yet support it.

…ers into scope cancel/recreation Committed-by: xiaolei.zl from Dev container

Committed-by: xiaolei.zl from Dev container

zhanglei1949

LGTM

yqylh changed the title ~~This commit primarily support six interfaces for creating, updating,…~~ PR Feat(interactive) : Supports RESTful API Support for Vertex and Edge Operations Including Create, Update, and Get Jul 10, 2024

yqylh changed the title ~~PR Feat(interactive) : Supports RESTful API Support for Vertex and Edge Operations Including Create, Update, and Get~~ Feat(interactive) : Supports RESTful API Support for Vertex and Edge Operations Including Create, Update, and Get Jul 10, 2024

yqylh changed the title ~~Feat(interactive) : Supports RESTful API Support for Vertex and Edge Operations Including Create, Update, and Get~~ Feat(interactive) : Supports API for Vertex and Edge Operations Including Create, Update, and Get Jul 10, 2024

luoxiaojian requested a review from zhanglei1949 July 10, 2024 04:22

zhanglei1949 changed the title ~~Feat(interactive) : Supports API for Vertex and Edge Operations Including Create, Update, and Get~~ feat(interactive): Add Create/Update/Get APIs for vertex/edge in Interactive Jul 10, 2024

yqylh force-pushed the feat-support-crud-http-new branch from 435308e to 6bcafb1 Compare July 18, 2024 07:22

zhanglei1949 reviewed Jul 23, 2024

View reviewed changes

yqylh force-pushed the feat-support-crud-http-new branch from 15728c8 to f057101 Compare July 29, 2024 12:58

yqylh added 21 commits July 30, 2024 11:57

This commit primarily support six interfaces for creating, updating, …

3f99894

…and retrieving vertices and edges. The Delete operation is not included as the underlying Graph DB does not yet support it.

format code

5577b67

refactor http handle

a29dbc3

format code

1eaaeef

add comment

43a28b6

refactor

856f345

refactor for input

313af1f

format

1616176

support for openapi

02c8681

fix output

4f4daaa

fix 200 response

92a6336

refactor handler

98b8d14

fix

e527762

refactor

0b9f4ca

remove property_name

b0f4433

update include

a074a24

refactor bool function

faa252c

add resutl/bool/status response

afa2a5c

implement interface

1122ea9

remove vertex_edge_example.py

ccde7c1

fix rebase bug

ad2dbde

yqylh added 2 commits July 30, 2024 11:57

format

336b650

move handle position

853a136

yqylh force-pushed the feat-support-crud-http-new branch from 7d23cd6 to 853a136 Compare July 30, 2024 03:58

zhanglei1949 requested review from luoxiaojian and liulx20 July 30, 2024 05:00

zhanglei1949 added 3 commits July 31, 2024 16:41

fixing ci by checking existence of graph_id and add vertex/edge handl…

aa91198

…ers into scope cancel/recreation Committed-by: xiaolei.zl from Dev container

fix sdk test

ddc52ef

Committed-by: xiaolei.zl from Dev container

Merge branch 'main' into feat-support-crud-http-new

2ade70c

luoxiaojian previously approved these changes Aug 1, 2024

View reviewed changes

Add some test for vertex/edge sdk

2d66b83

yqylh dismissed luoxiaojian’s stale review via 2d66b83 August 1, 2024 06:27

zhanglei1949 added 2 commits August 1, 2024 15:19

fixing ci

900c22b

Committed-by: xiaolei.zl from Dev container

Merge branch 'main' into feat-support-crud-http-new

db22ce5

zhanglei1949 approved these changes Aug 1, 2024

View reviewed changes

zhanglei1949 requested a review from lnfjpt August 1, 2024 07:49

lnfjpt approved these changes Aug 1, 2024

View reviewed changes

zhanglei1949 merged commit bfb70dc into alibaba:main Aug 1, 2024
32 of 33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(interactive): Add Create/Update/Get APIs for vertex/edge in Interactive #4025

feat(interactive): Add Create/Update/Get APIs for vertex/edge in Interactive #4025

yqylh commented Jul 10, 2024

zhanglei1949 commented Jul 10, 2024 •

edited

Loading

zhanglei1949 Jul 23, 2024

zhanglei1949 Jul 23, 2024

yqylh Jul 29, 2024

zhanglei1949 left a comment

feat(interactive): Add Create/Update/Get APIs for vertex/edge in Interactive #4025

feat(interactive): Add Create/Update/Get APIs for vertex/edge in Interactive #4025

Conversation

yqylh commented Jul 10, 2024

What do these changes do?

CreateVertex

Http Request

CreateEdge

Http Request

GetVertex（GraphManagement Category）

Http Request

Expected Response

GetEdge（GraphManagement Category）

Http Request

Expected Response

UpdateVertex（GraphManagement Category）

Http Request

UpdateEdge（GraphManagement Category）

Http Request

Limitations:

zhanglei1949 commented Jul 10, 2024 • edited Loading

zhanglei1949 Jul 23, 2024

Choose a reason for hiding this comment

zhanglei1949 Jul 23, 2024

Choose a reason for hiding this comment

yqylh Jul 29, 2024

Choose a reason for hiding this comment

zhanglei1949 left a comment

Choose a reason for hiding this comment

zhanglei1949 commented Jul 10, 2024 •

edited

Loading