gremlin 3.4.9 → 3.4.13

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 (69) hide show
  1. package/doc/AnonymousTraversalSource.html +1 -1
  2. package/doc/Authenticator.html +1 -1
  3. package/doc/Bytecode.html +1 -1
  4. package/doc/Client.html +1 -1
  5. package/doc/Connection.html +1 -1
  6. package/doc/DriverRemoteConnection.html +1 -1
  7. package/doc/EdgeLabelVerificationStrategy.html +1 -1
  8. package/doc/Graph.html +1 -1
  9. package/doc/GraphSON2Reader.html +1 -1
  10. package/doc/GraphSON2Writer.html +1 -1
  11. package/doc/GraphSON3Reader.html +1 -1
  12. package/doc/GraphSON3Writer.html +1 -1
  13. package/doc/GraphTraversal.html +213 -48
  14. package/doc/GraphTraversalSource.html +1 -1
  15. package/doc/HaltedTraverserStrategy.html +1 -1
  16. package/doc/MatchAlgorithmStrategy.html +1 -1
  17. package/doc/P.html +12 -12
  18. package/doc/PartitionStrategy.html +2 -2
  19. package/doc/Path.html +1 -1
  20. package/doc/PlainTextSaslAuthenticator.html +1 -1
  21. package/doc/ProductiveByStrategy.html +288 -0
  22. package/doc/RemoteConnection.html +1 -1
  23. package/doc/RemoteStrategy.html +1 -1
  24. package/doc/RemoteTraversal.html +1 -1
  25. package/doc/ReservedKeysVerificationStrategy.html +2 -2
  26. package/doc/ResponseError.html +1 -1
  27. package/doc/ResultSet.html +1 -1
  28. package/doc/SaslAuthenticator.html +1 -1
  29. package/doc/SaslMechanismBase.html +1 -1
  30. package/doc/SaslMechanismPlain.html +1 -1
  31. package/doc/{GraphSONReader.html → SeedStrategy.html} +12 -15
  32. package/doc/SubgraphStrategy.html +1 -1
  33. package/doc/TextP.html +9 -9
  34. package/doc/Transaction.html +655 -0
  35. package/doc/Translator.html +6 -6
  36. package/doc/TraversalStrategies.html +1 -1
  37. package/doc/TraversalStrategy.html +1 -1
  38. package/doc/TypeSerializer.html +1 -1
  39. package/doc/driver_auth_authenticator.js.html +1 -1
  40. package/doc/driver_auth_mechanisms_sasl-mechanism-base.js.html +1 -1
  41. package/doc/driver_auth_mechanisms_sasl-mechanism-plain.js.html +1 -1
  42. package/doc/driver_auth_plain-text-sasl-authenticator.js.html +1 -1
  43. package/doc/driver_auth_sasl-authenticator.js.html +1 -1
  44. package/doc/driver_client.js.html +1 -1
  45. package/doc/driver_connection.js.html +1 -1
  46. package/doc/driver_driver-remote-connection.js.html +1 -1
  47. package/doc/driver_remote-connection.js.html +1 -1
  48. package/doc/driver_response-error.js.html +1 -1
  49. package/doc/driver_result-set.js.html +1 -1
  50. package/doc/global.html +2 -2
  51. package/doc/index.html +1 -1
  52. package/doc/process_anonymous-traversal.js.html +1 -1
  53. package/doc/process_bytecode.js.html +1 -1
  54. package/doc/process_graph-traversal.js.html +11 -1
  55. package/doc/process_transaction.js.html +136 -0
  56. package/doc/process_translator.js.html +14 -5
  57. package/doc/process_traversal-strategy.js.html +1 -1
  58. package/doc/process_traversal.js.html +9 -2
  59. package/doc/structure_graph.js.html +1 -1
  60. package/doc/structure_io_graph-serializer.js.html +1 -1
  61. package/doc/structure_io_type-serializers.js.html +1 -1
  62. package/lib/process/graph-traversal.js +10 -0
  63. package/lib/process/translator.js +13 -4
  64. package/lib/process/traversal.js +8 -1
  65. package/package.json +7 -6
  66. package/.npmignore +0 -26
  67. package/doc/GraphSONWriter.html +0 -436
  68. package/gremlin-javascript.iml +0 -9
  69. package/package-lock.json +0 -2598
