@ultipa-graph/ultipa-driver 5.1.4-s5.1 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (215) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +65 -0
  3. package/dist/client.d.ts +194 -0
  4. package/dist/client.js +390 -0
  5. package/dist/config.d.ts +65 -0
  6. package/dist/config.js +135 -0
  7. package/dist/connection.d.ts +30 -0
  8. package/dist/connection.js +190 -0
  9. package/dist/errors.d.ts +99 -0
  10. package/dist/errors.js +237 -0
  11. package/dist/index.d.ts +14 -5
  12. package/dist/index.js +88 -39
  13. package/dist/printers.d.ts +33 -0
  14. package/dist/printers.js +312 -0
  15. package/dist/proto/gqldb.proto +632 -0
  16. package/dist/response.d.ts +256 -0
  17. package/dist/response.js +723 -0
  18. package/dist/services/admin-service.d.ts +40 -0
  19. package/dist/services/admin-service.js +115 -0
  20. package/dist/services/bulk-import-service.d.ts +35 -0
  21. package/dist/services/bulk-import-service.js +108 -0
  22. package/dist/services/converters.d.ts +57 -0
  23. package/dist/services/converters.js +254 -0
  24. package/dist/services/data-service.d.ts +44 -0
  25. package/dist/services/data-service.js +206 -0
  26. package/dist/services/graph-service.d.ts +32 -0
  27. package/dist/services/graph-service.js +127 -0
  28. package/dist/services/health-service.d.ts +50 -0
  29. package/dist/services/health-service.js +78 -0
  30. package/dist/services/index.d.ts +13 -0
  31. package/dist/services/index.js +30 -0
  32. package/dist/services/query-service.d.ts +39 -0
  33. package/dist/services/query-service.js +112 -0
  34. package/dist/services/service-context.d.ts +39 -0
  35. package/dist/services/service-context.js +73 -0
  36. package/dist/services/session-service.d.ts +24 -0
  37. package/dist/services/session-service.js +66 -0
  38. package/dist/services/transaction-service.d.ts +33 -0
  39. package/dist/services/transaction-service.js +100 -0
  40. package/dist/services.d.ts +28 -0
  41. package/dist/services.js +122 -0
  42. package/dist/session.d.ts +45 -0
  43. package/dist/session.js +75 -0
  44. package/dist/transaction.d.ts +42 -0
  45. package/dist/transaction.js +89 -0
  46. package/dist/types/bulk_import.d.ts +53 -0
  47. package/dist/types/bulk_import.js +6 -0
  48. package/dist/types/data_types.d.ts +116 -0
  49. package/dist/types/data_types.js +122 -0
  50. package/dist/types/enums.d.ts +59 -0
  51. package/dist/types/enums.js +67 -0
  52. package/dist/types/graph_models.d.ts +54 -0
  53. package/dist/types/graph_models.js +6 -0
  54. package/dist/types/index.d.ts +11 -5
  55. package/dist/types/index.js +36 -37
  56. package/dist/types/metadata.d.ts +60 -0
  57. package/dist/types/metadata.js +6 -0
  58. package/dist/types/schema.d.ts +31 -0
  59. package/dist/types/schema.js +6 -0
  60. package/dist/types/typed_value.d.ts +25 -0
  61. package/dist/types/typed_value.js +1176 -0
  62. package/dist/types/wrappers.d.ts +23 -0
  63. package/dist/types/wrappers.js +39 -0
  64. package/dist/types.d.ts +7 -0
  65. package/dist/types.js +24 -0
  66. package/package.json +40 -53
  67. package/dist/connection/connection.final.d.ts +0 -14
  68. package/dist/connection/connection.final.js +0 -96
  69. package/dist/connection/connection.final.js.map +0 -1
  70. package/dist/connection/connection.pool.d.ts +0 -21
  71. package/dist/connection/connection.pool.js +0 -103
  72. package/dist/connection/connection.pool.js.map +0 -1
  73. package/dist/connection/extra/base.extra.d.ts +0 -18
  74. package/dist/connection/extra/base.extra.js +0 -111
  75. package/dist/connection/extra/base.extra.js.map +0 -1
  76. package/dist/connection/extra/batch.insert.extra.d.ts +0 -58
  77. package/dist/connection/extra/batch.insert.extra.js +0 -353
  78. package/dist/connection/extra/batch.insert.extra.js.map +0 -1
  79. package/dist/connection/extra/connection.base.d.ts +0 -112
  80. package/dist/connection/extra/connection.base.js +0 -528
  81. package/dist/connection/extra/connection.base.js.map +0 -1
  82. package/dist/connection/extra/connection.d.ts +0 -17
  83. package/dist/connection/extra/connection.js +0 -44
  84. package/dist/connection/extra/connection.js.map +0 -1
  85. package/dist/connection/extra/graph.extra.d.ts +0 -54
  86. package/dist/connection/extra/graph.extra.js +0 -151
  87. package/dist/connection/extra/graph.extra.js.map +0 -1
  88. package/dist/connection/extra/hdc.extra.d.ts +0 -89
  89. package/dist/connection/extra/hdc.extra.js +0 -322
  90. package/dist/connection/extra/hdc.extra.js.map +0 -1
  91. package/dist/connection/extra/index.extra.d.ts +0 -102
  92. package/dist/connection/extra/index.extra.js +0 -210
  93. package/dist/connection/extra/index.extra.js.map +0 -1
  94. package/dist/connection/extra/job.extra.d.ts +0 -32
  95. package/dist/connection/extra/job.extra.js +0 -122
  96. package/dist/connection/extra/job.extra.js.map +0 -1
  97. package/dist/connection/extra/policy.extra.d.ts +0 -32
  98. package/dist/connection/extra/policy.extra.js +0 -114
  99. package/dist/connection/extra/policy.extra.js.map +0 -1
  100. package/dist/connection/extra/privilege.extra.d.ts +0 -8
  101. package/dist/connection/extra/privilege.extra.js +0 -20
  102. package/dist/connection/extra/privilege.extra.js.map +0 -1
  103. package/dist/connection/extra/property.extra.d.ts +0 -66
  104. package/dist/connection/extra/property.extra.js +0 -190
  105. package/dist/connection/extra/property.extra.js.map +0 -1
  106. package/dist/connection/extra/schema.extra.d.ts +0 -108
  107. package/dist/connection/extra/schema.extra.js +0 -253
  108. package/dist/connection/extra/schema.extra.js.map +0 -1
  109. package/dist/connection/extra/user.extra.d.ts +0 -28
  110. package/dist/connection/extra/user.extra.js +0 -91
  111. package/dist/connection/extra/user.extra.js.map +0 -1
  112. package/dist/connection/index.d.ts +0 -5
  113. package/dist/connection/index.js +0 -13
  114. package/dist/connection/index.js.map +0 -1
  115. package/dist/connection/network.manager.d.ts +0 -28
  116. package/dist/connection/network.manager.js +0 -179
  117. package/dist/connection/network.manager.js.map +0 -1
  118. package/dist/index.js.map +0 -1
  119. package/dist/printers/alias.d.ts +0 -2
  120. package/dist/printers/alias.js +0 -39
  121. package/dist/printers/alias.js.map +0 -1
  122. package/dist/printers/any.d.ts +0 -2
  123. package/dist/printers/any.js +0 -63
  124. package/dist/printers/any.js.map +0 -1
  125. package/dist/printers/array.aio.d.ts +0 -3
  126. package/dist/printers/array.aio.js +0 -259
  127. package/dist/printers/array.aio.js.map +0 -1
  128. package/dist/printers/edge.d.ts +0 -5
  129. package/dist/printers/edge.js +0 -78
  130. package/dist/printers/edge.js.map +0 -1
  131. package/dist/printers/explain.plan.d.ts +0 -2
  132. package/dist/printers/explain.plan.js +0 -46
  133. package/dist/printers/explain.plan.js.map +0 -1
  134. package/dist/printers/index.d.ts +0 -24
  135. package/dist/printers/index.js +0 -43
  136. package/dist/printers/index.js.map +0 -1
  137. package/dist/printers/node.d.ts +0 -5
  138. package/dist/printers/node.js +0 -77
  139. package/dist/printers/node.js.map +0 -1
  140. package/dist/printers/path.d.ts +0 -3
  141. package/dist/printers/path.js +0 -62
  142. package/dist/printers/path.js.map +0 -1
  143. package/dist/printers/status.d.ts +0 -3
  144. package/dist/printers/status.js +0 -68
  145. package/dist/printers/status.js.map +0 -1
  146. package/dist/printers/table.d.ts +0 -2
  147. package/dist/printers/table.js +0 -56
  148. package/dist/printers/table.js.map +0 -1
  149. package/dist/proto/tmp.js +0 -366
  150. package/dist/proto/ultipa_grpc_pb.d.ts +0 -258
  151. package/dist/proto/ultipa_grpc_pb.js +0 -366
  152. package/dist/proto/ultipa_grpc_pb.js.map +0 -1
  153. package/dist/proto/ultipa_pb.d.ts +0 -1
  154. package/dist/proto/ultipa_pb.js +0 -11002
  155. package/dist/proto/ultipa_pb.js.map +0 -1
  156. package/dist/types/index.js.map +0 -1
  157. package/dist/types/types.algos.params.d.ts +0 -545
  158. package/dist/types/types.algos.params.js +0 -16
  159. package/dist/types/types.algos.params.js.map +0 -1
  160. package/dist/types/types.d.ts +0 -1204
  161. package/dist/types/types.extra.d.ts +0 -146
  162. package/dist/types/types.extra.js +0 -27
  163. package/dist/types/types.extra.js.map +0 -1
  164. package/dist/types/types.js +0 -1596
  165. package/dist/types/types.js.map +0 -1
  166. package/dist/types/util.d.ts +0 -15
  167. package/dist/types/util.js +0 -136
  168. package/dist/types/util.js.map +0 -1
  169. package/dist/utils/common.d.ts +0 -3
  170. package/dist/utils/common.js +0 -22
  171. package/dist/utils/common.js.map +0 -1
  172. package/dist/utils/format.d.ts +0 -45
  173. package/dist/utils/format.js +0 -877
  174. package/dist/utils/format.js.map +0 -1
  175. package/dist/utils/index.d.ts +0 -10
  176. package/dist/utils/index.js +0 -30
  177. package/dist/utils/index.js.map +0 -1
  178. package/dist/utils/property.d.ts +0 -18
  179. package/dist/utils/property.js +0 -153
  180. package/dist/utils/property.js.map +0 -1
  181. package/dist/utils/serialize/commont.d.ts +0 -12
  182. package/dist/utils/serialize/commont.js +0 -46
  183. package/dist/utils/serialize/commont.js.map +0 -1
  184. package/dist/utils/serialize/deserialize.d.ts +0 -9
  185. package/dist/utils/serialize/deserialize.js +0 -166
  186. package/dist/utils/serialize/deserialize.js.map +0 -1
  187. package/dist/utils/serialize/null.d.ts +0 -25
  188. package/dist/utils/serialize/null.js +0 -136
  189. package/dist/utils/serialize/null.js.map +0 -1
  190. package/dist/utils/serialize/serialize.d.ts +0 -10
  191. package/dist/utils/serialize/serialize.js +0 -144
  192. package/dist/utils/serialize/serialize.js.map +0 -1
  193. package/dist/utils/stream.helper.d.ts +0 -10
  194. package/dist/utils/stream.helper.js +0 -71
  195. package/dist/utils/stream.helper.js.map +0 -1
  196. package/dist/utils/time.record.d.ts +0 -15
  197. package/dist/utils/time.record.js +0 -52
  198. package/dist/utils/time.record.js.map +0 -1
  199. package/dist/utils/ultipa.datetime.d.ts +0 -14
  200. package/dist/utils/ultipa.datetime.js +0 -160
  201. package/dist/utils/ultipa.datetime.js.map +0 -1
  202. package/dist/utils/uql-maker.d.ts +0 -165
  203. package/dist/utils/uql-maker.js +0 -402
  204. package/dist/utils/uql-maker.js.map +0 -1
  205. package/dist/utils/uql.parse.d.ts +0 -27
  206. package/dist/utils/uql.parse.js +0 -205
  207. package/dist/utils/uql.parse.js.map +0 -1
  208. package/readme.md +0 -65
  209. package/src/proto/build.sh +0 -41
  210. package/src/proto/build_windows.sh +0 -40
  211. package/src/proto/ultipa.proto +0 -492
  212. package/src/proto/ultipa_grpc_pb.d.ts +0 -92
  213. package/src/proto/ultipa_grpc_pb.js +0 -414
  214. package/src/proto/ultipa_pb.d.ts +0 -1806
  215. package/src/proto/ultipa_pb.js +0 -13499
