2.1 Vertex

顶点类型中的 Id 策略决定了顶点的 Id 类型，其对应关系如下：

Id_Strategy id type
AUTOMATIC number
PRIMARY_KEY string
CUSTOMIZE_STRING string
CUSTOMIZE_NUMBER number
CUSTOMIZE_UUID uuid

顶点的 GET/PUT/DELETE API 中 url 的 id 部分传入的应是带有类型信息的 id 值，这个类型信息用 json 串是否带引号表示，也就是说：

  • 当 id 类型为 number 时，url 中的 id 不带引号，形如 xxx/vertices/123456
  • 当 id 类型为 string 时，url 中的 id 带引号，形如 xxx/vertices/"123456"

接下来的示例均假设已经创建好了前述的各种 schema 信息

2.1.1 创建

功能介绍

创建一个vertex

Method & Url
POST http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
Body参数
名称 是否必填 类型 默认值 取值范围 说明
label 是 String 顶点的标签名
properties 是 Map {} 顶点关联的属性类
Response
名称 类型 说明
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
Request Body
{
    "label": "person",
    "properties": {
        "name": "marko",
        "age": 29
    }
}
Response Status
201
Response Body
{
    "id": "1:marko",
    "label": "person",
    "type": "vertex",
    "properties": {
        "name": [
            {
                "id": "1:marko>name",
                "value": "marko"
            }
        ],
        "age": [
            {
                "id": "1:marko>age",
                "value": 29
            }
        ]
    }
}

2.1.2 批量创建

功能介绍

创建多个顶点

Method & Url
POST http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices/batch
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
Body参数
名称 是否必填 类型 默认值 取值范围 说明
是 List[Map] 每个顶点的标签及关联属性类
label String 顶点的标签值
properties 是 Map {} 顶点关联的属性类
Response
名称 类型 说明
List[String] 顶点id的列表
Request Body
[
    {
        "label": "person",
        "properties": {
            "name": "marko",
            "age": 29
        }
    },
    {
        "label": "software",
        "properties": {
            "name": "ripple",
            "lang": "java",
            "price": 199
        }
    }
]
Response Status
201
Response Body
[
    "1:marko",
    "2:ripple"
]

2.1.3 更新

功能介绍

更新顶点属性

Method & Url
PUT http://127.0.0.1:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices/{vertexId}?action=append
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
vertexId 是 String 需要包含引号，例如"1:marko"
Body参数
名称 是否必填 类型 默认值 取值范围 说明
label 是 String 顶点的标签名
properties 否 List[String] [] 顶点关联的属性类
Response
名称 类型 说明
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
Request Body
{
    "label": "person",
    "properties": {
        "age": 30,
        "city": "Beijing"
    }
}

注意：属性的取值是有三种类别的，分别是single、set和list。如果是single，表示增加或更新属性值；如果是set或list，则表示追加属性值。

Response Status
200
Response Body
{
    "id": "1:marko",
    "label": "person",
    "type": "vertex",
    "properties": {
        "city": [
            {
                "id": "1:marko>city",
                "value": "Beijing"
            }
        ],
        "name": [
            {
                "id": "1:marko>name",
                "value": "marko"
            }
        ],
        "age": [
            {
                "id": "1:marko>age",
                "value": 30
            }
        ]
    }
}

2.1.4 批量更新顶点属性

功能介绍

批量更新顶点的属性，并支持多种更新策略，包括

  • SUM: 数值累加
  • BIGGER: 两个数字/日期取更大的
  • SMALLER: 两个数字/日期取更小的
  • UNION: Set属性取并集
  • INTERSECTION: Set属性取交集
  • APPEND: List属性追加元素
  • ELIMINATE: List/Set属性删除元素
  • OVERRIDE: 覆盖已有属性，如果新属性为null，则仍然使用旧属性

假设原顶点及属性为：

