jylis-rb 0.0.1 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +221 -0
  3. data/doc/Jylis.html +1087 -6
  4. data/doc/Jylis/Connection.html +1128 -0
  5. data/doc/Jylis/Connection/HostMissingError.html +135 -0
  6. data/doc/Jylis/Connection/UnsupportedSchemaError.html +135 -0
  7. data/doc/Jylis/DataType.html +135 -0
  8. data/doc/Jylis/DataType/Base.html +346 -0
  9. data/doc/Jylis/DataType/GCOUNT.html +331 -0
  10. data/doc/Jylis/DataType/GCOUNT/Result.html +132 -0
  11. data/doc/Jylis/DataType/MVREG.html +318 -0
  12. data/doc/Jylis/DataType/PNCOUNT.html +404 -0
  13. data/doc/Jylis/DataType/TLOG.html +750 -0
  14. data/doc/Jylis/DataType/TLOG/Result.html +640 -0
  15. data/doc/Jylis/DataType/TLOG/Row.html +616 -0
  16. data/doc/Jylis/DataType/TREG.html +345 -0
  17. data/doc/Jylis/DataType/TREG/Result.html +616 -0
  18. data/doc/Jylis/DataType/UJSON.html +549 -0
  19. data/doc/_index.html +185 -4
  20. data/doc/class_list.html +1 -1
  21. data/doc/file.README.html +223 -3
  22. data/doc/file.license.html +3 -3
  23. data/doc/frames.html +1 -1
  24. data/doc/index.html +223 -3
  25. data/doc/method_list.html +512 -0
  26. data/doc/top-level-namespace.html +3 -3
  27. data/lib/jylis-rb.rb +9 -0
  28. data/lib/jylis-rb/connection.rb +121 -0
  29. data/lib/jylis-rb/data_types/base.rb +24 -0
  30. data/lib/jylis-rb/data_types/gcount.rb +24 -0
  31. data/lib/jylis-rb/data_types/mvreg.rb +23 -0
  32. data/lib/jylis-rb/data_types/pncount.rb +33 -0
  33. data/lib/jylis-rb/data_types/tlog.rb +157 -0
  34. data/lib/jylis-rb/data_types/treg.rb +57 -0
  35. data/lib/jylis-rb/data_types/ujson.rb +87 -0
  36. data/lib/jylis-rb/jylis.rb +106 -0
  37. data/lib/jylis-rb/version.rb +1 -1
  38. metadata +39 -2
