/
riak_client.erl
214 lines (195 loc) · 8.37 KB
/
riak_client.erl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
%% This file is provided to you under the Apache License,
%% Version 2.0 (the "License"); you may not use this file
%% except in compliance with the License. You may obtain
%% a copy of the License at
%% http://www.apache.org/licenses/LICENSE-2.0
%% Unless required by applicable law or agreed to in writing,
%% software distributed under the License is distributed on an
%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
%% KIND, either express or implied. See the License for the
%% specific language governing permissions and limitations
%% under the License.
%% @doc The client object used for all access into the riak system.
%% @type riak_client() = term()
-module(riak_client, [Node,ClientId]).
-author('Justin Sheehy <justin@basho.com>').
-export([mapred/2,mapred/3]).
-export([get/3,get/4]).
-export([put/2,put/3,put/4]).
-export([delete/3,delete/4]).
-export([list_keys/1]).
-export([set_bucket/2,get_bucket/1]).
-export([reload_all/1]).
-export([remove_from_cluster/1]).
-export([send_event/2]).
%% @type default_timeout() = 15000
-define(DEFAULT_TIMEOUT, 15000).
%% @spec mapred(Inputs :: list(),
%% Query :: [riak_mapreduce_fsm:mapred_queryterm()]) ->
%% {ok, riak_mapreduce_fsm:mapred_result()} |
%% {error, {bad_qterm, riak_mapreduce_fsm:mapred_queryterm()}} |
%% {error, timeout} |
%% {error, Err :: term()}
%% @doc Perform a map/reduce job across the cluster.
%% See the map/reduce documentation for explanation of behavior.
%% @equiv mapred(Inputs, Query, default_timeout())
mapred(Inputs,Query) -> mapred(Inputs,Query,?DEFAULT_TIMEOUT).
%% @spec mapred(Inputs :: list(),
%% Query :: [riak_mapreduce_fsm:mapred_queryterm()],
%% TimeoutMillisecs :: integer()) ->
%% {ok, riak_mapreduce_fsm:mapred_result()} |
%% {error, {bad_qterm, riak_mapreduce_fsm:mapred_queryterm()}} |
%% {error, timeout} |
%% {error, Err :: term()}
%% @doc Perform a map/reduce job across the cluster.
%% See the map/reduce documentation for explanation of behavior.
mapred(Inputs,Query,Timeout)
when is_list(Inputs), is_list(Query), is_integer(Timeout) ->
Me = self(),
spawn(Node, riak_mapreduce_fsm, start, [Inputs,Query,Timeout,Me]),
receive
{error, Err} -> {error, Err};
{ok, Res} -> {ok, Res}
after Timeout ->
{error, timeout}
end.
%% @spec get(riak_object:bucket(), riak_object:key(), R :: integer()) ->
%% {ok, riak_object:riak_object()} |
%% {error, notfound} |
%% {error, timeout} |
%% {error, Err :: term()}
%% @doc Fetch the object at Bucket/Key. Return a value as soon as R
%% nodes have responded with a value or error.
%% @equiv get(Bucket, Key, R, default_timeout())
get(Bucket, Key, R) -> get(Bucket, Key, R, ?DEFAULT_TIMEOUT).
%% @spec get(riak_object:bucket(), riak_object:key(), R :: integer(),
%% TimeoutMillisecs :: integer()) ->
%% {ok, riak_object:riak_object()} |
%% {error, notfound} |
%% {error, timeout} |
%% {error, Err :: term()}
%% @doc Fetch the object at Bucket/Key. Return a value as soon as R
%% nodes have responded with a value or error, or TimeoutMillisecs passes.
get(Bucket, Key, R, Timeout) when is_atom(Bucket), is_binary(Key),
is_integer(R), is_integer(Timeout) ->
Me = self(),
spawn(Node, riak_get_fsm, start, [Bucket,Key,R,Timeout,Me]),
receive
{error, Err} -> {error, Err};
{ok, RObj} -> {ok, RObj}
after Timeout ->
{error, timeout}
end.
%% @spec put(RObj :: riak_object:riak_object(), W :: integer()) ->
%% ok |
%% {error, too_many_fails} |
%% {error, timeout}
%% @doc Store RObj in the cluster.
%% Return as soon as at least W nodes have received the request.
%% @equiv put(RObj, W, W, default_timeout())
put(RObj, W) -> put(RObj, W, W, ?DEFAULT_TIMEOUT).
%% @spec put(RObj::riak_object:riak_object(),W :: integer(),RW :: integer()) ->
%% ok |
%% {error, too_many_fails} |
%% {error, timeout}
%% @doc Store RObj in the cluster.
%% Return as soon as at least W nodes have received the request, and
%% at least DW nodes have stored it in their storage backend.
%% @equiv put(Robj, W, DW, default_timeout())
put(RObj, W, DW) -> put(RObj, W, DW, ?DEFAULT_TIMEOUT).
%% @spec put(RObj::riak_object:riak_object(), W :: integer(), RW :: integer(),
%% TimeoutMillisecs :: integer()) ->
%% ok |
%% {error, too_many_fails} |
%% {error, timeout}
%% @doc Store RObj in the cluster.
%% Return as soon as at least W nodes have received the request, and
%% at least DW nodes have stored it in their storage backend, or
%% TimeoutMillisecs passes.
put(RObj, W, DW, Timeout) ->
R0 = riak_object:increment_vclock(RObj, ClientId),
Me = self(),
spawn(Node, riak_put_fsm, start, [R0,W,DW,Timeout,Me]),
receive
ok -> ok
after Timeout ->
{error, timeout}
end.
%% @spec delete(riak_object:bucket(), riak_object:key(), RW :: integer()) ->
%% ok |
%% {error, too_many_fails} |
%% {error, notfound} |
%% {error, timeout} |
%% {error, Err :: term()}
%% @doc Delete the object at Bucket/Key. Return a value as soon as RW
%% nodes have responded with a value or error.
%% @equiv delete(Bucket, Key, RW, default_timeout())
delete(Bucket,Key,RW) -> delete(Bucket,Key,RW,?DEFAULT_TIMEOUT).
%% @spec delete(riak_object:bucket(), riak_object:key(), RW :: integer(),
%% TimeoutMillisecs :: integer()) ->
%% ok |
%% {error, too_many_fails} |
%% {error, notfound} |
%% {error, timeout} |
%% {error, Err :: term()}
%% @doc Delete the object at Bucket/Key. Return a value as soon as RW
%% nodes have responded with a value or error, or TimeoutMillisecs passes.
delete(Bucket,Key,RW,Timeout) ->
Me = self(),
spawn(Node, riak_delete, delete, [Bucket,Key,RW,Timeout,Me]),
receive
ok -> ok
after Timeout ->
{error, timeout}
end.
%% @spec list_keys(riak_object:bucket()) ->
%% {ok, [Key :: riak_object:key()]} |
%% {error, timeout} |
%% {error, Err :: term()}
%% @doc List the keys known to be present in Bucket.
%% Key lists are updated asynchronously, so this may be slightly
%% out of date if called immediately after a put or delete.
%% @equiv list_keys(Bucket, default_timeout()*8)
list_keys(Bucket) ->
list_keys(Bucket, ?DEFAULT_TIMEOUT*8).
%% @spec list_keys(riak_object:bucket(), TimeoutMillisecs :: integer()) ->
%% {ok, [Key :: riak_object:key()]} |
%% {error, timeout} |
%% {error, Err :: term()}
%% @doc List the keys known to be present in Bucket.
%% Key lists are updated asynchronously, so this may be slightly
%% out of date if called immediately after a put or delete.
list_keys(Bucket, Timeout) ->
Me = self(),
spawn(Node, riak_keys_fsm, start, [Bucket,Timeout,Me]),
receive
{ok, Reply} -> {ok, Reply}
after Timeout ->
{error, timeout}
end.
%% @spec set_bucket(riak_object:bucket(), [BucketProp :: {atom(),term()}]) -> ok
%% @doc Set the given properties for Bucket.
%% This is generally best if done at application start time,
%% to ensure expected per-bucket behavior.
%% See riak_bucket for expected useful properties.
set_bucket(BucketName,BucketProps) ->
rpc:call(Node,riak_bucket,set_bucket,[BucketName,BucketProps]).
%% @spec get_bucket(riak_object:bucket()) -> [BucketProp :: {atom(),term()}]
%% @doc Get all properties for Bucket.
%% See riak_bucket for expected useful properties.
get_bucket(BucketName) ->
rpc:call(Node,riak_bucket,get_bucket,[BucketName]).
%% @spec reload_all(Module :: atom()) -> term()
%% @doc Force all Riak nodes to reload Module.
%% This is used when loading new modules for map/reduce functionality.
reload_all(Module) -> rpc:call(Node,riak_util,reload_all,[Module]).
%% @spec remove_from_cluster(ExitingNode :: atom()) -> term()
%% @doc Cause all partitions owned by ExitingNode to be taken over
%% by other nodes.
remove_from_cluster(ExitingNode) ->
rpc:call(Node,riak_ring_gossiper,remove_from_cluster,[ExitingNode]).
%% @spec send_event(EventName::atom(), EventDetail::term()) -> ok
%% @doc Send a client-generated event to the Riak eventer.
send_event(EventName, EventDetail) ->
rpc:call(Node,riak_eventer,notify,
[client_event, EventName, {ClientId, EventDetail}]).