{
    "vertices":[
        {
            "id":"2:lop",
            "label":"software",
            "type":"vertex",
            "properties":{
                "name":"lop",
                "lang":"java",
                "price":328
            }
        },
        {
            "id":"1:josh",
            "label":"person",
            "type":"vertex",
            "properties":{
                "name":"josh",
                "age":32,
                "city":"Beijing",
                "weight":0.1,
                "hobby":[
                    "reading",
                    "football"
                ]
            }
        }
    ]
}
Method & Url
PUT http://127.0.0.1:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices/batch
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
Body参数
名称 是否必填 类型 默认值 取值范围 说明
vertices 是 List[Map] 待更新的顶点列表
label String 顶点的标签值
properties 是 Map {} 顶点关联的属性类
update_strategies 是 Map {} 针对不同属性的更新策略
create_if_not_exist 否 Boolean true true, false 自动创建
Response
名称 类型 说明
vertices List[Map] 更新的顶点列表
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
Request Body
{
    "vertices":[
        {
            "label":"software",
            "type":"vertex",
            "properties":{
                "name":"lop",
                "lang":"c++",
                "price":299
            }
        },
        {
            "label":"person",
            "type":"vertex",
            "properties":{
                "name":"josh",
                "city":"Shanghai",
                "weight":0.2,
                "hobby":[
                    "swiming"
                ]
            }
        }
    ],
    "update_strategies":{
        "price":"BIGGER",
        "age":"OVERRIDE",
        "city":"OVERRIDE",
        "weight":"SUM",
        "hobby":"UNION"
    },
    "create_if_not_exist":true
}
Response Status
200
Response Body
{
    "vertices": [
        {
            "id": "2:lop",
            "label": "software",
            "type": "vertex",
            "properties": {
                "name": "lop",
                "lang": "c++",
                "price": 328
            }
        },
        {
            "id": "1:josh",
            "label": "person",
            "type": "vertex",
            "properties": {
                "name": "josh",
                "age": 32,
                "city": "Shanghai",
                "weight": 0.3,
                "hobby": [
                    "swiming",
                    "reading",
                    "football"
                ]
            }
        }
    ]
}

结果分析：

  • lang 属性未指定更新策略，直接用新值覆盖旧值，无论新值是否为null；
  • price 属性指定 BIGGER 的更新策略，旧属性值为328，新属性值为299，所以仍然保留了旧属性值328；
  • age 属性指定 OVERRIDE 更新策略，而新属性值中未传入age，相当于age为null，所以仍然保留了原属性值32；
  • city 属性也指定了 OVERRIDE 更新策略，且新属性值不为null，所以覆盖了旧值；
  • weight 属性指定了 SUM 更新策略，旧属性值为0.1，新属性值为0.2，最后的值为0.3；
  • hobby 属性（基数为Set）指定了 UNION 更新策略，所以新值与旧值取了并集；

其他的更新策略使用方式可以类推，不再赘述。

2.1.5 删除顶点属性

功能介绍

删除顶点属性

Method & Url
PUT http://127.0.0.1:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices/{vertexId}?action=eliminate
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
vertexId 是 String 顶点的Id, 注意需要包含引号，例如"1:marko"
Body参数
名称 是否必填 类型 默认值 取值范围 说明
label String 顶点的标签值
properties 是 Map {} 顶点待删除的属性类
Response
名称 类型 说明
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
Request Body
{
    "label": "person",
    "properties": {
        "city": "Beijing"
    }
}

注意：这里会直接删除属性（删除key和所有value），无论其属性的取值是single、set或list。

Response Status
200
Response Body
{
    "id": "1:marko",
    "label": "person",
    "type": "vertex",
    "properties": {
        "name": [
            {
                "id": "1:marko>name",
                "value": "marko"
            }
        ],
        "age": [
            {
                "id": "1:marko>age",
                "value": 30
            }
        ]
    }
}

2.1.6 获取符合条件的顶点

功能介绍

根据条件查询并获取所有符合条件的顶点

Params
  • label: 顶点类型
  • properties: 属性键值对(根据属性查询的前提是预先建立了索引)
  • limit: 查询最大数目
  • page: 页号

以上参数都是可选的，如果提供page参数，必须提供limit参数，不允许带其他参数。label, properties和limit可以任意组合。

属性键值对由JSON格式的属性名称和属性值组成，允许多个属性键值对作为查询条件，属性值支持精确匹配和范围匹配，精确匹配时形如properties={"age":29}，范围匹配时形如properties={"age":"P.gt(29)"},范围匹配支持的表达式如下：

