Authors: Ransom Richardson (ransom@ransomr.net).
An low level Erlang interface to Amazon's DynamoDB.
This API is lower level than the one inerlcloud_ddb
. It takes JSON terms as
defined by jsx
.
attempt() = {attempt, pos_integer()} | {error, term()}
attr() = {attr_type(), attr_value()}
attr_name() = binary()
attr_type() = binary()
attr_value() = binary()
batch_get_item_request_item() = {table_name(), [key(), ...], opts()} | {table_name(), [key(), ...]}
batch_write_item_delete() = {delete, key()}
batch_write_item_put() = {put, item()}
batch_write_item_request() = batch_write_item_put() | batch_write_item_delete()
batch_write_item_request_item() = {table_name(), [batch_write_item_request()]}
hash_key() = attr()
hash_range_key() = {hash_key(), range_key()}
item() = jsx:json_term()
json_return() = {ok, jsx:json_term()} | {error, term()}
key() = hash_key() | hash_range_key()
key_schema() = key_schema_value() | {key_schema_value(), key_schema_value()}
key_schema_value() = {attr_name(), attr_type()}
opts() = jsx:json_term()
range_key() = attr()
retry_fun() = fun((pos_integer(), term()) -> attempt())
table_name() = binary()
updates() = jsx:json_term()
backoff(Attempt::pos_integer()) -> ok
batch_get_item(RequestItems::[batch_get_item_request_item()]) -> json_return()
batch_get_item(RequestItems::[batch_get_item_request_item()], Config::aws_config()) -> json_return()
batch_write_item(RequestItems::[batch_write_item_request_item()]) -> json_return()
batch_write_item(RequestItems::[batch_write_item_request_item()], Config::aws_config()) -> json_return()
create_table(Table::table_name(), KeySchema::key_schema(), ReadUnits::non_neg_integer(), WriteUnits::non_neg_integer()) -> json_return()
create_table(Table::table_name(), KeySchema::key_schema(), ReadUnits::non_neg_integer(), WriteUnits::non_neg_integer(), Config::aws_config()) -> json_return()
delete_item(Table::table_name(), Key::key()) -> json_return()
delete_item(Table::table_name(), Key::key(), Opts::opts()) -> json_return()
delete_item(Table::table_name(), Key::key(), Opts::opts(), Config::aws_config()) -> json_return()
delete_table(Table::table_name()) -> json_return()
delete_table(Table::table_name(), Config::aws_config()) -> json_return()
describe_table(Table::table_name()) -> json_return()
describe_table(Table::table_name(), Config::aws_config()) -> json_return()
get_item(Table::table_name(), Key::key()) -> json_return()
get_item(Table::table_name(), Key::key(), Opts::opts()) -> json_return()
get_item(Table::table_name(), Key::key(), Opts::opts(), Config::aws_config()) -> json_return()
key_value(HashKey::key()) -> jsx:json_term()
list_tables() -> json_return()
list_tables(Opts::opts()) -> json_return()
list_tables(Opts::opts(), Config::aws_config()) -> json_return()
put_item(Table::table_name(), Item::item()) -> json_return()
put_item(Table::table_name(), Item::item(), Opts::opts()) -> json_return()
put_item(Table::table_name(), Item::item(), Opts::opts(), Config::aws_config()) -> json_return()
q(Table::table_name(), HashKey::hash_key()) -> json_return()
q(Table::table_name(), HashKey::hash_key(), Opts::opts()) -> json_return()
q(Table::table_name(), HashKey::hash_key(), Opts::opts(), Config::aws_config()) -> json_return()
retry(Attempt::pos_integer(), Reason::term()) -> attempt()
scan(Table::table_name()) -> json_return()
scan(Table::table_name(), Opts::opts()) -> json_return()
scan(Table::table_name(), Opts::opts(), Config::aws_config()) -> json_return()
update_item(Table::table_name(), Key::key(), Updates::updates()) -> json_return()
update_item(Table::table_name(), Key::key(), Updates::updates(), Opts::opts()) -> json_return()
update_item(Table::table_name(), Key::key(), Updates::updates(), Opts::opts(), Config::aws_config()) -> json_return()
update_table(Table::table_name(), ReadUnits::non_neg_integer(), WriteUnits::non_neg_integer()) -> json_return()
update_table(Table::table_name(), ReadUnits::non_neg_integer(), WriteUnits::non_neg_integer(), Config::aws_config()) -> json_return()
Generated by EDoc