Liking cljdoc? Tell your friends :D

franklin.core

The core Franklin library.

The core Franklin library.
raw docstring

batch-get-itemclj

(batch-get-item {:keys [table-name] :as table-context}
                {:keys [keys consistent? expr-attr-names projections ch]})

BatchGetItem request.

Alpha. Subject to change.

BatchGetItem request.

Alpha. Subject to change.
sourceraw docstring

batch-write-itemclj

(batch-write-item {:keys [table-name] :as table-context}
                  {:keys [items return-cc return-item-coll-metrics sync? ch]})

BatchWriteItem request.

Alpha. Subject to change.

BatchWriteItem request.

Alpha. Subject to change.
sourceraw docstring

delete-itemclj

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

DeleteItem request.

Alpha. Subject to change.

DeleteItem request.

Alpha. Subject to change.
sourceraw docstring

describe-tableclj

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

DescribeTable request.

Alpha. Subject to change.

DescribeTable request.

Alpha. Subject to change.
sourceraw docstring

get-itemclj

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

GetItem request.

Alpha. Subject to change.

GetItem request.

Alpha. Subject to change.
sourceraw docstring

invokeclj

(invoke op client-opts request & [ch])

Wraps aws-api's async 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.

Wraps aws-api's async 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.
sourceraw docstring

make-clientclj

(make-client & [opts])
source

make-table-contextclj

(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.

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.
sourceraw docstring

put-itemclj

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

PutItem request.

Alpha. Subject to change.

PutItem request.

Alpha. Subject to change.
sourceraw docstring

queryclj

(query table-context {:keys [ch] :as query-opts})

Query request with items converted to Clojure data types.

Alpha. Subject to change.

Query request with items converted to Clojure data types.

Alpha. Subject to change.
sourceraw docstring

query-first-itemclj

source

query-last-itemclj

source

scanclj

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

Scan request with items converted to Clojure data types.

Alpha. Subject to change.

Scan request with items converted to Clojure data types.

Alpha. Subject to change.
sourceraw docstring

update-itemclj

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

UpdateItem request.

Alpha. Subject to change.

UpdateItem request.

Alpha. Subject to change.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close