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/Connection.html ADDED
@@ -0,0 +1,1128 @@
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::Connection
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::Connection";
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 (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Jylis.html" title="Jylis (class)">Jylis</a></span></span>
41
+ &raquo;
42
+ <span class="title">Connection</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::Connection
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::Connection</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/jylis-rb/connection.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>A connection to the database.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div><h2>Defined Under Namespace</h2>
114
+ <p class="children">
115
+
116
+
117
+
118
+
119
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Connection/HostMissingError.html" title="Jylis::Connection::HostMissingError (class)">HostMissingError</a></span>, <span class='object_link'><a href="Connection/UnsupportedSchemaError.html" title="Jylis::Connection::UnsupportedSchemaError (class)">UnsupportedSchemaError</a></span>
120
+
121
+
122
+ </p>
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <h2>
132
+ Data Types
133
+ <small><a href="#" class="summary_toggle">collapse</a></small>
134
+ </h2>
135
+
136
+ <ul class="summary">
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#gcount-instance_method" title="#gcount (instance method)">#<strong>gcount</strong> &#x21d2; Jylis::DataType::GCOUNT </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+ <span class="summary_desc"><div class='inline'>
156
+ <p>GCOUNT functions.</p>
157
+ </div></span>
158
+
159
+ </li>
160
+
161
+
162
+ <li class="public ">
163
+ <span class="summary_signature">
164
+
165
+ <a href="#mvreg-instance_method" title="#mvreg (instance method)">#<strong>mvreg</strong> &#x21d2; Jylis::DataType::MVREG </a>
166
+
167
+
168
+
169
+ </span>
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+ <span class="summary_desc"><div class='inline'>
180
+ <p>MVREG functions.</p>
181
+ </div></span>
182
+
183
+ </li>
184
+
185
+
186
+ <li class="public ">
187
+ <span class="summary_signature">
188
+
189
+ <a href="#pncount-instance_method" title="#pncount (instance method)">#<strong>pncount</strong> &#x21d2; Jylis::DataType::PNCOUNT </a>
190
+
191
+
192
+
193
+ </span>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+ <span class="summary_desc"><div class='inline'>
204
+ <p>PNCOUNT functions.</p>
205
+ </div></span>
206
+
207
+ </li>
208
+
209
+
210
+ <li class="public ">
211
+ <span class="summary_signature">
212
+
213
+ <a href="#tlog-instance_method" title="#tlog (instance method)">#<strong>tlog</strong> &#x21d2; Jylis::DataType::TLOG </a>
214
+
215
+
216
+
217
+ </span>
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+ <span class="summary_desc"><div class='inline'>
228
+ <p>TLOG functions.</p>
229
+ </div></span>
230
+
231
+ </li>
232
+
233
+
234
+ <li class="public ">
235
+ <span class="summary_signature">
236
+
237
+ <a href="#treg-instance_method" title="#treg (instance method)">#<strong>treg</strong> &#x21d2; Jylis::DataType::TREG </a>
238
+
239
+
240
+
241
+ </span>
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+ <span class="summary_desc"><div class='inline'>
252
+ <p>TREG functions.</p>
253
+ </div></span>
254
+
255
+ </li>
256
+
257
+
258
+ <li class="public ">
259
+ <span class="summary_signature">
260
+
261
+ <a href="#ujson-instance_method" title="#ujson (instance method)">#<strong>ujson</strong> &#x21d2; Jylis::DataType::UJSON </a>
262
+
263
+
264
+
265
+ </span>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+ <span class="summary_desc"><div class='inline'>
276
+ <p>UJSON functions.</p>
277
+ </div></span>
278
+
279
+ </li>
280
+
281
+
282
+ </ul>
283
+
284
+ <h2>
285
+ Instance Method Summary
286
+ <small><a href="#" class="summary_toggle">collapse</a></small>
287
+ </h2>
288
+
289
+ <ul class="summary">
290
+
291
+ <li class="public ">
292
+ <span class="summary_signature">
293
+
294
+ <a href="#connected%3F-instance_method" title="#connected? (instance method)">#<strong>connected?</strong> &#x21d2; Boolean </a>
295
+
296
+
297
+
298
+ </span>
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+ <span class="summary_desc"><div class='inline'>
309
+ <p>True if a connection to the server is established.</p>
310
+ </div></span>
311
+
312
+ </li>
313
+
314
+
315
+ <li class="public ">
316
+ <span class="summary_signature">
317
+
318
+ <a href="#disconnect-instance_method" title="#disconnect (instance method)">#<strong>disconnect</strong> &#x21d2; Object </a>
319
+
320
+
321
+
322
+ </span>
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+ <span class="summary_desc"><div class='inline'>
333
+ <p>Disconnect from the server.</p>
334
+ </div></span>
335
+
336
+ </li>
337
+
338
+
339
+ <li class="public ">
340
+ <span class="summary_signature">
341
+
342
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(server_uri) &#x21d2; Connection </a>
343
+
344
+
345
+
346
+ </span>
347
+
348
+
349
+ <span class="note title constructor">constructor</span>
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+ <span class="summary_desc"><div class='inline'>
359
+ <p>A new instance of Connection.</p>
360
+ </div></span>
361
+
362
+ </li>
363
+
364
+
365
+ <li class="public ">
366
+ <span class="summary_signature">
367
+
368
+ <a href="#query-instance_method" title="#query (instance method)">#<strong>query</strong>(*args) &#x21d2; Array </a>
369
+
370
+
371
+
372
+ </span>
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+ <span class="summary_desc"><div class='inline'>
383
+ <p>Make a query to the database.</p>
384
+ </div></span>
385
+
386
+ </li>
387
+
388
+
389
+ <li class="public ">
390
+ <span class="summary_signature">
391
+
392
+ <a href="#reconnect-instance_method" title="#reconnect (instance method)">#<strong>reconnect</strong> &#x21d2; Object </a>
393
+
394
+
395
+
396
+ </span>
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+ <span class="summary_desc"><div class='inline'>
407
+ <p>Reconnect to the server.</p>
408
+ </div></span>
409
+
410
+ </li>
411
+
412
+
413
+ </ul>
414
+
415
+
416
+ <div id="constructor_details" class="method_details_list">
417
+ <h2>Constructor Details</h2>
418
+
419
+ <div class="method_details first">
420
+ <h3 class="signature first" id="initialize-instance_method">
421
+
422
+ #<strong>initialize</strong>(server_uri) &#x21d2; <tt><span class='object_link'><a href="" title="Jylis::Connection (class)">Connection</a></span></tt>
423
+
424
+
425
+
426
+
427
+
428
+ </h3><div class="docstring">
429
+ <div class="discussion">
430
+
431
+ <p>Returns a new instance of Connection</p>
432
+
433
+
434
+ </div>
435
+ </div>
436
+ <div class="tags">
437
+ <p class="tag_title">Parameters:</p>
438
+ <ul class="param">
439
+
440
+ <li>
441
+
442
+ <span class='name'>server_uri</span>
443
+
444
+
445
+ <span class='type'>(<tt>URI</tt>, <tt>String</tt>)</span>
446
+
447
+
448
+
449
+ &mdash;
450
+ <div class='inline'>
451
+ <p>uri of the server to connect to</p>
452
+ </div>
453
+
454
+ </li>
455
+
456
+ </ul>
457
+
458
+ <p class="tag_title">Raises:</p>
459
+ <ul class="raise">
460
+
461
+ <li>
462
+
463
+
464
+ <span class='type'>(<tt><span class='object_link'><a href="Connection/UnsupportedSchemaError.html" title="Jylis::Connection::UnsupportedSchemaError (class)">UnsupportedSchemaError</a></span></tt>)</span>
465
+
466
+
467
+
468
+ &mdash;
469
+ <div class='inline'>
470
+ <p>if the server URI schema is not supported</p>
471
+ </div>
472
+
473
+ </li>
474
+
475
+ <li>
476
+
477
+
478
+ <span class='type'>(<tt><span class='object_link'><a href="Connection/HostMissingError.html" title="Jylis::Connection::HostMissingError (class)">HostMissingError</a></span></tt>)</span>
479
+
480
+
481
+
482
+ &mdash;
483
+ <div class='inline'>
484
+ <p>if the host is missing from the server URI</p>
485
+ </div>
486
+
487
+ </li>
488
+
489
+ </ul>
490
+
491
+ </div><table class="source_code">
492
+ <tr>
493
+ <td>
494
+ <pre class="lines">
495
+
496
+
497
+ 15
498
+ 16
499
+ 17
500
+ 18
501
+ 19
502
+ 20
503
+ 21
504
+ 22
505
+ 23
506
+ 24
507
+ 25
508
+ 26
509
+ 27
510
+ 28
511
+ 29
512
+ 30
513
+ 31
514
+ 32
515
+ 33</pre>
516
+ </td>
517
+ <td>
518
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 15</span>
519
+
520
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_server_uri'>server_uri</span><span class='rparen'>)</span>
521
+ <span class='id identifier rubyid_server_uri'>server_uri</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_server_uri'>server_uri</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_server_uri'>server_uri</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>URI</span><span class='rparen'>)</span>
522
+
523
+ <span class='kw'>unless</span> <span class='id identifier rubyid_server_uri'>server_uri</span><span class='period'>.</span><span class='id identifier rubyid_scheme'>scheme</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>jylis</span><span class='tstring_end'>&quot;</span></span>
524
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="Connection/UnsupportedSchemaError.html" title="Jylis::Connection::UnsupportedSchemaError (class)">UnsupportedSchemaError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
525
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_server_uri'>server_uri</span><span class='period'>.</span><span class='id identifier rubyid_scheme'>scheme</span><span class='embexpr_end'>}</span><span class='tstring_content'> is not a supported schema</span><span class='tstring_end'>&quot;</span></span>
526
+ <span class='rparen'>)</span>
527
+ <span class='kw'>end</span>
528
+
529
+ <span class='kw'>unless</span> <span class='id identifier rubyid_server_uri'>server_uri</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span>
530
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="Connection/HostMissingError.html" title="Jylis::Connection::HostMissingError (class)">HostMissingError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>No host specified</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
531
+ <span class='kw'>end</span>
532
+
533
+ <span class='ivar'>@server_host</span> <span class='op'>=</span> <span class='id identifier rubyid_server_uri'>server_uri</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span>
534
+ <span class='ivar'>@server_port</span> <span class='op'>=</span> <span class='id identifier rubyid_server_uri'>server_uri</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span> <span class='op'>||</span> <span class='int'>6379</span>
535
+ <span class='ivar'>@connection</span> <span class='op'>=</span> <span class='const'>Hiredis</span><span class='op'>::</span><span class='const'>Connection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
536
+
537
+ <span class='id identifier rubyid_connect'>connect</span>
538
+ <span class='kw'>end</span></pre>
539
+ </td>
540
+ </tr>
541
+ </table>
542
+ </div>
543
+
544
+ </div>
545
+
546
+
547
+ <div id="instance_method_details" class="method_details_list">
548
+ <h2>Instance Method Details</h2>
549
+
550
+
551
+ <div class="method_details first">
552
+ <h3 class="signature first" id="connected?-instance_method">
553
+
554
+ #<strong>connected?</strong> &#x21d2; <tt>Boolean</tt>
555
+
556
+
557
+
558
+
559
+
560
+ </h3><div class="docstring">
561
+ <div class="discussion">
562
+
563
+ <p>Returns true if a connection to the server is established</p>
564
+
565
+
566
+ </div>
567
+ </div>
568
+ <div class="tags">
569
+
570
+ <p class="tag_title">Returns:</p>
571
+ <ul class="return">
572
+
573
+ <li>
574
+
575
+
576
+ <span class='type'>(<tt>Boolean</tt>)</span>
577
+
578
+
579
+
580
+ &mdash;
581
+ <div class='inline'>
582
+ <p>true if a connection to the server is established</p>
583
+ </div>
584
+
585
+ </li>
586
+
587
+ </ul>
588
+
589
+ </div><table class="source_code">
590
+ <tr>
591
+ <td>
592
+ <pre class="lines">
593
+
594
+
595
+ 36
596
+ 37
597
+ 38</pre>
598
+ </td>
599
+ <td>
600
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 36</span>
601
+
602
+ <span class='kw'>def</span> <span class='id identifier rubyid_connected?'>connected?</span>
603
+ <span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_connected?'>connected?</span>
604
+ <span class='kw'>end</span></pre>
605
+ </td>
606
+ </tr>
607
+ </table>
608
+ </div>
609
+
610
+ <div class="method_details ">
611
+ <h3 class="signature " id="disconnect-instance_method">
612
+
613
+ #<strong>disconnect</strong> &#x21d2; <tt>Object</tt>
614
+
615
+
616
+
617
+
618
+
619
+ </h3><div class="docstring">
620
+ <div class="discussion">
621
+
622
+ <p>Disconnect from the server.</p>
623
+
624
+
625
+ </div>
626
+ </div>
627
+ <div class="tags">
628
+
629
+
630
+ </div><table class="source_code">
631
+ <tr>
632
+ <td>
633
+ <pre class="lines">
634
+
635
+
636
+ 48
637
+ 49
638
+ 50</pre>
639
+ </td>
640
+ <td>
641
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 48</span>
642
+
643
+ <span class='kw'>def</span> <span class='id identifier rubyid_disconnect'>disconnect</span>
644
+ <span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_disconnect'>disconnect</span>
645
+ <span class='kw'>end</span></pre>
646
+ </td>
647
+ </tr>
648
+ </table>
649
+ </div>
650
+
651
+ <div class="method_details ">
652
+ <h3 class="signature " id="gcount-instance_method">
653
+
654
+ #<strong>gcount</strong> &#x21d2; <tt><span class='object_link'><a href="DataType/GCOUNT.html" title="Jylis::DataType::GCOUNT (class)">Jylis::DataType::GCOUNT</a></span></tt>
655
+
656
+
657
+
658
+
659
+
660
+ </h3><div class="docstring">
661
+ <div class="discussion">
662
+
663
+ <p>GCOUNT functions</p>
664
+
665
+
666
+ </div>
667
+ </div>
668
+ <div class="tags">
669
+
670
+ <p class="tag_title">Returns:</p>
671
+ <ul class="return">
672
+
673
+ <li>
674
+
675
+
676
+ <span class='type'>(<tt><span class='object_link'><a href="DataType/GCOUNT.html" title="Jylis::DataType::GCOUNT (class)">Jylis::DataType::GCOUNT</a></span></tt>)</span>
677
+
678
+
679
+
680
+ </li>
681
+
682
+ </ul>
683
+
684
+ </div><table class="source_code">
685
+ <tr>
686
+ <td>
687
+ <pre class="lines">
688
+
689
+
690
+ 87
691
+ 88
692
+ 89</pre>
693
+ </td>
694
+ <td>
695
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 87</span>
696
+
697
+ <span class='kw'>def</span> <span class='id identifier rubyid_gcount'>gcount</span>
698
+ <span class='ivar'>@gcount</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType.html" title="Jylis::DataType (module)">DataType</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType/GCOUNT.html" title="Jylis::DataType::GCOUNT (class)">GCOUNT</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DataType/Base.html#initialize-instance_method" title="Jylis::DataType::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
699
+ <span class='kw'>end</span></pre>
700
+ </td>
701
+ </tr>
702
+ </table>
703
+ </div>
704
+
705
+ <div class="method_details ">
706
+ <h3 class="signature " id="mvreg-instance_method">
707
+
708
+ #<strong>mvreg</strong> &#x21d2; <tt><span class='object_link'><a href="DataType/MVREG.html" title="Jylis::DataType::MVREG (class)">Jylis::DataType::MVREG</a></span></tt>
709
+
710
+
711
+
712
+
713
+
714
+ </h3><div class="docstring">
715
+ <div class="discussion">
716
+
717
+ <p>MVREG functions</p>
718
+
719
+
720
+ </div>
721
+ </div>
722
+ <div class="tags">
723
+
724
+ <p class="tag_title">Returns:</p>
725
+ <ul class="return">
726
+
727
+ <li>
728
+
729
+
730
+ <span class='type'>(<tt><span class='object_link'><a href="DataType/MVREG.html" title="Jylis::DataType::MVREG (class)">Jylis::DataType::MVREG</a></span></tt>)</span>
731
+
732
+
733
+
734
+ </li>
735
+
736
+ </ul>
737
+
738
+ </div><table class="source_code">
739
+ <tr>
740
+ <td>
741
+ <pre class="lines">
742
+
743
+
744
+ 101
745
+ 102
746
+ 103</pre>
747
+ </td>
748
+ <td>
749
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 101</span>
750
+
751
+ <span class='kw'>def</span> <span class='id identifier rubyid_mvreg'>mvreg</span>
752
+ <span class='ivar'>@mvreg</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType.html" title="Jylis::DataType (module)">DataType</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType/MVREG.html" title="Jylis::DataType::MVREG (class)">MVREG</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DataType/Base.html#initialize-instance_method" title="Jylis::DataType::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
753
+ <span class='kw'>end</span></pre>
754
+ </td>
755
+ </tr>
756
+ </table>
757
+ </div>
758
+
759
+ <div class="method_details ">
760
+ <h3 class="signature " id="pncount-instance_method">
761
+
762
+ #<strong>pncount</strong> &#x21d2; <tt><span class='object_link'><a href="DataType/PNCOUNT.html" title="Jylis::DataType::PNCOUNT (class)">Jylis::DataType::PNCOUNT</a></span></tt>
763
+
764
+
765
+
766
+
767
+
768
+ </h3><div class="docstring">
769
+ <div class="discussion">
770
+
771
+ <p>PNCOUNT functions</p>
772
+
773
+
774
+ </div>
775
+ </div>
776
+ <div class="tags">
777
+
778
+ <p class="tag_title">Returns:</p>
779
+ <ul class="return">
780
+
781
+ <li>
782
+
783
+
784
+ <span class='type'>(<tt><span class='object_link'><a href="DataType/PNCOUNT.html" title="Jylis::DataType::PNCOUNT (class)">Jylis::DataType::PNCOUNT</a></span></tt>)</span>
785
+
786
+
787
+
788
+ </li>
789
+
790
+ </ul>
791
+
792
+ </div><table class="source_code">
793
+ <tr>
794
+ <td>
795
+ <pre class="lines">
796
+
797
+
798
+ 94
799
+ 95
800
+ 96</pre>
801
+ </td>
802
+ <td>
803
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 94</span>
804
+
805
+ <span class='kw'>def</span> <span class='id identifier rubyid_pncount'>pncount</span>
806
+ <span class='ivar'>@pncount</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType.html" title="Jylis::DataType (module)">DataType</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType/PNCOUNT.html" title="Jylis::DataType::PNCOUNT (class)">PNCOUNT</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DataType/Base.html#initialize-instance_method" title="Jylis::DataType::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
807
+ <span class='kw'>end</span></pre>
808
+ </td>
809
+ </tr>
810
+ </table>
811
+ </div>
812
+
813
+ <div class="method_details ">
814
+ <h3 class="signature " id="query-instance_method">
815
+
816
+ #<strong>query</strong>(*args) &#x21d2; <tt>Array</tt>
817
+
818
+
819
+
820
+
821
+
822
+ </h3><div class="docstring">
823
+ <div class="discussion">
824
+
825
+ <p>Make a query to the database.</p>
826
+
827
+
828
+ </div>
829
+ </div>
830
+ <div class="tags">
831
+ <p class="tag_title">Parameters:</p>
832
+ <ul class="param">
833
+
834
+ <li>
835
+
836
+ <span class='name'>args</span>
837
+
838
+
839
+ <span class='type'></span>
840
+
841
+
842
+
843
+ &mdash;
844
+ <div class='inline'>
845
+ <p>data type function args. Can be an args list or array.</p>
846
+ </div>
847
+
848
+ </li>
849
+
850
+ </ul>
851
+
852
+ <p class="tag_title">Returns:</p>
853
+ <ul class="return">
854
+
855
+ <li>
856
+
857
+
858
+ <span class='type'>(<tt>Array</tt>)</span>
859
+
860
+
861
+
862
+ &mdash;
863
+ <div class='inline'>
864
+ <p>query response</p>
865
+ </div>
866
+
867
+ </li>
868
+
869
+ </ul>
870
+
871
+ <p class="tag_title">See Also:</p>
872
+ <ul class="see">
873
+
874
+ <li><a href="https://jemc.github.io/jylis/docs/types/" target="_parent" title="https://jemc.github.io/jylis/docs/types/">https://jemc.github.io/jylis/docs/types/</a></li>
875
+
876
+ </ul>
877
+
878
+ </div><table class="source_code">
879
+ <tr>
880
+ <td>
881
+ <pre class="lines">
882
+
883
+
884
+ 59
885
+ 60
886
+ 61
887
+ 62
888
+ 63
889
+ 64
890
+ 65
891
+ 66</pre>
892
+ </td>
893
+ <td>
894
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 59</span>
895
+
896
+ <span class='kw'>def</span> <span class='id identifier rubyid_query'>query</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
897
+ <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span> <span class='op'>==</span> <span class='int'>1</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
898
+ <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
899
+ <span class='kw'>end</span>
900
+
901
+ <span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
902
+ <span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span>
903
+ <span class='kw'>end</span></pre>
904
+ </td>
905
+ </tr>
906
+ </table>
907
+ </div>
908
+
909
+ <div class="method_details ">
910
+ <h3 class="signature " id="reconnect-instance_method">
911
+
912
+ #<strong>reconnect</strong> &#x21d2; <tt>Object</tt>
913
+
914
+
915
+
916
+
917
+
918
+ </h3><div class="docstring">
919
+ <div class="discussion">
920
+
921
+ <p>Reconnect to the server.</p>
922
+
923
+
924
+ </div>
925
+ </div>
926
+ <div class="tags">
927
+
928
+
929
+ </div><table class="source_code">
930
+ <tr>
931
+ <td>
932
+ <pre class="lines">
933
+
934
+
935
+ 41
936
+ 42
937
+ 43
938
+ 44
939
+ 45</pre>
940
+ </td>
941
+ <td>
942
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 41</span>
943
+
944
+ <span class='kw'>def</span> <span class='id identifier rubyid_reconnect'>reconnect</span>
945
+ <span class='id identifier rubyid_disconnect'>disconnect</span> <span class='kw'>if</span> <span class='id identifier rubyid_connected?'>connected?</span>
946
+
947
+ <span class='id identifier rubyid_connect'>connect</span>
948
+ <span class='kw'>end</span></pre>
949
+ </td>
950
+ </tr>
951
+ </table>
952
+ </div>
953
+
954
+ <div class="method_details ">
955
+ <h3 class="signature " id="tlog-instance_method">
956
+
957
+ #<strong>tlog</strong> &#x21d2; <tt><span class='object_link'><a href="DataType/TLOG.html" title="Jylis::DataType::TLOG (class)">Jylis::DataType::TLOG</a></span></tt>
958
+
959
+
960
+
961
+
962
+
963
+ </h3><div class="docstring">
964
+ <div class="discussion">
965
+
966
+ <p>TLOG functions</p>
967
+
968
+
969
+ </div>
970
+ </div>
971
+ <div class="tags">
972
+
973
+ <p class="tag_title">Returns:</p>
974
+ <ul class="return">
975
+
976
+ <li>
977
+
978
+
979
+ <span class='type'>(<tt><span class='object_link'><a href="DataType/TLOG.html" title="Jylis::DataType::TLOG (class)">Jylis::DataType::TLOG</a></span></tt>)</span>
980
+
981
+
982
+
983
+ </li>
984
+
985
+ </ul>
986
+
987
+ </div><table class="source_code">
988
+ <tr>
989
+ <td>
990
+ <pre class="lines">
991
+
992
+
993
+ 80
994
+ 81
995
+ 82</pre>
996
+ </td>
997
+ <td>
998
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 80</span>
999
+
1000
+ <span class='kw'>def</span> <span class='id identifier rubyid_tlog'>tlog</span>
1001
+ <span class='ivar'>@tlog</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType.html" title="Jylis::DataType (module)">DataType</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType/TLOG.html" title="Jylis::DataType::TLOG (class)">TLOG</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DataType/Base.html#initialize-instance_method" title="Jylis::DataType::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
1002
+ <span class='kw'>end</span></pre>
1003
+ </td>
1004
+ </tr>
1005
+ </table>
1006
+ </div>
1007
+
1008
+ <div class="method_details ">
1009
+ <h3 class="signature " id="treg-instance_method">
1010
+
1011
+ #<strong>treg</strong> &#x21d2; <tt><span class='object_link'><a href="DataType/TREG.html" title="Jylis::DataType::TREG (class)">Jylis::DataType::TREG</a></span></tt>
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+ </h3><div class="docstring">
1018
+ <div class="discussion">
1019
+
1020
+ <p>TREG functions</p>
1021
+
1022
+
1023
+ </div>
1024
+ </div>
1025
+ <div class="tags">
1026
+
1027
+ <p class="tag_title">Returns:</p>
1028
+ <ul class="return">
1029
+
1030
+ <li>
1031
+
1032
+
1033
+ <span class='type'>(<tt><span class='object_link'><a href="DataType/TREG.html" title="Jylis::DataType::TREG (class)">Jylis::DataType::TREG</a></span></tt>)</span>
1034
+
1035
+
1036
+
1037
+ </li>
1038
+
1039
+ </ul>
1040
+
1041
+ </div><table class="source_code">
1042
+ <tr>
1043
+ <td>
1044
+ <pre class="lines">
1045
+
1046
+
1047
+ 73
1048
+ 74
1049
+ 75</pre>
1050
+ </td>
1051
+ <td>
1052
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 73</span>
1053
+
1054
+ <span class='kw'>def</span> <span class='id identifier rubyid_treg'>treg</span>
1055
+ <span class='ivar'>@treg</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType.html" title="Jylis::DataType (module)">DataType</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType/TREG.html" title="Jylis::DataType::TREG (class)">TREG</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DataType/Base.html#initialize-instance_method" title="Jylis::DataType::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
1056
+ <span class='kw'>end</span></pre>
1057
+ </td>
1058
+ </tr>
1059
+ </table>
1060
+ </div>
1061
+
1062
+ <div class="method_details ">
1063
+ <h3 class="signature " id="ujson-instance_method">
1064
+
1065
+ #<strong>ujson</strong> &#x21d2; <tt><span class='object_link'><a href="DataType/UJSON.html" title="Jylis::DataType::UJSON (class)">Jylis::DataType::UJSON</a></span></tt>
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+ </h3><div class="docstring">
1072
+ <div class="discussion">
1073
+
1074
+ <p>UJSON functions</p>
1075
+
1076
+
1077
+ </div>
1078
+ </div>
1079
+ <div class="tags">
1080
+
1081
+ <p class="tag_title">Returns:</p>
1082
+ <ul class="return">
1083
+
1084
+ <li>
1085
+
1086
+
1087
+ <span class='type'>(<tt><span class='object_link'><a href="DataType/UJSON.html" title="Jylis::DataType::UJSON (class)">Jylis::DataType::UJSON</a></span></tt>)</span>
1088
+
1089
+
1090
+
1091
+ </li>
1092
+
1093
+ </ul>
1094
+
1095
+ </div><table class="source_code">
1096
+ <tr>
1097
+ <td>
1098
+ <pre class="lines">
1099
+
1100
+
1101
+ 108
1102
+ 109
1103
+ 110</pre>
1104
+ </td>
1105
+ <td>
1106
+ <pre class="code"><span class="info file"># File 'lib/jylis-rb/connection.rb', line 108</span>
1107
+
1108
+ <span class='kw'>def</span> <span class='id identifier rubyid_ujson'>ujson</span>
1109
+ <span class='ivar'>@ujson</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType.html" title="Jylis::DataType (module)">DataType</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DataType/UJSON.html" title="Jylis::DataType::UJSON (class)">UJSON</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DataType/Base.html#initialize-instance_method" title="Jylis::DataType::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
1110
+ <span class='kw'>end</span></pre>
1111
+ </td>
1112
+ </tr>
1113
+ </table>
1114
+ </div>
1115
+
1116
+ </div>
1117
+
1118
+ </div>
1119
+
1120
+ <div id="footer">
1121
+ Generated on Sun Jun 3 21:46:59 2018 by
1122
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1123
+ 0.9.14 (ruby-2.5.1).
1124
+ </div>
1125
+
1126
+ </div>
1127
+ </body>
1128
+ </html>