Anonymous avatar Anonymous committed 6e3397e

re-export README.org

Comments (0)

Files changed (1)

                            Welcome to Riak.
                            ================
 
-Date: 2010-03-10 01:18:20 CST
+Date: 2010-03-10 09:25:33 EST
 
 
 
   * LICENSE: the license under which Riak is released
   * apps/    the source tree for Riak and all its dependencies
   * doc/
+    - admin.org: Riak Administration Guide
+    - architecture.txt: details about the underlying design of Riak
+    - basic-client.txt: slightly more detail on using Riak
     - basic-setup.txt:  slightly more detail on setting up Riak
-    - basic-client.txt: slightly more detail on using Riak
-    - architecture.txt: details about the underlying design of Riak
-    - index.html:       the root of the edoc output of 'make docs'
+    - basic-mapreduce.txt: introduction to map/reduce on Riak
+    - js-mapreduce.org: using Javascript with Riak map/reduce
+    - man/riak.1.gz: manual page for the riak(1) command
+    - man/riak-admin.1.gz manual page for the riak-admin(1) command
+    - raw-http-howto.txt: using the Riak HTTP interface
+
 
 
 2 Quick Start 
    Assuming you have a working Erlang (R13B03 or later) installation,
    building Riak should be as simple as:
 
-
   $ cd $RIAK
   $ make rel
 
+
 2.2 Starting Riak 
 ==================
 
    Once you have successfully built Riak, you can start the server with the
    following commands:
 
-
   $ cd $RIAK/rel/riak
   $ bin/riak start
 
+
    Now, verify that the server started up cleanly and is working:
 
    $ bin/riak-admin test
    Now that you have a functional server, let's try storing some data in
    it. First, start up a erlang node using our embedded version of erlang:
 
-
   $ erts-<vsn>/bin/erl -name riaktest@127.0.0.1 -setcookie riak
   
   Eshell V5.7.4  (abort with ^G)
   (riaktest@127.0.0.1)1>
 
+
    Now construct the node name of Riak server and make sure we can talk to it:
 
-
   (riaktest@127.0.0.1)4> RiakNode = 'riak@127.0.0.1'.
   
   (riaktest@127.0.0.1)2> net_adm:ping(RiakNode).
   pong
   (riaktest@127.0.0.1)2>
+
    
    We are now ready to start the Riak client:
 
-
   (riaktest@127.0.0.1)2> {ok, C} = riak:client_connect(RiakNode).
   {ok,{riak_client,'riak@127.0.0.1',<<4,136,81,151>>}}
 
+
    Let's create a shopping list for bread at /groceries/mine:
 
-
   (riaktest@127.0.0.1)6> O0 = riak_object:new(<<"groceries">>, <<"mine">>, ["bread"]).
   O0 = riak_object:new(<<"groceries">>, <<"mine">>, ["bread"]).
   {r_object,<<"groceries">>,<<"mine">>,
          undefined}
   
    (riaktest@127.0.0.1)3> C:put(O0, 1).
+
     
     Now, read the list back from the Riak server and extract the value
 
-
   (riaktest@127.0.0.1)4> {ok, O1} = C:get(<<"groceries">>, <<"mine">>, 1).
   {ok,{r_object,<<"groceries">>,<<"mine">>,
             [{r_content,{dict,2,16,16,8,80,48,
    (riaktest@127.0.0.1)5> V = riak_object:get_value(O1).
    ["bread"]
 
+
      Add milk to our list of groceries and write the new value to Riak:
 
-
   (riaktest@127.0.0.1)6> %% add milk to the list
   (riaktest@127.0.0.1)6> O2 = riak_object:update_value(O1, ["milk" | V]).
   {r_object,<<"groceries">>,<<"mine">>,
   (riaktest@127.0.0.1)7> C:put(O2, 1).
   ok
 
+
      Finally, see what other keys are available in groceries bucket:
 
-
   (riaktest@127.0.0.1)8> C:list_keys(<<"groceries">>).
   {ok,[<<"mine">>]}
 
 
+
 3 Server Management 
 ~~~~~~~~~~~~~~~~~~~~
 
 
     To join a new Riak node to an existing cluster:
 
-
   $ bin/riak start # If a local server is not already running
   $ bin/riak-admin join <node in cluster>
 
+
     (Note that you must have a local node already running for this to work)
     
     To verify that the local Riak node is able to read/write data:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.