@@ -0,0 +1,655 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: Transaction</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Class: Transaction</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2><span class="attribs"><span class="type-signature"></span></span>Transaction<span class="signature">()</span><span class="type-signature"></span></h2>
32
+
33
+ <div class="class-description">A controller for a remote transaction that is constructed from <code>g.tx()</code>. Calling <code>begin()</code>
34
+ on this object will produce a new <code>GraphTraversalSource</code> that is bound to a remote transaction over which
35
+ multiple traversals may be executed in that context. Calling <code>commit()</code> or <code>rollback()</code> will
36
+ then close the transaction and thus, the session. This feature only works with transaction enabled graphs.</div>
37
+
38
+
39
+ </header>
40
+
41
+ <article>
42
+ <div class="container-overview">
43
+
44
+
45
+
46
+
47
+ <h2>Constructor</h2>
48
+
49
+
50
+
51
+ <h4 class="name" id="Transaction"><span class="type-signature"></span>new Transaction<span class="signature">()</span><span class="type-signature"></span></h4>
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+ <dl class="details">
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dt class="tag-source">Source:</dt>
98
+ <dd class="tag-source"><ul class="dummy"><li>
99
+ <a href="process_transaction.js.html">process/transaction.js</a>, <a href="process_transaction.js.html#line31">line 31</a>
100
+ </li></ul></dd>
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+ </dl>
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ </div>
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+ <h3 class="subsection-title">Members</h3>
146
+
147
+
148
+
149
+ <h4 class="name" id="isOpen"><span class="type-signature"></span>isOpen<span class="type-signature"></span></h4>
150
+
151
+
152
+
153
+
154
+ <div class="description">
155
+ Returns true if transaction is open.
156
+ </div>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+ <dl class="details">
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <dt class="tag-source">Source:</dt>
192
+ <dd class="tag-source"><ul class="dummy"><li>
193
+ <a href="process_transaction.js.html">process/transaction.js</a>, <a href="process_transaction.js.html#line71">line 71</a>
194
+ </li></ul></dd>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+ </dl>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+ <h3 class="subsection-title">Methods</h3>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+ <h4 class="name" id="begin"><span class="type-signature"></span>begin<span class="signature">()</span><span class="type-signature"> &rarr; {*}</span></h4>
222
+
223
+
224
+
225
+
226
+
227
+
228
+ <div class="description">
229
+ Spawns a <code>GraphTraversalSource</code> that is bound to a remote session which enables a transaction.
230
+ </div>
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+ <dl class="details">
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+ <dt class="tag-source">Source:</dt>
272
+ <dd class="tag-source"><ul class="dummy"><li>
273
+ <a href="process_transaction.js.html">process/transaction.js</a>, <a href="process_transaction.js.html#line41">line 41</a>
274
+ </li></ul></dd>
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+ </dl>
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+ <h5>Returns:</h5>
299
+
300
+
301
+
302
+
303
+ <dl>
304
+ <dt>
305
+ Type
306
+ </dt>
307
+ <dd>
308
+
309
+ <span class="param-type">*</span>
310
+
311
+
312
+ </dd>
313
+ </dl>
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+ <h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+ <dl class="details">
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+ <dt class="tag-source">Source:</dt>
374
+ <dd class="tag-source"><ul class="dummy"><li>
375
+ <a href="process_transaction.js.html">process/transaction.js</a>, <a href="process_transaction.js.html#line78">line 78</a>
376
+ </li></ul></dd>
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+ </dl>
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+ <h5>Returns:</h5>
401
+
402
+
403
+
404
+
405
+ <dl>
406
+ <dt>
407
+ Type
408
+ </dt>
409
+ <dd>
410
+
411
+ <span class="param-type">Promise</span>
412
+
413
+
414
+ </dd>
415
+ </dl>
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+ <h4 class="name" id="commit"><span class="type-signature"></span>commit<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+ <dl class="details">
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+ <dt class="tag-source">Source:</dt>
476
+ <dd class="tag-source"><ul class="dummy"><li>
477
+ <a href="process_transaction.js.html">process/transaction.js</a>, <a href="process_transaction.js.html#line56">line 56</a>
478
+ </li></ul></dd>
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+ </dl>
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+ <h5>Returns:</h5>
503
+
504
+
505
+
506
+
507
+ <dl>
508
+ <dt>
509
+ Type
510
+ </dt>
511
+ <dd>
512
+
513
+ <span class="param-type">Promise</span>
514
+
515
+
516
+ </dd>
517
+ </dl>
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+ <h4 class="name" id="rollback"><span class="type-signature"></span>rollback<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+ <dl class="details">
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+ <dt class="tag-source">Source:</dt>
578
+ <dd class="tag-source"><ul class="dummy"><li>
579
+ <a href="process_transaction.js.html">process/transaction.js</a>, <a href="process_transaction.js.html#line63">line 63</a>
580
+ </li></ul></dd>
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+ </dl>
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+ <h5>Returns:</h5>
605
+
606
+
607
+
608
+
609
+ <dl>
610
+ <dt>
611
+ Type
612
+ </dt>
613
+ <dd>
614
+
615
+ <span class="param-type">Promise</span>
616
+
617
+
618
+ </dd>
619
+ </dl>
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+ </article>
634
+
635
+ </section>
636
+
637
+
638
+
639
+
640
+ </div>
641
+
642
+ <nav>
643
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnonymousTraversalSource.html">AnonymousTraversalSource</a></li><li><a href="Authenticator.html">Authenticator</a></li><li><a href="Bytecode.html">Bytecode</a></li><li><a href="Client.html">Client</a></li><li><a href="Connection.html">Connection</a></li><li><a href="DriverRemoteConnection.html">DriverRemoteConnection</a></li><li><a href="EdgeLabelVerificationStrategy.html">EdgeLabelVerificationStrategy</a></li><li><a href="Graph.html">Graph</a></li><li><a href="GraphSON2Reader.html">GraphSON2Reader</a></li><li><a href="GraphSON2Writer.html">GraphSON2Writer</a></li><li><a href="GraphSON3Reader.html">GraphSON3Reader</a></li><li><a href="GraphSON3Writer.html">GraphSON3Writer</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="HaltedTraverserStrategy.html">HaltedTraverserStrategy</a></li><li><a href="MatchAlgorithmStrategy.html">MatchAlgorithmStrategy</a></li><li><a href="P.html">P</a></li><li><a href="PartitionStrategy.html">PartitionStrategy</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</a></li><li><a href="ProductiveByStrategy.html">ProductiveByStrategy</a></li><li><a href="RemoteConnection.html">RemoteConnection</a></li><li><a href="RemoteStrategy.html">RemoteStrategy</a></li><li><a href="RemoteTraversal.html">RemoteTraversal</a></li><li><a href="ReservedKeysVerificationStrategy.html">ReservedKeysVerificationStrategy</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="SaslAuthenticator.html">SaslAuthenticator</a></li><li><a href="SaslMechanismBase.html">SaslMechanismBase</a></li><li><a href="SaslMechanismPlain.html">SaslMechanismPlain</a></li><li><a href="SeedStrategy.html">SeedStrategy</a></li><li><a href="SubgraphStrategy.html">SubgraphStrategy</a></li><li><a href="TextP.html">TextP</a></li><li><a href="Transaction.html">Transaction</a></li><li><a href="Translator.html">Translator</a></li><li><a href="TraversalStrategies.html">TraversalStrategies</a></li><li><a href="TraversalStrategy.html">TraversalStrategy</a></li><li><a href="TypeSerializer.html">TypeSerializer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#statics">statics</a></li></ul>
644
+ </nav>
645
+
646
+ <br class="clear">
647
+
648
+ <footer>
649
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 07:15:59 GMT-0500 (Eastern Standard Time)
650
+ </footer>
651
+
652
+ <script> prettyPrint(); </script>
653
+ <script src="scripts/linenumber.js"> </script>
654
+ </body>
655
+ </html>
@@ -93,7 +93,7 @@
93
93
 