@@ -1,1204 +0,0 @@
1
- /**
2
- * Ultipa Configuration is the basic configuration that used for establishing the connections.
3
- */
4
- export declare class UltipaConfig {
5
- /**
6
- * List of host addresses (IPs or URLs)
7
- * - Supports IPv4 and IPv6 addresses
8
- * - Supports URLs (if prefixed with https://, uses secure connection)
9
- * - Required
10
- */
11
- hosts: string[];
12
- /** Username for authentication (Required) */
13
- username: string;
14
- /** Password for authentication (Required) */
15
- password: string;
16
- /** Default graph to interact with (Optional) */
17
- defaultGraph?: string;
18
- /** Path string to CRT file, used for SSL connections. */
19
- crt?: string;
20
- /**
21
- * Password encryption method
22
- * @default "MD5"
23
- */
24
- passwordEncrypt?: "MD5" | "LDAP" | "NOTHING";
25
- /**
26
- * Request timeout in seconds
27
- * @default 2147483647
28
- */
29
- timeout?: number;
30
- /**
31
- * Heartbeat interval in milliseconds
32
- * Set to 0 to disable heartbeat
33
- * Used for keeping connection alive
34
- * @default 0
35
- */
36
- heartbeat?: number;
37
- /**
38
- * Maximum receive size in megabytes
39
- * @default 32
40
- */
41
- maxRecvSize?: number;
42
- }
43
- /**
44
- * Configuration for each request, can be null
45
- */
46
- export declare class RequestConfig {
47
- /**
48
- * specify graphName, if null will use defaultGraph of UltipaConfiguration
49
- */
50
- graph?: string;
51
- /**
52
- * Operation timeout in seconds
53
- */
54
- timeout?: number;
55
- /**
56
- * Specify the host to execute the request
57
- * */
58
- host?: string;
59
- /**
60
- * request,thread num
61
- */
62
- thread?: number;
63
- /**
64
- * name of time zone,
65
- * default: current time zone.
66
- * e.g. Aisa/Shanghai
67
- */
68
- timezone?: string;
69
- /**
70
- * hour elapse from UTC
71
- * When both `timezone` and `timezoneOffset` are provided, `timezoneOffset` takes precedence.
72
- * Unit: hour. Example:” +08:30”,”-05:00”,“+2”,“-0300”
73
- */
74
- timezoneOffset?: string;
75
- /**
76
- * If true the queryText will be logged.
77
- */
78
- logQueryText?: boolean;
79
- /**
80
- * If true the request info will be logged.
81
- */
82
- withRequestInfo?: boolean;
83
- }
84
- /**
85
- * configuration for insert request. extends RequestConfig,have all RequestConfig property
86
- */
87
- export declare class InsertRequestConfig extends RequestConfig {
88
- /**
89
- * NORMAL,
90
- * OVERWRITE,
91
- * UPSERT
92
- */
93
- insertType: InsertType;
94
- /**
95
- * Return data or not when insert/delete batch. true - not return data, false - return data.
96
- */
97
- silent: boolean;
98
- }
99
- /**
100
- * The insert error code from server.
101
- */
102
- export declare enum InsertErrorCode {
103
- ID_NOT_MATCH_UUID = 10001,
104
- ID_UUID_NOT_MATCH_SCHEMA = 10002,
105
- FROM_ID_NOT_EXISTED = 10003,
106
- TO_ID_NOT_EXISTED = 10004,
107
- ID_LEN = 10005,
108
- NOT_NULL = 10006,
109
- UNIQUCHECK = 10007,
110
- ID_EMPTY = 10008,
111
- FROM_ID_EMPTY = 10009,
112
- TO_ID_EMPTY = 10010,
113
- DUPLICATE_ID = 10011,
114
- KEY_CONSTRAINT_VIOLATED = 10012,
115
- OK_BUT_ID_EXISTED = 11001,
116
- OTHERS = 19999
117
- }
118
- export declare const InsertErrorMessages: {
119
- 10001: string;
120
- 10002: string;
121
- 10003: string;
122
- 10004: string;
123
- 10005: string;
124
- 10006: string;
125
- 10007: string;
126
- 10008: string;
127
- 10009: string;
128
- 10010: string;
129
- 10011: string;
130
- 10012: string;
131
- 11001: string;
132
- 19999: string;
133
- };
134
- export declare function getInsertErrorMessage(errorCode: InsertErrorCode | number): string;
135
- /**
136
- * TODO: delete Ttimezone
137
- */
138
- export interface Ttimezone {
139
- timezone?: string;
140
- timezoneOffset?: string;
141
- timestampToString?: boolean;
142
- }
143
- /**
144
- * The schema property type.When create property.Need set property type.
145
- */
146
- export declare enum UltipaPropertyType {
147
- /**
148
- * Ultipa schema id type
149
- */
150
- ID = -1,
151
- /**
152
- * Ultipa schema uuid type
153
- */
154
- UUID = -2,
155
- /**
156
- * Ultipa edge schema from_id type
157
- */
158
- FROM = -3,
159
- /**
160
- * Ultipa edge schema to_id type
161
- */
162
- TO = -4,
163
- /**
164
- * Ultipa edge schema from_uuid type
165
- */
166
- FROM_UUID = -5,
167
- /**
168
- * Ultipa edge schema to_uuid type
169
- */
170
- TO_UUID = -6,
171
- /**
172
- * Ignore
173
- */
174
- IGNORE = -7,
175
- /**
176
- * No type set
177
- */
178
- UNSET = 0,
179
- /**
180
- * Signed 32 integer
181
- */
182
- INT32 = 1,
183
- /**
184
- * Unsigned 32 integer
185
- */
186
- UINT32 = 2,
187
- /**
188
- * Signed 64 integer
189
- */
190
- INT64 = 3,
191
- /**
192
- * Unsigned 64 integer
193
- */
194
- UINT64 = 4,
195
- /**
196
- * Single floating-point number
197
- */
198
- FLOAT = 5,
199
- /**
200
- * Double-precision floating-point numbers
201
- */
202
- DOUBLE = 6,
203
- /**
204
- * A data type that represents a sequence of characters
205
- */
206
- STRING = 7,
207
- /**
208
- * Represents a combination of a date and a time
209
- */
210
- DATETIME = 8,
211
- /**
212
- * A data type that typically represents a specific point in time, often with a high level of precision
213
- */
214
- TIMESTAMP = 9,
215
- /**
216
- * Used to store large amounts of text data
217
- */
218
- TEXT = 10,
219
- /**
220
- * Stands for Binary Large Object
221
- */
222
- BLOB = 11,
223
- /**
224
- * In the context of databases dealing with spatial data (e.g., in GIS systems)
225
- */
226
- POINT = 12,
227
- /**
228
- * Represents a fixed-point number with a specified precision and scale
229
- */
230
- DECIMAL = 13,
231
- /**
232
- * A data structure that can hold a collection of elements
233
- */
234
- LIST = 14,
235
- /**
236
- * A data structure that stores a collection of unique elements
237
- */
238
- SET = 15,
239
- /**
240
- * A data structure that stores key-value pairs
241
- */
242
- MAP = 16,
243
- /**
244
- * Null type
245
- */
246
- NULL = 17,
247
- /**
248
- * Stands for Boolean
249
- */
250
- BOOL = 18
251
- }
252
- /**
253
- * The insertion mode.
254
- */
255
- export declare enum InsertType {
256
- /**
257
- * Insert new data
258
- */
259
- NORMAL = 0,
260
- /**
261
- * The insert overwrite operation first clears the existing data in the target location and then inserts new data
262
- */
263
- OVERWRITE = 1,
264
- /**
265
- * If the data record to be inserted already exists in the target location the record will be updated; if it does not exist, a new record will be inserted
266
- */
267
- UPSERT = 2
268
- }
269
- /**
270
- * Algorithm Detail Response Data
271
- */
272
- export declare class Algo {
273
- /**
274
- * name
275
- */
276
- name?: string;
277
- /**
278
- * type
279
- */
280
- type?: string;
281
- /**
282
- * write support type
283
- */
284
- writeSupportType?: string;
285
- /**
286
- * Whether the algorithm can be rolled back to previous version.
287
- */
288
- canRollback?: string;
289
- /**
290
- * config context
291
- */
292
- configContext?: string;
293
- /**
294
- * version
295
- */
296
- version?: string;
297
- /**
298
- * algo params
299
- */
300
- params?: AlgoParam[];
301
- /**
302
- * algo description
303
- */
304
- description?: string;
305
- }
306
- export interface AlgoParam {
307
- name: string;
308
- desc?: string;
309
- }
310
- /**
311
- * TODO delete Code
312
- */
313
- export declare enum ErrorCode {
314
- SUCCESS,
315
- FAILED,
316
- PARAM_ERROR,
317
- BASE_DB_ERROR,
318
- ENGINE_ERROR,
319
- SYSTEM_ERROR,
320
- SYNTAX_ERROR,
321
- PERMISSION_DENIED,
322
- DUPLICATE_ID,
323
- RAFT_REDIRECT,
324
- RAFT_LEADER_NOT_YET_ELECTED,
325
- RAFT_LOG_ERROR,
326
- NOT_RAFT_MODE,
327
- RAFT_NO_AVAILABLE_FOLLOWERS,
328
- RAFT_NO_AVAILABLE_ALGO_SERVERS,
329
- UNKNOWN_ERROR = 1000
330
- }
331
- export declare enum ResultType {
332
- RESULT_TYPE_UNSET,
333
- RESULT_TYPE_PATH,
334
- RESULT_TYPE_NODE,
335
- RESULT_TYPE_EDGE,
336
- RESULT_TYPE_ATTR,
337
- RESULT_TYPE_TABLE
338
- }
339
- export declare enum AuthenticateType {
340
- PERMISSION_TYPE_UNSET,
341
- PERMISSION_TYPE_UQL,
342
- PERMISSION_TYPE_GQL,
343
- PERMISSION_TYPE_INSERTNODES,
344
- PERMISSION_TYPE_INSERTEDGES,
345
- PERMISSION_TYPE_EXPORT,
346
- PERMISSION_TYPE_DOWNLOADFILE,
347
- PERMISSION_TYPE_INSTALLALGO,
348
- PERMISSION_TYPE_UNINSTALLALGO,
349
- PERMISSION_TYPE_ROLLBACKALGO
350
- }
351
- /**
352
- * privilege level type
353
- */
354
- export declare enum PrivilegeLevel {
355
- /**
356
- * Graph privilege type
357
- */
358
- GraphLevel = 0,
359
- /**
360
- * System privilege type
361
- */
362
- SystemLevel = 1
363
- }
364
- /**
365
- * HDC synchronization type.
366
- */
367
- export declare enum HDCSyncType {
368
- /**
369
- * Static synchronization
370
- */
371
- STATIC = "static",
372
- /**
373
- * Asynchronous synchronization
374
- */
375
- ASYNC = "async",
376
- /**
377
- * Synchronous synchronization
378
- */
379
- SYNC = "sync"
380
- }
381
- /** Query type contains UQL,GQL */
382
- export declare enum QueryType {
383
- QL_UNSET = 0,
384
- UQL = 1,
385
- GQL = 2
386
- }
387
- /**
388
- * The schema type in database.
389
- */
390
- export declare enum DBType {
391
- /**
392
- * Node
393
- */
394
- DBNODE,
395
- /**
396
- * Edge
397
- */
398
- DBEDGE
399
- }
400
- /**
401
- * Job status
402
- */
403
- export declare enum JOB_STATUS {
404
- JOB_PENDING,
405
- JOB_COMPUTING,
406
- JOB_WRITING,
407
- JOB_DONE,
408
- JOB_FAILED,
409
- JOB_STOPPED
410
- }
411
- /**
412
- * Property index
413
- */
414
- export declare class Index {
415
- id?: string;
416
- /**
417
- * Index name
418
- */
419
- name: string;
420
- /**
421
- * Index on which properties
422
- */
423
- properties: string;
424
- /**
425
- * Index on which scehma
426
- */
427
- schema: string;
428
- /**
429
- * Index status
430
- */
431
- status: string;
432
- /**
433
- * Index size
434
- */
435
- size?: string;
436
- /**
437
- * Node index or edge index
438
- */
439
- dbType?: DBType;
440
- }
441
- /**
442
- * User
443
- */
444
- export declare class User {
445
- /**
446
- * username
447
- */
448
- username?: string;
449
- /**
450
- * pasword
451
- */
452
- password?: string;
453
- /**
454
- * create time
455
- */
456
- createdTime?: Date;
457
- /**
458
- * System privileges list
459
- */
460
- systemPrivileges?: string[];
461
- /**
462
- * Graph privileges key value map
463
- */
464
- graphPrivileges?: Map<string, string[]>;
465
- /**
466
- * Property privileges
467
- */
468
- propertyPrivileges?: PropertyPrivilege;
469
- /**
470
- * Policy list
471
- */
472
- policies?: string[];
473
- }
474
- export interface PropertyPrivilege {
475
- node?: PropertyPrivilegeElement;
476
- edge?: PropertyPrivilegeElement;
477
- }
478
- export interface PropertyPrivilegeElement {
479
- read?: string[][];
480
- write?: string[][];
481
- deny?: string[][];
482
- }
483
- /**
484
- * A policy is a set of privileges designed for a specific user role, often encompassing multiple privileges and other policies. Effective policy design and usage enable role-based access control.
485
- */
486
- export declare class Policy {
487
- /** Policy name */
488
- name?: string;
489
- /** Atlas permissions included in the policy */
490
- systemPrivileges?: string[];
491
- /** System permissions included in the policy */
492
- graphPrivileges?: Map<string, string[]>;
493
- /** Permissions for properties included in the policy */
494
- propertyPrivileges?: PropertyPrivilege;
495
- /** Other strategies included in the policy */
496
- policies?: string[];
497
- }
498
- /**
499
- * Control user permissions to operate on the graph database
500
- */
501
- export declare class Privilege {
502
- /**
503
- * privilege name
504
- */
505
- name?: string;
506
- /**
507
- * privilege type
508
- */
509
- level?: PrivilegeLevel;
510
- }
511
- /**
512
- * 连接返回的统一状态
513
- */
514
- export type Status = {
515
- code: ErrorCode;
516
- message: string;
517
- };
518
- /**
519
- * The background job INFO from database.
520
- */
521
- export declare class Job {
522
- /**
523
- * job id
524
- */
525
- id?: string;
526
- /**
527
- * job run in graph name
528
- */
529
- graphName?: string;
530
- /**
531
- * job query
532
- */
533
- query?: string;
534
- /**
535
- * Job types, such as CREATE_INDEX, CACHE, COMPACT
536
- */
537
- type?: string;
538
- /**
539
- * Error messages encountered during job execution (if any)
540
- */
541
- errMsg?: string;
542
- /**
543
- * The results generated by assignments, such as output files or statistical overviews of algorithms.
544
- */
545
- result?: Map<any, any>;
546
- /**
547
- * job start time
548
- */
549
- startTime?: string;
550
- /**
551
- * job end time
552
- */
553
- endTime?: string;
554
- /**
555
- * Current state of the job, which can be FINISHED, RUNNING, STOPPING, STOPPED or FAILED.
556
- */
557
- status?: "FINISHED" | "RUNNING" | "STOPPING" | "STOPPED" | "FAILED";
558
- /**
559
- * Progress updates for the job, such as indications that the write operation has been started.
560
- */
561
- progress?: string;
562
- }
563
- /**
564
- * The response items of top()
565
- */
566
- export declare class Process {
567
- /**
568
- * process id
569
- */
570
- processId?: string;
571
- /**
572
- * process query
573
- */
574
- processQuery?: string;
575
- /**
576
- * duration
577
- */
578
- duration?: string;
579
- /**
580
- * status
581
- */
582
- status?: string;
583
- }
584
- /**
585
- * hdc.graph.show()
586
- */
587
- export declare class HDCGraph {
588
- /**
589
- * name
590
- */
591
- name?: string;
592
- /**
593
- * graph name
594
- */
595
- graphName?: string;
596
- /**
597
- * status
598
- */
599
- status?: string;
600
- /**
601
- * stats
602
- */
603
- stats?: string;
604
- /**
605
- * is default
606
- */
607
- isDefault?: string;
608
- /**
609
- * hdc server name
610
- */
611
- hdcServerName?: string;
612
- /**
613
- * hdc server status
614
- */
615
- hdcServerStatus?: string;
616
- /**
617
- * hdc config name
618
- */
619
- config?: string;
620
- }
621
- /**
622
- * projection
623
- */
624
- export declare class Projection {
625
- /**
626
- * name
627
- */
628
- name?: string;
629
- /**
630
- * graph name
631
- */
632
- graphName?: string;
633
- /**
634
- * status
635
- */
636
- status?: string;
637
- /**
638
- * stats
639
- */
640
- stats?: string;
641
- /**
642
- * config
643
- */
644
- config?: string;
645
- }
646
- /**
647
- * Statistics information about license and usage limits
648
- */
649
- export interface Stats {
650
- /**
651
- * License uuid
652
- */
653
- licenseUuid?: string;
654
- /**
655
- * Company name
656
- */
657
- company?: string;
658
- /**
659
- * Department name
660
- */
661
- department?: string;
662
- /**
663
- * Maximum number of users allowed
664
- */
665
- limitedUser?: string;
666
- /**
667
- * Maximum number of graphs allowed
668
- */
669
- limitedGraph?: string;
670
- /**
671
- * Maximum number of nodes allowed
672
- */
673
- limitedNode?: string;
674
- /**
675
- * Maximum number of edges allowed
676
- */
677
- limitedEdge?: string;
678
- /**
679
- * Maximum number of shards allowed
680
- */
681
- limitedShard?: string;
682
- /**
683
- * Maximum number of HDC connections allowed
684
- */
685
- limitedHdc?: string;
686
- /**
687
- * License expiration date
688
- */
689
- expiredDate?: string;
690
- }
691
- /**
692
- * The graph data about nodes.
693
- */
694
- export declare class Node {
695
- /**
696
- * _uuid
697
- */
698
- uuid?: string;
699
- /**
700
- * _id
701
- */
702
- id?: string;
703
- /**
704
- * schema
705
- */
706
- schema?: string;
707
- /**
708
- * key: value
709
- */
710
- values?: {
711
- [key: string]: any;
712
- };
713
- /**
714
- * returns property value
715
- * @param propName property name
716
- * @returns property value
717
- */
718
- get?(propName: string): any;
719
- /**
720
- * sets property value
721
- * @param propName
722
- * @param value
723
- */
724
- set?(propName: string, value: any): void;
725
- }
726
- /**
727
- * Stores edge data.
728
- */
729
- export declare class Edge {
730
- /**
731
- * _uuid
732
- */
733
- uuid?: string;
734
- /**
735
- * _from_uuid
736
- */
737
- fromUuid?: string;
738
- /**
739
- * _to_uuid
740
- */
741
- toUuid?: string;
742
- /**
743
- * _from: from id
744
- */
745
- from?: string;
746
- /**
747
- * _to: to id
748
- */
749
- to?: string;
750
- /**
751
- * schema
752
- */
753
- schema?: string;
754
- /**
755
- * key: value
756
- */
757
- values?: {
758
- [key: string]: any;
759
- };
760
- /**
761
- * returns property value
762
- * @param propName property name
763
- * @returns property value
764
- */
765
- get?(propName: string): any;
766
- /**
767
- * set property value
768
- * @param propName
769
- * @param value
770
- */
771
- set?(propName: string, value: any): void;
772
- }
773
- /**
774
- * 一组边
775
- */
776
- export type EdgeAlias = {
777
- edges: Edge[];
778
- alias: string;
779
- };
780
- /**
781
- * Path entity
782
- */
783
- export declare class Path {
784
- /**
785
- * Node uuid list
786
- */
787
- nodeUuids?: string[];
788
- /**
789
- * Edge uuid list
790
- */
791
- edgeUuids?: string[];
792
- /**
793
- * nodes details
794
- */
795
- nodes?: Map<string, Node>;
796
- /**
797
- * edges details
798
- */
799
- edges?: Map<string, Edge>;
800
- /**
801
- * return node by index
802
- * @param index node index
803
- * @returns node
804
- /**
805
- * return edge length
806
- * @returns edge length
807
- */
808
- length?(): number;
809
- }
810
- /**
811
- * Graph that contains nodes, edges maps and paths.
812
- */
813
- export declare class Graph {
814
- /**
815
- * Graph path list
816
- */
817
- paths?: Path[];
818
- /**
819
- * Graph all nodes
820
- */
821
- nodes?: Map<string, Node>;
822
- /**
823
- * Graph all edges
824
- */
825
- edges?: Map<string, Edge>;
826
- /**
827
- * Convert path list to
828
- * @returns Path[]
829
- */
830
- getPaths(): Path[];
831
- /**
832
- * Add node to nodes
833
- * @param node new Node
834
- */
835
- addNode(node: Node): void;
836
- /**
837
- * Add edge to graph
838
- * @param edge new Edge
839
- */
840
- addEdge(edge: Edge): void;
841
- }
842
- /**
843
- * GraphSet that contains the graph name and total nodes and edges.
844
- */
845
- export declare class GraphSet {
846
- /**
847
- * graph id
848
- */
849
- id?: string;
850
- /**
851
- * graph name
852
- */
853
- name: string;
854
- /**
855
- * number of nodes
856
- */
857
- totalNodes?: string;
858
- /**
859
- * number of edges
860
- */
861
- totalEdges?: string;
862
- /**
863
- * graph shards list
864
- */
865
- shards?: string[];
866
- /**
867
- * the partition type of graph
868
- */
869
- partitionBy?: string;
870
- /**
871
- * status
872
- */
873
- status?: string;
874
- /**
875
- * graph description
876
- */
877
- description?: string | null;
878
- /**
879
- * the number of slots
880
- */
881
- slotNum?: number | 0;
882
- }
883
- /**
884
- * Node or edge schemas
885
- */
886
- export declare class Schema {
887
- /**
888
- * schema name
889
- */
890
- name: string;
891
- /**
892
- * schema description
893
- */
894
- description?: string;
895
- /**
896
- * properties of schema
897
- */
898
- properties?: Property[];
899
- /**
900
- * schema type
901
- */
902
- dbType: DBType;
903
- /**
904
- * node or edge count
905
- */
906
- total?: string;
907
- /**
908
- * schema id
909
- */
910
- id?: string;
911
- /**
912
- * store the count for each pair of start and end node schemas of current edge schema.
913
- */
914
- stats?: SchemaStat[];
915
- /**
916
- * Convert list of schemas to a map of schema Schema name -> Schema
917
- * @param schemas
918
- * @returns
919
- */
920
- static toDict?(schemas: Schema[]): Map<string, Schema>;
921
- }
922
- /**
923
- * Statistics for node schema pairs in edge schema
924
- */
925
- export declare class SchemaStat {
926
- /**
927
- * Schema type
928
- */
929
- dbType?: DBType;
930
- /**
931
- * Schema name
932
- */
933
- schema?: string;
934
- /**
935
- * From Schema name
936
- */
937
- fromSchema: string;
938
- /**
939
- * To Schema name
940
- */
941
- toSchema: string;
942
- /**
943
- * Number of edges between these node schemas
944
- */
945
- count: string;
946
- }
947
- export declare class SchemaStats {
948
- stats: SchemaStat[];
949
- }
950
- /**
951
- * The properties of schema
952
- */
953
- export declare class Property {
954
- /**
955
- * Property name
956
- */
957
- name: string;
958
- /**
959
- * PropertyType Enum
960
- */
961
- type: UltipaPropertyType;
962
- /**
963
- * Sub PropertyType Enum
964
- */
965
- subType?: UltipaPropertyType[];
966
- /**
967
- * This property is lte
968
- */
969
- lte?: boolean;
970
- /**
971
- * Whether it has read permission or not true-yes,false-no
972
- */
973
- read?: boolean;
974
- /**
975
- * Whether it has write permission or not true-yes,false-no
976
- */
977
- write?: boolean;
978
- /**
979
- * Property`s schema name
980
- */
981
- schema: string;
982
- /**
983
- * Property`s description
984
- */
985
- description?: string;
986
- /**
987
- * encrypt method for this property, if null, value is not encrypted
988
- */
989
- encrypt?: string;
990
- /**
991
- * additional info for this property. For decimal property, it represents the length and precision in parentheses, default is "(20,8)"
992
- */
993
- decimalExtra?: DecimalExtral;
994
- }
995
- /**
996
- * Decimal additional info
997
- */
998
- export interface DecimalExtral {
999
- precision: number;
1000
- scale: number;
1001
- }
1002
- export interface AllProperties {
1003
- nodeProperties: Property[];
1004
- edgeProperties: Property[];
1005
- }
1006
- export declare class Header {
1007
- propertyName: string;
1008
- propertyType: UltipaPropertyType;
1009
- }
1010
- /**
1011
- * Table
1012
- */
1013
- export declare class Table {
1014
- /**
1015
- * Table name
1016
- */
1017
- name?: string;
1018
- /**
1019
- * Table headers
1020
- */
1021
- headers?: Header[];
1022
- /**
1023
- * Table rows
1024
- */
1025
- rows?: any[][];
1026
- /**
1027
- * Convert table to list of KV
1028
- * @returns
1029
- */
1030
- toKV(): any[];
1031
- getHeaders(): Header[];
1032
- getRows(): any[][];
1033
- }
1034
- export type Replica = {
1035
- addr: string;
1036
- status: string;
1037
- streamAddr: string;
1038
- lastHearBeat: string;
1039
- };
1040
- export type Statistics = {
1041
- nodeAffected?: number;
1042
- edgeAffected?: number;
1043
- totalCost: number;
1044
- engineCost: number;
1045
- };
1046
- /**
1047
- * Attribute Response Data
1048
- */
1049
- export declare class Attr {
1050
- /**
1051
- * Ultipa property type
1052
- */
1053
- propertyType?: UltipaPropertyType;
1054
- /**
1055
- * Ultipa result type
1056
- */
1057
- resultType?: ResultType;
1058
- /**
1059
- * Attr values
1060
- */
1061
- values?: object[];
1062
- /**
1063
- * Attr name
1064
- */
1065
- name?: string;
1066
- }
1067
- export type AttrListData = {
1068
- type: ResultType;
1069
- type_desc: string;
1070
- nodes?: Node[];
1071
- edges?: Edge[];
1072
- paths?: Path[];
1073
- attrs?: Attr[];
1074
- };
1075
- export declare class ExplainPlan {
1076
- planNodes: PlanNode[];
1077
- }
1078
- export declare class PlanNode {
1079
- alias: string;
1080
- childrenNum: number;
1081
- uql: string;
1082
- infos: string;
1083
- }
1084
- export declare function getExplainPlansTreeTopNode(plans: ExplainPlan): PlanNode;
1085
- /**
1086
- * The get () method or alias () method of the Response class returns a DataItem embedded in the query result. You need to use the as < Type > () method of the DataItem to convert the result to the appropriate driver type.
1087
- */
1088
- export declare class DataItem {
1089
- /**
1090
- * Alias name
1091
- */
1092
- alias?: string;
1093
- /**
1094
- * Ultipa result type
1095
- */
1096
- type?: ResultType;
1097
- /**
1098
- * result entity
1099
- */
1100
- entities?: any;
1101
- constructor(alias: string, type: ResultType, entities: any);
1102
- private _asTypeError;
1103
- asNodes(): Node[];
1104
- asFirstNode(): Node;
1105
- asEdges(): Edge[];
1106
- asFirstEdge(): Edge;
1107
- asPaths(): Path[];
1108
- asGraph(): Graph;
1109
- asTable(): Table;
1110
- asAttr(): Attr;
1111
- asGraphSets(): GraphSet[];
1112
- asProperties(): Property[];
1113
- asSchemas(): Schema[];
1114
- asIndexes(): Index[];
1115
- asPolicies(): Policy[];
1116
- asUsers(): User[];
1117
- asPrivileges(): Privilege[];
1118
- asProcesses(): Process[];
1119
- asHDCGraphs(): HDCGraph[];
1120
- asProjections(): Projection[];
1121
- asAlgos(): Algo[];
1122
- asJobs(): Job[];
1123
- asAny(): any;
1124
- asTableWithT<T>(): T[];
1125
- toJSONString(): string;
1126
- }
1127
- /**
1128
- * Unified response structure for all requests
1129
- */
1130
- export declare class Response {
1131
- /**
1132
- * Holds statistics field of rpc response
1133
- */
1134
- statistics?: Statistics;
1135
- /**
1136
- * Holds status field of rpc response
1137
- */
1138
- status?: Status;
1139
- /**
1140
- * Holds all alias result of grpc api
1141
- */
1142
- aliases?: Alias[];
1143
- /**
1144
- * Holds all result of grpc api, from aliases
1145
- */
1146
- items: {
1147
- [key: string]: DataItem;
1148
- };
1149
- requestInfo?: any;
1150
- /**
1151
- * Holds result of explain uql.
1152
- */
1153
- explainPlan?: ExplainPlan;
1154
- constructor(status?: Status);
1155
- get(index: number): DataItem;
1156
- alias(alias: string): DataItem;
1157
- }
1158
- export declare class InsertResponse {
1159
- ids?: string[];
1160
- uuids?: string[];
1161
- errorItems?: Map<number, InsertErrorCode>;
1162
- /**
1163
- * Holds statistics field of rpc response
1164
- */
1165
- statistics?: Statistics;
1166
- /**
1167
- * Holds status field of rpc response
1168
- */
1169
- status?: Status;
1170
- }
1171
- /**
1172
- * Remarks: A language that cannot return two results, use this to return results
1173
- */
1174
- export declare class ResponseWithExistCheck {
1175
- /**
1176
- * When insert,return insert item exist
1177
- */
1178
- exist?: boolean;
1179
- /**
1180
- * The insert response
1181
- */
1182
- response: Response;
1183
- }
1184
- export declare class JobResponse {
1185
- jobId?: string;
1186
- /**
1187
- * Holds statistics field of response
1188
- */
1189
- statistics?: Statistics;
1190
- /**
1191
- * Holds status field of response
1192
- */
1193
- status?: Status;
1194
- }
1195
- export interface Alias {
1196
- name?: string;
1197
- type?: ResultType;
1198
- }
1199
- export type AttrAlias = {
1200
- values: any[];
1201
- type: ResultType;
1202
- type_desc: string;
1203
- alias: string;
1204
- };