Franklin

A friendly turtle to harness the power of DynamoDB.

Usage

Leiningen and Boot

[ctorrisi/franklin "0.0.1-alpha3"]

deps

{:deps {ctorrisi/franklin {:mvn/version "0.0.1-alpha3"}}}

Friendly?

• minimal dependencies (only depends on aws-api)
• interact with clojure data types
• provide table-centric queries and persistence operations
• provide sensible defaults
• simple and easy

Non-goals

• Supporting legacy operations
• Full API coverage

Use aws-api for legacy operations and operations not related to queries or persistence.

Operations

All operations are centred around being executed on a single table (table-centric).

(ns franklin.example (:require [franklin.core :as f]))

In order to demonstrate these operations, assume the following table named user_location exists with a String typed partition key named user_name and a Number typed sort key named time_stamp.

make-table-context

The minimum to create a table context for a table named user_location.

(def user-location-ctx (f/make-table-context "user_location"))

The definition above is fine if your program is using a single table with default AWS connection/credential options.

make-client

make-client is a convenience function that wraps cognitect.aws.client.api/client with {:api :dynamodb}.

(def ddb-client (f/make-client {:region "ap-southeast-2"}))
(def ctx (f/make-table-context "user_location" {:client ddb-client}))
(def other-ctx (f/make-table-context "user_details" {:client ddb-client}))

put-item

(f/put-item ctx {:item {:user_name "corey"
                        :time_stamp 1564641545000
                        :latitude -37.813629
                        :longitude 144.963058}})

update-item

(f/update-item ctx {:key {:user_name "corey"
                          :time_stamp 1564641545000}
                          :update-expr "set latitude = :lat"
                          :expr-attr-vals {:lat -37.809010}})

get-item

(f/get-item ctx {:key {:user_name "corey"
                       :time_stamp 1564641545000}})

=> {:Item {:user_name "corey"
           :time_stamp 1564641545000
           :latitude -37.80901
           :longitude 144.963058}}

query

(f/query ctx {:partition-key "corey"
              :sort-key      1564641545000})

=> {:Items [{:time_stamp 1564641545000 :user_name "corey" :latitude -37.813629 :longitude 144.963058}]
    :Count 1
    :ScannedCount 1}

(f/query ctx {:partition-key "corey"
              :sort-key      {:between [1564641544999 1564641545001]}
              :projections   [:latitude "longitude"]})

=> {:Items [{:latitude -37.813629 :longitude 144.963058}]
    :Count 1
    :ScannedCount 1}

sort-key options

Supports all of the comparison operators available in DynamoDB's Query Key Condition Expression.

{:sort-key {:= x}}
{:sort-key x} ; equals is implicit, same as above.
{:sort-key {:< x}}
{:sort-key {:<= x}}
{:sort-key {:> x}}
{:sort-key {:>= x}}
{:sort-key {:between [x y]}}
{:sort-key {:begins_with x}}

scan

(f/scan ctx)

=> {:Items [{:user_name "corey" :latitude -37.80901 :longitude 144.963058 :time_stamp 1564641545000}]
    :Count 1
    :ScannedCount 1}

batch-write-item

To delete an item, assoc the :delete? key with a truthy value in the item's map.

(f/batch-write-item ctx {:items [{:user_name  "alice"
                                  :time_stamp 1564641565850}
                                 {:user_name  "bob"
                                  :time_stamp 1564641575140}
                                 {:user_name  "corey"
                                  :time_stamp 1564641545000
                                  :delete?    true}
                                 {:user_name  "corey"
                                  :time_stamp 100}
                                 {:user_name  "corey"
                                  :time_stamp 200}]})

(f/scan ctx)

=> {:Items [{:time_stamp 1564641575140, :user_name "bob"}
            {:time_stamp 1564641565850, :user_name "alice"}
            {:time_stamp 100, :user_name "corey"}
            {:time_stamp 200, :user_name "corey"}]
    :Count 3,
    :ScannedCount 3}

batch-get-item

(f/batch-get-item ctx {:keys [{:user_name  "alice"
                               :time_stamp 1564641565850}
                              {:user_name  "bob"
                               :time_stamp 1564641575140}]})

=> {:Responses {:user_location [{:time_stamp 1564641565850, :user_name "alice"}
                                {:time_stamp 1564641575140, :user_name "bob"}]}
    :UnprocessedKeys {}}

query-sorted-first-item

(f/query-sorted-first-item ctx {:partition-key "corey"})

=> {:time_stamp 100 :user_name "corey"}

query-sorted-last-item

(f/query-sorted-last-item ctx {:partition-key "corey"})

=> {:time_stamp 200 :user_name "corey"}

Credits

Thanks to:

• Peter Taoussanis for Faraday and some inspiration for this library.
• James Reeves for Rotary which Faraday was adapted from.
• Cognitect for aws-api.
• Pixabay for the stock graphics.

Licence

Distributed under the Eclipse Public License - v 2.0

Copyright © 2019 Corey Torrisi