1 |
package Redis; |
2 |
|
3 |
use warnings; |
4 |
use strict; |
5 |
|
6 |
use IO::Socket::INET; |
7 |
use Data::Dump qw/dump/; |
8 |
use Carp qw/confess/; |
9 |
|
10 |
=head1 NAME |
11 |
|
12 |
Redis - perl binding for Redis database |
13 |
|
14 |
=cut |
15 |
|
16 |
our $VERSION = '0.01'; |
17 |
|
18 |
|
19 |
=head1 SYNOPSIS |
20 |
|
21 |
Pure perl bindings for L<http://code.google.com/p/redis/> |
22 |
|
23 |
This version support git version of Redis available at |
24 |
L<git://github.com/antirez/redis> |
25 |
|
26 |
use Redis; |
27 |
|
28 |
my $r = Redis->new(); |
29 |
|
30 |
=head1 FUNCTIONS |
31 |
|
32 |
=head2 new |
33 |
|
34 |
=cut |
35 |
|
36 |
our $debug = $ENV{REDIS} || 0; |
37 |
|
38 |
our $sock; |
39 |
my $server = '127.0.0.1:6379'; |
40 |
|
41 |
sub new { |
42 |
my $class = shift; |
43 |
my $self = {}; |
44 |
bless($self, $class); |
45 |
|
46 |
warn "# opening socket to $server"; |
47 |
|
48 |
$sock ||= IO::Socket::INET->new( |
49 |
PeerAddr => $server, |
50 |
Proto => 'tcp', |
51 |
) || die $!; |
52 |
|
53 |
$self; |
54 |
} |
55 |
|
56 |
sub __sock_result { |
57 |
my $result = <$sock>; |
58 |
warn "## result: ",dump( $result ) if $debug; |
59 |
$result =~ s{\r\n$}{} || warn "can't find cr/lf"; |
60 |
return $result; |
61 |
} |
62 |
|
63 |
sub __sock_read_bulk { |
64 |
my $len = <$sock>; |
65 |
warn "## bulk len: ",dump($len) if $debug; |
66 |
return undef if $len eq "nil\r\n"; |
67 |
my $v; |
68 |
if ( $len > 0 ) { |
69 |
read($sock, $v, $len) || die $!; |
70 |
warn "## bulk v: ",dump($v) if $debug; |
71 |
} |
72 |
my $crlf; |
73 |
read($sock, $crlf, 2); # skip cr/lf |
74 |
return $v; |
75 |
} |
76 |
|
77 |
sub _sock_result_bulk { |
78 |
my $self = shift; |
79 |
warn "## _sock_result_bulk ",dump( @_ ) if $debug; |
80 |
print $sock join(' ',@_) . "\r\n"; |
81 |
__sock_read_bulk(); |
82 |
} |
83 |
|
84 |
sub _sock_result_bulk_list { |
85 |
my $self = shift; |
86 |
warn "## _sock_result_bulk_list ",dump( @_ ) if $debug; |
87 |
|
88 |
my $size = $self->_sock_send( @_ ); |
89 |
confess $size unless $size > 0; |
90 |
$size--; |
91 |
|
92 |
my @list = ( 0 .. $size ); |
93 |
foreach ( 0 .. $size ) { |
94 |
$list[ $_ ] = __sock_read_bulk(); |
95 |
} |
96 |
|
97 |
warn "## list = ", dump( @list ) if $debug; |
98 |
return @list; |
99 |
} |
100 |
|
101 |
sub __sock_ok { |
102 |
my $ok = <$sock>; |
103 |
return undef if $ok eq "nil\r\n"; |
104 |
confess dump($ok) unless $ok eq "+OK\r\n"; |
105 |
} |
106 |
|
107 |
sub _sock_send { |
108 |
my $self = shift; |
109 |
warn "## _sock_send ",dump( @_ ) if $debug; |
110 |
print $sock join(' ',@_) . "\r\n"; |
111 |
__sock_result(); |
112 |
} |
113 |
|
114 |
sub _sock_send_ok { |
115 |
my $self = shift; |
116 |
warn "## _sock_send_ok ",dump( @_ ) if $debug; |
117 |
print $sock join(' ',@_) . "\r\n"; |
118 |
__sock_ok(); |
119 |
} |
120 |
|
121 |
sub __sock_send_bulk_raw { |
122 |
warn "## _sock_send_bulk ",dump( @_ ) if $debug; |
123 |
my $value = pop; |
124 |
$value = '' unless defined $value; # FIXME errr? nil? |
125 |
print $sock join(' ',@_) . ' ' . length($value) . "\r\n$value\r\n" |
126 |
} |
127 |
|
128 |
sub _sock_send_bulk { |
129 |
my $self = shift; |
130 |
__sock_send_bulk_raw( @_ ); |
131 |
__sock_ok(); |
132 |
} |
133 |
|
134 |
sub _sock_send_bulk_number { |
135 |
my $self = shift; |
136 |
__sock_send_bulk_raw( @_ ); |
137 |
my $v = __sock_result(); |
138 |
confess $v unless $v =~ m{^\-?\d+$}; |
139 |
return $v; |
140 |
} |
141 |
|
142 |
=head1 Connection Handling |
143 |
|
144 |
=head2 quit |
145 |
|
146 |
$r->quit; |
147 |
|
148 |
=cut |
149 |
|
150 |
sub quit { |
151 |
my $self = shift; |
152 |
|
153 |
close( $sock ) || warn $!; |
154 |
} |
155 |
|
156 |
=head2 ping |
157 |
|
158 |
$r->ping || die "no server?"; |
159 |
|
160 |
=cut |
161 |
|
162 |
sub ping { |
163 |
print $sock "PING\r\n"; |
164 |
my $pong = <$sock>; |
165 |
die "ping failed, got ", dump($pong) unless $pong eq "+PONG\r\n"; |
166 |
} |
167 |
|
168 |
=head1 Commands operating on string values |
169 |
|
170 |
=head2 set |
171 |
|
172 |
$r->set( foo => 'bar', $new ); |
173 |
|
174 |
=cut |
175 |
|
176 |
sub set { |
177 |
my ( $self, $key, $value, $new ) = @_; |
178 |
$self->_sock_send_bulk( "SET" . ( $new ? 'NX' : '' ), $key, $value ); |
179 |
} |
180 |
|
181 |
=head2 get |
182 |
|
183 |
my $value = $r->get( 'foo' ); |
184 |
|
185 |
=cut |
186 |
|
187 |
sub get { |
188 |
my $self = shift; |
189 |
$self->_sock_result_bulk('GET',@_); |
190 |
} |
191 |
|
192 |
=head2 mget |
193 |
|
194 |
my @values = $r->get( 'foo', 'bar', 'baz' ); |
195 |
|
196 |
=cut |
197 |
|
198 |
sub mget { |
199 |
my $self = shift; |
200 |
$self->_sock_result_bulk_list('MGET',@_); |
201 |
} |
202 |
|
203 |
=head2 incr |
204 |
|
205 |
$r->incr('counter'); |
206 |
$r->incr('tripplets', 3); |
207 |
|
208 |
=cut |
209 |
|
210 |
|
211 |
|
212 |
sub incr { |
213 |
my $self = shift; |
214 |
$self->_sock_send( 'INCR' . ( $#_ ? 'BY' : '' ), @_ ); |
215 |
} |
216 |
|
217 |
=head2 decr |
218 |
|
219 |
$r->decr('counter'); |
220 |
$r->decr('tripplets', 3); |
221 |
|
222 |
=cut |
223 |
|
224 |
sub decr { |
225 |
my $self = shift; |
226 |
$self->_sock_send( 'DECR' . ( $#_ ? 'BY' : '' ), @_ ); |
227 |
} |
228 |
|
229 |
=head2 exists |
230 |
|
231 |
$r->exists( 'key' ) && print "got key!"; |
232 |
|
233 |
=cut |
234 |
|
235 |
sub exists { |
236 |
my ( $self, $key ) = @_; |
237 |
$self->_sock_send( 'EXISTS', $key ); |
238 |
} |
239 |
|
240 |
=head2 del |
241 |
|
242 |
$r->del( 'key' ) || warn "key doesn't exist"; |
243 |
|
244 |
=cut |
245 |
|
246 |
sub del { |
247 |
my ( $self, $key ) = @_; |
248 |
$self->_sock_send( 'DEL', $key ); |
249 |
} |
250 |
|
251 |
=head2 type |
252 |
|
253 |
$r->type( 'key' ); # = string |
254 |
|
255 |
=cut |
256 |
|
257 |
sub type { |
258 |
my ( $self, $key ) = @_; |
259 |
$self->_sock_send( 'TYPE', $key ); |
260 |
} |
261 |
|
262 |
=head1 Commands operating on the key space |
263 |
|
264 |
=head2 keys |
265 |
|
266 |
my @keys = $r->keys( '*glob_pattern*' ); |
267 |
|
268 |
=cut |
269 |
|
270 |
sub keys { |
271 |
my ( $self, $glob ) = @_; |
272 |
my $keys = $self->_sock_result_bulk( 'KEYS', $glob ); |
273 |
return split(/\s/, $keys) if $keys; |
274 |
return () if wantarray; |
275 |
} |
276 |
|
277 |
=head2 randomkey |
278 |
|
279 |
my $key = $r->randomkey; |
280 |
|
281 |
=cut |
282 |
|
283 |
sub randomkey { |
284 |
my ( $self ) = @_; |
285 |
$self->_sock_send( 'RANDOMKEY' ); |
286 |
} |
287 |
|
288 |
=head2 rename |
289 |
|
290 |
my $ok = $r->rename( 'old-key', 'new-key', $new ); |
291 |
|
292 |
=cut |
293 |
|
294 |
sub rename { |
295 |
my ( $self, $old, $new, $nx ) = @_; |
296 |
$self->_sock_send_ok( 'RENAME' . ( $nx ? 'NX' : '' ), $old, $new ); |
297 |
} |
298 |
|
299 |
=head2 dbsize |
300 |
|
301 |
my $nr_keys = $r->dbsize; |
302 |
|
303 |
=cut |
304 |
|
305 |
sub dbsize { |
306 |
my ( $self ) = @_; |
307 |
$self->_sock_send('DBSIZE'); |
308 |
} |
309 |
|
310 |
=head1 Commands operating on lists |
311 |
|
312 |
See also L<Redis::List> for tie interface. |
313 |
|
314 |
=head2 rpush |
315 |
|
316 |
$r->rpush( $key, $value ); |
317 |
|
318 |
=cut |
319 |
|
320 |
sub rpush { |
321 |
my ( $self, $key, $value ) = @_; |
322 |
$self->_sock_send_bulk('RPUSH', $key, $value); |
323 |
} |
324 |
|
325 |
=head2 lpush |
326 |
|
327 |
$r->lpush( $key, $value ); |
328 |
|
329 |
=cut |
330 |
|
331 |
sub lpush { |
332 |
my ( $self, $key, $value ) = @_; |
333 |
$self->_sock_send_bulk('LPUSH', $key, $value); |
334 |
} |
335 |
|
336 |
=head2 llen |
337 |
|
338 |
$r->llen( $key ); |
339 |
|
340 |
=cut |
341 |
|
342 |
sub llen { |
343 |
my ( $self, $key ) = @_; |
344 |
$self->_sock_send( 'LLEN', $key ); |
345 |
} |
346 |
|
347 |
=head2 lrange |
348 |
|
349 |
my @list = $r->lrange( $key, $start, $end ); |
350 |
|
351 |
=cut |
352 |
|
353 |
sub lrange { |
354 |
my ( $self, $key, $start, $end ) = @_; |
355 |
$self->_sock_result_bulk_list('LRANGE', $key, $start, $end); |
356 |
} |
357 |
|
358 |
=head2 ltrim |
359 |
|
360 |
my $ok = $r->ltrim( $key, $start, $end ); |
361 |
|
362 |
=cut |
363 |
|
364 |
sub ltrim { |
365 |
my ( $self, $key, $start, $end ) = @_; |
366 |
$self->_sock_send_ok( 'LTRIM', $key, $start, $end ); |
367 |
} |
368 |
|
369 |
=head2 lindex |
370 |
|
371 |
$r->lindex( $key, $index ); |
372 |
|
373 |
=cut |
374 |
|
375 |
sub lindex { |
376 |
my ( $self, $key, $index ) = @_; |
377 |
$self->_sock_result_bulk( 'LINDEX', $key, $index ); |
378 |
} |
379 |
|
380 |
=head2 lset |
381 |
|
382 |
$r->lset( $key, $index, $value ); |
383 |
|
384 |
=cut |
385 |
|
386 |
sub lset { |
387 |
my ( $self, $key, $index, $value ) = @_; |
388 |
$self->_sock_send_bulk( 'LSET', $key, $index, $value ); |
389 |
} |
390 |
|
391 |
=head2 lrem |
392 |
|
393 |
my $modified_count = $r->lrem( $key, $count, $value ); |
394 |
|
395 |
=cut |
396 |
|
397 |
sub lrem { |
398 |
my ( $self, $key, $count, $value ) = @_; |
399 |
$self->_sock_send_bulk_number( 'LREM', $key, $count, $value ); |
400 |
} |
401 |
|
402 |
=head2 lpop |
403 |
|
404 |
my $value = $r->lpop( $key ); |
405 |
|
406 |
=cut |
407 |
|
408 |
sub lpop { |
409 |
my ( $self, $key ) = @_; |
410 |
$self->_sock_result_bulk( 'LPOP', $key ); |
411 |
} |
412 |
|
413 |
=head2 rpop |
414 |
|
415 |
my $value = $r->rpop( $key ); |
416 |
|
417 |
=cut |
418 |
|
419 |
sub rpop { |
420 |
my ( $self, $key ) = @_; |
421 |
$self->_sock_result_bulk( 'RPOP', $key ); |
422 |
} |
423 |
|
424 |
=head1 Commands operating on sets |
425 |
|
426 |
=head2 sadd |
427 |
|
428 |
$r->sadd( $key, $member ); |
429 |
|
430 |
=cut |
431 |
|
432 |
sub sadd { |
433 |
my ( $self, $key, $member ) = @_; |
434 |
$self->_sock_send_bulk_number( 'SADD', $key, $member ); |
435 |
} |
436 |
|
437 |
=head2 srem |
438 |
|
439 |
$r->srem( $key, $member ); |
440 |
|
441 |
=cut |
442 |
|
443 |
sub srem { |
444 |
my ( $self, $key, $member ) = @_; |
445 |
$self->_sock_send_bulk_number( 'SREM', $key, $member ); |
446 |
} |
447 |
|
448 |
=head2 scard |
449 |
|
450 |
my $elements = $r->scard( $key ); |
451 |
|
452 |
=cut |
453 |
|
454 |
sub scard { |
455 |
my ( $self, $key ) = @_; |
456 |
$self->_sock_send( 'SCARD', $key ); |
457 |
} |
458 |
|
459 |
=head2 sismember |
460 |
|
461 |
$r->sismember( $key, $member ); |
462 |
|
463 |
=cut |
464 |
|
465 |
sub sismember { |
466 |
my ( $self, $key, $member ) = @_; |
467 |
$self->_sock_send_bulk_number( 'SISMEMBER', $key, $member ); |
468 |
} |
469 |
|
470 |
=head2 sinter |
471 |
|
472 |
$r->sinter( $key1, $key2, ... ); |
473 |
|
474 |
=cut |
475 |
|
476 |
sub sinter { |
477 |
my $self = shift; |
478 |
$self->_sock_result_bulk_list( 'SINTER', @_ ); |
479 |
} |
480 |
|
481 |
=head2 sinterstore |
482 |
|
483 |
my $ok = $r->sinterstore( $dstkey, $key1, $key2, ... ); |
484 |
|
485 |
=cut |
486 |
|
487 |
sub sinterstore { |
488 |
my $self = shift; |
489 |
$self->_sock_send_ok( 'SINTERSTORE', @_ ); |
490 |
} |
491 |
|
492 |
=head1 Multiple databases handling commands |
493 |
|
494 |
=head2 select |
495 |
|
496 |
$r->select( $dbindex ); # 0 for new clients |
497 |
|
498 |
=cut |
499 |
|
500 |
sub select { |
501 |
my ($self,$dbindex) = @_; |
502 |
confess dump($dbindex) . 'not number' unless $dbindex =~ m{^\d+$}; |
503 |
$self->_sock_send_ok( 'SELECT', $dbindex ); |
504 |
} |
505 |
|
506 |
=head2 move |
507 |
|
508 |
$r->move( $key, $dbindex ); |
509 |
|
510 |
=cut |
511 |
|
512 |
sub move { |
513 |
my ( $self, $key, $dbindex ) = @_; |
514 |
$self->_sock_send( 'MOVE', $key, $dbindex ); |
515 |
} |
516 |
|
517 |
=head2 flushdb |
518 |
|
519 |
$r->flushdb; |
520 |
|
521 |
=cut |
522 |
|
523 |
sub flushdb { |
524 |
my $self = shift; |
525 |
$self->_sock_send_ok('FLUSHDB'); |
526 |
} |
527 |
|
528 |
=head2 flushall |
529 |
|
530 |
$r->flushall; |
531 |
|
532 |
=cut |
533 |
|
534 |
sub flushall { |
535 |
my $self = shift; |
536 |
$self->_sock_send_ok('flushall'); |
537 |
} |
538 |
|
539 |
=head1 Sorting |
540 |
|
541 |
=head2 sort |
542 |
|
543 |
$r->sort("key BY pattern LIMIT start end GET pattern ASC|DESC ALPHA'); |
544 |
|
545 |
=cut |
546 |
|
547 |
sub sort { |
548 |
my ( $self, $sort ) = @_; |
549 |
$self->_sock_result_bulk_list( "SORT $sort" ); |
550 |
} |
551 |
|
552 |
=head1 Persistence control commands |
553 |
|
554 |
=head2 save |
555 |
|
556 |
$r->save; |
557 |
|
558 |
=cut |
559 |
|
560 |
sub save { |
561 |
my $self = shift; |
562 |
$self->_sock_send_ok( 'SAVE' ); |
563 |
} |
564 |
|
565 |
=head2 bgsave |
566 |
|
567 |
$r->bgsave; |
568 |
|
569 |
=cut |
570 |
|
571 |
sub bgsave { |
572 |
my $self = shift; |
573 |
$self->_sock_send_ok( 'BGSAVE' ); |
574 |
} |
575 |
|
576 |
=head2 lastsave |
577 |
|
578 |
$r->lastsave; |
579 |
|
580 |
=cut |
581 |
|
582 |
sub lastsave { |
583 |
my $self = shift; |
584 |
$self->_sock_send( 'LASTSAVE' ); |
585 |
} |
586 |
|
587 |
=head2 shutdown |
588 |
|
589 |
$r->shutdown; |
590 |
|
591 |
=cut |
592 |
|
593 |
sub shutdown { |
594 |
my $self = shift; |
595 |
$self->_sock_send( 'SHUTDOWN' ); |
596 |
} |
597 |
|
598 |
=head1 Remote server control commands |
599 |
|
600 |
=head2 info |
601 |
|
602 |
my $info_hash = $r->info; |
603 |
|
604 |
=cut |
605 |
|
606 |
sub info { |
607 |
my $self = shift; |
608 |
my $info = $self->_sock_result_bulk( 'INFO' ); |
609 |
my $hash; |
610 |
foreach my $l ( split(/\r\n/, $info ) ) { |
611 |
my ($n,$v) = split(/:/, $l, 2); |
612 |
$hash->{$n} = $v; |
613 |
} |
614 |
return $hash; |
615 |
} |
616 |
|
617 |
=head1 AUTHOR |
618 |
|
619 |
Dobrica Pavlinusic, C<< <dpavlin at rot13.org> >> |
620 |
|
621 |
=head1 BUGS |
622 |
|
623 |
Please report any bugs or feature requests to C<bug-redis at rt.cpan.org>, or through |
624 |
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Redis>. I will be notified, and then you'll |
625 |
automatically be notified of progress on your bug as I make changes. |
626 |
|
627 |
|
628 |
|
629 |
|
630 |
=head1 SUPPORT |
631 |
|
632 |
You can find documentation for this module with the perldoc command. |
633 |
|
634 |
perldoc Redis |
635 |
|
636 |
|
637 |
You can also look for information at: |
638 |
|
639 |
=over 4 |
640 |
|
641 |
=item * RT: CPAN's request tracker |
642 |
|
643 |
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Redis> |
644 |
|
645 |
=item * AnnoCPAN: Annotated CPAN documentation |
646 |
|
647 |
L<http://annocpan.org/dist/Redis> |
648 |
|
649 |
=item * CPAN Ratings |
650 |
|
651 |
L<http://cpanratings.perl.org/d/Redis> |
652 |
|
653 |
=item * Search CPAN |
654 |
|
655 |
L<http://search.cpan.org/dist/Redis> |
656 |
|
657 |
=back |
658 |
|
659 |
|
660 |
=head1 ACKNOWLEDGEMENTS |
661 |
|
662 |
|
663 |
=head1 COPYRIGHT & LICENSE |
664 |
|
665 |
Copyright 2009 Dobrica Pavlinusic, all rights reserved. |
666 |
|
667 |
This program is free software; you can redistribute it and/or modify it |
668 |
under the same terms as Perl itself. |
669 |
|
670 |
|
671 |
=cut |
672 |
|
673 |
1; # End of Redis |