Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drewkerrigan/riak-elixir-client
A Riak client written in Elixir.
https://github.com/drewkerrigan/riak-elixir-client
Last synced: about 1 month ago
JSON representation
A Riak client written in Elixir.
- Host: GitHub
- URL: https://github.com/drewkerrigan/riak-elixir-client
- Owner: drewkerrigan
- License: other
- Created: 2013-09-21T14:33:58.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2020-09-30T00:30:03.000Z (about 4 years ago)
- Last Synced: 2024-10-30T16:56:26.724Z (about 1 month ago)
- Language: Elixir
- Homepage:
- Size: 5.97 MB
- Stars: 197
- Watchers: 18
- Forks: 55
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A Riak client written in Elixir. (ORM and Datamapping)
- fucking-awesome-elixir - riak - A Riak client written in Elixir. (ORM and Datamapping)
- awesome-elixir - riak - A Riak client written in Elixir. (ORM and Datamapping)
README
# Riak Elixir Client
[](https://travis-ci.org/drewkerrigan/riak-elixir-client)
[](https://hex.pm/packages/riak)
[](https://waffle.io/drewkerrigan/riak-elixir-client)
A Riak client written in Elixir. Now includes connection pooling with [pooler](http://github.com/seth/pooler) and a variety of other improvements from [riex](https://github.com/edgurgel/riex).
## Setup
### Prerequisites
* Riak 2.0+
* Elixir 1.0+
#### In an Elixir application
Add the following to mix.exs
```elixir
...
def application do
[ applications: [ :riak ]]
end
...
defp deps do
[ {:riak, "~> 1.1.6"} ]
end
...
```
## Usage
### Establishing a Riak connection
```elixir
{:ok, pid} = Riak.Connection.start_link('127.0.0.1', 8087) # Default values
```
### Connection Pooling
Most functions in this module can be called by passing the pid of the established connection or using a pool of connections (provided by pooler). Define pools by using the group `riak`. Following is an example `config/config.exs`:
```elixir
config :pooler, pools:
[
[
name: :riaklocal1,
group: :riak,
max_count: 10,
init_count: 5,
start_mfa: { Riak.Connection, :start_link, [] }
], [
name: :riaklocal2,
group: :riak,
max_count: 15,
init_count: 2,
start_mfa: { Riak.Connection, :start_link, ['127.0.0.1', 9090] }
]
]
```
For an example using this functionality with a local Riak instance, check [`config/config.exs`](https://github.com/drewkerrigan/riak-elixir-client/blob/master/config/config.exs). More information about Elixir configuration can be found on [http://elixir-lang.org](http://elixir-lang.org): [Application environment and configuration](http://elixir-lang.org/getting-started/mix-otp/distributed-tasks-and-configuration.html#application-environment-and-configuration).
Once a pool configuration is properly defined in a project, calls to Riak can omit the pid. For example:
This call uses a pid from the pool of connections provided by pooler:
```elixir
Riak.delete("user", key)
```
This call requires a pid obtained by first calling `Riak.Connection.start_link`:
```elixir
Riak.delete(pid, "user", key)
```
### Save a value
```elixir
o = Riak.Object.create(bucket: "user", key: "my_key", data: "Han Solo")
Riak.put(pid, o)
```
### Find an object
```elixir
o = Riak.find(pid, "user", "my_key")
```
### Update an object
```elixir
o = %{o | data: "Something Else"}
Riak.put(pid, o)
```
### Delete an object
Using key
```elixir
Riak.delete(pid, "user", key)
```
Using object
```elixir
Riak.delete(pid, o)
```
### Timeseries
Riak Timeseries functionality is available in [TS 1.3.1 releases of Riak](http://docs.basho.com/riak/ts/1.3.1/downloads/) and greater.
#### Setup
Create a table:
```
riak-admin bucket-type create GeoCheckin '{"props":{"table_def": "CREATE TABLE GeoCheckin (region VARCHAR NOT NULL, state VARCHAR NOT NULL, time TIMESTAMP NOT NULL, weather VARCHAR NOT NULL, temperature DOUBLE, PRIMARY KEY ((region, state, QUANTUM(time, 15, 'm')), region, state, time))"}}'
riak-admin bucket-type activate GeoCheckin
```
#### Insert Rows
```
Riak.Timeseries.put("GeoCheckin", [
{"region1", "state1", 25, "hot", 23.0},
{"region2", "state99", 26, "windy", 19.0}
])
> :ok
```
#### Get a row by primary key
```
Riak.Timeseries.get("GeoCheckin", ["region1", "state1", 25])
> {["region", "state", "time", "weather", "temperature"], [{"region1", "state1", 25, "hot", 23.0}]}
```
#### Get all rows
*Note*: This is a very expensive operation for a loaded cluster
```
Riak.Timeseries.list!("GeoCheckin")
> [{"region1", "state1", 25, "hot", 23.0}, {"region2", "state99", 26, "windy", 19.0}]
```
#### Delete a row
```
Riak.Timeseries.delete("GeoCheckin", ["region2", "state99", 26])
> :ok
```
#### Query
```
Riak.Timeseries.query("select * from GeoCheckin where time > 24 and time < 26 and region = 'region1' and state = 'state1'")
> {["region", "state", "time", "weather", "temperature"], [{"region1", "state1", 25, "hot", 23.0}]}
```
### Datatypes
Riak Datatypes (a.k.a. CRDTs) are avaiable in [Riak versions 2.0](http://basho.com/introducing-riak-2-0/) and greater. The types included are: maps, sets, counters, registers and flags.
#### Setup
Datatypes require the use of bucket-types. Maps, sets, counters, and hyper-log-logs can be used as top-level bucket-type datatypes; Registers and flags may only be used within maps.
The following examples assume the presence of 4 datatype enabled bucket-types. You can create these bucket-types by running the following commands on a single Riak node in your cluster:
Bucket-Type: `counters`
```
riak-admin bucket-type create counters '{"props":{"datatype":"counter"}}'
riak-admin bucket-type activate counters
```
Bucket-Type: `sets`
```
riak-admin bucket-type create sets '{"props":{"datatype":"set"}}'
riak-admin bucket-type activate sets
```
Bucket-Type: `maps`
```
riak-admin bucket-type create maps '{"props":{"datatype":"map"}}'
riak-admin bucket-type activate maps
```
Bucket-Type: `hll`
```
riak-admin bucket-type create hll '{"props":{"datatype":"hll"}}'
riak-admin bucket-type activate hll
```
#### Counters
Create a counter (`alias Riak.CRDT.Counter`):
```elixir
Counter.new
|> Counter.increment
|> Counter.increment(2)
|> Riak.update("counters", "my_counter_bucket", "my_key")
```
Fetch a counter:
```elixir
counter = Riak.find("counters", "my_counter_bucket", "my_key")
|> Counter.value
```
`counter` will be 3.
***NOTE***: "Counter drift" is a possibility that needs to be accounted for with any distributed system such as Riak. The problem can manifest itself during failure states in either your applicaiton or Riak itself. If an increment operation fails from the client's point of view, there is not sufficient information available to know whether or not that call made it to zero or all of the replicas for that counter object. As such, if the client attempts to retry the increment after recieving something like a error code 500 from Riak, that counter object is at risk of drifting positive. Similarly if the client decides not to retry, that counter object is at risk of drifting negative.
For these reasons, counters are only suggested for use-cases that can handle some (albeit small) amount of counter drift. Good examples of appropriate use-cases are: Facebook likes, Twitter retweet counts, Youtube view counts, etc. Some examples of poor use-cases for Riak counters are: bank account balances, anything related to money. It is possible to implement these types of solutions using Riak, but more client side logic is necessary. For an example of a client-side ledger with tunable retry options, check [github.com/drewkerrigan/riak-ruby-ledger](https://github.com/drewkerrigan/riak-ruby-ledger). Another approach could be the client-side implementation of a HAT (Highly Available Transaction) algorithm.
#### Sets
Create a set (`alias Riak.CRDT.Set`):
```elixir
Set.new
|> Set.put("foo")
|> Set.put("bar")
|> Riak.update("sets", "my_set_bucket", "my_key")
```
And fetch the set:
```elixir
set = Riak.find("sets", "my_set_bucket", "my_key")
|> Set.value
```
Where `set` is an `orddict`.
#### Maps
Maps handle binary keys with any other datatype (map, set, flag, register and counter).
Create a map (`alias Riak.CRDT.Map`):
```elixir
register = Register.new("some string")
flag = Flag.new |> Flag.enable
Map.new
|> Map.put("k1", register)
|> Map.put("k2", flag)
|> Riak.update("maps", "my_map_bucket", "map_key")
```
And fetch the map:
```elixir
map = Riak.find("maps", "my_map_bucket", key) |> Map.value
```
Where `map` is an `orddict`.
#### Hyper Log Logs
The use case for this type is counting distinct elements in a monotonic way.
I think of it as like a counter for customers visited but once a customer visits
the counter will never go up again. It also isn't possible to remove a element
once it has been added to the log.
Create a HLL (`alias Riak.CRDT.HyperLogLog`):
```elixir
HyperLogLog.new
|> HyperLogLog.add_element("foo")
|> Riak.update("hll", "my_hll_bucket", "hll_key")
```
And fetch the distinct count:
```elixir
hll = Riak.find("hll", "my_hll_bucket", "hll_key") |> HLL.value
```
Where `hll` is an `integer`.
## Examples
Check the `examples/` directory for a few example elixir applications using the riak client.
For more functionality, check `test/` directory.
## Tests
```
MIX_ENV=test mix do deps.get, test
```
***NOTE:*** If you see errors related to `{:error, :nil_object}`, Ensure that you have created and activated the below `map`, `set`, and `counter` bucket types.
*Note*
The creation of the following CRDT bucket-types is a prerequisite for passing the CRDT tests.
```
riak-admin bucket-type create maps '{"props":{"datatype":"map"}}'
riak-admin bucket-type activate maps
riak-admin bucket-type create sets '{"props":{"datatype":"set"}}'
riak-admin bucket-type activate sets
riak-admin bucket-type create counters '{"props":{"datatype":"counter"}}'
riak-admin bucket-type activate counters
riak-admin bucket-type create hll '{"props":{"datatype":"hll"}}'
riak-admin bucket-type activate hll
```
*Note*
The creation of this Timeseries table is a prerequisite for passing the Timeseries tests.
```
riak-admin bucket-type create GeoCheckin '{"props":{"table_def": "CREATE TABLE GeoCheckin (region VARCHAR NOT NULL, state VARCHAR NOT NULL, time TIMESTAMP NOT NULL, weather VARCHAR NOT NULL, temperature DOUBLE, PRIMARY KEY ((region, state, QUANTUM(time, 15, 'm')), region, state, time))"}}'
riak-admin bucket-type activate GeoCheckin
```
## License
Copyright 2017 Drew Kerrigan.
Copyright 2014 Eduardo Gurgel.
Licensed 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.