Module erlcloud_ddb1

An low level Erlang interface to Amazon's DynamoDB.

Authors: Ransom Richardson (ransom@ransomr.net).

Description

An low level Erlang interface to Amazon's DynamoDB.

This API is lower level than the one in erlcloud_ddb. It takes JSON terms as defined by jsx.

Data Types

attempt()

attempt() = {attempt, pos_integer()} | {error, term()}

attr()

attr() = {attr_type(), attr_value()}

attr_name()

attr_name() = binary()

attr_type()

attr_type() = binary()

attr_value()

attr_value() = binary()

batch_get_item_request_item()

batch_get_item_request_item() = {table_name(), [key(), ...], opts()} | {table_name(), [key(), ...]}

batch_write_item_delete()

batch_write_item_delete() = {delete, key()}

batch_write_item_put()

batch_write_item_put() = {put, item()}

batch_write_item_request()

batch_write_item_request() = batch_write_item_put() | batch_write_item_delete()

batch_write_item_request_item()

batch_write_item_request_item() = {table_name(), [batch_write_item_request()]}

hash_key()

hash_key() = attr()

hash_range_key()

hash_range_key() = {hash_key(), range_key()}

item()

item() = jsx:json_term()

json_return()

json_return() = {ok, jsx:json_term()} | {error, term()}

key()

key() = hash_key() | hash_range_key()

key_schema()

key_schema() = key_schema_value() | {key_schema_value(), key_schema_value()}

key_schema_value()

key_schema_value() = {attr_name(), attr_type()}

opts()

opts() = jsx:json_term()

range_key()

range_key() = attr()

retry_fun()

retry_fun() = fun((pos_integer(), term()) -> attempt())

table_name()

table_name() = binary()

updates()

updates() = jsx:json_term()

Function Index

backoff/1
batch_get_item/1
batch_get_item/2
batch_write_item/1
batch_write_item/2
create_table/4
create_table/5
delete_item/2
delete_item/3
delete_item/4
delete_table/1
delete_table/2
describe_table/1
describe_table/2
get_item/2
get_item/3
get_item/4
key_value/1
list_tables/0
list_tables/1
list_tables/2
put_item/2
put_item/3
put_item/4
q/2
q/3
q/4
retry/2
scan/1
scan/2
scan/3
update_item/3
update_item/4
update_item/5
update_table/3
update_table/4

Function Details

backoff/1

backoff(Attempt::pos_integer()) -> ok

batch_get_item/1

batch_get_item(RequestItems::[batch_get_item_request_item()]) -> json_return()

batch_get_item/2

batch_get_item(RequestItems::[batch_get_item_request_item()], Config::aws_config()) -> json_return()

batch_write_item/1

batch_write_item(RequestItems::[batch_write_item_request_item()]) -> json_return()

batch_write_item/2

batch_write_item(RequestItems::[batch_write_item_request_item()], Config::aws_config()) -> json_return()

create_table/4

create_table(Table::table_name(), KeySchema::key_schema(), ReadUnits::non_neg_integer(), WriteUnits::non_neg_integer()) -> json_return()

create_table/5

create_table(Table::table_name(), KeySchema::key_schema(), ReadUnits::non_neg_integer(), WriteUnits::non_neg_integer(), Config::aws_config()) -> json_return()

delete_item/2

delete_item(Table::table_name(), Key::key()) -> json_return()

delete_item/3

delete_item(Table::table_name(), Key::key(), Opts::opts()) -> json_return()

delete_item/4

delete_item(Table::table_name(), Key::key(), Opts::opts(), Config::aws_config()) -> json_return()

delete_table/1

delete_table(Table::table_name()) -> json_return()

delete_table/2

delete_table(Table::table_name(), Config::aws_config()) -> json_return()

describe_table/1

describe_table(Table::table_name()) -> json_return()

describe_table/2

describe_table(Table::table_name(), Config::aws_config()) -> json_return()

get_item/2

get_item(Table::table_name(), Key::key()) -> json_return()

get_item/3

get_item(Table::table_name(), Key::key(), Opts::opts()) -> json_return()

get_item/4

get_item(Table::table_name(), Key::key(), Opts::opts(), Config::aws_config()) -> json_return()

key_value/1

key_value(HashKey::key()) -> jsx:json_term()

list_tables/0

list_tables() -> json_return()

list_tables/1

list_tables(Opts::opts()) -> json_return()

list_tables/2

list_tables(Opts::opts(), Config::aws_config()) -> json_return()

put_item/2

put_item(Table::table_name(), Item::item()) -> json_return()

put_item/3

put_item(Table::table_name(), Item::item(), Opts::opts()) -> json_return()

put_item/4

put_item(Table::table_name(), Item::item(), Opts::opts(), Config::aws_config()) -> json_return()

q/2

q(Table::table_name(), HashKey::hash_key()) -> json_return()

q/3

q(Table::table_name(), HashKey::hash_key(), Opts::opts()) -> json_return()

q/4

q(Table::table_name(), HashKey::hash_key(), Opts::opts(), Config::aws_config()) -> json_return()

retry/2

retry(Attempt::pos_integer(), Reason::term()) -> attempt()

scan/1

scan(Table::table_name()) -> json_return()

scan/2

scan(Table::table_name(), Opts::opts()) -> json_return()

scan/3

scan(Table::table_name(), Opts::opts(), Config::aws_config()) -> json_return()

update_item/3

update_item(Table::table_name(), Key::key(), Updates::updates()) -> json_return()

update_item/4

update_item(Table::table_name(), Key::key(), Updates::updates(), Opts::opts()) -> json_return()

update_item/5

update_item(Table::table_name(), Key::key(), Updates::updates(), Opts::opts(), Config::aws_config()) -> json_return()

update_table/3

update_table(Table::table_name(), ReadUnits::non_neg_integer(), WriteUnits::non_neg_integer()) -> json_return()

update_table/4

update_table(Table::table_name(), ReadUnits::non_neg_integer(), WriteUnits::non_neg_integer(), Config::aws_config()) -> json_return()


Generated by EDoc