summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--Changes3
-rw-r--r--lib/Net/Riak.pm28
-rw-r--r--lib/Net/Riak/Client.pm5
-rw-r--r--lib/Net/Riak/Role/REST.pm1
-rw-r--r--lib/Net/Riak/Role/REST/Search.pm76
-rw-r--r--lib/Net/Riak/Search.pm85
-rw-r--r--t/20_search.t30
7 files changed, 224 insertions, 4 deletions
diff --git a/Changes b/Changes
index 5db7b94..c34d759 100644
--- a/Changes
+++ b/Changes
@@ -1,3 +1,6 @@
+0.1503
+ - added Riak search (Germain Maurice)
+
0.1502 Thu Jun 23 15:39:10 BST 2011
- added status line to REST response (Robin Edwards)
diff --git a/lib/Net/Riak.pm b/lib/Net/Riak.pm
index f2a9403..8ac536b 100644
--- a/lib/Net/Riak.pm
+++ b/lib/Net/Riak.pm
@@ -14,7 +14,7 @@ has client => (
is => 'rw',
isa => Client_T,
required => 1,
- handles => [qw/is_alive all_buckets server_info stats/]
+ handles => [qw/is_alive all_buckets server_info stats search setup_indexing/]
);
sub BUILDARGS {
@@ -37,7 +37,7 @@ sub bucket {
1;
=head1 SYNOPSIS
-
+
# REST interface
my $client = Net::Riak->new(
host => 'http://10.0.0.40:8098',
@@ -58,6 +58,14 @@ sub bucket {
$obj = $bucket->get('new_post');
say "title for ".$obj->key." is ".$obj->data->{title};
+ # Indexing and searching (REST interface)
+ $client->setup_indexing("bucket_name");
+ ...adding documents to riak...
+ my $response = $client->search(
+ index => 'bucket_name',
+ q => 'field:value'
+ );
+
=head1 DESCRIPTION
=head2 ATTRIBUTES
@@ -116,7 +124,7 @@ Disable returning of object content in response in a store operation.
If set to true and the object has siblings these will not be available without an additional fetch.
-This will become the default behaviour in 0.17
+This will become the default behaviour in 0.17
=back
@@ -165,13 +173,25 @@ Start assembling a Map/Reduce operation
Start assembling a Map/Reduce operation
=head2 server_info (PBC only)
-
+
$client->server_info->{server_version};
=head2 stats (REST only)
say Dumper $client->stats;
+=head2 search (REST only)
+
+ $client->search( index => 'bucket_name', q => 'field:value' );
+
+Makes a query to the index (see L<Net::Riak::Search> for more details on parameters)
+
+=head2 setup_indexing (REST only)
+
+ $client->setup_indexing('bucket_name');
+
+Define precommit hook in order to enable indexing documents written into the given bucket
+
=head1 SEE ALSO
L<Net::Riak::MapReduce>
diff --git a/lib/Net/Riak/Client.pm b/lib/Net/Riak/Client.pm
index f38bec6..ad9315e 100644
--- a/lib/Net/Riak/Client.pm
+++ b/lib/Net/Riak/Client.pm
@@ -15,6 +15,11 @@ has mapred_prefix => (
isa => 'Str',
default => 'mapred'
);
+has search_prefix => (
+ is => 'rw',
+ isa => 'Str',
+ default => 'solr'
+);
has [qw/r w dw/] => (
is => 'rw',
isa => 'Int',
diff --git a/lib/Net/Riak/Role/REST.pm b/lib/Net/Riak/Role/REST.pm
index dfab5a0..261d573 100644
--- a/lib/Net/Riak/Role/REST.pm
+++ b/lib/Net/Riak/Role/REST.pm
@@ -12,6 +12,7 @@ with qw/Net::Riak::Role::REST::Bucket
Net::Riak::Role::REST::Object
Net::Riak::Role::REST::Link
Net::Riak::Role::REST::MapReduce
+ Net::Riak::Role::REST::Search
/;
has http_request => (
diff --git a/lib/Net/Riak/Role/REST/Search.pm b/lib/Net/Riak/Role/REST/Search.pm
new file mode 100644
index 0000000..b83e3d4
--- /dev/null
+++ b/lib/Net/Riak/Role/REST/Search.pm
@@ -0,0 +1,76 @@
+package Net::Riak::Role::REST::Search;
+use Moose::Role;
+use JSON;
+
+#ABSTRACT: Search interface
+
+sub search {
+ my $self = shift;
+ my %params = @_;
+ my $request;
+
+ $request =
+ $self->new_request( 'GET',
+ [ $self->search_prefix, "select" ], \%params ) unless $params{index};
+ if ( $params{index} ){
+ my $index = delete $params{index};
+ $request =
+ $self->new_request( 'GET',
+ [ $self->search_prefix, $index, "select" ], \%params );
+ }
+
+ my $http_response = $self->send_request($request);
+
+ return if (!$http_response);
+
+ my $status = $http_response->code;
+ if ($status == 404) {
+ return;
+ }
+
+ return JSON::decode_json($http_response->content) if $params{wt} =~ /json/i;
+ $http_response->content;
+};
+
+sub setup_indexing {
+ my ( $self, $bucket ) = @_;
+ my $request =
+ $self->new_request( 'GET',
+ [ $self->prefix, $bucket ] );
+
+ my $http_response = $self->send_request($request);
+
+ return if (!$http_response);
+ my $status = $http_response->code;
+ if ($status == 404) {
+ return;
+ }
+
+ my $precommits = JSON::decode_json($http_response->content)->{props}->{precommit};
+
+ for (@$precommits){
+ return JSON::decode_json($http_response->content) if $_->{mod} eq "riak_search_kv_hook";
+ }
+ push ( @$precommits, { mod => "riak_search_kv_hook" , fun => "precommit" } );
+
+ $request = $self->new_request( 'PUT', [ $self->prefix, $bucket ] );
+ $request->content( JSON::encode_json({ props => { precommit => $precommits } } ) );
+ $request->header('Content-Type' => "application/json" );
+
+ $http_response = $self->send_request($request);
+
+ return if (!$http_response);
+ $status = $http_response->code;
+ if ($status == 404) {
+ return;
+ }
+ $request =
+ $self->new_request( 'GET',
+ [ $self->prefix, $bucket ] );
+
+ $http_response = $self->send_request($request);
+
+ JSON::decode_json($http_response->content);
+}
+
+1;
diff --git a/lib/Net/Riak/Search.pm b/lib/Net/Riak/Search.pm
new file mode 100644
index 0000000..ee2ed57
--- /dev/null
+++ b/lib/Net/Riak/Search.pm
@@ -0,0 +1,85 @@
+package
+Net::Riak::Search;
+use Moose;
+
+#ABSTRACT: Search interface
+
+with 'Net::Riak::Role::Base' => {classes =>
+ [{name => 'client', required => 0},]};
+
+sub search {
+ my ($self, $params) = @_;
+ $self->client->search($params);
+};
+
+sub setup_indexing {
+ my ($self, $bucket) = @_;
+ $self->client->setup_indexing($bucket);
+};
+
+1;
+
+=head1 SYNOPSIS
+
+ my $client = Net::Riak->new(...);
+ my $bucket = $client->bucket('foo');
+
+ # retrieve an existing object
+ my $obj1 = $bucket->get('foo');
+
+ # create/store a new object
+ my $obj2 = $bucket->new_object('foo2', {...});
+ $object->store;
+
+ $bucket->delete_object($key, 3); # optional w val
+
+=head1 DESCRIPTION
+
+L<Net::Riak::Search> allows you to enable indexing documents for a given bucket and querying/searching the index.
+
+=head2 METHODS
+
+=head3 setup_indexing
+
+ $client->setup_indexing('bucket_name');
+
+Does the same as :
+
+ curl -X PUT -H "content-type:application/json" http://localhost:8098/riak/bucket_name -d '{"props":{"precommit":[{"mod":"riak_search_kv_hook","fun":"precommit"}]}'
+
+but takes in account previouses precommits.
+
+=head3 search
+
+ my $response = $client->search(
+ index => 'bucket_name',
+ q => 'field:value'
+ );
+ # is the same as :
+ my $response = $client->search(
+ q => 'bucket_name.field:value'
+ );
+
+Search the index
+
+=over 4
+
+=item wt => 'XML|JSON'
+
+defines the response format (XML is the default value as for Solr/Lucene)
+
+=item q
+
+the query string
+
+=item index
+
+is the default index you want to query, if no index is provided you have to add it as a prefix of the fields in the query string
+
+=item rows
+
+is the number of documents you want to be returned in the response
+
+=back
+
+More parameters are available, just check at L<http://wiki.basho.com/Riak-Search---Querying.html#Querying-via-the-Solr-Interface>
diff --git a/t/20_search.t b/t/20_search.t
new file mode 100644
index 0000000..b25e811
--- /dev/null
+++ b/t/20_search.t
@@ -0,0 +1,30 @@
+use lib 't/lib';
+use Test::More;
+use Test::Riak;
+
+test_riak_rest {
+ my ($client, $bucket_name) = @_;
+ ok $client->setup_indexing($bucket_name), 'setup indexing ok';
+
+ ok my $bucket = $client->bucket($bucket_name), 'got bucket test';
+ my $content = { field => "indexed" };
+
+ ok my $obj = $bucket->new_object(undef, $content),
+ 'created a new riak object without a key';
+ ok $obj->store, 'store object without key';
+ ok $obj->key, 'key created';
+
+ is $client->search(
+ index => $bucket_name,
+ wt => "json",
+ q => "field:indexed")->{response}->{docs}[0]->{id},
+ $obj->key,
+ 'search with index in path';
+
+ is $client->search(
+ wt => "json",
+ q => "$bucket_name.field:indexed")->{response}->{docs}[0]->{id},
+ $obj->key,
+ 'search with index prefixes in query';
+ $obj->delete;
+}
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-06 04:28:42 +0000