/[Redis.pre-github]/lib/Redis.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Contents of /lib/Redis.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 41 - (show annotations)
Sun Mar 22 18:42:21 2009 UTC (15 years, 1 month ago) by dpavlin
File size: 8861 byte(s)
flushdb, flushall
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 incr
193
194 $r->incr('counter');
195 $r->incr('tripplets', 3);
196
197 =cut
198
199
200
201 sub incr {
202 my $self = shift;
203 $self->_sock_send( 'INCR' . ( $#_ ? 'BY' : '' ), @_ );
204 }
205
206 =head2 decr
207
208 $r->decr('counter');
209 $r->decr('tripplets', 3);
210
211 =cut
212
213 sub decr {
214 my $self = shift;
215 $self->_sock_send( 'DECR' . ( $#_ ? 'BY' : '' ), @_ );
216 }
217
218 =head2 exists
219
220 $r->exists( 'key' ) && print "got key!";
221
222 =cut
223
224 sub exists {
225 my ( $self, $key ) = @_;
226 $self->_sock_send( 'EXISTS', $key );
227 }
228
229 =head2 del
230
231 $r->del( 'key' ) || warn "key doesn't exist";
232
233 =cut
234
235 sub del {
236 my ( $self, $key ) = @_;
237 $self->_sock_send( 'DEL', $key );
238 }
239
240 =head2 type
241
242 $r->type( 'key' ); # = string
243
244 =cut
245
246 sub type {
247 my ( $self, $key ) = @_;
248 $self->_sock_send( 'TYPE', $key );
249 }
250
251 =head1 Commands operating on the key space
252
253 =head2 keys
254
255 my @keys = $r->keys( '*glob_pattern*' );
256
257 =cut
258
259 sub keys {
260 my ( $self, $glob ) = @_;
261 return split(/\s/, $self->_sock_result_bulk( 'KEYS', $glob ));
262 }
263
264 =head2 randomkey
265
266 my $key = $r->randomkey;
267
268 =cut
269
270 sub randomkey {
271 my ( $self ) = @_;
272 $self->_sock_send( 'RANDOMKEY' );
273 }
274
275 =head2 rename
276
277 my $ok = $r->rename( 'old-key', 'new-key', $new );
278
279 =cut
280
281 sub rename {
282 my ( $self, $old, $new, $nx ) = @_;
283 $self->_sock_send_ok( 'RENAME' . ( $nx ? 'NX' : '' ), $old, $new );
284 }
285
286 =head2 dbsize
287
288 my $nr_keys = $r->dbsize;
289
290 =cut
291
292 sub dbsize {
293 my ( $self ) = @_;
294 $self->_sock_send('DBSIZE');
295 }
296
297 =head1 Commands operating on lists
298
299 See also L<Redis::List> for tie interface.
300
301 =head2 rpush
302
303 $r->rpush( $key, $value );
304
305 =cut
306
307 sub rpush {
308 my ( $self, $key, $value ) = @_;
309 $self->_sock_send_bulk('RPUSH', $key, $value);
310 }
311
312 =head2 lpush
313
314 $r->lpush( $key, $value );
315
316 =cut
317
318 sub lpush {
319 my ( $self, $key, $value ) = @_;
320 $self->_sock_send_bulk('LPUSH', $key, $value);
321 }
322
323 =head2 llen
324
325 $r->llen( $key );
326
327 =cut
328
329 sub llen {
330 my ( $self, $key ) = @_;
331 $self->_sock_send( 'LLEN', $key );
332 }
333
334 =head2 lrange
335
336 my @list = $r->lrange( $key, $start, $end );
337
338 =cut
339
340 sub lrange {
341 my ( $self, $key, $start, $end ) = @_;
342 $self->_sock_result_bulk_list('LRANGE', $key, $start, $end);
343 }
344
345 =head2 ltrim
346
347 my $ok = $r->ltrim( $key, $start, $end );
348
349 =cut
350
351 sub ltrim {
352 my ( $self, $key, $start, $end ) = @_;
353 $self->_sock_send_ok( 'LTRIM', $key, $start, $end );
354 }
355
356 =head2 lindex
357
358 $r->lindex( $key, $index );
359
360 =cut
361
362 sub lindex {
363 my ( $self, $key, $index ) = @_;
364 $self->_sock_result_bulk( 'LINDEX', $key, $index );
365 }
366
367 =head2 lset
368
369 $r->lset( $key, $index, $value );
370
371 =cut
372
373 sub lset {
374 my ( $self, $key, $index, $value ) = @_;
375 $self->_sock_send_bulk( 'LSET', $key, $index, $value );
376 }
377
378 =head2 lrem
379
380 my $modified_count = $r->lrem( $key, $count, $value );
381
382 =cut
383
384 sub lrem {
385 my ( $self, $key, $count, $value ) = @_;
386 $self->_sock_send_bulk_number( 'LREM', $key, $count, $value );
387 }
388
389 =head2 lpop
390
391 my $value = $r->lpop( $key );
392
393 =cut
394
395 sub lpop {
396 my ( $self, $key ) = @_;
397 $self->_sock_result_bulk( 'LPOP', $key );
398 }
399
400 =head2 rpop
401
402 my $value = $r->rpop( $key );
403
404 =cut
405
406 sub rpop {
407 my ( $self, $key ) = @_;
408 $self->_sock_result_bulk( 'RPOP', $key );
409 }
410
411 =head1 Commands operating on sets
412
413 =head2 sadd
414
415 $r->sadd( $key, $member );
416
417 =cut
418
419 sub sadd {
420 my ( $self, $key, $member ) = @_;
421 $self->_sock_send_bulk_number( 'SADD', $key, $member );
422 }
423
424 =head2 srem
425
426 $r->srem( $key, $member );
427
428 =cut
429
430 sub srem {
431 my ( $self, $key, $member ) = @_;
432 $self->_sock_send_bulk_number( 'SREM', $key, $member );
433 }
434
435 =head2 scard
436
437 my $elements = $r->scard( $key );
438
439 =cut
440
441 sub scard {
442 my ( $self, $key ) = @_;
443 $self->_sock_send( 'SCARD', $key );
444 }
445
446 =head2 sismember
447
448 $r->sismember( $key, $member );
449
450 =cut
451
452 sub sismember {
453 my ( $self, $key, $member ) = @_;
454 $self->_sock_send_bulk_number( 'SISMEMBER', $key, $member );
455 }
456
457 =head2 sinter
458
459 $r->sinter( $key1, $key2, ... );
460
461 =cut
462
463 sub sinter {
464 my $self = shift;
465 $self->_sock_result_bulk_list( 'SINTER', @_ );
466 }
467
468 =head2 sinterstore
469
470 my $ok = $r->sinterstore( $dstkey, $key1, $key2, ... );
471
472 =cut
473
474 sub sinterstore {
475 my $self = shift;
476 $self->_sock_send_ok( 'SINTERSTORE', @_ );
477 }
478
479 =head1 Multiple databases handling commands
480
481 =head2 select
482
483 $r->select( $dbindex ); # 0 for new clients
484
485 =cut
486
487 sub select {
488 my ($self,$dbindex) = @_;
489 confess dump($dbindex) . 'not number' unless $dbindex =~ m{^\d+$};
490 $self->_sock_send_ok( 'SELECT', $dbindex );
491 }
492
493 =head2 move
494
495 $r->move( $key, $dbindex );
496
497 =cut
498
499 sub move {
500 my ( $self, $key, $dbindex ) = @_;
501 $self->_sock_send( 'MOVE', $key, $dbindex );
502 }
503
504 =head2 flushdb
505
506 $r->flushdb;
507
508 =cut
509
510 sub flushdb {
511 my $self = shift;
512 $self->_sock_send_ok('FLUSHDB');
513 }
514
515 =head2 flushall
516
517 $r->flushall;
518
519 =cut
520
521 sub flushall {
522 my $self = shift;
523 $self->_sock_send_ok('flushall');
524 }
525
526 =head1 AUTHOR
527
528 Dobrica Pavlinusic, C<< <dpavlin at rot13.org> >>
529
530 =head1 BUGS
531
532 Please report any bugs or feature requests to C<bug-redis at rt.cpan.org>, or through
533 the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Redis>. I will be notified, and then you'll
534 automatically be notified of progress on your bug as I make changes.
535
536
537
538
539 =head1 SUPPORT
540
541 You can find documentation for this module with the perldoc command.
542
543 perldoc Redis
544
545
546 You can also look for information at:
547
548 =over 4
549
550 =item * RT: CPAN's request tracker
551
552 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Redis>
553
554 =item * AnnoCPAN: Annotated CPAN documentation
555
556 L<http://annocpan.org/dist/Redis>
557
558 =item * CPAN Ratings
559
560 L<http://cpanratings.perl.org/d/Redis>
561
562 =item * Search CPAN
563
564 L<http://search.cpan.org/dist/Redis>
565
566 =back
567
568
569 =head1 ACKNOWLEDGEMENTS
570
571
572 =head1 COPYRIGHT & LICENSE
573
574 Copyright 2009 Dobrica Pavlinusic, all rights reserved.
575
576 This program is free software; you can redistribute it and/or modify it
577 under the same terms as Perl itself.
578
579
580 =cut
581
582 1; # End of Redis

  ViewVC Help
Powered by ViewVC 1.1.26