From 08cf0c72671e94086352b03683e1ad57348bee1f Mon Sep 17 00:00:00 2001 From: gmaurice Date: Thu, 7 Jul 2011 13:19:06 +0200 Subject: documentation added for search --- lib/Net/Riak.pm | 20 ++++++++++++ lib/Net/Riak/Role/REST/Search.pm | 4 ++- lib/Net/Riak/Search.pm | 69 +++++++++++++++++++++++++++++++++++++++- 3 files changed, 91 insertions(+), 2 deletions(-) (limited to 'lib') diff --git a/lib/Net/Riak.pm b/lib/Net/Riak.pm index dbfc6a5..49a4d0f 100644 --- a/lib/Net/Riak.pm +++ b/lib/Net/Riak.pm @@ -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 @@ -173,6 +181,18 @@ Start assembling a Map/Reduce operation say Dumper $client->stats; +=head2 search (REST only) + + $client->search( index => 'bucket_name', q => 'field:value' ); + +Makes a query to the index (see L 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 diff --git a/lib/Net/Riak/Role/REST/Search.pm b/lib/Net/Riak/Role/REST/Search.pm index 642964b..6748b20 100644 --- a/lib/Net/Riak/Role/REST/Search.pm +++ b/lib/Net/Riak/Role/REST/Search.pm @@ -2,6 +2,8 @@ package Net::Riak::Role::REST::Search; use Moose::Role; use JSON; +#ABSTRACT: Search interface + sub search { my $self = shift; my %params = @_; @@ -71,4 +73,4 @@ sub setup_indexing { JSON::decode_json($http_response->content); } -1; +1; \ No newline at end of file diff --git a/lib/Net/Riak/Search.pm b/lib/Net/Riak/Search.pm index 8cf42b7..a6282de 100644 --- a/lib/Net/Riak/Search.pm +++ b/lib/Net/Riak/Search.pm @@ -1,7 +1,8 @@ package Net::Riak::Search; - use Moose; +#ABSTRACT: Search interface + with 'Net::Riak::Role::Base' => {classes => [{name => 'client', required => 0},]}; @@ -16,3 +17,69 @@ sub setup_indexing { }; 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 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 \ No newline at end of file -- cgit v1.2.3 From f3c37bba30c316f6b37d82282f6ecf0cef61ea62 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Thu, 7 Jul 2011 13:22:27 +0200 Subject: remove white spaces Signed-off-by: franck cuny --- lib/Net/Riak.pm | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'lib') diff --git a/lib/Net/Riak.pm b/lib/Net/Riak.pm index 49a4d0f..45d445a 100644 --- a/lib/Net/Riak.pm +++ b/lib/Net/Riak.pm @@ -37,7 +37,7 @@ sub bucket { 1; =head1 SYNOPSIS - + # REST interface my $client = Net::Riak->new( host => 'http://10.0.0.40:8098', @@ -58,7 +58,7 @@ 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... @@ -125,7 +125,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 @@ -174,7 +174,7 @@ 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) @@ -190,8 +190,8 @@ Makes a query to the index (see L for more details on paramet =head2 setup_indexing (REST only) $client->setup_indexing('bucket_name'); - -Define precommit hook in order to enable indexing documents written into the given bucket + +Define precommit hook in order to enable indexing documents written into the given bucket =head1 SEE ALSO -- cgit v1.2.3 From 94209555eaa12357b177f36be40497a9b0d83ed6 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Thu, 7 Jul 2011 13:23:39 +0200 Subject: perltidy + whitespaces removed Signed-off-by: franck cuny --- lib/Net/Riak/Search.pm | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'lib') diff --git a/lib/Net/Riak/Search.pm b/lib/Net/Riak/Search.pm index a6282de..ee2ed57 100644 --- a/lib/Net/Riak/Search.pm +++ b/lib/Net/Riak/Search.pm @@ -1,4 +1,5 @@ -package Net::Riak::Search; +package +Net::Riak::Search; use Moose; #ABSTRACT: Search interface @@ -18,7 +19,6 @@ sub setup_indexing { 1; - =head1 SYNOPSIS my $client = Net::Riak->new(...); @@ -45,8 +45,8 @@ L allows you to enable indexing documents for a given bucket 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"}]}' - + 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 @@ -82,4 +82,4 @@ is the number of documents you want to be returned in the response =back -More parameters are available, just check at L \ No newline at end of file +More parameters are available, just check at L -- cgit v1.2.3 From 61ec75a67b45b696c8e078c89f44139117e8360f Mon Sep 17 00:00:00 2001 From: franck cuny Date: Thu, 7 Jul 2011 13:24:24 +0200 Subject: removed more white spaces Signed-off-by: franck cuny --- lib/Net/Riak/Role/REST/Search.pm | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'lib') diff --git a/lib/Net/Riak/Role/REST/Search.pm b/lib/Net/Riak/Role/REST/Search.pm index 6748b20..b83e3d4 100644 --- a/lib/Net/Riak/Role/REST/Search.pm +++ b/lib/Net/Riak/Role/REST/Search.pm @@ -18,7 +18,7 @@ sub search { $self->new_request( 'GET', [ $self->search_prefix, $index, "select" ], \%params ); } - + my $http_response = $self->send_request($request); return if (!$http_response); @@ -34,23 +34,23 @@ sub search { sub setup_indexing { my ( $self, $bucket ) = @_; - my $request = + 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 ] ); @@ -58,19 +58,19 @@ sub setup_indexing { $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 = + $request = $self->new_request( 'GET', [ $self->prefix, $bucket ] ); $http_response = $self->send_request($request); JSON::decode_json($http_response->content); -} +} -1; \ No newline at end of file +1; -- cgit v1.2.3