summaryrefslogtreecommitdiff
path: root/lib/Net/Riak/Bucket.pm
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--lib/Net/Riak/Bucket.pm22
1 files changed, 13 insertions, 9 deletions
diff --git a/lib/Net/Riak/Bucket.pm b/lib/Net/Riak/Bucket.pm
index b8a0a36..06cd508 100644
--- a/lib/Net/Riak/Bucket.pm
+++ b/lib/Net/Riak/Bucket.pm
@@ -180,31 +180,33 @@ DW value setting for this client (default 2)
=head2 METHODS
-=method new_object
+=over 4
+
+=item new_object
my $obj = $bucket->new_object($key, $data, @args);
Create a new L<Net::Riak::Object> object. Additional Object constructor arguments can be passed after $data. If $data is a reference and no explicit Object content_type is given in @args, the data will be serialised and stored as JSON.
-=method get
+=item get
my $obj = $bucket->get($key, [$r]);
Retrieve an object from Riak.
-=method n_val
+=item n_val
my $n_val = $bucket->n_val;
Get/set the N-value for this bucket, which is the number of replicas that will be written of each object in the bucket. Set this once before you write any data to the bucket, and never change it again, otherwise unpredictable things could happen. This should only be used if you know what you are doing.
-=method allow_multiples
+=item allow_multiples
$bucket->allow_multiples(1|0);
If set to True, then writes with conflicting data will be stored and returned to the client. This situation can be detected by calling has_siblings() and get_siblings(). This should only be used if you know what you are doing.
-=method get_keys
+=item get_keys
my $keys = $bucket->get_keys;
my $keys = $bucket->get_keys($args);
@@ -219,23 +221,23 @@ Use 'keys=stream' streaming mode to fetch the list of keys, which may be faster
=back
-=method set_property
+=item set_property
$bucket->set_property({n_val => 2});
Set a bucket property. This should only be used if you know what you are doing.
-=method get_property
+=item get_property
my $prop = $bucket->get_property('n_val');
Retrieve a bucket property.
-=method set_properties
+=item set_properties
Set multiple bucket properties in one call. This should only be used if you know what you are doing.
-=method get_properties
+=item get_properties
Retrieve an associative array of all bucket properties, containing 'props' and 'keys' elements.
@@ -245,4 +247,6 @@ Accepts a hashref of parameters, containing flags for 'props' and 'keys'. By def
The 'props' parameter may be 'true' or 'false'. The 'keys' parameter may be 'false' or 'true' or 'stream', to get the keys back in streaming mode (which may be faster for large keyspaces).
+=back
+
=cut