jylis-rb 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96c30037533c2d352d4a385f753d149d0c537a2ec528b4c44c9e068d199f7d5b
-  data.tar.gz: db547bd9b48b4f3b1473e5f1a5a801d7cf620792f6a9a6f71e3e8e2ae0c92484
+  metadata.gz: 41185cdd95d1e64b87795154c5faf305e3cb779a40ac700c7dfd2cbf72ee612a
+  data.tar.gz: 3bac8f3e7f9e452b728125692b8f6e774e9a3385fc37a22fc903e24b444ee7cc
 SHA512:
-  metadata.gz: f9434d2675f8a33b626c20bb37b48ff6009d628024ec47fc095f49f7bab8a14f83d672ea33c484bc6317542c9ccea07b439a5fe14060ec876f103d6d8b9c7f65
-  data.tar.gz: afe761467bcb2e92dba77ce8d56dc0687b93d8679b1dbd7a1cfc440a0f542b19a0673e9c948f3ab887a1476df0b059cd0a429ba889ad637aa408c8d5d174882c
+  metadata.gz: 7c4f4eea104188d50d6c87357aadcdd6892191315792a244d408a91124017959d322f95623c4be4c66eb46430d8949ae45c574594e723bcb48d8fe950ccb0a5b
+  data.tar.gz: 895123f2fbdfbc566b32874fc4a0741a78166128401918224090379aa15ee00435acf41d2913f269e06cd7eda91abe3b825b6e81b7ab62ccd53635fc55d02f96

data/README.md

@@ -1,7 +1,228 @@
 # jylis-rb
 