data/doc/Jylis/DataType/TLOG/Result.html ADDED
@@ -0,0 +1,640 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Jylis::DataType::TLOG::Result
8
+
9
+ &mdash; Documentation by YARD 0.9.14
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Jylis::DataType::TLOG::Result";
19
+ relpath = '../../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../../_index.html">Index (R)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../Jylis.html" title="Jylis (class)">Jylis</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../DataType.html" title="Jylis::DataType (module)">DataType</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../TLOG.html" title="Jylis::DataType::TLOG (class)">TLOG</a></span></span>
41
+ &raquo;
42
+ <span class="title">Result</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Jylis::DataType::TLOG::Result
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Jylis::DataType::TLOG::Result</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+ <dl>
91
+ <dt>Includes:</dt>
92
+ <dd>Enumerable</dd>
93
+ </dl>
94
+
95
+
96
+
97
+
98
+
99
+
100
+ <dl>
101
+ <dt>Defined in:</dt>
102
+ <dd>lib/jylis-rb/data_types/tlog.rb</dd>
103
+ </dl>
104
+
105
+ </div>
106
+
107
+ <h2>Overview</h2><div class="docstring">
108
+ <div class="discussion">
109
+
110
+ <p>The result of a TLOG query.</p>
111
+
112
+
113
+ </div>
114
+ </div>
115
+ <div class="tags">
116
+
117
+
118
+ </div>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+ <h2>
127
+ Class Method Summary
128
+ <small><a href="#" class="summary_toggle">collapse</a></small>
129
+ </h2>
130
+
131
+ <ul class="summary">
132
+
133
+ <li class="public ">
134
+ <span class="summary_signature">
135
+
136
+ <a href="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(query_result) &#x21d2; Jylis::DataType::TLOG::Result </a>
137
+
138
+
139
+
140
+ </span>
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <span class="summary_desc"><div class='inline'>
151
+ <p>Construct a Result from a raw query result.</p>
152
+ </div></span>
153
+
154
+ </li>
155
+
156
+
157
+ </ul>
158
+
159
+ <h2>
160
+ Instance Method Summary
161
+ <small><a href="#" class="summary_toggle">collapse</a></small>
162
+ </h2>
163
+
164
+ <ul class="summary">
165
+
166
+ <li class="public ">
167
+ <span class="summary_signature">
168
+
169
+ <a href="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(index) &#x21d2; Jylis::DataType::TLOG::Row </a>
170
+
171
+
172
+
173
+ </span>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'>
184
+ <p>The row at the given index.</p>
185
+ </div></span>
186
+
187
+ </li>
188
+
189
+
190
+ <li class="public ">
191
+ <span class="summary_signature">
192
+
193
+ <a href="#count-instance_method" title="#count (instance method)">#<strong>count</strong> &#x21d2; Integer </a>
194
+
195
+
196
+
197
+ </span>
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+ <span class="summary_desc"><div class='inline'>
208
+ <p>Number of rows.</p>
209
+ </div></span>
210
+
211
+ </li>
212
+
213
+
214
+ <li class="public ">
215
+ <span class="summary_signature">
216
+
217
+ <a href="#each-instance_method" title="#each (instance method)">#<strong>each</strong>(&amp;block) &#x21d2; Object </a>
218
+
219
+
220
+
221
+ </span>
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'>
232
+ <p>:no doc:.</p>
233
+ </div></span>
234
+
235
+ </li>
236
+
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(rows) &#x21d2; Result </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+ <span class="note title constructor">constructor</span>
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+ <span class="summary_desc"><div class='inline'>
258
+ <p>A new instance of Result.</p>
259
+ </div></span>
260
+
261
+ </li>
262
+
263
+
264
+ <li class="public ">
265
+ <span class="summary_signature">
266
+
267
+ <a href="#to_a-instance_method" title="#to_a (instance method)">#<strong>to_a</strong> &#x21d2; Object </a>
268
+
269
+
270
+
271
+ </span>
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+ <span class="summary_desc"><div class='inline'>
282
+ <p>Reconstruct the raw result returned by the database.</p>
283
+ </div></span>
284
+
285
+ </li>
286
+
287
+
288
+ </ul>
289
+
290
+
291
+
292
+ <div id="constructor_details" class="method_details_list">
293
+ <h2>Constructor Details</h2>
294
+
295
+ <div class="method_details first">
296
+ <h3 class="signature first" id="initialize-instance_method">
297
+
298
+ #<strong>initialize</strong>(rows) &#x21d2; <tt><span class='object_link'><a href="" title="Jylis::DataType::TLOG::Result (class)">Result</a></span></tt>
299
+
300
+
301
+
302
+
303
+
304
+ </h3><div class="docstring">
305
+ <div class="discussion">
306
+
307
+ <p>Returns a new instance of Result</p>
308
+
309
+
310
+ </div>
311
+ </div>
312
+ <div class="tags">
313
+
314
+
315
+ </div><table class="source_code">
316
+ <tr>
317
+ <td>
318
+ <pre class="lines">
319
+
320
+
321
+ 25
322
+ 26
323
+ 27</pre>
324
+ </td>
325
+ <td>
326
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/data_types/tlog.rb', line 25</span>
327
+
328
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_rows'>rows</span><span class='rparen'>)</span>
329
+ <span class='ivar'>@rows</span> <span class='op'>=</span> <span class='id identifier rubyid_rows'>rows</span>
330
+ <span class='kw'>end</span></pre>
331
+ </td>
332
+ </tr>
333
+ </table>
334
+ </div>
335
+
336
+ </div>
337
+
338
+
339
+ <div id="class_method_details" class="method_details_list">
340
+ <h2>Class Method Details</h2>
341
+
342
+
343
+ <div class="method_details first">
344
+ <h3 class="signature first" id="parse-class_method">
345
+
346
+ .<strong>parse</strong>(query_result) &#x21d2; <tt><span class='object_link'><a href="" title="Jylis::DataType::TLOG::Result (class)">Jylis::DataType::TLOG::Result</a></span></tt>
347
+
348
+
349
+
350
+
351
+
352
+ </h3><div class="docstring">
353
+ <div class="discussion">
354
+
355
+ <p>Construct a Result from a raw query result.</p>
356
+
357
+
358
+ </div>
359
+ </div>
360
+ <div class="tags">
361
+ <p class="tag_title">Parameters:</p>
362
+ <ul class="param">
363
+
364
+ <li>
365
+
366
+ <span class='name'>query_result</span>
367
+
368
+
369
+ <span class='type'>(<tt>Array</tt>)</span>
370
+
371
+
372
+
373
+ </li>
374
+
375
+ </ul>
376
+
377
+ <p class="tag_title">Returns:</p>
378
+ <ul class="return">
379
+
380
+ <li>
381
+
382
+
383
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Jylis::DataType::TLOG::Result (class)">Jylis::DataType::TLOG::Result</a></span></tt>)</span>
384
+
385
+
386
+
387
+ </li>
388
+
389
+ </ul>
390
+
391
+ </div><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 16
398
+ 17
399
+ 18
400
+ 19
401
+ 20
402
+ 21
403
+ 22
404
+ 23</pre>
405
+ </td>
406
+ <td>
407
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/data_types/tlog.rb', line 16</span>
408
+
409
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_query_result'>query_result</span><span class='rparen'>)</span>
410
+ <span class='id identifier rubyid_rows'>rows</span> <span class='op'>=</span> <span class='id identifier rubyid_query_result'>query_result</span><span class='period'>.</span><span class='id identifier rubyid_reduce'>reduce</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_memo'>memo</span><span class='comma'>,</span> <span class='id identifier rubyid_row'>row</span><span class='op'>|</span>
411
+ <span class='id identifier rubyid_memo'>memo</span> <span class='op'>&lt;&lt;</span> <span class='const'><span class='object_link'><a href="Row.html" title="Jylis::DataType::TLOG::Row (class)">Row</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse'><span class='object_link'><a href="Row.html#parse-class_method" title="Jylis::DataType::TLOG::Row.parse (method)">parse</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_row'>row</span><span class='rparen'>)</span>
412
+ <span class='id identifier rubyid_memo'>memo</span>
413
+ <span class='kw'>end</span>
414
+
415
+ <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_rows'>rows</span><span class='rparen'>)</span>
416
+ <span class='kw'>end</span></pre>
417
+ </td>
418
+ </tr>
419
+ </table>
420
+ </div>
421
+
422
+ </div>
423
+
424
+ <div id="instance_method_details" class="method_details_list">
425
+ <h2>Instance Method Details</h2>
426
+
427
+
428
+ <div class="method_details first">
429
+ <h3 class="signature first" id="[]-instance_method">
430
+
431
+ #<strong>[]</strong>(index) &#x21d2; <tt><span class='object_link'><a href="Row.html" title="Jylis::DataType::TLOG::Row (class)">Jylis::DataType::TLOG::Row</a></span></tt>
432
+
433
+
434
+
435
+
436
+
437
+ </h3><div class="docstring">
438
+ <div class="discussion">
439
+
440
+ <p>Returns the row at the given index</p>
441
+
442
+
443
+ </div>
444
+ </div>
445
+ <div class="tags">
446
+
447
+ <p class="tag_title">Returns:</p>
448
+ <ul class="return">
449
+
450
+ <li>
451
+
452
+
453
+ <span class='type'>(<tt><span class='object_link'><a href="Row.html" title="Jylis::DataType::TLOG::Row (class)">Jylis::DataType::TLOG::Row</a></span></tt>)</span>
454
+
455
+
456
+
457
+ &mdash;
458
+ <div class='inline'>
459
+ <p>the row at the given index</p>
460
+ </div>
461
+
462
+ </li>
463
+
464
+ </ul>
465
+
466
+ </div><table class="source_code">
467
+ <tr>
468
+ <td>
469
+ <pre class="lines">
470
+
471
+
472
+ 30
473
+ 31
474
+ 32</pre>
475
+ </td>
476
+ <td>
477
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/data_types/tlog.rb', line 30</span>
478
+
479
+ <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
480
+ <span class='ivar'>@rows</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
481
+ <span class='kw'>end</span></pre>
482
+ </td>
483
+ </tr>
484
+ </table>
485
+ </div>
486
+
487
+ <div class="method_details ">
488
+ <h3 class="signature " id="count-instance_method">
489
+
490
+ #<strong>count</strong> &#x21d2; <tt>Integer</tt>
491
+
492
+
493
+
494
+
495
+
496
+ </h3><div class="docstring">
497
+ <div class="discussion">
498
+
499
+ <p>Returns number of rows</p>
500
+
501
+
502
+ </div>
503
+ </div>
504
+ <div class="tags">
505
+
506
+ <p class="tag_title">Returns:</p>
507
+ <ul class="return">
508
+
509
+ <li>
510
+
511
+
512
+ <span class='type'>(<tt>Integer</tt>)</span>
513
+
514
+
515
+
516
+ &mdash;
517
+ <div class='inline'>
518
+ <p>number of rows</p>
519
+ </div>
520
+
521
+ </li>
522
+
523
+ </ul>
524
+
525
+ </div><table class="source_code">
526
+ <tr>
527
+ <td>
528
+ <pre class="lines">
529
+
530
+
531
+ 40
532
+ 41
533
+ 42</pre>
534
+ </td>
535
+ <td>
536
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/data_types/tlog.rb', line 40</span>
537
+
538
+ <span class='kw'>def</span> <span class='id identifier rubyid_count'>count</span>
539
+ <span class='ivar'>@rows</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span>
540
+ <span class='kw'>end</span></pre>
541
+ </td>
542
+ </tr>
543
+ </table>
544
+ </div>
545
+
546
+ <div class="method_details ">
547
+ <h3 class="signature " id="each-instance_method">
548
+
549
+ #<strong>each</strong>(&amp;block) &#x21d2; <tt>Object</tt>
550
+
551
+
552
+
553
+
554
+
555
+ </h3><div class="docstring">
556
+ <div class="discussion">
557
+
558
+ <p>:no doc:</p>
559
+
560
+
561
+ </div>
562
+ </div>
563
+ <div class="tags">
564
+
565
+
566
+ </div><table class="source_code">
567
+ <tr>
568
+ <td>
569
+ <pre class="lines">
570
+
571
+
572
+ 35
573
+ 36
574
+ 37</pre>
575
+ </td>
576
+ <td>
577
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/data_types/tlog.rb', line 35</span>
578
+
579
+ <span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
580
+ <span class='ivar'>@rows</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
581
+ <span class='kw'>end</span></pre>
582
+ </td>
583
+ </tr>
584
+ </table>
585
+ </div>
586
+
587
+ <div class="method_details ">
588
+ <h3 class="signature " id="to_a-instance_method">
589
+
590
+ #<strong>to_a</strong> &#x21d2; <tt>Object</tt>
591
+
592
+
593
+
594
+
595
+
596
+ </h3><div class="docstring">
597
+ <div class="discussion">
598
+
599
+ <p>Reconstruct the raw result returned by the database.</p>
600
+
601
+
602
+ </div>
603
+ </div>
604
+ <div class="tags">
605
+
606
+
607
+ </div><table class="source_code">
608
+ <tr>
609
+ <td>
610
+ <pre class="lines">
611
+
612
+
613
+ 45
614
+ 46
615
+ 47</pre>
616
+ </td>
617
+ <td>
618
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/data_types/tlog.rb', line 45</span>
619
+
620
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_a'>to_a</span>
621
+ <span class='ivar'>@rows</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_a</span><span class='rparen'>)</span>
622
+ <span class='kw'>end</span></pre>
623
+ </td>
624
+ </tr>
625
+ </table>
626
+ </div>
627
+
628
+ </div>
629
+
630
+ </div>
631
+
632
+ <div id="footer">
633
+ Generated on Sun Jun 3 21:47:00 2018 by
634
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
635
+ 0.9.14 (ruby-2.5.1).
636
+ </div>
637
+
638
+ </div>
639
+ </body>
640
+ </html>