Update dynamodb to use the latest API version #209
Conversation
|
Note that this includes several breaking changes. So we might want to release a major version with it, or change it to support both the deprecated and new versions. |
| # | ||
| # See DynamoDB Documentation: http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html | ||
| # | ||
| def query(table_name, options = {}) |
There was a problem hiding this comment.
I'm not super familiar with the new stuff here, but is there any way we could take either format here? ie if hash_key is supplied, warn about deprecation but then merge it appropriately into the options and continue? If so, would be great to avoid the backwards-incompatibility here.
There was a problem hiding this comment.
The previous API required a HashKeyValue argument, which contained: {:S => 1}.
See http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/API_Query_v20111205.html
DynamoDB would take the id and compare the provided value with it.
The new API requires to do:
:KeyConditionExpression => 'id = :id'
And unless the DynamoDB documentation is wrong, it doesn't appear HashKeyValue is still supported.
Transforming the former hash to the new value seems difficult, as we don't know the name of the primary key.
There was a problem hiding this comment.
Hmm. Maybe we should still catch that case to provide a more explicit/specific error message, even if we just have to bail out at that point. What do you think?
There was a problem hiding this comment.
Sure, that works for me. I'll do that.
There was a problem hiding this comment.
I've updated this to show a deprecation notice and fallback to the former api version.
|
Thanks, looking good overall. |
| # See DynamoDB Documentation: http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html | ||
| # | ||
| def query(table_name, options = {}, hash_key_deprecated = nil) | ||
| if has_deprecated_hash_key || (options.keys.length == 1 && [:S, :N, :B].include?(options.keys.first.to_sym)) |
There was a problem hiding this comment.
Hey, maybe I'm just missing something, but where is has_deprecated_hash_key defined? Seems like maybe we could just drop that part of the conditional?
There was a problem hiding this comment.
It is a method argument. We need it because the method signature changes, as DynamoDB doesn't have any HashKey option anymore. We need to do a string KeyConditionExpression instead.
There was a problem hiding this comment.
Right. But in that case wouldn't it be if hash_key_deprecated?
There was a problem hiding this comment.
You're absolutely right. I've fixed it. Thanks you.
|
Thanks! |
Update dynamodb to use the latest API version
The
20111205API version is deprecated, and doesn't provide many of the features the latest version offers, such as the conditional parameters.