94
94
  <dt class="tag-source">Source:</dt>
95
95
  <dd class="tag-source"><ul class="dummy"><li>
96
- <a href="process_translator.js.html">process/translator.js</a>, <a href="process_translator.js.html#line26">line 26</a>
96
+ <a href="process_translator.js.html">process/translator.js</a>, <a href="process_translator.js.html#line27">line 27</a>
97
97
  </li></ul></dd>
98
98
 
99
99
 
@@ -147,7 +147,7 @@
147
147
 
148
148
 
149
149
 
150
- <h4 class="name" id="translate"><span class="type-signature"></span>translate<span class="signature">(bytecode)</span><span class="type-signature"> &rarr; {string}</span></h4>
150
+ <h4 class="name" id="translate"><span class="type-signature"></span>translate<span class="signature">(bytecodeOrTraversal)</span><span class="type-signature"> &rarr; {string}</span></h4>
151
151
 
152
152
 
153
153
 
@@ -191,7 +191,7 @@
191
191
 
192
192
  <tr>
193
193
 
194
- <td class="name"><code>bytecode</code></td>
194
+ <td class="name"><code>bytecodeOrTraversal</code></td>
195
195
 
196
196
 
197
197
  <td class="type">
@@ -207,7 +207,7 @@
207
207
 
