-
Notifications
You must be signed in to change notification settings - Fork 7
/
README
431 lines (305 loc) · 10.3 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
NAME
EV::Tarantool16 - EV client for Tarantool 1.6
VESRION
Version 1.39
SYNOPSIS
use EV::Tarantool16;
my $c; $c = EV::Tarantool16->new({
host => '127.0.0.1',
port => 3301,
username => 'test_user',
password => 'test_passwd',
reconnect => 0.2,
connected => sub {
warn "connected: @_";
EV::unloop;
},
connfail => sub {
warn "connfail: @_ / $!";
EV::unloop;
},
disconnected => sub {
warn "discon: @_ / $!";
EV::unloop;
},
});
$c->connect;
EV::loop;
$c->ping(sub {
my $a = @_[0];
diag Dumper \@_ if !$a;
EV::unloop;
});
EV::loop;
SUBROUTINES/METHODS
new {option => value,...}
Create new EV::Tarantool16 instance.
host => $address
Address connect to.
port => $port
Port connect to.
username => $username
Username.
password => $password
Password.
reconnect => $reconnect
Reconnect timeout.
log_level => $log_level
Logging level. Values: (0: None), (1: Error), (2: Warning), (3:
Info), (4: Debug)
cnntrace => $cnntrace
Enable (1) or disable(0) evcnn tracing.
ares_reuse => $ares_reuse
Enable (1) or disable(0) c-ares connection reuse (default = 0).
wbuf_limit => $wbuf_limit
Write vector buffer length limit. Defaults to 16384. Set wbuf_limit
= 0 to disable write buffer length check on every request.
connected => $sub
Called when connection to Tarantool 1.6 instance is established,
authenticated successfully and retrieved spaces information from it.
connfail => $sub
Called when connection to Tarantool 1.6 instance failed.
disconnected => $sub
Called when Tarantool 1.6 instance disconnected.
connect
Connect to Tarantool 1.6 instance. EV::Tarantool16->connected is called
when connection is established.
disconnect
Disconnect from Tarantool 1.6 instance. EV::Tarantool16->disconnected is
called afterwards.
ping $opts, $cb->($result)
Execute ping request
$opts
HASHREF of additional options to the request
timeout => $timeout
Request execution timeout
eval $lua_expression, $tuple_args, $opts, $cb->($result)
Execute eval request
$lua_expression
Lua code that will be run in tarantool
tuple_args
Tuple (ARRAYREF) that will be passed as argument in lua code
$opts
HASHREF of additional options to the request
timeout => $timeout
Request execution timeout
space => $space
This space definition will be used to decode response tuple
in => $in
Format for parsing input (string). One char is for one argument
('s' = string, 'n' = number, 'a' = array, '*' = anything (type
is determined automatically))
call $function_name, $tuple_args, $opts, $cb->($result)
Execute eval request
$function_name
Lua function that will be called in tarantool
tuple_args
Tuple (ARRAYREF) that will be passed as argument in lua code
$opts
HASHREF of additional options to the request
timeout => $timeout
Request execution timeout
space => $space
This space definition will be used to decode response tuple
in => $in
Format for parsing input (string). One char is for one argument
('s' = string, 'n' = number, 'a' = array, '*' = anything (type
is determined automatically))
select $space_name, $keys, $opts, $cb->($result)
Execute select request
$space_name
Tarantool space name.
$keys
Select keys (ARRAYREF or HASHREF).
$opts
HASHREF of additional options to the request
timeout => $timeout
Request execution timeout
hash => $hash
Use hash as result
index => $index
Index name or id to use
limit => $limit
Select limit
offset => $offset
Select offset
iterator => $iterator
Select iterator type. It is recommended to use the predefined
constants EV::Tarantool16::INDEX_#iterator_name# (eg.
EV::Tarantool16::INDEX_EQ, EV::Tarantool16::INDEX_GE and so on).
List of possible iterator names:
* EQ
* REQ
* ALL
* LT
* LE
* GE
* GT
* BITS_ALL_SET
* BITS_ANY_SET
* BITS_ALL_NOT_SET
* OVERLAPS
* NEIGHBOR
You can also use string names as the value to this option (like
'EQ' or 'LT').
in => $in
Format for parsing input (string). One char is for one argument
('s' = string, 'n' = number, 'a' = array, '*' = anything (type
is determined automatically))
insert $space_name, $tuple, $opts, $cb->($result)
Execute insert request
$space_name
Tarantool space name.
$tuple
Tuple to be inserted (ARRAYREF or HASHREF).
$opts
HASHREF of additional options to the request
timeout => $timeout
Request execution timeout
hash => $hash
Use hash as result
replace => $replace
Insert(0) or replace(1) a tuple
in => $in
Format for parsing input (string). One char is for one argument
('s' = string, 'n' = number, 'a' = array, '*' = anything (type
is determined automatically))
replace $space_name, $tuple, $opts, $cb->($result)
Execute replace request (same as insert, but replaces tuple if already
exists). ($opts->{replace} = 1)
update $space_name, $key, $operations, $opts, $cb->($result)
Execute update request
$space_name
Tarantool space name.
$key
Select key where to perform update (ARRAYREF or HASHREF).
$operations
Update operations (ARRAYREF) in this format: [$field_no =>
$operation, $operation_args] Please refer to Tarantool 1.6
documentaion for more details.
$opts
HASHREF of additional options to the request
timeout => $timeout
Request execution timeout
hash => $hash
Use hash as result
index => $index
Index name or id to use
in => $in
Format for parsing input (string). One char is for one argument
('s' = string, 'n' = number, 'a' = array, '*' = anything (type
is determined automatically))
upsert $space_name, $tuple, $operations, $opts, $cb->($result)
Execute upsert request
$space_name
Tarantool space name.
$tuple
A tuple that will be inserted to Tarantool if there is no tuple like
it already (ARRAYREF or HASHREF).
$operations
Update operations (ARRAYREF) in this format: [$field_no =>
$operation, $operation_args] Please refer to Tarantool 1.6
documentaion for more details.
$opts
HASHREF of additional options to the request
timeout => $timeout
Request execution timeout
hash => $hash
Use hash as result
in => $in
Format for parsing input (string). One char is for one argument
('s' = string, 'n' = number, 'a' = array, '*' = anything (type
is determined automatically))
delete $space_name, $key, $opts, $cb->($result)
Execute delete request
$space_name
Tarantool space name.
$key
Select key (ARRAYREF or HASHREF).
$opts
HASHREF of additional options to the request
timeout => $timeout
Request execution timeout
hash => $hash
Use hash as result
index => $index
Index name or id to use
in => $in
Format for parsing input (string). One char is for one argument
('s' = string, 'n' = number, 'a' = array, '*' = anything (type
is determined automatically))
lua $function_name, $args, $opts, $cb->($result)
Execute call request (added for backward compatibility with
EV::Tarantool). See 'call' method.
stats $cb->($result)
Get Tarantool stats
Result
Returns a HASHREF, consisting of the following data:
arena
size
Arena allocated size
used
Arena used size
slabs
Slabs memory use
info
lsn Tarantool log sequence number
lut Last update time (current_time - box_info.replication.idle)
lag Replication lag
pid Process pid
uptime
Server's uptime
op Total operations count for each operation (select, insert, ...)
space
Tuples count in each space
RESULT
Success result
count => 1,
tuples => [
{
_t1 => 'tt1',
_t2 => 'tt2',
_t3 => 456,
_t4 => 5
}
],
status => 'ok',
code => 0,
sync => 5
count
Tuples count
tuples
Tuples themeselves
status
Status string ('ok')
code
Return code (0 if ok, else error code
(<https://github.com/tarantool/tarantool/blob/master/src/box/errcode
.h>))
sync
Request id
Error result
[undef, $error_msg, {
errstr => $error_msg,
status => 'error',
code => $error_code,
sync => 3
}]
errstr
Error string
status
Status string ('error')
code
Return code (0 if ok, else error code
(<https://github.com/tarantool/tarantool/blob/master/src/box/errcode
.h>))
sync
Request id
AUTHOR
igorcoding, <[email protected]>, Mons Anderson, <[email protected]>
BUGS
Please report any bugs or feature requests in
<https://github.com/igorcoding/EV-Tarantool16/issues>
COPYRIGHT AND LICENSE
Copyright (C) 2015 by igorcoding
This program is released under the following license: GPL