jylis-rb 0.0.1 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +221 -0
- data/doc/Jylis.html +1087 -6
- data/doc/Jylis/Connection.html +1128 -0
- data/doc/Jylis/Connection/HostMissingError.html +135 -0
- data/doc/Jylis/Connection/UnsupportedSchemaError.html +135 -0
- data/doc/Jylis/DataType.html +135 -0
- data/doc/Jylis/DataType/Base.html +346 -0
- data/doc/Jylis/DataType/GCOUNT.html +331 -0
- data/doc/Jylis/DataType/GCOUNT/Result.html +132 -0
- data/doc/Jylis/DataType/MVREG.html +318 -0
- data/doc/Jylis/DataType/PNCOUNT.html +404 -0
- data/doc/Jylis/DataType/TLOG.html +750 -0
- data/doc/Jylis/DataType/TLOG/Result.html +640 -0
- data/doc/Jylis/DataType/TLOG/Row.html +616 -0
- data/doc/Jylis/DataType/TREG.html +345 -0
- data/doc/Jylis/DataType/TREG/Result.html +616 -0
- data/doc/Jylis/DataType/UJSON.html +549 -0
- data/doc/_index.html +185 -4
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +223 -3
- data/doc/file.license.html +3 -3
- data/doc/frames.html +1 -1
- data/doc/index.html +223 -3
- data/doc/method_list.html +512 -0
- data/doc/top-level-namespace.html +3 -3
- data/lib/jylis-rb.rb +9 -0
- data/lib/jylis-rb/connection.rb +121 -0
- data/lib/jylis-rb/data_types/base.rb +24 -0
- data/lib/jylis-rb/data_types/gcount.rb +24 -0
- data/lib/jylis-rb/data_types/mvreg.rb +23 -0
- data/lib/jylis-rb/data_types/pncount.rb +33 -0
- data/lib/jylis-rb/data_types/tlog.rb +157 -0
- data/lib/jylis-rb/data_types/treg.rb +57 -0
- data/lib/jylis-rb/data_types/ujson.rb +87 -0
- data/lib/jylis-rb/jylis.rb +106 -0
- data/lib/jylis-rb/version.rb +1 -1
- metadata +39 -2
data/doc/_index.html
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
<meta charset="utf-8">
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
|
-
Documentation by YARD 0.9.
|
7
|
+
Documentation by YARD 0.9.14
|
8
8
|
|
9
9
|
</title>
|
10
10
|
|
@@ -52,7 +52,7 @@
|
|
52
52
|
<div class="clear"></div>
|
53
53
|
</div>
|
54
54
|
|
55
|
-
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.
|
55
|
+
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.14</h1>
|
56
56
|
<div id="listing">
|
57
57
|
<h1 class="alphaindex">Alphabetic Index</h1>
|
58
58
|
|
@@ -79,6 +79,81 @@
|
|
79
79
|
<td valign='top' width="33%">
|
80
80
|
|
81
81
|
|
82
|
+
<ul id="alpha_B" class="alpha">
|
83
|
+
<li class="letter">B</li>
|
84
|
+
<ul>
|
85
|
+
|
86
|
+
<li>
|
87
|
+
<span class='object_link'><a href="Jylis/DataType/Base.html" title="Jylis::DataType::Base (class)">Base</a></span>
|
88
|
+
|
89
|
+
<small>(Jylis::DataType)</small>
|
90
|
+
|
91
|
+
</li>
|
92
|
+
|
93
|
+
</ul>
|
94
|
+
</ul>
|
95
|
+
|
96
|
+
|
97
|
+
<ul id="alpha_C" class="alpha">
|
98
|
+
<li class="letter">C</li>
|
99
|
+
<ul>
|
100
|
+
|
101
|
+
<li>
|
102
|
+
<span class='object_link'><a href="Jylis/Connection.html" title="Jylis::Connection (class)">Connection</a></span>
|
103
|
+
|
104
|
+
<small>(Jylis)</small>
|
105
|
+
|
106
|
+
</li>
|
107
|
+
|
108
|
+
</ul>
|
109
|
+
</ul>
|
110
|
+
|
111
|
+
|
112
|
+
<ul id="alpha_D" class="alpha">
|
113
|
+
<li class="letter">D</li>
|
114
|
+
<ul>
|
115
|
+
|
116
|
+
<li>
|
117
|
+
<span class='object_link'><a href="Jylis/DataType.html" title="Jylis::DataType (module)">DataType</a></span>
|
118
|
+
|
119
|
+
<small>(Jylis)</small>
|
120
|
+
|
121
|
+
</li>
|
122
|
+
|
123
|
+
</ul>
|
124
|
+
</ul>
|
125
|
+
|
126
|
+
|
127
|
+
<ul id="alpha_G" class="alpha">
|
128
|
+
<li class="letter">G</li>
|
129
|
+
<ul>
|
130
|
+
|
131
|
+
<li>
|
132
|
+
<span class='object_link'><a href="Jylis/DataType/GCOUNT.html" title="Jylis::DataType::GCOUNT (class)">GCOUNT</a></span>
|
133
|
+
|
134
|
+
<small>(Jylis::DataType)</small>
|
135
|
+
|
136
|
+
</li>
|
137
|
+
|
138
|
+
</ul>
|
139
|
+
</ul>
|
140
|
+
|
141
|
+
|
142
|
+
<ul id="alpha_H" class="alpha">
|
143
|
+
<li class="letter">H</li>
|
144
|
+
<ul>
|
145
|
+
|
146
|
+
<li>
|
147
|
+
<span class='object_link'><a href="Jylis/Connection/HostMissingError.html" title="Jylis::Connection::HostMissingError (class)">HostMissingError</a></span>
|
148
|
+
|
149
|
+
<small>(Jylis::Connection)</small>
|
150
|
+
|
151
|
+
</li>
|
152
|
+
|
153
|
+
</ul>
|
154
|
+
</ul>
|
155
|
+
|
156
|
+
|
82
157
|
<ul id="alpha_J" class="alpha">
|
83
158
|
<li class="letter">J</li>
|
84
159
|
<ul>
|
@@ -91,6 +166,112 @@
|
|
91
166
|
</ul>
|
92
167
|
</ul>
|
93
168
|
|
169
|
+
|
170
|
+
<ul id="alpha_M" class="alpha">
|
171
|
+
<li class="letter">M</li>
|
172
|
+
<ul>
|
173
|
+
|
174
|
+
<li>
|
175
|
+
<span class='object_link'><a href="Jylis/DataType/MVREG.html" title="Jylis::DataType::MVREG (class)">MVREG</a></span>
|
176
|
+
|
177
|
+
<small>(Jylis::DataType)</small>
|
178
|
+
|
179
|
+
</li>
|
180
|
+
|
181
|
+
</ul>
|
182
|
+
</ul>
|
183
|
+
|
184
|
+
|
185
|
+
</td><td valign='top' width="33%">
|
186
|
+
|
187
|
+
|
188
|
+
<ul id="alpha_P" class="alpha">
|
189
|
+
<li class="letter">P</li>
|
190
|
+
<ul>
|
191
|
+
|
192
|
+
<li>
|
193
|
+
<span class='object_link'><a href="Jylis/DataType/PNCOUNT.html" title="Jylis::DataType::PNCOUNT (class)">PNCOUNT</a></span>
|
194
|
+
|
195
|
+
<small>(Jylis::DataType)</small>
|
196
|
+
|
197
|
+
</li>
|
198
|
+
|
199
|
+
</ul>
|
200
|
+
</ul>
|
201
|
+
|
202
|
+
|
203
|
+
<ul id="alpha_R" class="alpha">
|
204
|
+
<li class="letter">R</li>
|
205
|
+
<ul>
|
206
|
+
|
207
|
+
<li>
|
208
|
+
<span class='object_link'><a href="Jylis/DataType/TLOG/Result.html" title="Jylis::DataType::TLOG::Result (class)">Result</a></span>
|
209
|
+
|
210
|
+
<small>(Jylis::DataType::TLOG)</small>
|
211
|
+
|
212
|
+
</li>
|
213
|
+
|
214
|
+
<li>
|
215
|
+
<span class='object_link'><a href="Jylis/DataType/TREG/Result.html" title="Jylis::DataType::TREG::Result (class)">Result</a></span>
|
216
|
+
|
217
|
+
<small>(Jylis::DataType::TREG)</small>
|
218
|
+
|
219
|
+
</li>
|
220
|
+
|
221
|
+
<li>
|
222
|
+
<span class='object_link'><a href="Jylis/DataType/TLOG/Row.html" title="Jylis::DataType::TLOG::Row (class)">Row</a></span>
|
223
|
+
|
224
|
+
<small>(Jylis::DataType::TLOG)</small>
|
225
|
+
|
226
|
+
</li>
|
227
|
+
|
228
|
+
</ul>
|
229
|
+
</ul>
|
230
|
+
|
231
|
+
|
232
|
+
<ul id="alpha_T" class="alpha">
|
233
|
+
<li class="letter">T</li>
|
234
|
+
<ul>
|
235
|
+
|
236
|
+
<li>
|
237
|
+
<span class='object_link'><a href="Jylis/DataType/TLOG.html" title="Jylis::DataType::TLOG (class)">TLOG</a></span>
|
238
|
+
|
239
|
+
<small>(Jylis::DataType)</small>
|
240
|
+
|
241
|
+
</li>
|
242
|
+
|
243
|
+
<li>
|
244
|
+
<span class='object_link'><a href="Jylis/DataType/TREG.html" title="Jylis::DataType::TREG (class)">TREG</a></span>
|
245
|
+
|
246
|
+
<small>(Jylis::DataType)</small>
|
247
|
+
|
248
|
+
</li>
|
249
|
+
|
250
|
+
</ul>
|
251
|
+
</ul>
|
252
|
+
|
253
|
+
|
254
|
+
<ul id="alpha_U" class="alpha">
|
255
|
+
<li class="letter">U</li>
|
256
|
+
<ul>
|
257
|
+
|
258
|
+
<li>
|
259
|
+
<span class='object_link'><a href="Jylis/DataType/UJSON.html" title="Jylis::DataType::UJSON (class)">UJSON</a></span>
|
260
|
+
|
261
|
+
<small>(Jylis::DataType)</small>
|
262
|
+
|
263
|
+
</li>
|
264
|
+
|
265
|
+
<li>
|
266
|
+
<span class='object_link'><a href="Jylis/Connection/UnsupportedSchemaError.html" title="Jylis::Connection::UnsupportedSchemaError (class)">UnsupportedSchemaError</a></span>
|
267
|
+
|
268
|
+
<small>(Jylis::Connection)</small>
|
269
|
+
|
270
|
+
</li>
|
271
|
+
|
272
|
+
</ul>
|
273
|
+
</ul>
|
274
|
+
|
94
275
|
</td>
|
95
276
|
</tr>
|
96
277
|
</table>
|
@@ -100,9 +281,9 @@
|
|
100
281
|
</div>
|
101
282
|
|
102
283
|
<div id="footer">
|
103
|
-
Generated on
|
284
|
+
Generated on Sun Jun 3 21:46:59 2018 by
|
104
285
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
105
|
-
0.9.
|
286
|
+
0.9.14 (ruby-2.5.1).
|
106
287
|
</div>
|
107
288
|
|
108
289
|
</div>
|
data/doc/class_list.html
CHANGED
@@ -43,7 +43,7 @@
|
|
43
43
|
|
44
44
|
<ul id="full_list" class="class">
|
45
45
|
<li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
|
46
|
-
<li id='object_Jylis' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span> < Object<small class='search_info'>Top Level Namespace</small></div></li>
|
46
|
+
<li id='object_Jylis' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span> < Object<small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Jylis::Connection' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Jylis/Connection.html" title="Jylis::Connection (class)">Connection</a></span> < Object<small class='search_info'>Jylis</small></div><ul><li id='object_Jylis::Connection::HostMissingError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Jylis/Connection/HostMissingError.html" title="Jylis::Connection::HostMissingError (class)">HostMissingError</a></span> < StandardError<small class='search_info'>Jylis::Connection</small></div></li><li id='object_Jylis::Connection::UnsupportedSchemaError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Jylis/Connection/UnsupportedSchemaError.html" title="Jylis::Connection::UnsupportedSchemaError (class)">UnsupportedSchemaError</a></span> < StandardError<small class='search_info'>Jylis::Connection</small></div></li></ul></li><li id='object_Jylis::DataType' class='collapsed even'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Jylis/DataType.html" title="Jylis::DataType (module)">DataType</a></span><small class='search_info'>Jylis</small></div><ul><li id='object_Jylis::DataType::Base' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Jylis/DataType/Base.html" title="Jylis::DataType::Base (class)">Base</a></span> < Object<small class='search_info'>Jylis::DataType</small></div></li><li id='object_Jylis::DataType::GCOUNT' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Jylis/DataType/GCOUNT.html" title="Jylis::DataType::GCOUNT (class)">GCOUNT</a></span> < Base<small class='search_info'>Jylis::DataType</small></div></li><li id='object_Jylis::DataType::MVREG' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Jylis/DataType/MVREG.html" title="Jylis::DataType::MVREG (class)">MVREG</a></span> < Base<small class='search_info'>Jylis::DataType</small></div></li><li id='object_Jylis::DataType::PNCOUNT' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Jylis/DataType/PNCOUNT.html" title="Jylis::DataType::PNCOUNT (class)">PNCOUNT</a></span> < Base<small class='search_info'>Jylis::DataType</small></div></li><li id='object_Jylis::DataType::TLOG' class='collapsed'><div class='item' style='padding-left:60px'><a class='toggle'></a> <span class='object_link'><a href="Jylis/DataType/TLOG.html" title="Jylis::DataType::TLOG (class)">TLOG</a></span> < Base<small class='search_info'>Jylis::DataType</small></div><ul><li id='object_Jylis::DataType::TLOG::Result' class='collapsed'><div class='item' style='padding-left:75px'><span class='object_link'><a href="Jylis/DataType/TLOG/Result.html" title="Jylis::DataType::TLOG::Result (class)">Result</a></span> < Object<small class='search_info'>Jylis::DataType::TLOG</small></div></li><li id='object_Jylis::DataType::TLOG::Row' class='collapsed'><div class='item' style='padding-left:75px'><span class='object_link'><a href="Jylis/DataType/TLOG/Row.html" title="Jylis::DataType::TLOG::Row (class)">Row</a></span> < Object<small class='search_info'>Jylis::DataType::TLOG</small></div></li></ul></li><li id='object_Jylis::DataType::TREG' class='collapsed'><div class='item' style='padding-left:60px'><a class='toggle'></a> <span class='object_link'><a href="Jylis/DataType/TREG.html" title="Jylis::DataType::TREG (class)">TREG</a></span> < Base<small class='search_info'>Jylis::DataType</small></div><ul><li id='object_Jylis::DataType::TREG::Result' class='collapsed'><div class='item' style='padding-left:75px'><span class='object_link'><a href="Jylis/DataType/TREG/Result.html" title="Jylis::DataType::TREG::Result (class)">Result</a></span> < Object<small class='search_info'>Jylis::DataType::TREG</small></div></li></ul></li><li id='object_Jylis::DataType::UJSON' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Jylis/DataType/UJSON.html" title="Jylis::DataType::UJSON (class)">UJSON</a></span> < Base<small class='search_info'>Jylis::DataType</small></div></li></ul></li></ul></li>
|
47
47
|
|
48
48
|
</ul>
|
49
49
|
</div>
|
data/doc/file.README.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
File: README
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.14
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -60,6 +60,15 @@
|
|
60
60
|
<div id="content"><div id='filecontents'>
|
61
61
|
<h1 id="label-jylis-rb">jylis-rb</h1>
|
62
62
|
|
63
|
+
<p><a href="https://badge.fury.io/rb/jylis-rb"><img
|
64
|
+
src="https://badge.fury.io/rb/jylis-rb.svg"></a> <a
|
65
|
+
href="https://coveralls.io/github/amclain/jylis-rb?branch=master"><img
|
66
|
+
src="https://coveralls.io/repos/github/amclain/jylis-rb/badge.svg?branch=master"></a>
|
67
|
+
<a href="http://www.rubydoc.info/gems/jylis-rb"><img
|
68
|
+
src="http://img.shields.io/badge/docs-api-blue.svg"></a> <a
|
69
|
+
href="https://github.com/amclain/jylis-rb/blob/master/license.txt"><img
|
70
|
+
src="https://img.shields.io/badge/license-MIT-yellowgreen.svg"></a></p>
|
71
|
+
|
63
72
|
<p>An idiomatic library for connecting a Ruby project to a <a
|
64
73
|
href="https://github.com/jemc/jylis">Jylis</a> database.</p>
|
65
74
|
|
@@ -67,12 +76,223 @@ href="https://github.com/jemc/jylis">Jylis</a> database.</p>
|
|
67
76
|
<p>Jylis is a distributed in-memory database for Conflict-free Replicated Data
|
68
77
|
Types (CRDTs), built for speed, scalability, availability, and ease of use.</p>
|
69
78
|
</blockquote>
|
79
|
+
|
80
|
+
<h2 id="label-Installation">Installation</h2>
|
81
|
+
|
82
|
+
<p>Install this library from the Ruby package manager with the following
|
83
|
+
command:</p>
|
84
|
+
|
85
|
+
<pre class="code ruby"><code class="ruby">$ gem install jylis-rb
|
86
|
+
</code></pre>
|
87
|
+
|
88
|
+
<p>Add the following <code>require</code> to your project:</p>
|
89
|
+
|
90
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>jylis-rb</span><span class='tstring_end'>'</span></span>
|
91
|
+
</code></pre>
|
92
|
+
|
93
|
+
<p>The library is now ready for use.</p>
|
94
|
+
|
95
|
+
<h3 id="label-Installing+From+Source">Installing From Source</h3>
|
96
|
+
|
97
|
+
<p>If you choose not to use a version of the gem provided by the package
|
98
|
+
manager, you may alternatively install this library from the source code.
|
99
|
+
This section can be skipped if you have already installed the gem from the
|
100
|
+
package manager.</p>
|
101
|
+
|
102
|
+
<p>Ensure <code>bundler</code> and <code>rake</code> are installed:</p>
|
103
|
+
|
104
|
+
<pre class="code ruby"><code class="ruby">$ gem install bundler
|
105
|
+
$ gem install rake
|
106
|
+
</code></pre>
|
107
|
+
|
108
|
+
<p>Clone the repository and navigate inside the project directory:</p>
|
109
|
+
|
110
|
+
<pre class="code ruby"><code class="ruby">$ git clone git@github.com:amclain/jylis-rb.git
|
111
|
+
$ cd jylis-rb
|
112
|
+
</code></pre>
|
113
|
+
|
114
|
+
<p>Install the dependencies:</p>
|
115
|
+
|
116
|
+
<pre class="code ruby"><code class="ruby">$ bundle install
|
117
|
+
</code></pre>
|
118
|
+
|
119
|
+
<p>Ensure the tests pass:</p>
|
120
|
+
|
121
|
+
<pre class="code ruby"><code class="ruby">$ rake
|
122
|
+
</code></pre>
|
123
|
+
|
124
|
+
<p>Install the gem from the working source code:</p>
|
125
|
+
|
126
|
+
<pre class="code ruby"><code class="ruby">$ rake install
|
127
|
+
</code></pre>
|
128
|
+
|
129
|
+
<h2 id="label-Database+Connection">Database Connection</h2>
|
130
|
+
|
131
|
+
<p>The connection URI must be specified in the format:
|
132
|
+
<code>schema://host:port</code>, where the schema is <code>jylis</code>.
|
133
|
+
The <code>host</code> can be a host name, IP address, or domain name of the
|
134
|
+
database host to connect to. The <code>port</code> is optional and defaults
|
135
|
+
to <code>6379</code> unless otherwise specified.</p>
|
136
|
+
|
137
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_connect'><span class='object_link'><a href="Jylis.html#connect-class_method" title="Jylis.connect (method)">connect</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>jylis://host:port</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
138
|
+
</code></pre>
|
139
|
+
|
140
|
+
<h2 id="label-Queries">Queries</h2>
|
141
|
+
|
142
|
+
<p>This library aims to be idiomatic with both Ruby and Jylis. Therefore, the
|
143
|
+
syntax of the queries closely match the <a
|
144
|
+
href="https://jemc.github.io/jylis/docs/types/">Jylis documentation</a> and
|
145
|
+
ideally it should feel so natural to you, a Ruby programmer, that you
|
146
|
+
don't need to read the documentation for this library (although this
|
147
|
+
library is thoroughly documented in the case that you do).</p>
|
148
|
+
|
149
|
+
<p>For example, take the case of a Jylis query to set a value for a <a
|
150
|
+
href="https://jemc.github.io/jylis/docs/types/ujson/#set-key-key-ujson">UJSON</a>
|
151
|
+
key:</p>
|
152
|
+
|
153
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>UJSON</span> <span class='const'>SET</span> <span class='id identifier rubyid_fruit'>fruit</span> <span class='id identifier rubyid_apple'>apple</span> <span class='id identifier rubyid_properties'>properties</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>{"color": "red", "ripe": true}</span><span class='tstring_end'>'</span></span>
|
154
|
+
</code></pre>
|
155
|
+
|
156
|
+
<p>Using this library, the query looks like this:</p>
|
157
|
+
|
158
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>fruit</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>apple</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>properties</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>color:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>red</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>ripe:</span> <span class='kw'>true</span><span class='rbrace'>}</span>
|
159
|
+
</code></pre>
|
160
|
+
|
161
|
+
<p>The format for a query is:</p>
|
162
|
+
|
163
|
+
<pre class="code ruby"><code class="ruby">Jylis.<data_type>.<function> key(s), [value], [timestamp]
|
164
|
+
</code></pre>
|
165
|
+
|
166
|
+
<p>However, be sure to consult the <a
|
167
|
+
href="http://www.rubydoc.info/gems/jylis-rb">API documentation</a> or the
|
168
|
+
<a href="https://jemc.github.io/jylis/docs/types/">Jylis documentation</a>
|
169
|
+
for the exact format of your particular query.</p>
|
170
|
+
|
171
|
+
<h3 id="label-TREG">TREG</h3>
|
172
|
+
|
173
|
+
<p>Timestamped Register
|
174
|
+
<sup>[link[https://jemc.github.io/jylis/docs/types/treg/]]</sup></p>
|
175
|
+
|
176
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_treg'><span class='object_link'><a href="Jylis.html#treg-class_method" title="Jylis.treg (method)">treg</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/TREG.html#set-instance_method" title="Jylis::DataType::TREG#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lamp_brightness</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>80</span><span class='comma'>,</span> <span class='int'>1528082143</span>
|
177
|
+
|
178
|
+
<span class='id identifier rubyid_result'>result</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='period'>.</span><span class='id identifier rubyid_treg'><span class='object_link'><a href="Jylis.html#treg-class_method" title="Jylis.treg (method)">treg</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/TREG.html#get-instance_method" title="Jylis::DataType::TREG#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lamp_brightness</span><span class='tstring_end'>"</span></span>
|
179
|
+
<span class='comment'># => #<Jylis::DataType::TREG::Result:0x00005598dd3941c8 @timestamp=1528082143, @value="80">
|
180
|
+
</span>
|
181
|
+
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
|
182
|
+
<span class='comment'># => "80"
|
183
|
+
</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_timestamp'>timestamp</span>
|
184
|
+
<span class='comment'># => 1528082143
|
185
|
+
</span></code></pre>
|
186
|
+
|
187
|
+
<h3 id="label-TLOG">TLOG</h3>
|
188
|
+
|
189
|
+
<p>Timestamped Log
|
190
|
+
<sup>[link[https://jemc.github.io/jylis/docs/types/tlog/]]</sup></p>
|
191
|
+
|
192
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tlog'><span class='object_link'><a href="Jylis.html#tlog-class_method" title="Jylis.tlog (method)">tlog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ins'><span class='object_link'><a href="Jylis/DataType/TLOG.html#ins-instance_method" title="Jylis::DataType::TLOG#ins (method)">ins</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='float'>68.8</span><span class='comma'>,</span> <span class='int'>1528082150</span>
|
193
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tlog'><span class='object_link'><a href="Jylis.html#tlog-class_method" title="Jylis.tlog (method)">tlog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ins'><span class='object_link'><a href="Jylis/DataType/TLOG.html#ins-instance_method" title="Jylis::DataType::TLOG#ins (method)">ins</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='float'>70.1</span><span class='comma'>,</span> <span class='int'>1528082160</span>
|
194
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tlog'><span class='object_link'><a href="Jylis.html#tlog-class_method" title="Jylis.tlog (method)">tlog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ins'><span class='object_link'><a href="Jylis/DataType/TLOG.html#ins-instance_method" title="Jylis::DataType::TLOG#ins (method)">ins</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='float'>73.6</span><span class='comma'>,</span> <span class='int'>1528082170</span>
|
195
|
+
|
196
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tlog'><span class='object_link'><a href="Jylis.html#tlog-class_method" title="Jylis.tlog (method)">tlog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_size'><span class='object_link'><a href="Jylis/DataType/TLOG.html#size-instance_method" title="Jylis::DataType::TLOG#size (method)">size</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span>
|
197
|
+
<span class='comment'># => 3
|
198
|
+
</span>
|
199
|
+
<span class='id identifier rubyid_result'>result</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='period'>.</span><span class='id identifier rubyid_tlog'><span class='object_link'><a href="Jylis.html#tlog-class_method" title="Jylis.tlog (method)">tlog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/TLOG.html#get-instance_method" title="Jylis::DataType::TLOG#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span>
|
200
|
+
<span class='comment'># => #<Jylis::DataType::TLOG::Result:0x00005598dd345d20
|
201
|
+
</span><span class='comment'># @rows=
|
202
|
+
</span><span class='comment'># [#<Jylis::DataType::TLOG::Row:0x00005598dd345d98 @timestamp=1528082170, @value="73.6">,
|
203
|
+
</span><span class='comment'># #<Jylis::DataType::TLOG::Row:0x00005598dd345d70 @timestamp=1528082160, @value="70.1">,
|
204
|
+
</span><span class='comment'># #<Jylis::DataType::TLOG::Row:0x00005598dd345d48 @timestamp=1528082150, @value="68.8">]>
|
205
|
+
</span>
|
206
|
+
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
|
207
|
+
<span class='comment'># => "73.6"
|
208
|
+
</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_timestamp'>timestamp</span>
|
209
|
+
<span class='comment'># => 1528082170
|
210
|
+
</span>
|
211
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tlog'><span class='object_link'><a href="Jylis.html#tlog-class_method" title="Jylis.tlog (method)">tlog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_trim'><span class='object_link'><a href="Jylis/DataType/TLOG.html#trim-instance_method" title="Jylis::DataType::TLOG#trim (method)">trim</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>1</span>
|
212
|
+
|
213
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tlog'><span class='object_link'><a href="Jylis.html#tlog-class_method" title="Jylis.tlog (method)">tlog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/TLOG.html#get-instance_method" title="Jylis::DataType::TLOG#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span>
|
214
|
+
<span class='comment'># => #<Jylis::DataType::TLOG::Result:0x00005598dd2faac8
|
215
|
+
</span><span class='comment'># @rows=[#<Jylis::DataType::TLOG::Row:0x00005598dd2faaf0 @timestamp=1528082170, @value="73.6">]>
|
216
|
+
</span>
|
217
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tlog'><span class='object_link'><a href="Jylis.html#tlog-class_method" title="Jylis.tlog (method)">tlog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_cutoff'><span class='object_link'><a href="Jylis/DataType/TLOG.html#cutoff-instance_method" title="Jylis::DataType::TLOG#cutoff (method)">cutoff</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span>
|
218
|
+
<span class='comment'># => 1528082170
|
219
|
+
</span></code></pre>
|
220
|
+
|
221
|
+
<h3 id="label-GCOUNT">GCOUNT</h3>
|
222
|
+
|
223
|
+
<p>Grow-Only Counter
|
224
|
+
<sup>[link[https://jemc.github.io/jylis/docs/types/gcount/]]</sup></p>
|
225
|
+
|
226
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_gcount'><span class='object_link'><a href="Jylis.html#gcount-class_method" title="Jylis.gcount (method)">gcount</a></span></span><span class='period'>.</span><span class='id identifier rubyid_inc'><span class='object_link'><a href="Jylis/DataType/GCOUNT.html#inc-instance_method" title="Jylis::DataType::GCOUNT#inc (method)">inc</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>mileage</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>10</span>
|
227
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_gcount'><span class='object_link'><a href="Jylis.html#gcount-class_method" title="Jylis.gcount (method)">gcount</a></span></span><span class='period'>.</span><span class='id identifier rubyid_inc'><span class='object_link'><a href="Jylis/DataType/GCOUNT.html#inc-instance_method" title="Jylis::DataType::GCOUNT#inc (method)">inc</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>mileage</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>5</span>
|
228
|
+
|
229
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_gcount'><span class='object_link'><a href="Jylis.html#gcount-class_method" title="Jylis.gcount (method)">gcount</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/GCOUNT.html#get-instance_method" title="Jylis::DataType::GCOUNT#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>mileage</span><span class='tstring_end'>"</span></span>
|
230
|
+
<span class='comment'># => 15
|
231
|
+
</span></code></pre>
|
232
|
+
|
233
|
+
<h3 id="label-PNCOUNT">PNCOUNT</h3>
|
234
|
+
|
235
|
+
<p>Positive/Negative Counter
|
236
|
+
<sup>[link[https://jemc.github.io/jylis/docs/types/pncount/]]</sup></p>
|
237
|
+
|
238
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_pncount'><span class='object_link'><a href="Jylis.html#pncount-class_method" title="Jylis.pncount (method)">pncount</a></span></span><span class='period'>.</span><span class='id identifier rubyid_inc'><span class='object_link'><a href="Jylis/DataType/PNCOUNT.html#inc-instance_method" title="Jylis::DataType::PNCOUNT#inc (method)">inc</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>subscribers</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>3</span>
|
239
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_pncount'><span class='object_link'><a href="Jylis.html#pncount-class_method" title="Jylis.pncount (method)">pncount</a></span></span><span class='period'>.</span><span class='id identifier rubyid_dec'><span class='object_link'><a href="Jylis/DataType/PNCOUNT.html#dec-instance_method" title="Jylis::DataType::PNCOUNT#dec (method)">dec</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>subscribers</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>1</span>
|
240
|
+
|
241
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_pncount'><span class='object_link'><a href="Jylis.html#pncount-class_method" title="Jylis.pncount (method)">pncount</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/PNCOUNT.html#get-instance_method" title="Jylis::DataType::PNCOUNT#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>subscribers</span><span class='tstring_end'>"</span></span>
|
242
|
+
<span class='comment'># => 2
|
243
|
+
</span></code></pre>
|
244
|
+
|
245
|
+
<h3 id="label-MVREG">MVREG</h3>
|
246
|
+
|
247
|
+
<p>Multi-Value Register
|
248
|
+
<sup>[link[https://jemc.github.io/jylis/docs/types/mvreg/]]</sup></p>
|
249
|
+
|
250
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_mvreg'><span class='object_link'><a href="Jylis.html#mvreg-class_method" title="Jylis.mvreg (method)">mvreg</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/MVREG.html#set-instance_method" title="Jylis::DataType::MVREG#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>thermostat</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>68</span>
|
251
|
+
|
252
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_mvreg'><span class='object_link'><a href="Jylis.html#mvreg-class_method" title="Jylis.mvreg (method)">mvreg</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/MVREG.html#get-instance_method" title="Jylis::DataType::MVREG#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>thermostat</span><span class='tstring_end'>"</span></span>
|
253
|
+
<span class='comment'># => ["68"]
|
254
|
+
</span></code></pre>
|
255
|
+
|
256
|
+
<h3 id="label-UJSON">UJSON</h3>
|
257
|
+
|
258
|
+
<p>Unordered JSON
|
259
|
+
<sup>[link[https://jemc.github.io/jylis/docs/types/ujson/]]</sup></p>
|
260
|
+
|
261
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>users</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>alice</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>admin</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>false</span>
|
262
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>users</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brett</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>admin</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>false</span>
|
263
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>users</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>carol</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>admin</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>true</span>
|
264
|
+
|
265
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/UJSON.html#get-instance_method" title="Jylis::DataType::UJSON#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>users</span><span class='tstring_end'>"</span></span>
|
266
|
+
<span class='comment'># => {"brett"=>{"admin"=>false}, "carol"=>{"admin"=>true}, "alice"=>{"admin"=>false}}
|
267
|
+
</span>
|
268
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ins'><span class='object_link'><a href="Jylis/DataType/UJSON.html#ins-instance_method" title="Jylis::DataType::UJSON#ins (method)">ins</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>users</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brett</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>banned</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>true</span>
|
269
|
+
|
270
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_clr'><span class='object_link'><a href="Jylis/DataType/UJSON.html#clr-instance_method" title="Jylis::DataType::UJSON#clr (method)">clr</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>users</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>alice</span><span class='tstring_end'>"</span></span>
|
271
|
+
|
272
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/UJSON.html#get-instance_method" title="Jylis::DataType::UJSON#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>users</span><span class='tstring_end'>"</span></span>
|
273
|
+
<span class='comment'># => {"brett"=>{"banned"=>true, "admin"=>false}, "carol"=>{"admin"=>true}}
|
274
|
+
</span></code></pre>
|
275
|
+
|
276
|
+
<h3 id="label-Raw+Query">Raw Query</h3>
|
277
|
+
|
278
|
+
<p>If this library doesn't contain a method for the query you would like
|
279
|
+
to perform, you can construct the query yourself by calling
|
280
|
+
<code>Jylis.query</code>. However, be aware that this method is
|
281
|
+
non-idiomatic and may require you to do your own pre/post processing on the
|
282
|
+
data.</p>
|
283
|
+
|
284
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="Jylis.html#query-class_method" title="Jylis.query (method)">query</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>TLOG</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>INS</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='float'>72.6</span><span class='comma'>,</span> <span class='int'>5</span>
|
285
|
+
<span class='comment'># => "OK"
|
286
|
+
</span>
|
287
|
+
<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="Jylis.html#query-class_method" title="Jylis.query (method)">query</a></span></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>TLOG</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>GET</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>temperature</span><span class='tstring_end'>"</span></span>
|
288
|
+
<span class='comment'># => [["72.6", 5]]
|
289
|
+
</span></code></pre>
|
70
290
|
</div></div>
|
71
291
|
|
72
292
|
<div id="footer">
|
73
|
-
Generated on
|
293
|
+
Generated on Sun Jun 3 21:46:59 2018 by
|
74
294
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
75
|
-
0.9.
|
295
|
+
0.9.14 (ruby-2.5.1).
|
76
296
|
</div>
|
77
297
|
|
78
298
|
</div>
|