文档 1.5 版本已不再积极维护，你当前浏览的是一份归档快照。
最新文档请参阅 最新版本 。
VertexLabel API 1.3 VertexLabel 假设已经创建好了1.1.3中列出来的 PropertyKeys
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
POST http://localhost:8080/graphs/hugegraph/schema/vertexlabelsRequest Body
{
"name" : "person" ,
"id_strategy" : "DEFAULT" ,
"properties" : [
"name" ,
"age"
],
"primary_keys" : [
"name"
],
"nullable_keys" : [],
"enable_label_index" : true
} Response Status Response Body
{
"id" : 1 ,
"primary_keys" : [
"name"
],
"id_strategy" : "PRIMARY_KEY" ,
"name" : "person2" ,
"index_names" : [
],
"properties" : [
"name" ,
"age"
],
"nullable_keys" : [
],
"enable_label_index" : true ,
"user_data" : {}
} 从 hugegraph-server v0.11.2 版本开始支持顶点的 TTL 功能。顶点的 TTL 是通过 VertexLabel 来设置的。比如希望 person 类型的顶点存活时间为一天，需要在创建 person VertexLabel 的时候将 TTL 字段设置为 86400000，即单位为毫秒。
{
"name" : "person" ,
"id_strategy" : "DEFAULT" ,
"properties" : [
"name" ,
"age"
],
"primary_keys" : [
"name"
],
"nullable_keys" : [],
"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
PUT http://localhost:8080/graphs/hugegraph/schema/vertexlabels/person?action=appendRequest Body
{
"name" : "person" ,
"properties" : [
"city"
],
"nullable_keys" : [ "city" ],
"user_data" : {
"super" : "animal"
}
} Response Status 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.3 获取所有的VertexLabel Method & Url
GET http://localhost:8080/graphs/hugegraph/schema/vertexlabelsResponse Status 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" : {}
}
]
} 1.3.4 根据name获取VertexLabel Method & Url
GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels/personResponse Status 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 删除 VertexLabel 会导致删除对应的顶点以及相关的索引数据，会产生一个异步任务
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/schema/vertexlabels/personResponse Status Response Body 注：
可以通过GET http://localhost:8080/graphs/hugegraph/tasks/1（其中"1"是task_id）来查询异步任务的执行状态，更多异步任务RESTful API