208
208
 
209
209
 
210
- <td class="description last">The bytecode object containing step instructions.</td>
210
+ <td class="description last">The traversal or bytecode of a traversal containing step instructions.</td>
211
211
  </tr>
212
212
 
213
213
 
@@ -248,7 +248,7 @@
248
248
 
249
249
  <dt class="tag-source">Source:</dt>
250
250
  <dd class="tag-source"><ul class="dummy"><li>
251
- <a href="process_translator.js.html">process/translator.js</a>, <a href="process_translator.js.html#line48">line 48</a>
251
+ <a href="process_translator.js.html">process/translator.js</a>, <a href="process_translator.js.html#line49">line 49</a>
252
252
  </li></ul></dd>
253
253
 
254
254
 
@@ -320,7 +320,7 @@
320
320
  <br class="clear">
321
321
 
322
322
  <footer>
323
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Dec 11 2020 07:07:57 GMT-0500 (EST)
323
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 14 2022 08:27:43 GMT-0500 (Eastern Standard Time)
324
324
  </footer>
325
325
 
326
326
  <script> prettyPrint(); </script>
@@ -504,7 +504,7 @@
504
504
  <br class="clear">
505
505
 
506
506
  <footer>
507
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Dec 11 2020 07:07:57 GMT-0500 (EST)
507
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 14 2022 08:27:43 GMT-0500 (Eastern Standard Time)
508
508
  </footer>
509
509
 
510
510
  <script> prettyPrint(); </script>
@@ -380,7 +380,7 @@
380
380
  <br class="clear">
381
381
 
382
382
  <footer>
383
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Dec 11 2020 07:07:57 GMT-0500 (EST)
383
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 14 2022 08:27:43 GMT-0500 (Eastern Standard Time)
384
384
  </footer>
385
385
 
386
386
  <script> prettyPrint(); </script>