| Overview |  |
Authors: Ransom Richardson (ransom@ransomr.net).
Helpers for using DynamoDB from Erlang.
This is a higher layer API that augments the operations supported by erlcloud_ddb2. The functions in this file do not map directly to DynamoDB operations. Instead they will perform multiple operations in order to implement functionality that isn't available directly using the DynamoDB API.batch_read_ddb_opt() = typed_out() | erlcloud_ddb2:out_opt()
batch_read_ddb_opts() = [batch_read_ddb_opt()]
conditions() = erlcloud_ddb2:conditions()
ddb_opts() = erlcloud_ddb2:ddb_opts()
expression() = erlcloud_ddb2:expression()
get_all_opts() = erlcloud_ddb2:batch_get_item_request_item_opts()
hash_key() = erlcloud_ddb2:in_attr()
in_item() = erlcloud_ddb2:in_item()
items_return() = {ok, [out_item()]} | {ok, non_neg_integer()} | {error, term()}
key() = erlcloud_ddb2:key()
out_item() = erlcloud_ddb2:out_item()
q_all_opts() = [erlcloud_ddb2:q_opt() | batch_read_ddb_opt()]
range_key_name() = erlcloud_ddb2:range_key_name()
scan_all_opts() = [erlcloud_ddb2:scan_opt() | batch_read_ddb_opt()]
table_name() = erlcloud_ddb2:table_name()
typed_out() = {typed_out, boolean()}
write_all_item() = erlcloud_ddb2:batch_write_item_request()
delete_all(Table::table_name(), Keys::[key()]) -> ok | {error, term()}
delete_all(Table::table_name(), Keys::[key()], Opts::ddb_opts()) -> ok | {error, term()}
delete_all(Table::table_name(), Keys::[key()], Opts::ddb_opts(), Config::aws_config()) -> ok | {error, term()}
Perform one or more BatchWriteItem operations to delete all items. Operations are performed in parallel. Writing to only one table is supported.
ok =
erlcloud_ddb_util:delete_all(
[{<<"Forum">>,
[{<<"Name">>, {s, <<"Amazon DynamoDB">>}},
{<<"Name">>, {s, <<"Amazon RDS">>}},
{<<"Name">>, {s, <<"Amazon Redshift">>}},
{<<"Name">>, {s, <<"Amazon ElastiCache">>}}
]}]),
delete_hash_key(Table::table_name(), HashKey::hash_key(), RangeKeyName::range_key_name()) -> ok | {error, term()}
delete_hash_key(Table::table_name(), HashKey::hash_key(), RangeKeyName::range_key_name(), Opts::ddb_opts()) -> ok | {error, term()}
delete_hash_key(Table::table_name(), HashKey::hash_key(), RangeKeyName::range_key_name(), Opts::ddb_opts(), Config::aws_config()) -> ok | {error, term()}
Delete all items with the specified table. Table must be a hash-and-range primary key table. Opts is currently ignored and is provided for future enhancements. This method is not transacted.
ok = erlcloud_ddb_util:delete_hash_key(<<"tn">>, {<<"hash-key-name">>, <<"hash-key-value">>}, <<"range-key-name">>, [])),
get_all(Table::table_name(), Keys::[key()]) -> items_return()
get_all(Table::table_name(), Keys::[key()], Opts::get_all_opts()) -> items_return()
get_all(Table::table_name(), Keys::[key()], Opts::get_all_opts(), Config::aws_config() | batch_read_ddb_opts()) -> items_return()
list_tables_all() -> any()
list_tables_all(Config::aws_config()) -> {ok, [table_name()]} | {error, any()}
put_all(Table::table_name(), Items::[in_item()]) -> ok | {error, term()}
put_all(Table::table_name(), Items::[in_item()], Opts::ddb_opts()) -> ok | {error, term()}
put_all(Table::table_name(), Items::[in_item()], Opts::ddb_opts(), Config::aws_config()) -> ok | {error, term()}
Perform one or more BatchWriteItem operations to put all items. Operations are performed in parallel. Writing to only one table is supported.
ok =
erlcloud_ddb_util:put_all(
[{<<"Forum">>,
[[{<<"Name">>, {s, <<"Amazon DynamoDB">>}},
{<<"Category">>, {s, <<"Amazon Web Services">>}}],
[{<<"Name">>, {s, <<"Amazon RDS">>}},
{<<"Category">>, {s, <<"Amazon Web Services">>}}],
[{<<"Name">>, {s, <<"Amazon Redshift">>}},
{<<"Category">>, {s, <<"Amazon Web Services">>}}],
[{<<"Name">>, {s, <<"Amazon ElastiCache">>}},
{<<"Category">>, {s, <<"Amazon Web Services">>}}]
]}]),
q_all(Table::table_name(), KeyConditionsOrExpression::conditions() | expression()) -> items_return()
q_all(Table::table_name(), KeyConditionsOrExpression::conditions() | expression(), Opts::q_all_opts()) -> items_return()
q_all(Table::table_name(), KeyConditionsOrExpression::conditions() | expression(), Opts::q_all_opts(), Config::aws_config()) -> items_return()
Perform one or more Query operations to get all matching items.
{ok, Items} =
erlcloud_ddb_util:q_all(
<<"Thread">>,
<<"ForumName = :n AND LastPostDateTime BETWEEN :t1 AND :t2">>,
[{expression_attribute_values,
[{<<":n">>, <<"Amazon DynamoDB">>},
{<<":t1">>, <<"20130101">>},
{<<":t2">>, <<"20130115">>}]},
{index_name, <<"LastPostIndex">>},
{select, all_attributes},
{consistent_read, true},
{typed_out, true}]),
scan_all(Table::table_name()) -> items_return()
scan_all(Table::table_name(), Opts::scan_all_opts()) -> items_return()
scan_all(Table::table_name(), Opts::scan_all_opts(), Config::aws_config()) -> items_return()
Perform one or more Scan operations to get all matching items.
{ok, Items} =
erlcloud_ddb_util:scan_all(
<<"Thread">>,
[{segment, 0},
{total_segments, 4},
{typed_out, true}]),
set_out_opt(Opts::batch_read_ddb_opts()) -> ddb_opts()
wait_for_table_active(Table) -> any()
wait_for_table_active(Table, AWSCfg) -> any()
wait_for_table_active(Table, Interval, RetryTimes) -> any()
wait_for_table_active(Table::table_name(), Interval::pos_integer() | infinity, RetryTimes::non_neg_integer() | infinity, Config::aws_config()) -> ok | {error, deleting | retry_threshold_exceeded | any()}
wait until table_status==active.
erlcloud_ddb2:wait_for_table_active(<<"TableName">>, 3000, 40, Config)
write_all(Table::table_name(), Items::[write_all_item()]) -> ok | {error, term()}
write_all(Table::table_name(), Items::[write_all_item()], Opts::ddb_opts()) -> ok | {error, term()}
write_all(Table::table_name(), Items::[write_all_item()], Opts::ddb_opts(), Config::aws_config()) -> ok | {error, term()}
Perform one or more BatchWriteItem operations to put or delete all items. Operations are performed in parallel. Writing to only one table is supported.
ok =
erlcloud_ddb_util:write_all(
[{<<"Forum">>,
[{put, [{<<"Name">>, {s, <<"Amazon DynamoDB">>}},
{<<"Category">>, {s, <<"Amazon Web Services">>}}]},
{put, [{<<"Name">>, {s, <<"Amazon RDS">>}},
{<<"Category">>, {s, <<"Amazon Web Services">>}}]},
{put, [{<<"Name">>, {s, <<"Amazon Redshift">>}},
{<<"Category">>, {s, <<"Amazon Web Services">>}}]},
{put, [{<<"Name">>, {s, <<"Amazon ElastiCache">>}},
{<<"Category">>, {s, <<"Amazon Web Services">>}}]}
]}]),
Generated by EDoc