4.4.2.顶点类型

VertextLabel的描述字段详细说明

id_strategy可选值:

• DEFAULT: 如果设置了 primary_keys，则采用PRIMARY_KEY策略，否则采用AUTOMATIC策略
• AUTOMATIC: Snowflake算法自动生成ID
• PRIMARY_KEY: 主键策略生成ID
• CUSTOMIZE_STRING: 用户自定义字符串ID
• CUSTOMIZE_NUMBER: 用户自动移数字ID
• CUSTOMIZE_UUID: 用户自定义UUID

从 hugegraph-server v0.11.2 版本开始支持顶点的 TTL 功能。顶点的 TTL 是通过 VertexLabel 来设置的。比如希望 person 类型的顶点存活时间为一天，需要在创建 person VertexLabel 的时候将 TTL 字段设置为 86400000，即单位为毫秒。

另外，当顶点中带有"创建时间"的属性且希望以"创建时间"属性作为计算顶点存活时间的起点时，可以设置 VertexLabel 中的 ttl_start_time 字段。

4.4.2.1.创建VertexLabel

功能介绍

创建一个VertexLabel

URI

POST /graphspaces/${graphspace}/graphs/${hugegraph}/schema/vertexlabels

URI参数

Body参数

Response

使用示例

person VertexLabel 有 createdTime 属性，且 createdTime 是 Date 类型的参数，希望 person 类型的顶点从创建开始存活一天的时间，那么创建 person VertexLabel 的 Request Body。

Method & Url

POST http://localhost:8080/graphspaces/gs1/graphs/hugegraph/schema/vertexlabels

Request Body

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

Response Status

201

Response Body

{
    "id": 1,
    "primary_keys": [
        "name"
    ],
    "id_strategy": "PRIMARY_KEY",
    "name": "person2",
    "index_names": [
    ],
    "properties": [
        "name",
        "age"
    ],
    "nullable_keys": [
    ],
    "enable_label_index": true,
    "ttl": 86400000,
    "ttl_start_time": "createdTime",
    "user_data": {}
}

4.4.2.2.更新VertexLabel

功能介绍

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

URI

PUT /graphspaces/${graphspace}/graphs/${hugegraph}/schema/vertexlabels/${name}?action=${action}

URI参数

Body参数

Response

使用示例

Method & Url

PUT http://localhost:8080/graphspaces/gs1/graphs/hugegraph/schema/vertexlabels/person?action=append

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": [
    ],
    "properties": [
        "city",
        "name",
        "age"
    ],
    "nullable_keys": [
        "city"
    ],
    "enable_label_index": true,
    "user_data": {
        "super": "animal"
    }
}

4.4.2.3.获取所有的VertexLabel

功能介绍

获取所有的VertexLabel列表

URI

GET /graphspaces/${grphspace}/graphs/${hugegraph}/schema/vertexlabels

URI参数

Body参数

无

Response

使用示例

Method & Url

GET http://localhost:8080/graphspaces/${graphspace}/graphs/${hugegraph}/schema/vertexlabels

Response Status

200

Response Body

{
    "vertexlabels": [
        {
            "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"
            }
        },
        {
            "id": 2,
            "primary_keys": [
                "name"
            ],
            "id_strategy": "PRIMARY_KEY",
            "name": "software",
            "index_names": [
            ],
            "properties": [
                "price",
                "name",
                "lang"
            ],
            "nullable_keys": [
                "price"
            ],
            "enable_label_index": false,
            "user_data": {}
        }
    ]
}

4.4.2.4.获取单个VertexLabel

功能介绍

根据name获取VertexLabel

URI

GET /graphspaces/${graphspace}/graphs/${hugegraph}/schema/vertexlabels/${name}

URI参数

Body参数

无

使用示例

Method & Url

GET http://localhost:8080/graphspaces/${grphspace}/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"
    }
}

4.4.2.5.删除VertexLabel

功能介绍

根据name删除VertexLabel

删除 VertexLabel 会导致删除对应的顶点以及相关的索引数据，会产生一个异步任务

URI

DELETE /graphspaces/${graphspace}/graphs/${hugegraph}/schema/vertexlabels/${name}

URI参数

Body参数

无

Response

使用示例

Method & Url

DELETE http://localhost:8080/graphspaces/${graphspace}/graphs/${hugegraph}/schema/vertexlabels/person

Response Status

202

Response Body

{
    "task_id": 1
}

注：

可以通过GET /graphspaces/${graphspace}/graphs/${hugegraph}/tasks/1（其中"1"是task_id）来查询异步任务的执行状态，更多异步任务RESTful API