franklin.core — ctorrisi/franklin 0.0.1-alpha10

The core Franklin library.

batch-get-item clj

(batch-get-item {:keys [table-name] :as table-context} item-opts)

BatchGetItem request.

Alpha. Subject to change.

batch-write-item clj

(batch-write-item table-context {:keys [items] :as item-opts})

BatchWriteItem request.

Alpha. Subject to change.

delete-item clj

(delete-item table-context {:keys [item key] :as item-opts})

DeleteItem request.

Alpha. Subject to change.

describe-index-key-schema clj

(describe-index-key-schema m)

describe-single-index clj

(describe-single-index v)

describe-table clj

(describe-table {:keys [table-name] :as table-context})

DescribeTable request.

Alpha. Subject to change.

get-item clj

(get-item table-context item-opts)

GetItem request with items converted to Clojure data types.

Alpha. Subject to change.

get-item-raw clj

(get-item-raw {:keys [table-name] :as table-context}
              {:keys [item key projections expr-attr-names return-cc]})

GetItem request without items converted to Clojure data types.

Alpha. Subject to change.

invoke clj

(invoke client-opts op request)

Wraps aws-api's invoke function accepts client-opts consisting of either a cognitect.aws.client.api/client config map, or a map containing:

:client - An existing aws-api DynamoDB client, consistent with Franklin's table context.

Alpha. Subject to change.

make-client clj

(make-client & [opts])

make-table-context clj

(make-table-context table-name & [client-opts])

Given a table-name and an optional set of client-opts in the same format as cognitect.aws.client.api/client config map. make-table-context constructs a map consisting of:

:client - The aws-api DynamoDB client. :table-name - The name of the table. :partition-key-name - The name of the partition key for the table. :sort-key-name - The name of the sort key for the table, if it exists. :key-keywords - The partition key and sort key as a vector of keywords.

Alpha. Subject to change.

put-item clj

(put-item table-context {:keys [item key] :as item-opts})

PutItem request.

Alpha. Subject to change.

query clj

(query table-context query-opts)

Query request with items converted to Clojure data types.

Alpha. Subject to change.

query-first-item clj

query-last-item clj

query-raw clj

(query-raw table-context query-opts)

Query request without converting items to Clojure data types.

Alpha. Subject to change.

scan clj

(scan table-context)

(scan table-context scan-opts)

Scan request with items converted to Clojure data types.

Alpha. Subject to change.

scan-raw clj

(scan-raw table-context {:keys [segment total-segments] :as scan-opts})

Scan request without converting items to Clojure data types.

update-item clj

(update-item table-context {:keys [item key update-expr] :as item-opts})

UpdateItem request.

Alpha. Subject to change.