表达式 说明
P.eq(number) 属性值等于number的顶点
P.neq(number) 属性值不等于number的顶点
P.lt(number) 属性值小于number的顶点
P.lte(number) 属性值小于等于number的顶点
P.gt(number) 属性值大于number的顶点
P.gte(number) 属性值大于等于number的顶点
P.between(number1,number2) 属性值大于等于number1且小于number2的顶点
P.inside(number1,number2) 属性值大于number1且小于number2的顶点
P.outside(number1,number2) 属性值小于number1且大于number2的顶点
P.within(value1,value2,value3,...) 属性值等于任何一个给定value的顶点

查询所有 age 为 20 且 label 为 person 的顶点

Method & Url
GET http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices?label=person&properties={"age":29}&limit=1
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
label 否 String 顶点的标签值
properties 否 String 顶点的属性的Json格式
limit 否 Int 100 1 - 2^64 限制获取的顶点的数量
Body参数

无

Response
名称 类型 说明
vertices List[Map] 获取到的顶点列表
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
Response Status
200
Response Body
{
    "vertices": [
        {
            "id": "1:marko",
            "label": "person",
            "type": "vertex",
            "properties": {
                "city": [
                    {
                        "id": "1:marko>city",
                        "value": "Beijing"
                    }
                ],
                "name": [
                    {
                        "id": "1:marko>name",
                        "value": "marko"
                    }
                ],
                "age": [
                    {
                        "id": "1:marko>age",
                        "value": 29
                    }
                ]
            }
        }
    ]
}

分页查询所有顶点，获取第一页（page不带参数值），限定3条

Method & Url
GET http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices?page&limit=3
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
limit 否 Int 100 1 - 2^64 限制获取的顶点的数量
Body参数

无

Response
名称 类型 说明
vertices List[Map] 获取到的顶点列表
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
page String 分页值，用于下次查询时从当前分页点继续查询。null则表示没有下一页了
Response Status
200
Response Body
{
    "vertices": [{
            "id": "2:ripple",
            "label": "software",
            "type": "vertex",
            "properties": {
                "price": [{
                    "id": "2:ripple>price",
                    "value": 199
                }],
                "name": [{
                    "id": "2:ripple>name",
                    "value": "ripple"
                }],
                "lang": [{
                    "id": "2:ripple>lang",
                    "value": "java"
                }]
            }
        },
        {
            "id": "1:vadas",
            "label": "person",
            "type": "vertex",
            "properties": {
                "city": [{
                    "id": "1:vadas>city",
                    "value": "Hongkong"
                }],
                "name": [{
                    "id": "1:vadas>name",
                    "value": "vadas"
                }],
                "age": [{
                    "id": "1:vadas>age",
                    "value": 27
                }]
            }
        },
        {
            "id": "1:peter",
            "label": "person",
            "type": "vertex",
            "properties": {
                "city": [{
                    "id": "1:peter>city",
                    "value": "Shanghai"
                }],
                "name": [{
                    "id": "1:peter>name",
                    "value": "peter"
                }],
                "age": [{
                    "id": "1:peter>age",
                    "value": 35
                }]
            }
        }
    ],
    "page": "001000100853313a706574657200f07ffffffc00e797c6349be736fffc8699e8a502efe10004"
}

返回的body里面是带有下一页的页号信息的，"page": "001000100853313a706574657200f07ffffffc00e797c6349be736fffc8699e8a502efe10004"， 在查询下一页的时候将该值赋给page参数。

分页查询所有顶点，获取下一页（page带上上一页返回的page值），限定3条

Method & Url
GET http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices?page=001000100853313a706574657200f07ffffffc00e797c6349be736fffc8699e8a502efe10004&limit=3
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
page 是 String 上一次使用page查询时，Response返回的page值
limit 否 Int 100 1 - 2^64 限制获取的顶点的数量
Body参数

无

