Version 1.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.
Schema API
1.1 Schema
HugeGraph 提供单一接口获取某个图的全部 Schema 信息，包括：PropertyKey、VertexLabel、EdgeLabel 和 IndexLabel。
Method & Url
1GET http://localhost:8080/graphs/hugegraph/schemaResponse Status
1200Response Body
1{
2 "propertykeys": [
3 {
4 "id": 7,
5 "name": "price",
6 "data_type": "INT",
7 "cardinality": "SINGLE",
8 "aggregate_type": "NONE",
9 "write_type": "OLTP",
10 "properties": [
11 ],
12 "status": "CREATED",
13 "user_data": {
14 "~create_time": "2021-09-03 15:13:40.741"
15 }
16 },
17 {
18 "id": 6,
19 "name": "date",
20 "data_type": "TEXT",
21 "cardinality": "SINGLE",
22 "aggregate_type": "NONE",
23 "write_type": "OLTP",
24 "properties": [
25 ],
26 "status": "CREATED",
27 "user_data": {
28 "~create_time": "2021-09-03 15:13:40.729"
29 }
30 },
31 {
32 "id": 3,
33 "name": "city",
34 "data_type": "TEXT",
35 "cardinality": "SINGLE",
36 "aggregate_type": "NONE",
37 "write_type": "OLTP",
38 "properties": [
39 ],
40 "status": "CREATED",
41 "user_data": {
42 "~create_time": "2021-09-03 15:13:40.691"
43 }
44 },
45 {
46 "id": 2,
47 "name": "age",
48 "data_type": "INT",
49 "cardinality": "SINGLE",
50 "aggregate_type": "NONE",
51 "write_type": "OLTP",
52 "properties": [
53 ],
54 "status": "CREATED",
55 "user_data": {
56 "~create_time": "2021-09-03 15:13:40.678"
57 }
58 },
59 {
60 "id": 5,
61 "name": "lang",
62 "data_type": "TEXT",
63 "cardinality": "SINGLE",
64 "aggregate_type": "NONE",
65 "write_type": "OLTP",
66 "properties": [
67 ],
68 "status": "CREATED",
69 "user_data": {
70 "~create_time": "2021-09-03 15:13:40.718"
71 }
72 },
73 {
74 "id": 4,
75 "name": "weight",
76 "data_type": "DOUBLE",
77 "cardinality": "SINGLE",
78 "aggregate_type": "NONE",
79 "write_type": "OLTP",
80 "properties": [
81 ],
82 "status": "CREATED",
83 "user_data": {
84 "~create_time": "2021-09-03 15:13:40.707"
85 }
86 },
87 {
88 "id": 1,
89 "name": "name",
90 "data_type": "TEXT",
91 "cardinality": "SINGLE",
92 "aggregate_type": "NONE",
93 "write_type": "OLTP",
94 "properties": [
95 ],
96 "status": "CREATED",
97 "user_data": {
98 "~create_time": "2021-09-03 15:13:40.609"
99 }
100 }
101 ],
102 "vertexlabels": [
103 {
104 "id": 1,
105 "name": "person",
106 "id_strategy": "PRIMARY_KEY",
107 "primary_keys": [
108 "name"
109 ],
110 "nullable_keys": [
111 "age"
112 ],
113 "index_labels": [
114 "personByCity",
115 "personByAgeAndCity"
116 ],
117 "properties": [
118 "name",
119 "age",
120 "city"
121 ],
122 "status": "CREATED",
123 "ttl": 0,
124 "enable_label_index": true,
125 "user_data": {
126 "~create_time": "2021-09-03 15:13:40.783"
127 }
128 },
129 {
130 "id": 2,
131 "name": "software",
132 "id_strategy": "PRIMARY_KEY",
133 "primary_keys": [
134 "name"
135 ],
136 "nullable_keys": [
137 "price"
138 ],
139 "index_labels": [
140 "softwareByPrice"
141 ],
142 "properties": [
143 "name",
144 "lang",
145 "price"
146 ],
147 "status": "CREATED",
148 "ttl": 0,
149 "enable_label_index": true,
150 "user_data": {
151 "~create_time": "2021-09-03 15:13:40.840"
152 }
153 }
154 ],
155 "edgelabels": [
156 {
157 "id": 1,
158 "name": "knows",
159 "source_label": "person",
160 "target_label": "person",
161 "frequency": "MULTIPLE",
162 "sort_keys": [
163 "date"
164 ],
165 "nullable_keys": [
166 "weight"
167 ],
168 "index_labels": [
169 "knowsByWeight"
170 ],
171 "properties": [
172 "weight",
173 "date"
174 ],
175 "status": "CREATED",
176 "ttl": 0,
177 "enable_label_index": true,
178 "user_data": {
179 "~create_time": "2021-09-03 15:13:41.840"
180 }
181 },
182 {
183 "id": 2,
184 "name": "created",
185 "source_label": "person",
186 "target_label": "software",
187 "frequency": "SINGLE",
188 "sort_keys": [
189 ],
190 "nullable_keys": [
191 "weight"
192 ],
193 "index_labels": [
194 "createdByDate",
195 "createdByWeight"
196 ],
197 "properties": [
198 "weight",
199 "date"
200 ],
201 "status": "CREATED",
202 "ttl": 0,
203 "enable_label_index": true,
204 "user_data": {
205 "~create_time": "2021-09-03 15:13:41.868"
206 }
207 }
208 ],
209 "indexlabels": [
210 {
211 "id": 1,
212 "name": "personByCity",
213 "base_type": "VERTEX_LABEL",
214 "base_value": "person",
215 "index_type": "SECONDARY",
216 "fields": [
217 "city"
218 ],
219 "status": "CREATED",
220 "user_data": {
221 "~create_time": "2021-09-03 15:13:40.886"
222 }
223 },
224 {
225 "id": 4,
226 "name": "createdByDate",
227 "base_type": "EDGE_LABEL",
228 "base_value": "created",
229 "index_type": "SECONDARY",
230 "fields": [
231 "date"
232 ],
233 "status": "CREATED",
234 "user_data": {
235 "~create_time": "2021-09-03 15:13:41.878"
236 }
237 },
238 {
239 "id": 5,
240 "name": "createdByWeight",
241 "base_type": "EDGE_LABEL",
242 "base_value": "created",
243 "index_type": "RANGE_DOUBLE",
244 "fields": [
245 "weight"
246 ],
247 "status": "CREATED",
248 "user_data": {
249 "~create_time": "2021-09-03 15:13:42.117"
250 }
251 },
252 {
253 "id": 2,
254 "name": "personByAgeAndCity",
255 "base_type": "VERTEX_LABEL",
256 "base_value": "person",
257 "index_type": "SECONDARY",
258 "fields": [
259 "age",
260 "city"
261 ],
262 "status": "CREATED",
263 "user_data": {
264 "~create_time": "2021-09-03 15:13:41.351"
265 }
266 },
267 {
268 "id": 3,
269 "name": "softwareByPrice",
270 "base_type": "VERTEX_LABEL",
271 "base_value": "software",
272 "index_type": "RANGE_INT",
273 "fields": [
274 "price"
275 ],
276 "status": "CREATED",
277 "user_data": {
278 "~create_time": "2021-09-03 15:13:41.587"
279 }
280 },
281 {
282 "id": 6,
283 "name": "knowsByWeight",
284 "base_type": "EDGE_LABEL",
285 "base_value": "knows",
286 "index_type": "RANGE_DOUBLE",
287 "fields": [
288 "weight"
289 ],
290 "status": "CREATED",
291 "user_data": {
292 "~create_time": "2021-09-03 15:13:42.376"
293 }
294 }
295 ]
296}
Last modified 2022-04-17 · rebuild doc (ef3654447)