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 - The great new Redis! |
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 |
use Redis; |
24 |
|
25 |
my $r = Redis->new(); |
26 |
|
27 |
|
28 |
|
29 |
|
30 |
=head1 FUNCTIONS |
31 |
|
32 |
=head2 new |
33 |
|
34 |
=cut |
35 |
|
36 |
our $sock; |
37 |
my $server = '127.0.0.1:6379'; |
38 |
|
39 |
sub new { |
40 |
my $class = shift; |
41 |
my $self = {}; |
42 |
bless($self, $class); |
43 |
|
44 |
warn "# opening socket to $server"; |
45 |
|
46 |
$sock ||= IO::Socket::INET->new( |
47 |
PeerAddr => $server, |
48 |
Proto => 'tcp', |
49 |
) || die $!; |
50 |
|
51 |
$self; |
52 |
} |
53 |
|
54 |
sub _sock_result { |
55 |
my $result = <$sock>; |
56 |
warn "# result: ",dump( $result ); |
57 |
$result =~ s{\r\n$}{} || warn "can't find cr/lf"; |
58 |
return $result; |
59 |
} |
60 |
|
61 |
sub _sock_read_bulk { |
62 |
my $len = <$sock>; |
63 |
warn "## bulk len: ",dump($len); |
64 |
return undef if $len eq "nil\r\n"; |
65 |
my $v; |
66 |
read($sock, $v, $len) || die $!; |
67 |
warn "## bulk v: ",dump($v); |
68 |
my $crlf; |
69 |
read($sock, $crlf, 2); # skip cr/lf |
70 |
return $v; |
71 |
} |
72 |
|
73 |
sub _sock_result_bulk { |
74 |
my $self = shift; |
75 |
warn "## _sock_result_bulk ",dump( @_ ); |
76 |
print $sock join(' ',@_) . "\r\n"; |
77 |
_sock_read_bulk(); |
78 |
} |
79 |
|
80 |
sub _sock_ok { |
81 |
my $ok = <$sock>; |
82 |
confess dump($ok) unless $ok eq "+OK\r\n"; |
83 |
} |
84 |
|
85 |
sub _sock_send { |
86 |
my $self = shift; |
87 |
warn "## _sock_send ",dump( @_ ); |
88 |
print $sock join(' ',@_) . "\r\n"; |
89 |
_sock_result(); |
90 |
} |
91 |
|
92 |
sub _sock_send_ok { |
93 |
my $self = shift; |
94 |
warn "## _sock_send_ok ",dump( @_ ); |
95 |
print $sock join(' ',@_) . "\r\n"; |
96 |
_sock_ok(); |
97 |
} |
98 |
|
99 |
sub _sock_send_bulk { |
100 |
my ( $self, $command, $key, $value ) = @_; |
101 |
print $sock "$command $key " . length($value) . "\r\n$value\r\n"; |
102 |
_sock_ok(); |
103 |
} |
104 |
|
105 |
|
106 |
=head1 Connection Handling |
107 |
|
108 |
=head2 quit |
109 |
|
110 |
$r->quit; |
111 |
|
112 |
=cut |
113 |
|
114 |
sub quit { |
115 |
my $self = shift; |
116 |
|
117 |
close( $sock ) || warn $!; |
118 |
} |
119 |
|
120 |
=head2 ping |
121 |
|
122 |
$r->ping || die "no server?"; |
123 |
|
124 |
=cut |
125 |
|
126 |
sub ping { |
127 |
print $sock "PING\r\n"; |
128 |
my $pong = <$sock>; |
129 |
die "ping failed, got ", dump($pong) unless $pong eq "+PONG\r\n"; |
130 |
} |
131 |
|
132 |
=head1 Commands operating on string values |
133 |
|
134 |
=head2 set |
135 |
|
136 |
$r->set( foo => 'bar', $new ); |
137 |
|
138 |
=cut |
139 |
|
140 |
sub set { |
141 |
my ( $self, $key, $value, $new ) = @_; |
142 |
$self->_sock_send_bulk( "SET" . ( $new ? 'NX' : '' ), $key, $value ); |
143 |
} |
144 |
|
145 |
=head2 get |
146 |
|
147 |
my $value = $r->get( 'foo' ); |
148 |
|
149 |
=cut |
150 |
|
151 |
sub get { |
152 |
my $self = shift; |
153 |
$self->_sock_result_bulk('GET', @_); |
154 |
} |
155 |
|
156 |
=head2 incr |
157 |
|
158 |
$r->incr('counter'); |
159 |
$r->incr('tripplets', 3); |
160 |
|
161 |
=cut |
162 |
|
163 |
|
164 |
|
165 |
sub incr { |
166 |
my $self = shift; |
167 |
$self->_sock_send( 'INCR' . ( $#_ ? 'BY' : '' ), @_ ); |
168 |
} |
169 |
|
170 |
=head2 decr |
171 |
|
172 |
$r->decr('counter'); |
173 |
$r->decr('tripplets', 3); |
174 |
|
175 |
=cut |
176 |
|
177 |
sub decr { |
178 |
my $self = shift; |
179 |
$self->_sock_send( 'DECR' . ( $#_ ? 'BY' : '' ), @_ ); |
180 |
} |
181 |
|
182 |
=head2 exists |
183 |
|
184 |
$r->exists( 'key' ) && print "got key!"; |
185 |
|
186 |
=cut |
187 |
|
188 |
sub exists { |
189 |
my ( $self, $key ) = @_; |
190 |
$self->_sock_send( 'EXISTS', $key ); |
191 |
} |
192 |
|
193 |
=head2 del |
194 |
|
195 |
$r->del( 'key' ) || warn "key doesn't exist"; |
196 |
|
197 |
=cut |
198 |
|
199 |
sub del { |
200 |
my ( $self, $key ) = @_; |
201 |
$self->_sock_send( 'DEL', $key ); |
202 |
} |
203 |
|
204 |
=head2 type |
205 |
|
206 |
$r->type( 'key' ); # = string |
207 |
|
208 |
=cut |
209 |
|
210 |
sub type { |
211 |
my ( $self, $key ) = @_; |
212 |
$self->_sock_send( 'TYPE', $key ); |
213 |
} |
214 |
|
215 |
=head1 Commands operating on the key space |
216 |
|
217 |
=head2 keys |
218 |
|
219 |
my @keys = $r->keys( '*glob_pattern*' ); |
220 |
|
221 |
=cut |
222 |
|
223 |
sub keys { |
224 |
my ( $self, $glob ) = @_; |
225 |
return split(/\s/, $self->_sock_result_bulk( 'KEYS', $glob )); |
226 |
} |
227 |
|
228 |
=head2 randomkey |
229 |
|
230 |
my $key = $r->randomkey; |
231 |
|
232 |
=cut |
233 |
|
234 |
sub randomkey { |
235 |
my ( $self ) = @_; |
236 |
$self->_sock_send( 'RANDOMKEY' ); |
237 |
} |
238 |
|
239 |
=head2 rename |
240 |
|
241 |
my $ok = $r->rename( 'old-key', 'new-key', $new ); |
242 |
|
243 |
=cut |
244 |
|
245 |
sub rename { |
246 |
my ( $self, $old, $new, $nx ) = @_; |
247 |
$self->_sock_send_ok( 'RENAME' . ( $nx ? 'NX' : '' ), $old, $new ); |
248 |
} |
249 |
|
250 |
=head2 dbsize |
251 |
|
252 |
my $nr_keys = $r->dbsize; |
253 |
|
254 |
=cut |
255 |
|
256 |
sub dbsize { |
257 |
my ( $self ) = @_; |
258 |
$self->_sock_send('DBSIZE'); |
259 |
} |
260 |
|
261 |
=head1 Commands operating on lists |
262 |
|
263 |
=head2 rpush |
264 |
|
265 |
$r->rpush( $key, $value ); |
266 |
|
267 |
=cut |
268 |
|
269 |
sub rpush { |
270 |
my ( $self, $key, $value ) = @_; |
271 |
$self->_sock_send_bulk('RPUSH', $key, $value); |
272 |
} |
273 |
|
274 |
=head2 lpush |
275 |
|
276 |
$r->lpush( $key, $value ); |
277 |
|
278 |
=cut |
279 |
|
280 |
sub lpush { |
281 |
my ( $self, $key, $value ) = @_; |
282 |
$self->_sock_send_bulk('LPUSH', $key, $value); |
283 |
} |
284 |
|
285 |
=head2 llen |
286 |
|
287 |
$r->llen( $key ); |
288 |
|
289 |
=cut |
290 |
|
291 |
sub llen { |
292 |
my ( $self, $key ) = @_; |
293 |
$self->_sock_send( 'LLEN', $key ); |
294 |
} |
295 |
|
296 |
=head2 lrange |
297 |
|
298 |
my @list = $r->lrange( $key, $start, $end ); |
299 |
|
300 |
=cut |
301 |
|
302 |
sub lrange { |
303 |
my ( $self, $key, $start, $end ) = @_; |
304 |
my $size = $self->_sock_send('LRANGE', $key, $start, $end); |
305 |
|
306 |
confess $size unless $size > 0; |
307 |
$size--; |
308 |
|
309 |
my @list = ( 0 .. $size ); |
310 |
foreach ( 0 .. $size ) { |
311 |
$list[ $_ ] = _sock_read_bulk(); |
312 |
} |
313 |
|
314 |
warn "## lrange $key $start $end = [$size] ", dump( @list ); |
315 |
return @list; |
316 |
} |
317 |
|
318 |
=head1 AUTHOR |
319 |
|
320 |
Dobrica Pavlinusic, C<< <dpavlin at rot13.org> >> |
321 |
|
322 |
=head1 BUGS |
323 |
|
324 |
Please report any bugs or feature requests to C<bug-redis at rt.cpan.org>, or through |
325 |
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Redis>. I will be notified, and then you'll |
326 |
automatically be notified of progress on your bug as I make changes. |
327 |
|
328 |
|
329 |
|
330 |
|
331 |
=head1 SUPPORT |
332 |
|
333 |
You can find documentation for this module with the perldoc command. |
334 |
|
335 |
perldoc Redis |
336 |
|
337 |
|
338 |
You can also look for information at: |
339 |
|
340 |
=over 4 |
341 |
|
342 |
=item * RT: CPAN's request tracker |
343 |
|
344 |
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Redis> |
345 |
|
346 |
=item * AnnoCPAN: Annotated CPAN documentation |
347 |
|
348 |
L<http://annocpan.org/dist/Redis> |
349 |
|
350 |
=item * CPAN Ratings |
351 |
|
352 |
L<http://cpanratings.perl.org/d/Redis> |
353 |
|
354 |
=item * Search CPAN |
355 |
|
356 |
L<http://search.cpan.org/dist/Redis> |
357 |
|
358 |
=back |
359 |
|
360 |
|
361 |
=head1 ACKNOWLEDGEMENTS |
362 |
|
363 |
|
364 |
=head1 COPYRIGHT & LICENSE |
365 |
|
366 |
Copyright 2009 Dobrica Pavlinusic, all rights reserved. |
367 |
|
368 |
This program is free software; you can redistribute it and/or modify it |
369 |
under the same terms as Perl itself. |
370 |
|
371 |
|
372 |
=cut |
373 |
|
374 |
1; # End of Redis |