Response
名称 类型 说明
vertices List[Map] 获取到的顶点列表
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
page String 分页值，用于下次查询时从当前分页点继续查询，null则表示没有下一页了
Response Status
200
Response Body
{
    "vertices": [{
            "id": "1:josh",
            "label": "person",
            "type": "vertex",
            "properties": {
                "city": [{
                    "id": "1:josh>city",
                    "value": "Beijing"
                }],
                "name": [{
                    "id": "1:josh>name",
                    "value": "josh"
                }],
                "age": [{
                    "id": "1:josh>age",
                    "value": 32
                }]
            }
        },
        {
            "id": "1:marko",
            "label": "person",
            "type": "vertex",
            "properties": {
                "city": [{
                    "id": "1:marko>city",
                    "value": "Beijing"
                }],
                "name": [{
                    "id": "1:marko>name",
                    "value": "marko"
                }],
                "age": [{
                    "id": "1:marko>age",
                    "value": 29
                }]
            }
        },
        {
            "id": "2:lop",
            "label": "software",
            "type": "vertex",
            "properties": {
                "price": [{
                    "id": "2:lop>price",
                    "value": 328
                }],
                "name": [{
                    "id": "2:lop>name",
                    "value": "lop"
                }],
                "lang": [{
                    "id": "2:lop>lang",
                    "value": "java"
                }]
            }
        }
    ],
    "page": null
}

此时"page": null表示已经没有下一页了 (注: 后端为 Cassandra 时，为了性能考虑，返回页恰好为最后一页时，返回 page 值可能非空，通过该 page 再请求下一页数据时则返回 空数据 及 page = null，其他情况类似)

2.1.7 根据Id获取顶点

功能介绍

根据Id获取顶点

Method & Url
GET http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices/{vertexId}
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
vertexId 是 String 需要包含引号，例如"1:marko"
Body参数

无

Response
名称 类型 说明
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
page String 分页值，用于下次查询时从当前分页点继续查询
Response Status
200
Response Body
{
    "id": "1:marko",
    "label": "person",
    "type": "vertex",
    "properties": {
        "name": [
            {
                "id": "1:marko>name",
                "value": "marko"
            }
        ],
        "age": [
            {
                "id": "1:marko>age",
                "value": 29
            }
        ]
    }
}

2.1.8 删除顶点

功能介绍

仅根据Id删除顶点

Method & Url
DELETE http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices/{vertexId}
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
vertexId 是 String 需要包含引号，例如"1:marko"
Body参数

无

Response

无

Response Status
204

根据Label+Id删除顶点

通过指定Label参数和Id来删除顶点时，一般来说其性能比仅根据Id删除会更好。

Method & Url
DELETE http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices/{vertexId}?label=person
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
vertexId 是 String 需要包含引号，例如"1:marko"
label 是 String 顶点的标签名
Body参数

无

Response

无

Response Status
204

2.1.9 Vertices

2.1.9.1 根据顶点的id列表，批量查询顶点

功能介绍

根据顶点的Id列表,批量查询顶点

Method & Url
GET http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices?ids="1:marko"&ids="2:lop"
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
ids 是 String 待查询的顶点Id列表，需要包含引号，例如"1:marko"。通过多次输入来进行批量查询
Body参数

无

Response
名称 类型 说明
vertices List[Map] 获取到的顶点列表
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
Response Status
200
Response Body
{
    "vertices":[
        {
            "id":"1:marko",
            "label":"person",
            "type":"vertex",
            "properties":{
                "city":[
                    {
                        "id":"1:marko>city",
                        "value":"Beijing"
                    }
                ],
                "name":[
                    {
                        "id":"1:marko>name",
                        "value":"marko"
                    }
                ],
                "age":[
                    {
                        "id":"1:marko>age",
                        "value":29
                    }
                ]
            }
        },
        {
            "id":"2:lop",
            "label":"software",
            "type":"vertex",
            "properties":{
                "price":[
                    {
                        "id":"2:lop>price",
                        "value":328
                    }
                ],
                "name":[
                    {
                        "id":"2:lop>name",
                        "value":"lop"
                    }
                ],
                "lang":[
                    {
                        "id":"2:lop>lang",
                        "value":"java"
                    }
                ]
            }
        }
    ]
}
2.1.9.2 获取顶点 Shard 信息

功能介绍

通过指定的分片大小split_size，获取顶点分片信息（可以与 3.2.21.3 中的 Scan 配合使用来获取顶点）。

Method & Url
GET http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices/shards?split_size=67108864
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
split_size 是 Int 分片的大小
Body参数

无

