forked from ghaskins/riak_wiki
/
riak_python.html
991 lines (804 loc) · 76.8 KB
/
riak_python.html
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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package riak</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>riak</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/jmeredith/basho/riak-python-client/riak/__init__.py">/Users/jmeredith/basho/riak-python-client/riak/__init__.py</a></font></td></tr></table>
<p><tt>Copyright 2010 Rusty Klophaus <rusty@basho.com><br>
Copyright 2010 Justin Sheehy <justin@basho.com><br>
Copyright 2009 Jay Baird <jay@mochimedia.com><br>
<br>
This file is provided to you under the Apache License,<br>
Version 2.0 (the "License"); you may not use this file<br>
except in compliance with the License. You may obtain<br>
a copy of the License at<br>
<br>
<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a><br>
<br>
Unless required by applicable law or agreed to in writing,<br>
software distributed under the License is distributed on an<br>
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<br>
KIND, either express or implied. See the License for the<br>
specific language governing permissions and limitations<br>
under the License.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="riak.riakclient_pb2.html">riakclient_pb2</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="riak.html#RiakBucket">RiakBucket</a>
</font></dt><dt><font face="helvetica, arial"><a href="riak.html#RiakClient">RiakClient</a>
</font></dt><dt><font face="helvetica, arial"><a href="riak.html#RiakLink">RiakLink</a>
</font></dt><dt><font face="helvetica, arial"><a href="riak.html#RiakLinkPhase">RiakLinkPhase</a>
</font></dt><dt><font face="helvetica, arial"><a href="riak.html#RiakMapReduce">RiakMapReduce</a>
</font></dt><dt><font face="helvetica, arial"><a href="riak.html#RiakMapReducePhase">RiakMapReducePhase</a>
</font></dt><dt><font face="helvetica, arial"><a href="riak.html#RiakObject">RiakObject</a>
</font></dt><dt><font face="helvetica, arial"><a href="riak.html#RiakTransport">RiakTransport</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="riak.html#RiakHttpTransport">RiakHttpTransport</a>
</font></dt><dt><font face="helvetica, arial"><a href="riak.html#RiakPbcTransport">RiakPbcTransport</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="riak.html#RiakUtils">RiakUtils</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="riak.html#RiakError">RiakError</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakBucket">class <strong>RiakBucket</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The <a href="#RiakBucket">RiakBucket</a> <a href="__builtin__.html#object">object</a> allows you to access and change information<br>
about a Riak bucket, and provides methods to create or retrieve<br>
objects within the bucket.<br>
@package <a href="#RiakBucket">RiakBucket</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="RiakBucket-__init__"><strong>__init__</strong></a>(self, client, name)</dt></dl>
<dl><dt><a name="RiakBucket-get"><strong>get</strong></a>(self, key, r<font color="#909090">=None</font>)</dt><dd><tt>Retrieve a JSON-encoded <a href="__builtin__.html#object">object</a> from Riak.<br>
@param string key - Name of the key.<br>
@param int r - R-Value of the request (defaults to bucket's R)<br>
@return <a href="#RiakObject">RiakObject</a></tt></dd></dl>
<dl><dt><a name="RiakBucket-get_allow_multiples"><strong>get_allow_multiples</strong></a>(self)</dt><dd><tt>Retrieve the 'allow multiples' setting.<br>
@return Boolean</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_binary"><strong>get_binary</strong></a>(self, key, r<font color="#909090">=None</font>)</dt><dd><tt>Retrieve a binary/string <a href="__builtin__.html#object">object</a> from Riak.<br>
@param string key - Name of the key.<br>
@param int r - R-Value of the request (defaults to bucket's R)<br>
@return <a href="#RiakObject">RiakObject</a></tt></dd></dl>
<dl><dt><a name="RiakBucket-get_bool_property"><strong>get_bool_property</strong></a>(self, key)</dt><dd><tt>Get a boolean bucket property. Converts to a True/False value<br>
@param string key - Property to set.</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_decoder"><strong>get_decoder</strong></a>(self, content_type)</dt><dd><tt>Get the decoding function for this content type for this bucket<br>
@param content_type: Content type for decoder</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_dw"><strong>get_dw</strong></a>(self, dw)</dt><dd><tt>Get the DW-value for this bucket, if it is set, otherwise return<br>
the DW-value for the client.<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_encoder"><strong>get_encoder</strong></a>(self, content_type)</dt><dd><tt>Get the encoding function for this content type for this bucket<br>
@param content_type: Content type requested</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_n_val"><strong>get_n_val</strong></a>(self)</dt><dd><tt>Retrieve the N-value for this bucket.<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_name"><strong>get_name</strong></a>(self)</dt><dd><tt>Get the bucket name.</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_properties"><strong>get_properties</strong></a>(self)</dt><dd><tt>Retrieve an associative array of all bucket properties.<br>
@return Array</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_property"><strong>get_property</strong></a>(self, key)</dt><dd><tt>Retrieve a bucket property.<br>
@param string key - The property to retrieve.<br>
@return mixed</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_r"><strong>get_r</strong></a>(self, r<font color="#909090">=None</font>)</dt><dd><tt>Get the R-value for this bucket, if it is set, otherwise return<br>
the R-value for the client.<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_rw"><strong>get_rw</strong></a>(self, rw)</dt><dd><tt>Get the RW-value for this bucket, if it is set, otherwise return<br>
the RW-value for the client.<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakBucket-get_w"><strong>get_w</strong></a>(self, w)</dt><dd><tt>Get the W-value for this bucket, if it is set, otherwise return<br>
the W-value for the client.<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakBucket-new"><strong>new</strong></a>(self, key, data<font color="#909090">=None</font>, content_type<font color="#909090">='application/json'</font>)</dt><dd><tt>Create a new Riak <a href="__builtin__.html#object">object</a> that will be stored as JSON.<br>
@param string key - Name of the key.<br>
@param <a href="__builtin__.html#object">object</a> data - The data to store. (default None)<br>
@return <a href="#RiakObject">RiakObject</a></tt></dd></dl>
<dl><dt><a name="RiakBucket-new_binary"><strong>new_binary</strong></a>(self, key, data, content_type<font color="#909090">='application/octet-stream'</font>)</dt><dd><tt>Create a new Riak <a href="__builtin__.html#object">object</a> that will be stored as plain text/binary.<br>
@param string key - Name of the key.<br>
@param <a href="__builtin__.html#object">object</a> data - The data to store.<br>
@param string content_type - The content type of the <a href="__builtin__.html#object">object</a>.<br>
(default 'application/octet-stream')<br>
@return <a href="#RiakObject">RiakObject</a></tt></dd></dl>
<dl><dt><a name="RiakBucket-set_allow_multiples"><strong>set_allow_multiples</strong></a>(self, bool)</dt><dd><tt>If set to True, then writes with conflicting data will be stored<br>
and returned to the client. This situation can be detected by<br>
calling has_siblings() and get_siblings(). This should only be used<br>
if you know what you are doing.<br>
@param boolean bool - True to store and return conflicting writes.</tt></dd></dl>
<dl><dt><a name="RiakBucket-set_decoder"><strong>set_decoder</strong></a>(self, content_type, decoder)</dt><dd><tt>Set the decoding function for this content type for this bucket<br>
@param content_type: Content type for decoder<br>
@param decoder: Function to decode with - will be called with string</tt></dd></dl>
<dl><dt><a name="RiakBucket-set_dw"><strong>set_dw</strong></a>(self, dw)</dt><dd><tt>Set the DW-value for this bucket. See <a href="#RiakBucket-set_r">set_r</a>(...) for more information.<br>
@param integer dw - The new DW-value<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakBucket-set_encoder"><strong>set_encoder</strong></a>(self, content_type, encoder)</dt><dd><tt>Set the encoding function for this content type for this bucket<br>
@param content_type: Content type for encoder<br>
@param encoder: Function to encode with - will be called with data as single<br>
argument.</tt></dd></dl>
<dl><dt><a name="RiakBucket-set_n_val"><strong>set_n_val</strong></a>(self, nval)</dt><dd><tt>Set the N-value for this bucket, which is the number of replicas<br>
that will be written of each <a href="__builtin__.html#object">object</a> in the bucket. Set this once<br>
before you write any data to the bucket, and never change it<br>
again, otherwise unpredictable things could happen. This should<br>
only be used if you know what you are doing.<br>
@param integer nval - The new N-Val.</tt></dd></dl>
<dl><dt><a name="RiakBucket-set_properties"><strong>set_properties</strong></a>(self, props)</dt><dd><tt>Set multiple bucket properties in one call. This should only be<br>
used if you know what you are doing.<br>
@param array props - An associative array of key:value.</tt></dd></dl>
<dl><dt><a name="RiakBucket-set_property"><strong>set_property</strong></a>(self, key, value)</dt><dd><tt>Set a bucket property. This should only be used if you know what<br>
you are doing.<br>
@param string key - Property to set.<br>
@param mixed value - Property value.</tt></dd></dl>
<dl><dt><a name="RiakBucket-set_r"><strong>set_r</strong></a>(self, r)</dt><dd><tt>Set the R-value for this bucket. <a href="#RiakBucket-get">get</a>(...) and <a href="#RiakBucket-get_binary">get_binary</a>(...)<br>
operations that do not specify an R-value will use this value.<br>
@param integer r - The new R-value.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakBucket-set_rw"><strong>set_rw</strong></a>(self, rw)</dt><dd><tt>Set the RW-value for this bucket. See <a href="#RiakBucket-set_r">set_r</a>(...) for more information.<br>
@param integer rw - The new RW-value<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakBucket-set_w"><strong>set_w</strong></a>(self, w)</dt><dd><tt>Set the W-value for this bucket. See <a href="#RiakBucket-set_r">set_r</a>(...) for more information.<br>
@param integer w - The new W-value.<br>
@return self</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakClient">class <strong>RiakClient</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The <a href="#RiakClient">RiakClient</a> <a href="__builtin__.html#object">object</a> holds information necessary to connect to<br>
Riak. The Riak API uses HTTP, so there is no persistent<br>
connection, and the <a href="#RiakClient">RiakClient</a> <a href="__builtin__.html#object">object</a> is extremely lightweight.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="RiakClient-__init__"><strong>__init__</strong></a>(self, host<font color="#909090">='127.0.0.1'</font>, port<font color="#909090">=8098</font>, prefix<font color="#909090">='riak'</font>, mapred_prefix<font color="#909090">='mapred'</font>, transport_class<font color="#909090">=None</font>, client_id<font color="#909090">=None</font>)</dt><dd><tt>Construct a new <a href="#RiakClient">RiakClient</a> <a href="__builtin__.html#object">object</a>.<br>
@param string host - Hostname or IP address (default '127.0.0.1')<br>
@param int port - Port number (default 8098)<br>
@param string prefix - Interface prefix (default 'riak')<br>
@param string mapred_prefix - MapReduce prefix (default 'mapred')<br>
@param <a href="#RiakTransport">RiakTransport</a> transport_class - transport class to use</tt></dd></dl>
<dl><dt><a name="RiakClient-add"><strong>add</strong></a>(self, *args)</dt><dd><tt>Start assembling a Map/Reduce operation.<br>
@see <a href="#RiakMapReduce">RiakMapReduce</a>.<a href="#RiakClient-add">add</a>()<br>
@return <a href="#RiakMapReduce">RiakMapReduce</a></tt></dd></dl>
<dl><dt><a name="RiakClient-bucket"><strong>bucket</strong></a>(self, name)</dt><dd><tt>Get the bucket by the specified name. Since buckets always exist,<br>
this will always return a <a href="#RiakBucket">RiakBucket</a>.<br>
@return <a href="#RiakBucket">RiakBucket</a></tt></dd></dl>
<dl><dt><a name="RiakClient-get_client_id"><strong>get_client_id</strong></a>(self)</dt><dd><tt>Get the client_id for this <a href="#RiakClient">RiakClient</a>.<br>
@return string</tt></dd></dl>
<dl><dt><a name="RiakClient-get_decoder"><strong>get_decoder</strong></a>(self, content_type)</dt><dd><tt>Get the decoding function for this content type</tt></dd></dl>
<dl><dt><a name="RiakClient-get_dw"><strong>get_dw</strong></a>(self)</dt><dd><tt>Get the DW-value for this ClientOBject. (default 2)<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakClient-get_encoder"><strong>get_encoder</strong></a>(self, content_type)</dt><dd><tt>Get the encoding function for this content type</tt></dd></dl>
<dl><dt><a name="RiakClient-get_r"><strong>get_r</strong></a>(self)</dt><dd><tt>Get the R-value setting for this <a href="#RiakClient">RiakClient</a>. (default 2)<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakClient-get_rw"><strong>get_rw</strong></a>(self)</dt><dd><tt>Get the RW-value for this ClientObject. (default 2)<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakClient-get_transport"><strong>get_transport</strong></a>(self)</dt><dd><tt>Get a transport <a href="__builtin__.html#object">object</a></tt></dd></dl>
<dl><dt><a name="RiakClient-get_w"><strong>get_w</strong></a>(self)</dt><dd><tt>Get the W-value setting for this <a href="#RiakClient">RiakClient</a>. (default 2)<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakClient-is_alive"><strong>is_alive</strong></a>(self)</dt><dd><tt>Check if the Riak server for this <a href="#RiakClient">RiakClient</a> is alive.<br>
@return boolean</tt></dd></dl>
<dl><dt><a name="RiakClient-link"><strong>link</strong></a>(self, args)</dt><dd><tt>Start assembling a Map/Reduce operation.<br>
@see <a href="#RiakMapReduce">RiakMapReduce</a>.<a href="#RiakClient-link">link</a>()</tt></dd></dl>
<dl><dt><a name="RiakClient-map"><strong>map</strong></a>(self, *args)</dt><dd><tt>Start assembling a Map/Reduce operation.<br>
@see <a href="#RiakMapReduce">RiakMapReduce</a>.<a href="#RiakClient-map">map</a>()</tt></dd></dl>
<dl><dt><a name="RiakClient-reduce"><strong>reduce</strong></a>(self, *args)</dt><dd><tt>Start assembling a Map/Reduce operation.<br>
@see <a href="#RiakMapReduce">RiakMapReduce</a>.<a href="#RiakClient-reduce">reduce</a>()</tt></dd></dl>
<dl><dt><a name="RiakClient-set_client_id"><strong>set_client_id</strong></a>(self, client_id)</dt><dd><tt>Set the client_id for this <a href="#RiakClient">RiakClient</a>. Should not be called<br>
unless you know what you are doing.<br>
@param string client_id - The new client_id.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakClient-set_decoder"><strong>set_decoder</strong></a>(self, content_type, decoder)</dt><dd><tt>Set the decoding function for this content type<br>
@param function decoder</tt></dd></dl>
<dl><dt><a name="RiakClient-set_dw"><strong>set_dw</strong></a>(self, dw)</dt><dd><tt>Set the DW-value for this <a href="#RiakClient">RiakClient</a>. See <a href="#RiakClient-set_r">set_r</a>(...) for a<br>
description of how these values are used.<br>
@param integer dw - The DW value.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakClient-set_encoder"><strong>set_encoder</strong></a>(self, content_type, encoder)</dt><dd><tt>Set the encoding function for this content type<br>
@param function encoder</tt></dd></dl>
<dl><dt><a name="RiakClient-set_r"><strong>set_r</strong></a>(self, r)</dt><dd><tt>Set the R-value for this <a href="#RiakClient">RiakClient</a>. This value will be used<br>
for any calls to get(...) or get_binary(...) where where 1) no<br>
R-value is specified in the method call and 2) no R-value has<br>
been set in the <a href="#RiakBucket">RiakBucket</a>.<br>
@param integer r - The R value.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakClient-set_rw"><strong>set_rw</strong></a>(self, rw)</dt><dd><tt>Set the RW-value for this <a href="#RiakClient">RiakClient</a>. See <a href="#RiakClient-set_r">set_r</a>(...) for a<br>
description of how these values are used.<br>
@param integer rw - The RW value.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakClient-set_w"><strong>set_w</strong></a>(self, w)</dt><dd><tt>Set the W-value for this <a href="#RiakClient">RiakClient</a>. See <a href="#RiakClient-set_r">set_r</a>(...) for a<br>
description of how these values are used.<br>
@param integer w - The W value.<br>
@return self</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakError">class <strong>RiakError</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="riak.html#RiakError">RiakError</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="RiakError-__init__"><strong>__init__</strong></a>(self, value)</dt></dl>
<dl><dt><a name="RiakError-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x100119f80><dd><tt>T.<a href="#RiakError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="RiakError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RiakError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="RiakError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#RiakError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="RiakError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#RiakError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="RiakError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#RiakError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="RiakError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="RiakError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#RiakError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="RiakError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RiakError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="RiakError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="RiakError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakHttpTransport">class <strong>RiakHttpTransport</strong></a>(<a href="riak.html#RiakTransport">RiakTransport</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The <a href="#RiakHttpTransport">RiakHttpTransport</a> <a href="__builtin__.html#object">object</a> holds information necessary to connect to<br>
Riak. The Riak API uses HTTP, so there is no persistent<br>
connection, and the <a href="#RiakClient">RiakClient</a> <a href="__builtin__.html#object">object</a> is extremely lightweight.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="riak.html#RiakHttpTransport">RiakHttpTransport</a></dd>
<dd><a href="riak.html#RiakTransport">RiakTransport</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="RiakHttpTransport-__copy__"><strong>__copy__</strong></a>(self)</dt></dl>
<dl><dt><a name="RiakHttpTransport-__init__"><strong>__init__</strong></a>(self, host<font color="#909090">='127.0.0.1'</font>, port<font color="#909090">=8098</font>, prefix<font color="#909090">='riak'</font>, mapred_prefix<font color="#909090">='mapred'</font>, client_id<font color="#909090">=None</font>)</dt><dd><tt>Construct a new <a href="#RiakClient">RiakClient</a> <a href="__builtin__.html#object">object</a>.<br>
@param string host - Hostname or IP address (default '127.0.0.1')<br>
@param int port - Port number (default 8098)<br>
@param string prefix - Interface prefix (default 'riak')<br>
@param string mapred_prefix - MapReduce prefix (default 'mapred')<br>
@param string client_id - client id to use for vector clocks</tt></dd></dl>
<dl><dt><a name="RiakHttpTransport-build_rest_path"><strong>build_rest_path</strong></a>(self, bucket, key<font color="#909090">=None</font>, spec<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt><dd><tt>Given a <a href="#RiakClient">RiakClient</a>, <a href="#RiakBucket">RiakBucket</a>, Key, LinkSpec, and Params,<br>
construct and return a URL.</tt></dd></dl>
<dl><dt><a name="RiakHttpTransport-check_http_code"><strong>check_http_code</strong></a>(self, response, expected_statuses)</dt></dl>
<dl><dt><a name="RiakHttpTransport-delete"><strong>delete</strong></a>(self, robj, rw)</dt></dl>
<dl><dt><a name="RiakHttpTransport-get"><strong>get</strong></a>(self, robj, r, vtag<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="RiakHttpTransport-get_bucket_props"><strong>get_bucket_props</strong></a>(self, bucket)</dt></dl>
<dl><dt><a name="RiakHttpTransport-mapred"><strong>mapred</strong></a>(self, inputs, query, timeout<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="RiakHttpTransport-parse_body"><strong>parse_body</strong></a>(self, response, expected_statuses)</dt><dd><tt>Given the output of <a href="#RiakUtils">RiakUtils</a>.http_request and a list of<br>
statuses, populate the <a href="__builtin__.html#object">object</a>. Only for use by the Riak client<br>
library.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakHttpTransport-parse_links"><strong>parse_links</strong></a>(self, links, linkHeaders)</dt><dd><tt>Private.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakHttpTransport-ping"><strong>ping</strong></a>(self)</dt></dl>
<dl><dt><a name="RiakHttpTransport-put"><strong>put</strong></a>(self, robj, w<font color="#909090">=None</font>, dw<font color="#909090">=None</font>, return_body<font color="#909090">=True</font>)</dt><dd><tt>Serialize put request and deserialize response</tt></dd></dl>
<dl><dt><a name="RiakHttpTransport-set_bucket_props"><strong>set_bucket_props</strong></a>(self, bucket, props)</dt><dd><tt>Set the properties on the bucket <a href="__builtin__.html#object">object</a> given</tt></dd></dl>
<dl><dt><a name="RiakHttpTransport-to_link_header"><strong>to_link_header</strong></a>(self, link)</dt><dd><tt>Convert this <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a> to a link header string. Used internally.</tt></dd></dl>
<hr>
Class methods defined here:<br>
<dl><dt><a name="RiakHttpTransport-build_headers"><strong>build_headers</strong></a>(self, headers)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
<dl><dt><a name="RiakHttpTransport-get_value"><strong>get_value</strong></a>(self, key, array, defaultValue)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
<dl><dt><a name="RiakHttpTransport-http_request"><strong>http_request</strong></a>(self, method, host, port, url, headers<font color="#909090">={}</font>, obj<font color="#909090">=''</font>)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Given a Method, URL, Headers, and Body, perform and HTTP request,<br>
and return an array of arity 2 containing an associative array of<br>
response headers and the response body.</tt></dd></dl>
<dl><dt><a name="RiakHttpTransport-httplib_request"><strong>httplib_request</strong></a>(self, method, host, port, uri, headers<font color="#909090">={}</font>, body<font color="#909090">=''</font>)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
<dl><dt><a name="RiakHttpTransport-parse_http_headers"><strong>parse_http_headers</strong></a>(self, headers)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Parse an HTTP Header string into an asssociative array of<br>
response headers.</tt></dd></dl>
<dl><dt><a name="RiakHttpTransport-pycurl_request"><strong>pycurl_request</strong></a>(self, method, host, port, uri, headers<font color="#909090">={}</font>, body<font color="#909090">=''</font>)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
<hr>
Class methods inherited from <a href="riak.html#RiakTransport">RiakTransport</a>:<br>
<dl><dt><a name="RiakHttpTransport-make_fixed_client_id"><strong>make_fixed_client_id</strong></a>(self)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Returns a unique identifier for the current machine/process/thread.</tt></dd></dl>
<dl><dt><a name="RiakHttpTransport-make_random_client_id"><strong>make_random_client_id</strong></a>(self)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Returns a random client identifier</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="riak.html#RiakTransport">RiakTransport</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakLink">class <strong>RiakLink</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a> represents a link from one Riak <a href="__builtin__.html#object">object</a> to<br>
another.<br>
@package <a href="#RiakLink">RiakLink</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="RiakLink-__init__"><strong>__init__</strong></a>(self, bucket, key, tag<font color="#909090">=None</font>)</dt><dd><tt>Construct a <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a>.<br>
@param string bucket - The bucket name.<br>
@param string key - The key.<br>
@param string tag - The tag.</tt></dd></dl>
<dl><dt><a name="RiakLink-get"><strong>get</strong></a>(self, r<font color="#909090">=None</font>)</dt><dd><tt>Retrieve the <a href="#RiakObject">RiakObject</a> to which this link points.<br>
@param integer r - The R-value to use.<br>
@return <a href="#RiakObject">RiakObject</a></tt></dd></dl>
<dl><dt><a name="RiakLink-get_binary"><strong>get_binary</strong></a>(self, r<font color="#909090">=None</font>)</dt><dd><tt>Retrieve the <a href="#RiakObject">RiakObject</a> to which this link points, as a binary.<br>
@param integer r - The R-value to use.<br>
@return <a href="#RiakObject">RiakObject</a></tt></dd></dl>
<dl><dt><a name="RiakLink-get_bucket"><strong>get_bucket</strong></a>(self)</dt><dd><tt>Get the bucket name of this link.<br>
@return string</tt></dd></dl>
<dl><dt><a name="RiakLink-get_key"><strong>get_key</strong></a>(self)</dt><dd><tt>Get the key of this link.<br>
@return string</tt></dd></dl>
<dl><dt><a name="RiakLink-get_tag"><strong>get_tag</strong></a>(self)</dt><dd><tt>Get the tag of this link.<br>
@return string</tt></dd></dl>
<dl><dt><a name="RiakLink-isEqual"><strong>isEqual</strong></a>(self, link)</dt><dd><tt>Return True if the links are equal.<br>
@param <a href="#RiakLink">RiakLink</a> link - A <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a>.<br>
@return boolean</tt></dd></dl>
<dl><dt><a name="RiakLink-set_bucket"><strong>set_bucket</strong></a>(self, name)</dt><dd><tt>Set the bucket name of this link.<br>
@param string name - The bucket name.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakLink-set_key"><strong>set_key</strong></a>(self, key)</dt><dd><tt>Set the key of this link.<br>
@param string key - The key.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakLink-set_tag"><strong>set_tag</strong></a>(self, tag)</dt><dd><tt>Set the tag of this link.<br>
@param string tag - The tag.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakLink-to_link_header"><strong>to_link_header</strong></a>(self, client)</dt><dd><tt>Convert this <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a> to a link header string. Used internally.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakLinkPhase">class <strong>RiakLinkPhase</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The <a href="#RiakLinkPhase">RiakLinkPhase</a> <a href="__builtin__.html#object">object</a> holds information about a Link phase in a<br>
map/reduce operation.<br>
@package <a href="#RiakLinkPhase">RiakLinkPhase</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="RiakLinkPhase-__init__"><strong>__init__</strong></a>(self, bucket, tag, keep)</dt><dd><tt>Construct a <a href="#RiakLinkPhase">RiakLinkPhase</a> <a href="__builtin__.html#object">object</a>.<br>
@param string bucket - The bucket name.<br>
@param string tag - The tag.<br>
@param boolean keep - True to return results of this phase.</tt></dd></dl>
<dl><dt><a name="RiakLinkPhase-to_array"><strong>to_array</strong></a>(self)</dt><dd><tt>Convert the <a href="#RiakLinkPhase">RiakLinkPhase</a> to an associative array. Used<br>
internally.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakMapReduce">class <strong>RiakMapReduce</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The <a href="#RiakMapReduce">RiakMapReduce</a> <a href="__builtin__.html#object">object</a> allows you to build up and run a<br>
map/reduce operation on Riak.<br>
@package <a href="#RiakMapReduce">RiakMapReduce</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="RiakMapReduce-__init__"><strong>__init__</strong></a>(self, client)</dt><dd><tt>Construct a Map/Reduce <a href="__builtin__.html#object">object</a>.<br>
@param <a href="#RiakClient">RiakClient</a> client - A <a href="#RiakClient">RiakClient</a> <a href="__builtin__.html#object">object</a>.<br>
@return <a href="#RiakMapReduce">RiakMapReduce</a></tt></dd></dl>
<dl><dt><a name="RiakMapReduce-add"><strong>add</strong></a>(self, arg1, arg2<font color="#909090">=None</font>, arg3<font color="#909090">=None</font>)</dt><dd><tt>Add inputs to a map/reduce operation. This method takes three<br>
different forms, depending on the provided inputs. You can<br>
specify either a <a href="#RiakObject">RiakObject</a>, a string bucket name, or a bucket,<br>
key, and additional arg.<br>
@param mixed arg1 - <a href="#RiakObject">RiakObject</a> or Bucket<br>
@param mixed arg2 - Key or blank<br>
@param mixed arg3 - Arg or blank<br>
@return <a href="#RiakMapReduce">RiakMapReduce</a></tt></dd></dl>
<dl><dt><a name="RiakMapReduce-add_bucket"><strong>add_bucket</strong></a>(self, bucket)</dt></dl>
<dl><dt><a name="RiakMapReduce-add_bucket_key_data"><strong>add_bucket_key_data</strong></a>(self, bucket, key, data)</dt></dl>
<dl><dt><a name="RiakMapReduce-add_object"><strong>add_object</strong></a>(self, obj)</dt></dl>
<dl><dt><a name="RiakMapReduce-link"><strong>link</strong></a>(self, bucket<font color="#909090">='_'</font>, tag<font color="#909090">='_'</font>, keep<font color="#909090">=False</font>)</dt><dd><tt>Add a link phase to the map/reduce operation.<br>
@param string bucket - Bucket name (default '_', which means all<br>
buckets)<br>
@param string tag - Tag (default '_', which means all buckets)<br>
@param boolean keep - Flag whether to keep results from this<br>
stage in the map/reduce. (default False, unless this is the last<br>
step in the phase)<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakMapReduce-map"><strong>map</strong></a>(self, function, options<font color="#909090">=[]</font>)</dt><dd><tt>Add a map phase to the map/reduce operation.<br>
@param mixed function - Either a named Javascript function (ie:<br>
'Riak.mapValues'), or an anonymous javascript function (ie:<br>
'function(...) ... ' or an array ['erlang_module',<br>
'function'].<br>
@param array() options - An optional associative array<br>
containing 'language', 'keep' flag, and/or 'arg'.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakMapReduce-reduce"><strong>reduce</strong></a>(self, function, options<font color="#909090">=[]</font>)</dt><dd><tt>Add a reduce phase to the map/reduce operation.<br>
@param mixed function - Either a named Javascript function (ie.<br>
'Riak.mapValues'), or an anonymous javascript function(ie:<br>
'function(...) { ... }' or an array ['erlang_module', 'function'].<br>
@param array() options - An optional associative array<br>
containing 'language', 'keep' flag, and/or 'arg'.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakMapReduce-run"><strong>run</strong></a>(self, timeout<font color="#909090">=None</font>)</dt><dd><tt>Run the map/reduce operation. Returns an array of results, or an<br>
array of <a href="#RiakLink">RiakLink</a> objects if the last phase is a link phase.<br>
@param integer timeout - Timeout in seconds.<br>
@return array()</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakMapReducePhase">class <strong>RiakMapReducePhase</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The <a href="#RiakMapReducePhase">RiakMapReducePhase</a> holds information about a Map phase or<br>
Reduce phase in a <a href="#RiakMapReduce">RiakMapReduce</a> operation.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="RiakMapReducePhase-__init__"><strong>__init__</strong></a>(self, type, function, language, keep, arg)</dt><dd><tt>Construct a <a href="#RiakMapReducePhase">RiakMapReducePhase</a> <a href="__builtin__.html#object">object</a>.<br>
@param string type - 'map'placeholder149'reduce'<br>
@param mixed function - string or array():<br>
@param string language - 'javascript'placeholder149'erlang'<br>
@param boolean keep - True to return the output of this phase in<br>
the results.<br>
@param mixed arg - Additional value to pass into the map or<br>
reduce function.</tt></dd></dl>
<dl><dt><a name="RiakMapReducePhase-to_array"><strong>to_array</strong></a>(self)</dt><dd><tt>Convert the <a href="#RiakMapReducePhase">RiakMapReducePhase</a> to an associative array. Used<br>
internally.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakObject">class <strong>RiakObject</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The <a href="#RiakObject">RiakObject</a> holds meta information about a Riak <a href="__builtin__.html#object">object</a>, plus the<br>
<a href="__builtin__.html#object">object</a>'s data.<br>
@package <a href="#RiakObject">RiakObject</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="RiakObject-__init__"><strong>__init__</strong></a>(self, client, bucket, key<font color="#909090">=None</font>)</dt><dd><tt>Construct a new <a href="#RiakObject">RiakObject</a>.<br>
@param <a href="#RiakClient">RiakClient</a> client - A <a href="#RiakClient">RiakClient</a> <a href="__builtin__.html#object">object</a>.<br>
@param <a href="#RiakBucket">RiakBucket</a> bucket - A <a href="#RiakBucket">RiakBucket</a> <a href="__builtin__.html#object">object</a>.<br>
@param string key - An optional key. If not specified, then key<br>
is generated by server when <a href="#RiakObject-store">store</a>(...) is called.</tt></dd></dl>
<dl><dt><a name="RiakObject-add"><strong>add</strong></a>(self, *args)</dt><dd><tt>Start assembling a Map/Reduce operation.<br>
@see <a href="#RiakMapReduce">RiakMapReduce</a>.<a href="#RiakObject-add">add</a>()<br>
@return <a href="#RiakMapReduce">RiakMapReduce</a></tt></dd></dl>
<dl><dt><a name="RiakObject-add_link"><strong>add_link</strong></a>(self, obj, tag<font color="#909090">=None</font>)</dt><dd><tt>Add a link to a <a href="#RiakObject">RiakObject</a>.<br>
@param mixed obj - Either a <a href="#RiakObject">RiakObject</a> or a <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a>.<br>
@param string tag - Optional link tag. (default is bucket name,<br>
ignored if obj is a <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a>.)<br>
@return <a href="#RiakObject">RiakObject</a></tt></dd></dl>
<dl><dt><a name="RiakObject-clear"><strong>clear</strong></a>(self)</dt><dd><tt>Reset this <a href="__builtin__.html#object">object</a>.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakObject-delete"><strong>delete</strong></a>(self, rw<font color="#909090">=None</font>)</dt><dd><tt>Delete this <a href="__builtin__.html#object">object</a> from Riak.<br>
@param integer rw - RW-value. Wait until this many partitions have<br>
deleted the <a href="__builtin__.html#object">object</a> before responding.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakObject-exists"><strong>exists</strong></a>(self)</dt><dd><tt>Return True if the <a href="__builtin__.html#object">object</a> exists, False otherwise. Allows you to<br>
detect a get(...) or get_binary(...) operation where the <a href="__builtin__.html#object">object</a> is missing.<br>
@return boolean</tt></dd></dl>
<dl><dt><a name="RiakObject-get_bucket"><strong>get_bucket</strong></a>(self)</dt><dd><tt>Get the bucket of this <a href="__builtin__.html#object">object</a>.<br>
@return <a href="#RiakBucket">RiakBucket</a></tt></dd></dl>
<dl><dt><a name="RiakObject-get_content_type"><strong>get_content_type</strong></a>(self)</dt><dd><tt>Get the content type of this <a href="__builtin__.html#object">object</a>. This is either application/json, or<br>
the provided content type if the <a href="__builtin__.html#object">object</a> was created via new_binary(...).<br>
@return string</tt></dd></dl>
<dl><dt><a name="RiakObject-get_data"><strong>get_data</strong></a>(self)</dt><dd><tt>Get the data stored in this <a href="__builtin__.html#object">object</a>. Will return a associative<br>
array, unless the <a href="__builtin__.html#object">object</a> was constructed with new_binary(...) or<br>
get_binary(...), in which case this will return a string.<br>
@return array or string</tt></dd></dl>
<dl><dt><a name="RiakObject-get_encoded_data"><strong>get_encoded_data</strong></a>(self)</dt><dd><tt>Get the data encoded for storing</tt></dd></dl>
<dl><dt><a name="RiakObject-get_key"><strong>get_key</strong></a>(self)</dt><dd><tt>Get the key of this <a href="__builtin__.html#object">object</a>.<br>
@return string</tt></dd></dl>
<dl><dt><a name="RiakObject-get_links"><strong>get_links</strong></a>(self)</dt><dd><tt>Return an array of <a href="#RiakLink">RiakLink</a> objects.<br>
@return array()</tt></dd></dl>
<dl><dt><a name="RiakObject-get_metadata"><strong>get_metadata</strong></a>(self)</dt><dd><tt>Get the metadata stored in this <a href="__builtin__.html#object">object</a>. Will return a associative<br>
array<br>
@return dict</tt></dd></dl>
<dl><dt><a name="RiakObject-get_sibling"><strong>get_sibling</strong></a>(self, i, r<font color="#909090">=None</font>)</dt><dd><tt>Retrieve a sibling by sibling number.<br>
@param integer i - Sibling number.<br>
@param integer r - R-Value. Wait until this many partitions<br>
have responded before returning to client.<br>
@return <a href="#RiakObject">RiakObject</a>.</tt></dd></dl>
<dl><dt><a name="RiakObject-get_sibling_count"><strong>get_sibling_count</strong></a>(self)</dt><dd><tt>Get the number of siblings that this <a href="__builtin__.html#object">object</a> contains.<br>
@return integer</tt></dd></dl>
<dl><dt><a name="RiakObject-get_siblings"><strong>get_siblings</strong></a>(self, r<font color="#909090">=None</font>)</dt><dd><tt>Retrieve an array of siblings.<br>
@param integer r - R-Value. Wait until this many partitions have<br>
responded before returning to client.<br>
@return array of <a href="#RiakObject">RiakObject</a></tt></dd></dl>
<dl><dt><a name="RiakObject-has_siblings"><strong>has_siblings</strong></a>(self)</dt><dd><tt>Return True if this <a href="__builtin__.html#object">object</a> has siblings.<br>
@return boolean</tt></dd></dl>
<dl><dt><a name="RiakObject-link"><strong>link</strong></a>(self, *args)</dt><dd><tt>Start assembling a Map/Reduce operation.<br>
@see <a href="#RiakMapReduce">RiakMapReduce</a>.<a href="#RiakObject-link">link</a>()<br>
@return <a href="#RiakMapReduce">RiakMapReduce</a></tt></dd></dl>
<dl><dt><a name="RiakObject-map"><strong>map</strong></a>(self, *args)</dt><dd><tt>Start assembling a Map/Reduce operation.<br>
@see <a href="#RiakMapReduce">RiakMapReduce</a>.<a href="#RiakObject-map">map</a>()<br>
@return <a href="#RiakMapReduce">RiakMapReduce</a></tt></dd></dl>
<dl><dt><a name="RiakObject-populate"><strong>populate</strong></a>(self, Result)</dt><dd><tt>Populate the <a href="__builtin__.html#object">object</a> based on the return from get.<br>
If None returned, then <a href="__builtin__.html#object">object</a> is not found<br>
If a tuple of vclock, contents then one or more<br>
whole revisions of the key were found<br>
If a list of vtags is returned there are multiple<br>
sibling that need to be retrieved with get.</tt></dd></dl>
<dl><dt><a name="RiakObject-populate_links"><strong>populate_links</strong></a>(self, linkHeaders)</dt><dd><tt>Private.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakObject-reduce"><strong>reduce</strong></a>(self, params)</dt><dd><tt>Start assembling a Map/Reduce operation.<br>
@see <a href="#RiakMapReduce">RiakMapReduce</a>.<a href="#RiakObject-reduce">reduce</a>()<br>
@return <a href="#RiakMapReduce">RiakMapReduce</a></tt></dd></dl>
<dl><dt><a name="RiakObject-reload"><strong>reload</strong></a>(self, r<font color="#909090">=None</font>, vtag<font color="#909090">=None</font>)</dt><dd><tt>Reload the <a href="__builtin__.html#object">object</a> from Riak. When this operation completes, the<br>
<a href="__builtin__.html#object">object</a> could contain new metadata and a new value, if the <a href="__builtin__.html#object">object</a><br>
was updated in Riak since it was last retrieved.<br>
@param integer r - R-Value, wait for this many partitions to respond<br>
before returning to client.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakObject-remove_link"><strong>remove_link</strong></a>(self, obj, tag<font color="#909090">=None</font>)</dt><dd><tt>Remove a link to a <a href="#RiakObject">RiakObject</a>.<br>
@param mixed obj - Either a <a href="#RiakObject">RiakObject</a> or a <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a>.<br>
@param string tag -<br>
@param mixed obj - Either a <a href="#RiakObject">RiakObject</a> or a <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a>.<br>
@param string tag - Optional link tag. (default is bucket name,<br>
ignored if obj is a <a href="#RiakLink">RiakLink</a> <a href="__builtin__.html#object">object</a>.)<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakObject-set_content_type"><strong>set_content_type</strong></a>(self, content_type)</dt><dd><tt>Set the content type of this <a href="__builtin__.html#object">object</a>.<br>
@param string content_type - The new content type.<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakObject-set_data"><strong>set_data</strong></a>(self, data)</dt><dd><tt>Set the data stored in this <a href="__builtin__.html#object">object</a>. This data will be<br>
JSON encoded unless the <a href="__builtin__.html#object">object</a> was constructed with<br>
new_binary(...) or get_binary(...).<br>
@param mixed data - The data to store.<br>
@return data</tt></dd></dl>
<dl><dt><a name="RiakObject-set_encoded_data"><strong>set_encoded_data</strong></a>(self, data)</dt><dd><tt>Set the <a href="__builtin__.html#object">object</a> data from an encoded string - make sure<br>
the metadata has been set correctly first.</tt></dd></dl>
<dl><dt><a name="RiakObject-set_metadata"><strong>set_metadata</strong></a>(self, metadata)</dt><dd><tt>Set the metadata stored in this <a href="__builtin__.html#object">object</a>.<br>
@param dict metadata - The data to store.<br>
@return data</tt></dd></dl>
<dl><dt><a name="RiakObject-set_siblings"><strong>set_siblings</strong></a>(self, siblings)</dt><dd><tt>Set the array of siblings - used internally<br>
Make sure this <a href="__builtin__.html#object">object</a> is at index 0 so <a href="#RiakObject-get_siblings">get_siblings</a>(0) always returns<br>
the current <a href="__builtin__.html#object">object</a></tt></dd></dl>
<dl><dt><a name="RiakObject-store"><strong>store</strong></a>(self, w<font color="#909090">=None</font>, dw<font color="#909090">=None</font>, return_body<font color="#909090">=True</font>)</dt><dd><tt>Store the <a href="__builtin__.html#object">object</a> in Riak. When this operation completes, the<br>
<a href="__builtin__.html#object">object</a> could contain new metadata and possibly new data if Riak<br>
contains a newer version of the <a href="__builtin__.html#object">object</a> according to the <a href="__builtin__.html#object">object</a>'s<br>
vector clock.<br>
@param integer w - W-value, wait for this many partitions to respond<br>
before returning to client.<br>
@param integer dw - DW-value, wait for this many partitions to<br>
confirm the write before returning to client.<br>
@param bool return_body - if the newly stored <a href="__builtin__.html#object">object</a> should be retrieved<br>
@return self</tt></dd></dl>
<dl><dt><a name="RiakObject-vclock"><strong>vclock</strong></a>(self)</dt><dd><tt>Get the vclock of this <a href="__builtin__.html#object">object</a>.<br>
@return string</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakPbcTransport">class <strong>RiakPbcTransport</strong></a>(<a href="riak.html#RiakTransport">RiakTransport</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The <a href="#RiakPbcTransport">RiakPbcTransport</a> <a href="__builtin__.html#object">object</a> holds a connection to the protocol buffers interface<br>
on the riak server.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="riak.html#RiakPbcTransport">RiakPbcTransport</a></dd>
<dd><a href="riak.html#RiakTransport">RiakTransport</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="RiakPbcTransport-__copy__"><strong>__copy__</strong></a>(self)</dt></dl>
<dl><dt><a name="RiakPbcTransport-__init__"><strong>__init__</strong></a>(self, host<font color="#909090">='127.0.0.1'</font>, port<font color="#909090">=8087</font>, client_id<font color="#909090">=None</font>)</dt><dd><tt>Construct a new <a href="#RiakPbcTransport">RiakPbcTransport</a> <a href="__builtin__.html#object">object</a>.<br>
@param string host - Hostname or IP address (default '127.0.0.1')<br>
@param int port - Port number (default 8087)</tt></dd></dl>
<dl><dt><a name="RiakPbcTransport-decode_content"><strong>decode_content</strong></a>(self, rpb_content)</dt></dl>
<dl><dt><a name="RiakPbcTransport-decode_contents"><strong>decode_contents</strong></a>(self, rpb_contents)</dt></dl>
<dl><dt><a name="RiakPbcTransport-delete"><strong>delete</strong></a>(self, robj, rw<font color="#909090">=None</font>)</dt><dd><tt>Serialize get request and deserialize response</tt></dd></dl>
<dl><dt><a name="RiakPbcTransport-encode_msg"><strong>encode_msg</strong></a>(self, msg_code, msg)</dt></dl>
<dl><dt><a name="RiakPbcTransport-get"><strong>get</strong></a>(self, robj, r<font color="#909090">=None</font>, vtag<font color="#909090">=None</font>)</dt><dd><tt>Serialize get request and deserialize response</tt></dd></dl>
<dl><dt><a name="RiakPbcTransport-get_client_id"><strong>get_client_id</strong></a>(self)</dt><dd><tt>Get the client id used by this connection</tt></dd></dl>
<dl><dt><a name="RiakPbcTransport-maybe_connect"><strong>maybe_connect</strong></a>(self)</dt></dl>
<dl><dt><a name="RiakPbcTransport-pbify_content"><strong>pbify_content</strong></a>(self, metadata, data, rpb_content)</dt></dl>
<dl><dt><a name="RiakPbcTransport-ping"><strong>ping</strong></a>(self)</dt><dd><tt>Ping the remote server<br>
@return boolean</tt></dd></dl>
<dl><dt><a name="RiakPbcTransport-put"><strong>put</strong></a>(self, robj, w<font color="#909090">=None</font>, dw<font color="#909090">=None</font>, return_body<font color="#909090">=True</font>)</dt><dd><tt>Serialize get request and deserialize response</tt></dd></dl>
<dl><dt><a name="RiakPbcTransport-recv_msg"><strong>recv_msg</strong></a>(self)</dt></dl>
<dl><dt><a name="RiakPbcTransport-recv_pkt"><strong>recv_pkt</strong></a>(self)</dt></dl>
<dl><dt><a name="RiakPbcTransport-send_msg"><strong>send_msg</strong></a>(self, msg_code, msg)</dt></dl>
<dl><dt><a name="RiakPbcTransport-send_msg_code"><strong>send_msg_code</strong></a>(self, msg_code)</dt></dl>
<dl><dt><a name="RiakPbcTransport-set_client_id"><strong>set_client_id</strong></a>(self, client_id)</dt><dd><tt>Set the client id used by this connection</tt></dd></dl>
<hr>
Methods inherited from <a href="riak.html#RiakTransport">RiakTransport</a>:<br>
<dl><dt><a name="RiakPbcTransport-get_bucket_props"><strong>get_bucket_props</strong></a>(self, bucket)</dt><dd><tt>Serialize get bucket property request and deserialize response<br>
@return dict()</tt></dd></dl>
<dl><dt><a name="RiakPbcTransport-mapred"><strong>mapred</strong></a>(self, inputs, query, timeout<font color="#909090">=None</font>)</dt><dd><tt>Serialize map/reduce request</tt></dd></dl>
<dl><dt><a name="RiakPbcTransport-set_bucket_props"><strong>set_bucket_props</strong></a>(self, bucket, props)</dt><dd><tt>Serialize set bucket property request and deserialize response<br>
bucket = bucket <a href="__builtin__.html#object">object</a><br>
props = dictionary of properties<br>
@return boolean</tt></dd></dl>
<hr>
Class methods inherited from <a href="riak.html#RiakTransport">RiakTransport</a>:<br>
<dl><dt><a name="RiakPbcTransport-make_fixed_client_id"><strong>make_fixed_client_id</strong></a>(self)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Returns a unique identifier for the current machine/process/thread.</tt></dd></dl>
<dl><dt><a name="RiakPbcTransport-make_random_client_id"><strong>make_random_client_id</strong></a>(self)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Returns a random client identifier</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="riak.html#RiakTransport">RiakTransport</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakTransport">class <strong>RiakTransport</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Class to encapsulate transport details<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="RiakTransport-delete"><strong>delete</strong></a>(self, robj, rw<font color="#909090">=None</font>)</dt><dd><tt>Serialize delete request and deserialize response<br>
@return true</tt></dd></dl>
<dl><dt><a name="RiakTransport-get"><strong>get</strong></a>(self, robj, r<font color="#909090">=None</font>, vtag<font color="#909090">=None</font>)</dt><dd><tt>Serialize get request and deserialize response<br>
@return (vclock=None, [(metadata, value)]=None)</tt></dd></dl>
<dl><dt><a name="RiakTransport-get_bucket_props"><strong>get_bucket_props</strong></a>(self, bucket)</dt><dd><tt>Serialize get bucket property request and deserialize response<br>
@return dict()</tt></dd></dl>
<dl><dt><a name="RiakTransport-mapred"><strong>mapred</strong></a>(self, inputs, query, timeout<font color="#909090">=None</font>)</dt><dd><tt>Serialize map/reduce request</tt></dd></dl>
<dl><dt><a name="RiakTransport-ping"><strong>ping</strong></a>(self)</dt><dd><tt>Ping the remote server<br>
@return boolean</tt></dd></dl>
<dl><dt><a name="RiakTransport-put"><strong>put</strong></a>(self, robj, w<font color="#909090">=None</font>, dw<font color="#909090">=None</font>, return_body<font color="#909090">=True</font>)</dt><dd><tt>Serialize put request and deserialize response - if 'content'<br>
is true, retrieve the updated metadata/content<br>
@return (vclock=None, [(metadata, value)]=None)</tt></dd></dl>
<dl><dt><a name="RiakTransport-set_bucket_props"><strong>set_bucket_props</strong></a>(self, bucket, props)</dt><dd><tt>Serialize set bucket property request and deserialize response<br>
bucket = bucket <a href="__builtin__.html#object">object</a><br>
props = dictionary of properties<br>
@return boolean</tt></dd></dl>
<hr>
Class methods defined here:<br>
<dl><dt><a name="RiakTransport-make_fixed_client_id"><strong>make_fixed_client_id</strong></a>(self)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Returns a unique identifier for the current machine/process/thread.</tt></dd></dl>
<dl><dt><a name="RiakTransport-make_random_client_id"><strong>make_random_client_id</strong></a>(self)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Returns a random client identifier</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="RiakUtils">class <strong>RiakUtils</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Utility functions used by Riak library.<br>
@package <a href="#RiakUtils">RiakUtils</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Class methods defined here:<br>
<dl><dt><a name="RiakUtils-get_value"><strong>get_value</strong></a>(self, key, array, defaultValue)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-StringIO"><strong>StringIO</strong></a>(...)</dt><dd><tt><a href="#-StringIO">StringIO</a>([s]) -- Return a StringIO-like stream for reading or writing</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>HAS_PYCURL</strong> = True<br>
<strong>MD_CHARSET</strong> = 'charset'<br>
<strong>MD_CTYPE</strong> = 'content-type'<br>
<strong>MD_ENCODING</strong> = 'content-encoding'<br>
<strong>MD_LASTMOD</strong> = 'lastmod'<br>
<strong>MD_LASTMOD_USECS</strong> = 'lastmod-usecs'<br>
<strong>MD_LINKS</strong> = 'links'<br>
<strong>MD_USERMETA</strong> = 'usermeta'<br>
<strong>MD_VTAG</strong> = 'vtag'<br>
<strong>MSG_CODE_DEL_REQ</strong> = 13<br>
<strong>MSG_CODE_DEL_RESP</strong> = 14<br>
<strong>MSG_CODE_ERROR_RESP</strong> = 0<br>
<strong>MSG_CODE_GET_CLIENT_ID_REQ</strong> = 3<br>
<strong>MSG_CODE_GET_CLIENT_ID_RESP</strong> = 4<br>
<strong>MSG_CODE_GET_REQ</strong> = 9<br>
<strong>MSG_CODE_GET_RESP</strong> = 10<br>
<strong>MSG_CODE_GET_SERVER_INFO_REQ</strong> = 7<br>
<strong>MSG_CODE_GET_SERVER_INFO_RESP</strong> = 8<br>
<strong>MSG_CODE_LIST_BUCKETS_REQ</strong> = 15<br>
<strong>MSG_CODE_LIST_BUCKETS_RESP</strong> = 16<br>
<strong>MSG_CODE_LIST_KEYS_REQ</strong> = 17<br>
<strong>MSG_CODE_LIST_KEYS_RESP</strong> = 18<br>
<strong>MSG_CODE_PING_REQ</strong> = 1<br>
<strong>MSG_CODE_PING_RESP</strong> = 2<br>
<strong>MSG_CODE_PUT_REQ</strong> = 11<br>
<strong>MSG_CODE_PUT_RESP</strong> = 12<br>
<strong>MSG_CODE_SET_CLIENT_ID_REQ</strong> = 5<br>
<strong>MSG_CODE_SET_CLIENT_ID_RESP</strong> = 6</td></tr></table>
</body></html>