Params说明

• id：顶点类型id值
• name：顶点类型名称，必填
• id_strategy: 顶点类型的ID策略，主键ID、自动生成、自定义字符串、自定义数字、自定义UUID，默认主键ID
• properties: 顶点类型关联的属性类型
• primary_keys: 主键属性，当ID策略为PRIMARY_KEY时必须有值，其他ID策略时必须为空；
• enable_label_index： 是否开启类型索引，默认关闭
• index_names：顶点类型创建的索引，详情见3.4
• nullable_keys：可为空的属性
• user_data：设置顶点类型的通用信息，作用同属性类型

1.3.1 创建一个VertexLabel

Method & Url

Request Body

    "name": "person",
    "id_strategy": "DEFAULT",
    "properties": [
        "name",
        "age"
    ],
    "primary_keys": [
        "name"
    ],
    "nullable_keys": [],
    "enable_label_index": true
}

Response Status

201

Response Body

{
    "id": 1,
    "primary_keys": [
        "name"
    ],
    "name": "person2",
    "index_names": [
    ],
    "properties": [
        "name",
        "age"
    ],
    "nullable_keys": [
    ],
    "enable_label_index": true,
    "user_data": {}
}

{
    "name": "person",
    "id_strategy": "DEFAULT",
    "properties": [
        "name",
        "age"
    ],
    "primary_keys": [
        "name"
    ],
    "ttl": 86400000,
    "enable_label_index": true
}

另外，当顶点中带有”创建时间”的属性且希望以”创建时间”属性作为计算顶点存活时间的起点时，可以设置 VertexLabel 中的 ttl_start_time 字段。比如 person VertexLabel 有 createdTime 属性，且 createdTime 是 Date 类型的参数，希望 person 类型的顶点从创建开始存活一天的时间，那么创建 person VertexLabel 的 Request Body 如下：

{
    "name": "person",
    "id_strategy": "DEFAULT",
    "properties": [
        "name",
        "age",
        "createdTime"
    ],
    "primary_keys": [
        "name"
    ],
    "nullable_keys": [],
    "ttl": 86400000,
    "ttl_start_time": "createdTime",
    "enable_label_index": true
}

1.3.2 为已存在的VertexLabel添加properties或userdata，或者移除userdata（目前不支持移除properties）

Params

• action: 表示当前行为是添加还是移除，取值为append（添加）和eliminate（移除）

Method & Url

Request Body

{
    "name": "person",
    "properties": [
        "city"
    ],
    "nullable_keys": ["city"],
    "user_data": {
        "super": "animal"
}

Response Status

200

Response Body

{
    "id": 1,
    "primary_keys": [
        "name"
    ],
    "id_strategy": "PRIMARY_KEY",
    "name": "person",
    "index_names": [
    ],
        "city",
        "name",
        "age"
    ],
    "nullable_keys": [
        "city"
    ],
    "enable_label_index": true,
    "user_data": {
        "super": "animal"
    }
}

1.3.3 获取所有的VertexLabel

Method & Url

GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels

Response Status

200

Response Body

1.3.4 根据name获取VertexLabel

Method & Url

GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels/person

Response Status

200

Response Body

{
    "id": 1,
    "primary_keys": [
        "name"
    ],
    "id_strategy": "PRIMARY_KEY",
    "name": "person",
    "index_names": [
    ],
    "properties": [
        "city",
        "name",
        "age"
    ],
    "nullable_keys": [
        "city"
    ],
    "enable_label_index": true,
    "user_data": {
        "super": "animal"
    }
}

1.3.5 根据name删除VertexLabel

Method & Url

DELETE http://localhost:8080/graphs/hugegraph/schema/vertexlabels/person

Response Status

Response Body

注：