Response
名称 类型 说明
shard List[Map] 分片信息的类表
start String 分片起始位置
end String 分片结束位置（不包含）
length Int 分片的长度
Response Status
200
Response Body
{
    "shards":[
        {
            "start": "0",
            "end": "2165893",
            "length": 0
        },
        {
            "start": "2165893",
            "end": "4331786",
            "length": 0
        },
        {
            "start": "4331786",
            "end": "6497679",
            "length": 0
        },
        {
            "start": "6497679",
            "end": "8663572",
            "length": 0
        },
        ......
    ]
}
2.1.9.3 根据Shard信息批量获取顶点

功能介绍

通过指定的分片信息批量查询顶点（Shard信息的获取参见 3.2.21.2 Shard）。

Method & Url
GET http://localhost:8080/graphspaces/{graphspace}/graphs/{graph}/graph/vertices/scan?start=0&end=4294967295&page={page}&page_limit={page_limit}
URI参数
名称 是否必填 类型 默认值 取值范围 说明
graphspace 是 String 图空间名称
graph 是 String 图名称
start 是 String 分片起始位置
end 是 String 分片结束位置
page 否 String null 分页位置
page_limit 否 Int 1000 分页获取顶点时，一页中顶点数目的上限
Body参数

无

Response
名称 类型 说明
vertices List[Map] 获取到的顶点列表
id Int 顶点id
label String 顶点的标签
type String 创建的类型，这里固定为vertex
properties Map 顶点类型关联的属性类型
Response Status
200
Response Body
{
    "vertices":[
        {
            "id":"2:ripple",
            "label":"software",
            "type":"vertex",
            "properties":{
                "price":[
                    {
                        "id":"2:ripple>price",
                        "value":199
                    }
                ],
                "name":[
                    {
                        "id":"2:ripple>name",
                        "value":"ripple"
                    }
                ],
                "lang":[
                    {
                        "id":"2:ripple>lang",
                        "value":"java"
                    }
                ]
            }
        },
        {
            "id":"1:vadas",
            "label":"person",
            "type":"vertex",
            "properties":{
                "city":[
                    {
                        "id":"1:vadas>city",
                        "value":"Hongkong"
                    }
                ],
                "name":[
                    {
                        "id":"1:vadas>name",
                        "value":"vadas"
                    }
                ],
                "age":[
                    {
                        "id":"1:vadas>age",
                        "value":27
                    }
                ]
            }
        },
        {
            "id":"1:peter",
            "label":"person",
            "type":"vertex",
            "properties":{
                "city":[
                    {
                        "id":"1:peter>city",
                        "value":"Shanghai"
                    }
                ],
                "name":[
                    {
                        "id":"1:peter>name",
                        "value":"peter"
                    }
                ],
                "age":[
                    {
                        "id":"1:peter>age",
                        "value":35
                    }
                ]
            }
        },
        {
            "id":"1:josh",
            "label":"person",
            "type":"vertex",
            "properties":{
                "city":[
                    {
                        "id":"1:josh>city",
                        "value":"Beijing"
                    }
                ],
                "name":[
                    {
                        "id":"1:josh>name",
                        "value":"josh"
                    }
                ],
                "age":[
                    {
                        "id":"1:josh>age",
                        "value":32
                    }
                ]
            }
        },
        {
            "id":"1:marko",
            "label":"person",
            "type":"vertex",
            "properties":{
                "city":[
                    {
                        "id":"1:marko>city",
                        "value":"Beijing"
                    }
                ],
                "name":[
                    {
                        "id":"1:marko>name",
                        "value":"marko"
                    }
                ],
                "age":[
                    {
                        "id":"1:marko>age",
                        "value":29
                    }
                ]
            }
        },
        {
            "id":"2:lop",
            "label":"software",
            "type":"vertex",
            "properties":{
                "price":[
                    {
                        "id":"2:lop>price",
                        "value":328
                    }
                ],
                "name":[
                    {
                        "id":"2:lop>name",
                        "value":"lop"
                    }
                ],
                "lang":[
                    {
                        "id":"2:lop>lang",
                        "value":"java"
                    }
                ]
            }
        }
    ]
}
2.1.9.4 适用场景
  • 按id列表查询顶点，可用于批量查询顶点，比如在path查询到多条路径之后，可以进一步查询某条路径的所有顶点属性。
  • 获取分片和按分片查询顶点，可以用来遍历全部顶点

results matching ""

    No results matching ""