From 08cf0c72671e94086352b03683e1ad57348bee1f Mon Sep 17 00:00:00 2001
From: gmaurice <germain.maurice@linkfluence.net>
Date: Thu, 7 Jul 2011 13:19:06 +0200
Subject: documentation added for search

---
 lib/Net/Riak/Search.pm | 69 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 68 insertions(+), 1 deletion(-)

(limited to 'lib/Net/Riak/Search.pm')

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<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>
\ No newline at end of file
-- 
cgit v1.2.3


From 94209555eaa12357b177f36be40497a9b0d83ed6 Mon Sep 17 00:00:00 2001
From: franck cuny <franck@lumberjaph.net>
Date: Thu, 7 Jul 2011 13:23:39 +0200
Subject: perltidy + whitespaces removed

Signed-off-by: franck cuny <franck@lumberjaph.net>
---
 lib/Net/Riak/Search.pm | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'lib/Net/Riak/Search.pm')

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<Net::Riak::Search> 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<http://wiki.basho.com/Riak-Search---Querying.html#Querying-via-the-Solr-Interface>
\ No newline at end of file
+More parameters are available, just check at L<http://wiki.basho.com/Riak-Search---Querying.html#Querying-via-the-Solr-Interface>
-- 
cgit v1.2.3