+[![Gem Version](https://badge.fury.io/rb/jylis-rb.svg)](https://badge.fury.io/rb/jylis-rb)
+[![Coverage Status](https://coveralls.io/repos/github/amclain/jylis-rb/badge.svg?branch=master)](https://coveralls.io/github/amclain/jylis-rb?branch=master)
+[![API Documentation](http://img.shields.io/badge/docs-api-blue.svg)](http://www.rubydoc.info/gems/jylis-rb)
+[![MIT License](https://img.shields.io/badge/license-MIT-yellowgreen.svg)](https://github.com/amclain/jylis-rb/blob/master/license.txt)
+
 An idiomatic library for connecting a Ruby project to a
 [Jylis](https://github.com/jemc/jylis) database.
 
 > Jylis is a distributed in-memory database for Conflict-free Replicated Data
 > Types (CRDTs), built for speed, scalability, availability, and ease of use.
+
+## Installation
+
+Install this library from the Ruby package manager with the following command:
+
+```text
+$ gem install jylis-rb
+```
+
+Add the following `require` to your project:
+
+```ruby
+require 'jylis-rb'
+```
+
+The library is now ready for use.
+
+### Installing From Source
+
+If you choose not to use a version of the gem provided by the package manager,
+you may alternatively install this library from the source code. This section
+can be skipped if you have already installed the gem from the package manager.
+
+Ensure `bundler` and `rake` are installed:
+
+```text
+$ gem install bundler
+$ gem install rake
+```
+
+Clone the repository and navigate inside the project directory:
+
+```text
+$ git clone git@github.com:amclain/jylis-rb.git
+$ cd jylis-rb
+```
+
+Install the dependencies:
+
+```text
+$ bundle install
+```
+
+Ensure the tests pass:
+
+```text
+$ rake
+```
+
+Install the gem from the working source code:
+
+```text
+$ rake install
+```
+
+## Database Connection
+
+The connection URI must be specified in the format: `schema://host:port`, where
+the schema is `jylis`. The `host` can be a host name, IP address, or domain name
+of the database host to connect to. The `port` is optional and defaults to
+`6379` unless otherwise specified.
+
+```ruby
+Jylis.connect("jylis://host:port")
+```
+
+## Queries
+
+This library aims to be idiomatic with both Ruby and Jylis. Therefore, the
+syntax of the queries closely match the [Jylis documentation](https://jemc.github.io/jylis/docs/types/)
+and ideally it should feel so natural to you, a Ruby programmer, that you don't
+need to read the documentation for this library (although this library is
+thoroughly documented in the case that you do).
+
+For example, take the case of a Jylis query to set a value for a
+[`UJSON`](https://jemc.github.io/jylis/docs/types/ujson/#set-key-key-ujson) key:
+
+```text
+UJSON SET fruit apple properties '{"color": "red", "ripe": true}'
+```
+
+Using this library, the query looks like this:
+
+```ruby
+Jylis.ujson.set "fruit", "apple", "properties", {color: "red", ripe: true}
+```
+
+The format for a query is:
+
+```text
+Jylis.<data_type>.<function> key(s), [value], [timestamp]
+```
+
+However, be sure to consult the [API documentation](http://www.rubydoc.info/gems/jylis-rb)
+or the [Jylis documentation](https://jemc.github.io/jylis/docs/types/) for the
+exact format of your particular query.
+
+### TREG
+
+Timestamped Register <sup>[[link](https://jemc.github.io/jylis/docs/types/treg/)]</sup>
+
+```ruby
+Jylis.treg.set "lamp_brightness", 80, 1528082143
+
+result = Jylis.treg.get "lamp_brightness"
+# => #<Jylis::DataType::TREG::Result:0x00005598dd3941c8 @timestamp=1528082143, @value="80">
+
+result.value
+# => "80"
+result.timestamp
+# => 1528082143
+```
+
+### TLOG
+
+Timestamped Log <sup>[[link](https://jemc.github.io/jylis/docs/types/tlog/)]</sup>
+
+```ruby
+Jylis.tlog.ins "temperature", 68.8, 1528082150
+Jylis.tlog.ins "temperature", 70.1, 1528082160
+Jylis.tlog.ins "temperature", 73.6, 1528082170
+
+Jylis.tlog.size "temperature"
+# => 3
+
+result = Jylis.tlog.get "temperature"
+# => #<Jylis::DataType::TLOG::Result:0x00005598dd345d20
+#  @rows=
+#   [#<Jylis::DataType::TLOG::Row:0x00005598dd345d98 @timestamp=1528082170, @value="73.6">,
+#    #<Jylis::DataType::TLOG::Row:0x00005598dd345d70 @timestamp=1528082160, @value="70.1">,
+#    #<Jylis::DataType::TLOG::Row:0x00005598dd345d48 @timestamp=1528082150, @value="68.8">]>
+
+result.first.value
+# => "73.6"
+result.first.timestamp
+# => 1528082170
+
+Jylis.tlog.trim "temperature", 1
+
+Jylis.tlog.get "temperature"
+# => #<Jylis::DataType::TLOG::Result:0x00005598dd2faac8
+#  @rows=[#<Jylis::DataType::TLOG::Row:0x00005598dd2faaf0 @timestamp=1528082170, @value="73.6">]>
+
+Jylis.tlog.cutoff "temperature"
+# => 1528082170
+```
+
+### GCOUNT
+
+Grow-Only Counter <sup>[[link](https://jemc.github.io/jylis/docs/types/gcount/)]</sup>
+
+```ruby
+Jylis.gcount.inc "mileage", 10
+Jylis.gcount.inc "mileage", 5
+
+Jylis.gcount.get "mileage"
+# => 15
+```
+
+### PNCOUNT
+
+Positive/Negative Counter <sup>[[link](https://jemc.github.io/jylis/docs/types/pncount/)]</sup>
+
+```ruby
+Jylis.pncount.inc "subscribers", 3
+Jylis.pncount.dec "subscribers", 1
+
+Jylis.pncount.get "subscribers"
+# => 2
+```
+
+### MVREG
+
+Multi-Value Register <sup>[[link](https://jemc.github.io/jylis/docs/types/mvreg/)]</sup>
+
+```ruby
+Jylis.mvreg.set "thermostat", 68
+
+Jylis.mvreg.get "thermostat"
+# => ["68"]
+```
+
+### UJSON
+
+Unordered JSON <sup>[[link](https://jemc.github.io/jylis/docs/types/ujson/)]</sup>
+
+```ruby
+Jylis.ujson.set "users", "alice", "admin", false
+Jylis.ujson.set "users", "brett", "admin", false
+Jylis.ujson.set "users", "carol", "admin", true
+
+Jylis.ujson.get "users"
+# => {"brett"=>{"admin"=>false}, "carol"=>{"admin"=>true}, "alice"=>{"admin"=>false}}
+
+Jylis.ujson.ins "users", "brett", "banned", true
+
+Jylis.ujson.clr "users", "alice"
+
+Jylis.ujson.get "users"
+# => {"brett"=>{"banned"=>true, "admin"=>false}, "carol"=>{"admin"=>true}}
+```
+
+### Raw Query
+
+If this library doesn't contain a method for the query you would like to
+perform, you can construct the query yourself by calling `Jylis.query`.
+However, be aware that this method is non-idiomatic and may require you to
+do your own pre/post processing on the data.
+
+```ruby
+Jylis.query "TLOG", "INS", "temperature", 72.6, 5
+# => "OK"
+
+Jylis.query "TLOG", "GET", "temperature"
+# => [["72.6", 5]]
+```

data/doc/Jylis.html

@@ -6,7 +6,7 @@
 <title>
   Class: Jylis
   
-    &mdash; Documentation by YARD 0.9.13
+    &mdash; Documentation by YARD 0.9.14
   
 </title>
 
@@ -95,7 +95,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/jylis-rb/jylis.rb<span class="defines">,<br />
-  lib/jylis-rb/version.rb</span>
+  lib/jylis-rb/version.rb,<br /> lib/jylis-rb/connection.rb,<br /> lib/jylis-rb/data_types/base.rb,<br /> lib/jylis-rb/data_types/tlog.rb,<br /> lib/jylis-rb/data_types/treg.rb,<br /> lib/jylis-rb/data_types/mvreg.rb,<br /> lib/jylis-rb/data_types/ujson.rb,<br /> lib/jylis-rb/data_types/gcount.rb,<br /> lib/jylis-rb/data_types/pncount.rb</span>
 </dd>
   </dl>
   
@@ -112,7 +112,19 @@
 <div class="tags">
   
 
-</div>
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Jylis/DataType.html" title="Jylis::DataType (module)">DataType</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Jylis/Connection.html" title="Jylis::Connection (class)">Connection</a></span>
+    
+  
+</p>
+
   
     <h2>
       Constant Summary
@@ -135,7 +147,7 @@
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.1</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
       
     </dl>
   
@@ -143,17 +155,1086 @@
 
 
 
+  <h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#current-class_method" title="current (class method)">.<strong>current</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>The current connection.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+  
+    <h2>
+      Data Types
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#gcount-class_method" title="gcount (class method)">.<strong>gcount</strong>  &#x21d2; Jylis::DataType::GCOUNT </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>GCOUNT functions.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#mvreg-class_method" title="mvreg (class method)">.<strong>mvreg</strong>  &#x21d2; Jylis::DataType::MVREG </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>MVREG functions.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#pncount-class_method" title="pncount (class method)">.<strong>pncount</strong>  &#x21d2; Jylis::DataType::PNCOUNT </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>PNCOUNT functions.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#tlog-class_method" title="tlog (class method)">.<strong>tlog</strong>  &#x21d2; Jylis::DataType::TLOG </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>TLOG functions.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#treg-class_method" title="treg (class method)">.<strong>treg</strong>  &#x21d2; Jylis::DataType::TREG </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>TREG functions.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ujson-class_method" title="ujson (class method)">.<strong>ujson</strong>  &#x21d2; Jylis::DataType::UJSON </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>UJSON functions.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#connect-class_method" title="connect (class method)">.<strong>connect</strong>(server_uri)  &#x21d2; Jylis::Connection </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Connect to a server and store the current connection.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#connected%3F-class_method" title="connected? (class method)">.<strong>connected?</strong>  &#x21d2; Boolean </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>True if a connection to the current server is established.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#disconnect-class_method" title="disconnect (class method)">.<strong>disconnect</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Disconnect from the current server.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#query-class_method" title="query (class method)">.<strong>query</strong>(*args)  &#x21d2; Array </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Make a query to the database.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#reconnect-class_method" title="reconnect (class method)">.<strong>reconnect</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Reconnect to the current server.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  <div id="class_attr_details" class="attr_details">
+    <h2>Class Attribute Details</h2>
+    
+      
+      <span id="current=-class_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="current-class_method">
+  
+    .<strong>current</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>The current connection.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
 
+10
+11
+12</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 10</span>
 
+<span class='kw'>def</span> <span class='id identifier rubyid_current'>current</span>
+  <span class='ivar'>@current</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="connect-class_method">
+  
+    .<strong>connect</strong>(server_uri)  &#x21d2; <tt><span class='object_link'><a href="Jylis/Connection.html" title="Jylis::Connection (class)">Jylis::Connection</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Connect to a server and store the current connection.</p>
 
 
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>server_uri</span>
+      
+      
+        <span class='type'>(<tt>URI</tt>, <tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>uri of the server to connect to</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Jylis/Connection.html" title="Jylis::Connection (class)">Jylis::Connection</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>connection</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+17
+18
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 17</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_connect'>connect</span><span class='lparen'>(</span><span class='id identifier rubyid_server_uri'>server_uri</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_disconnect'>disconnect</span> <span class='kw'>if</span> <span class='id identifier rubyid_current'>current</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_connected?'>connected?</span>
+
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Jylis (class)">Jylis</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Jylis/Connection.html" title="Jylis::Connection (class)">Connection</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Jylis/Connection.html#initialize-instance_method" title="Jylis::Connection#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_server_uri'>server_uri</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="connected?-class_method">
+  
+    .<strong>connected?</strong>  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns true if a connection to the current server is established</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if a connection to the current server is established</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#connected%3F-instance_method" title="Jylis::Connection#connected? (method)">Jylis::Connection#connected?</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+25
+26
+27</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 25</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_connected?'>connected?</span>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_connected?'>connected?</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="disconnect-class_method">
+  
+    .<strong>disconnect</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Disconnect from the current server.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#disconnect-instance_method" title="Jylis::Connection#disconnect (method)">Jylis::Connection#disconnect</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+37
+38
+39</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 37</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_disconnect'>disconnect</span>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_disconnect'>disconnect</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="gcount-class_method">
+  
+    .<strong>gcount</strong>  &#x21d2; <tt><span class='object_link'><a href="Jylis/DataType/GCOUNT.html" title="Jylis::DataType::GCOUNT (class)">Jylis::DataType::GCOUNT</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>GCOUNT functions</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Jylis/DataType/GCOUNT.html" title="Jylis::DataType::GCOUNT (class)">Jylis::DataType::GCOUNT</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#gcount-instance_method" title="Jylis::Connection#gcount (method)">Jylis::Connection#gcount</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+78
+79
+80</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 78</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_gcount'>gcount</span>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_gcount'>gcount</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="mvreg-class_method">
+  
+    .<strong>mvreg</strong>  &#x21d2; <tt><span class='object_link'><a href="Jylis/DataType/MVREG.html" title="Jylis::DataType::MVREG (class)">Jylis::DataType::MVREG</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>MVREG functions</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Jylis/DataType/MVREG.html" title="Jylis::DataType::MVREG (class)">Jylis::DataType::MVREG</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#mvreg-instance_method" title="Jylis::Connection#mvreg (method)">Jylis::Connection#mvreg</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+96
+97
+98</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 96</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_mvreg'>mvreg</span>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_mvreg'>mvreg</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="pncount-class_method">
+  
+    .<strong>pncount</strong>  &#x21d2; <tt><span class='object_link'><a href="Jylis/DataType/PNCOUNT.html" title="Jylis::DataType::PNCOUNT (class)">Jylis::DataType::PNCOUNT</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>PNCOUNT functions</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Jylis/DataType/PNCOUNT.html" title="Jylis::DataType::PNCOUNT (class)">Jylis::DataType::PNCOUNT</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#pncount-instance_method" title="Jylis::Connection#pncount (method)">Jylis::Connection#pncount</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+87
+88
+89</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 87</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_pncount'>pncount</span>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_pncount'>pncount</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="query-class_method">
+  
+    .<strong>query</strong>(*args)  &#x21d2; <tt>Array</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Make a query to the database.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>args</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>data type function args. Can be an args list or array.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>query response</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#query-instance_method" title="Jylis::Connection#query (method)">Jylis::Connection#query</a></span></li>
+    
+      <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>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+49
+50
+51</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 49</span>
+
+<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>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</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>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="reconnect-class_method">
+  
+    .<strong>reconnect</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Reconnect to the current server.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#reconnect-instance_method" title="Jylis::Connection#reconnect (method)">Jylis::Connection#reconnect</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 31</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_reconnect'>reconnect</span>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_reconnect'>reconnect</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="tlog-class_method">
+  
+    .<strong>tlog</strong>  &#x21d2; <tt><span class='object_link'><a href="Jylis/DataType/TLOG.html" title="Jylis::DataType::TLOG (class)">Jylis::DataType::TLOG</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>TLOG functions</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Jylis/DataType/TLOG.html" title="Jylis::DataType::TLOG (class)">Jylis::DataType::TLOG</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#tlog-instance_method" title="Jylis::Connection#tlog (method)">Jylis::Connection#tlog</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+69
+70
+71</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 69</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_tlog'>tlog</span>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_tlog'>tlog</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="treg-class_method">
+  
+    .<strong>treg</strong>  &#x21d2; <tt><span class='object_link'><a href="Jylis/DataType/TREG.html" title="Jylis::DataType::TREG (class)">Jylis::DataType::TREG</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>TREG functions</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Jylis/DataType/TREG.html" title="Jylis::DataType::TREG (class)">Jylis::DataType::TREG</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#treg-instance_method" title="Jylis::Connection#treg (method)">Jylis::Connection#treg</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+60
+61
+62</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 60</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_treg'>treg</span>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_treg'>treg</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="ujson-class_method">
+  
+    .<strong>ujson</strong>  &#x21d2; <tt><span class='object_link'><a href="Jylis/DataType/UJSON.html" title="Jylis::DataType::UJSON (class)">Jylis::DataType::UJSON</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>UJSON functions</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Jylis/DataType/UJSON.html" title="Jylis::DataType::UJSON (class)">Jylis::DataType::UJSON</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Jylis/Connection.html#ujson-instance_method" title="Jylis::Connection#ujson (method)">Jylis::Connection#ujson</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+105
+106
+107</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jylis-rb/jylis.rb', line 105</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_ujson'>ujson</span>
+  <span class='id identifier rubyid_current'>current</span><span class='period'>.</span><span class='id identifier rubyid_ujson'>ujson</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
 
 </div>
 
       <div id="footer">
-  Generated on Sat Jun  2 13:02:48 2018 by
+  Generated on Sun Jun  3 21:46:59 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.13 (ruby-2.5.1).
+  0.9.14 (ruby-2.5.1).
 </div>
 
     </div>